The structure of the document is generated by using the following commands:
\section{}
\subsection{}
\subsubsection{}
\paragraph{}
\subparagraph{}
Between the curly brackets place the title of the current section. What this looks like in concrete terms can be seen in the Appendix of this package.
Itemizing can be achieved in three different ways:
This item list was generated by the following LATEX-Code:
\begin{itemize} \item first item \item second item \begin{itemize} \item first subitem \item second subitem \end{itemize} \end{itemize}
This item list was generated by the following LATEX-Code:
\begin{enumerate} \item first item \item second item \begin{enumerate} \item first subitem \item second subitem \end{enumerate} \end{enumerate}
\config{var var1 ...}{index}{label}{description}
.
The variables are listed in bold type and prefix the description. In addition, an entry in the index and a label is created that can be used to access this variable quickly. This might look as follows:
This is generated by the following LATEX-Code:
\begin{description} \config{FOO\_N FOO\_x}{FOO\_N}{FOON}{Description Of Configuration For \var{FOO_N} and \var{FOO_x}} \end{description}
In the index the keyword FOO_N appears and by the help of
\jump{FOON}
a reference to this part may be generated.
In order to generate lists of differences between versions properly it is necessary that the label (in this case FOON) is identical with the index (here FOO_N), but without underscores.
Hence: Index: FOO\_N => Label: FOON
.
When describing more variables the environment description only needs to be opened and closed once.
\configlabel{FOO\_x}{FOOx}
.
This might look as follows:
\begin{description} \configlabel{FOO\_x}{FOOx} \config{FOO\_N FOO\_x}{FOO\_N}{FOON}{Description Of Configuration For \var{FOO\_N} und \var{FOO\_x}} \end{description}
\marklabel{sec:fli4lenv}{ \subsection{Special Commands For The fli4l Documentation} }
\jump{label}{text}
a clickable (i.e. in html/pdf format)
reference to another part of the document can be generated. If we want to jump to
the description for variable FOO_x we write:
(\jump{FOOx}{\var{FOO\_x}})
In the text this looks like this: (FOO_x)
(\smalljump{FOOx}{\var{FOO\_x}})
In the text this looks like this: (FOO_x)
\altlink{url}
an URL is inserted into the document
i.e. a reference to fli4l's website might look like this:
http://www.fli4l.de, generated by the statement:
\altlink{http://www.fli4l.de}
Attention: the old command \link{url}
is deprecated and
should not be used anymore.
\achtung{text}
and
\wichtig{text}
passages may be highlighted in the text.
\achtung{Please note that...}
will become:
Please note that...
and \wichtig{Please note that...}
will become:
Important: Please note that...
\email{foo@bar.org}
, in the text looks like this:
email: foo@bar.org
\var{FOO\_x}
and get formatted different.
This looks as follows: FOO_x versus FOO_x
\begin{example} ... \end{example}
and hence will be uniformly set in a slightly smaller font.