Subsections

1.1 Template - A Package Example

1.1.1 Structure Of The Document

The structure of the document is generated by using the following commands:

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:

itemize
With itemize an unnumbered list is generated, that could look like this:

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}

enumerate
With enumerate a numbererd list is generated, that could look like this:
  1. first item
  2. second item
    1. first subitem
    2. second subitem

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}

description
With description an unnumbered list with introductory words in bold is generated (see the source of this documentation).


1.1.2 Special Commands For The fli4l Documentation

In the fli4l documentation some commands and environments are defined, that simplify the writing of documentation and ensure uniform appearance. These are basically the following:

config
Description of a config variable in the following format:

 		\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:

FOO_N FOO_x
Description Of Configuration For FOO_N and FOO_x

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
Insert an index entry and a label for a variable. In the example above we have described two variables, but only for (FOO_N) an index entry and a label was generated. For FOO_x this has to be done separately, by adding the following line:


 		\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
Sets a label that can be referenced from other locations in the document. In this way it is possible to reference sections by starting the sections as follows:
\marklabel{sec:fli4lenv}{
  \subsection{Special Commands For The fli4l Documentation}
}

jump
With \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
Small jump, like jump, but without page number appended (pdf/ps). Example:
(\smalljump{FOOx}{\var{FOO\_x}})

In the text this looks like this: (FOO_x)

altlink
With \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, wichtig
With \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
Specifying an E-Mail-Address in the form \email{foo@bar.org}, in the text looks like this:

email: foo@bar.org

var
Since variables look ugly when just being inserted in the text, they might be bracketed with \var{FOO\_x} and get formatted different. This looks as follows: FOO_x versus FOO_x

example
Examples tend to occupy a lot of space. Therefore they should be bracketed with \begin{example} ... \end{example} and hence will be uniformly set in a slightly smaller font.

© 2001-2016 The fli4l-Team - 16 February 2016