jlcode.sty

License

This work may be distributed and/or modified under the conditions of the LaTeX Project
Public License, either version 1.3 of this license or (at your option) any later version.
The latest version of this license is in http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX version 2005/12/01 or later.

This work has the LPPL maintenance status 'maintained'.

The Current Maintainer of this work is GitHub user wg030.

This work consists of the files jlcode.sty, createlists.jl, testfile1.jl, testfile2.jl, and manual.pdf.

Short Package Description

The jlcode.sty is a latex package, which contains a Julia language definition for the listings package as well as a style definition.
Check out the manual (manual.pdf), which explains all package options and also shows how the Julia code from testfile.jl and testfile2.jl looks when displayed.

Current State

Current version of the jlcode package: 4.1.1.
Date of creation: 2018/01/25
Date of last modification: 2020/08/04

Keywords

The lists for the keywords, literals, built-ins, macros and string types for this language definition were created with the julia script createlists.jl, which was strongly inspired by the approach of the following script: https://github.com/isagalaev/highlight.js/blob/master/src/languages/julia.js.

Colors

All colors for this language definition were taken from the files
https://docs.julialang.org/en/latest/assets/themes/documenter-light.css and
https://docs.julialang.org/en/latest/assets/documenter.css.

Special Unicode Characters

All unicode characters that are supported by Julia can be found under
https://docs.julialang.org/en/latest/manual/unicode-input/.

Right now the following of them have already been added to jlcode package, too:

Most common special characters that appear in latin languages.
All greek small and capital letters.
All latin and greek letters with dot, double dot, tilde, hat or bar above.
All superscripts and subscripts (except for the latin small letter schwa).
Some mathematical operators and symbols.

What's New in Version 4.1.1?

The package option courierasttdflt has been added.
Keywords, literals, built-ins and macros have been refreshed according to Julia 1.4.2 and functions have been added.
The mathematical symbol for the partial derivative has been added.
A few typing errors have been corrected.

How to Use the Package:

Standard Use

Copy the jlcode.sty file to same folder of your latex file and add the
following line to your latex document header, which will load the package with
its default options:

\usepackage{jlcode}

Then use the package as follows:

% listing of standalone files
\lstinputlisting{filename.jl}

% displayed code
\begin{lstlisting}
# some julia code
println( "Here we go with Julia!")
\end{lstlisting}

% code snippets
Julia's standard library contains some useful macros like \jlinl{@time}.

The Option autoload

If you have to display not only Julia code with the listings package, it is
best to not load the Julia style automatically because otherwise your are very
likely to get some unwanted ugly interferences.

\usepackage[autoload=false]{jlcode}

With that option you can then use the style only when it is really needed:

% listing of standalone files
\lstinputlisting[language=julia, style=jlcodestyle]{filename.jl}

% displayed code
\begin{lstlisting}[language=julia, style=jlcodestyle]
# some julia code
println( "Here we go with Julia!")
\end{lstlisting}

% code snippets
Julia's standard library contains some useful macros like \jlinl{@time}.

The default behaviour is autoload=true.

The Options usecolors and usebox

If you want to highlight your code with some nice colors use

\usepackage[usecolors=true]{jlcode}

and if you want to have the code surrounded by a nice box, do it this way:

\usepackage[usebox=true]{jlcode}

The default values are usecolors=true and usebox=true.

The Options nocolors and nobox

If you want to print your code in black and white instead of coloured use

\usepackage[nocolors=true]{jlcode}

and if you don't want to have a code box, do it this way:

\usepackage[nobox=true]{jlcode}

The default values are nocolors=false and nobox=false.

The Option charsperline

If you decide not to get rid of the code box, you can control its number of
characters per line with this option, i.e. influence the width of the box.
However make sure your code respects the limit since otherwise some of the
displayed code will be out of the box.

\usepackage[charsperline=65]{jlcode}

The default value is charsperline=80. Moreover note that with nobox=true or usebox=false this option has no effect at all.

Known Managable Issues

Since it is rather difficult to handle special unicode characters with the listings package, there are some issues that can appear in special cases when using the jlcode package.
Most of them have to do with the fact that the listings package does not seem to offer an option, that makes it possible to force a special unicode character, for example a small greek beta, to be treated like a normal letter. Having said this the command

\lstdefinelanguage{julia}
{
  % ...
  alsoletter={β},
  % ...
}

of the listings package unfortunately causes an error.
However the problems that can occur due to this circumstance can be repaired manually. For that purpose two commands have been implemented in the jlcode package. The easiest way to show how they work is giving some examples. So here are the known managable issues and how to fix them with the jlcode package:
(See the provided example files).

identifier name with a number that follows directly behind a special unicode character:
- example:
```
  myβ2ndvar = 2 * 0.12E-2 * xʸ
```
- latex command for fixing it:
```
  \addlitjlbase{myβ2ndvar}{my$\beta$2ndvar}{9}
```

identifier name, which contains a γ, π or φ:

example:

  myφvar₊ = sqrt(2)
  approx4π = 3.142

latex command for fixing it:

  \addlitjlbase{myφvar₊}{my$\phi$var${\scriptstyle {}_{+}}$}{7}
  \addlitjlbase{approx4π}{approx4$\pi$}{8}

numbers in E-notation wihtout using a + sign:

example:
```
  evar = 3.99e400
  evar₂ = 3.99E400
```

latex commands for fixing it:

  \addlitjlstring{e400}{e400}{4}
  \addlitjlstring{E400}{E400}{4}

single characters: