Subsections

1.1 Template - Ein Beispiel-Paket

1.1.1 Strukturierung des Dokumentes

Die Strukturierung des Dokumentes erfolgt durch die folgenden Kommandos:

In den geschweiften Klammern steht dann der jeweilige Titel des Abschnittes. Wie das konkret aussieht, kann man sich im Anhang dieses Paketes ansehen.

Zur Aufzählung von Dingen werden drei Umgebungen verwendet:

itemize
Mit itemize wird eine unnummerierte Aufzählung erzeugt, die wie folgt aussehen könnte:

Erzeugt wurde diese Aufzählung durch folgenden LATEX-Code:

  \begin{itemize}
  \item erster Punkt
  \item zweiter Punkt
    \begin{itemize}
    \item erster Unterpunkt
    \item zweiter Unterpunkt
    \end{itemize}
  \end{itemize}

enumerate
Mit enumerate wird eine nummerierte Aufzählung erzeugt, die wie folgt aussehen könnte:
  1. erster Punkt
  2. zweiter Punkt
    1. erster Unterpunkt
    2. zweiter Unterpunkt

Erzeugt wurde diese Aufzählung durch folgenden LATEX-Code:

  \begin{enumerate}
  \item erster Punkt
  \item zweiter Punkt
    \begin{enumerate}
    \item erster Unterpunkt
    \item zweiter Unterpunkt
    \end{enumerate}
  \end{enumerate}

description
Mit description wird eine unnummerierte Liste erzeugt, in der die einleitenden Worte fett gedruckt werden (siehe Quelltext dieser Dokumentation).


1.1.2 Spezielle Kommandos für die fli4l-Dokumentation

In der fli4l-Dokumentation werden einige Kommandos und Umgebungen definiert, die das Schreiben der Dokumentation vereinfachen und die für ein einheitliches Aussehen sorgen sollen. Das sind im Wesentlichen die Folgenden:

config
Beschreibung einer Konfigurationsvariablen im folgenden Format:

 		\config{var var1 ...}{index}{label}{beschreibung}.  

Die angeführten Variablen werden fett gedruckt der Beschreibung voran gestellt. Zusätzlich wird ein Eintrag im Index und ein Label erstellt, die dazu benutzt werden können, schnell zu dieser Variable zu gelangen. Aussehen könnte das wie folgt:

FOO_N FOO_x
Beschreibung der Konfiguration von FOO_N und FOO_x

Erzeugt wird dies durch folgenden LATEX-Code:

    \begin{description}
      \config{FOO\_N  FOO\_x}{FOO\_N}{FOON}{Beschreibung der
        Konfiguration von \var{FOO_N} und \var{FOO_x}}
    \end{description}

Im Index erscheint das Stichwort FOO_N und man kann mit Hilfe von \jump{FOON} eine Referenz auf diese Stelle erzeugen.

Um Listen mit Unterschieden zwischen Versionen richtig generieren zu können, ist es nötig, dass das Label (hier: FOON) identisch ist mit dem Index (hier FOO_N), jedoch ohne Unterstriche.

Also: Index: FOO\_N => Label: FOON.

Die Umgebung description braucht man nur einmal auf und wieder zuzumachen, wenn man mehrere Variablen beschreibt.

configlabel
Setzen eines Index-Eintrages und eines Labels für eine Variable. Im obigen Beispiel haben wir zwei Variablen beschrieben, aber nur für eine (FOO_N) einen Index-Eintrag und ein Label erzeugt. Für FOO_x muß man das separat machen, indem man folgende Zeile hinzufügt:


 		\configlabel{FOO\_x}{FOOx}.  

Aussehen könnte das dann wie folgt:

    \begin{description}
      \configlabel{FOO\_x}{FOOx}
      \config{FOO\_N  FOO\_x}{FOO\_N}{FOON}{Beschreibung der
        Konfiguration von \var{FOO\_N} und \var{FOO\_x}}
    \end{description}

marklabel
Setzt ein Label, das man von anderen Stellen im Dokument aus referenzieren kann. So können wir z.B. die Abschnitte referenzieren, indem wir die sie wie folgt einleiten:
\marklabel{sec:fli4lenv}{
  \subsection{Spezielle Kommandos für die fli4l-Dokumentation}
}

jump
Mit \jump{label}{text} können wir einen Verweis auf eine andere Stelle im Dokument generieren, die man z.B. im html/pdf Format einfach anklicken kann. Wollen wir also zur Beschreibung der Variable FOO_x springen, schreiben wir:
(\jump{FOOx}{\var{FOO\_x}})

Im Text sieht das dann so aus: (FOO_x)

smalljump
Kleiner jump, wie jump, nur dass die Seitennummer nicht hinzugefügt wird (pdf/ps). Beispiel:
(\smalljump{FOOx}{\var{FOO\_x}})

Im Text sieht das dann so aus: (FOO_x)

altlink
Mit \altlink{url} fügt man eine URL ins Dokument ein, z.B. könnte eine Referenz auf die fli4l-Webseite wie folgt aussehen: http://www.fli4l.de, generiert von folgendem Statement:

\altlink{http://www.fli4l.de}
Achtung: das veraltete Kommando \link{url} ist abgekündigt und sollte nicht mehr verwendet werden.

achtung, wichtig
Mit \achtung{text} und \wichtig{text} können Dinge im Text hervor gehoben werden.

Aus \achtung{Beachten sie, dass ...} wird:


Beachten sie, dass ...

und aus \wichtig{Beachten sie, dass ...} wird:


Wichtig: Beachten sie, dass ...

email
Angabe einer E-Mail-Adresse in der Form \email{foo@bar.org}, im Text sieht das dann so aus:

E-Mail: foo@bar.org

var
Da Variablen einfach so in den Text eingestreut einfach häßlich aussehen, werden sie in \var{FOO\_x} geklammert und anders formatiert. Das sieht dann wie folgt aus: FOO_x versus FOO_x

example
Beispiele haben die Tendenz, sehr viel Platz einzunehmen. Diese werden daher mit \begin{example} ... \end{example} eingeklammert und einheitlich in einem etwas kleineren Font gesetzt.

© 2001-2016 Das fli4l-Team - February 16, 2016