Zeichen die escaped werden muessen

    \$
    \&
    \%
    \#
    \{
    \}
    \_

    Tag-Klammern muessen folgendermassen angegeben werden:

    $>$
    $<$

    Ausgabe:

    >
    <

    Da dies sehr umstaendlich ist, gibt es in der eisfair und der Devdoku den Befehl

    \tag

    Beispiel:

    \tag{package}

    Gibt folgenden Text mit fester Zeichenbreite aus:

    <package>

    Kann leider nicht in Ueberschriften (z.B. \section{\tag{package}-Tag}) verwendet werden (wieso weiss ich nicht). Hier muss dann z.B.

    \subsection{$<$name$>$-Tag}

    angegeben werden


$package

    Um den Paketnamen als $package in nicht-proportionaler Schrift in kursiv zu schreiben,
    genuegt es ihn als \package bzw. \PACKAGE zu schreiben.


Neue Zeile erzwingen

    Hinter die Zeile zwei Backslashes haengen:

    \\

Zeilenumbrueche

    Einfache Zeilenumbrueche im Latex-Quelltext sind Latex egal.
    Doppelte Zeilenumbrueche erzeugen einen Absatz im fertigen Dokument.

Sprungmarken einfuegen

    \marklabel{name_der_sprungmarke}{Linktext, kann auch \subsection{Meine ueberschrift o.ae.} enthalten}

    Beispiel:

        \marklabel{nametag}{\subsection{$<$name$>$-Tag}}

Auf Sprungmarken verweisen

    \jump{name_der_sprungmarke}{Linktext, kann auch z.B. \tag{name}-Tag enthalten}

    Beispiel:

        \jump{nametag}{\tag{name}-Tag}

Text so einfuegen wie er ist

    \begin{verbatim}
    blabla
    blafasel
    text
    \end{verbatim}

    Achtung: _Alle_ Leerzeichen werden mit in das neue Dokument uebernommen. Deshalb sollte der Text in verbatim-Abschnitten immer in der Spalte 0 im Quelltext beginnen, da sonst der Text im fertigen Dokument zu stark eingerueckt ist.

Hinweis/Achtung-Kaesten einfuegen

    Dafuer gibt es folgende Befehle: \achtung, \hinweis und \tipp

    Beispiel:

        \tipp{
            Bei den Tags \tag{edit} und \tag{init} koennen in der Option \begin{tt}package=''\end{tt} auch
            mehrere Pakete durch Leerzeichen getrennt angegeben werden. Die jeweiligen
            Aktionen werden dann fuer alle Pakete ausgefuehrt:\\

            Beispiel:

            \begin{tt}
            <init package='foo bar' task='start'>Foo und Bar starten</init>
            \end{tt}
        }

Tabellen einfuegen

    Einfache Tabelle ohne Gitternetz

        Beispiel:

            \begin{tabular}{rl}
            X & Hauptversion\\
            Y & Unterversion\\
            Z & Patchlevel\\
            \end{tabular}

        Das "{ll}" in der ersten Zeile bedeutet: Erste Zeile _r_echts ausgerichtet, Erste Zeile _l_inks ausgerichtet

        Mit "&" wird in die naechste horizontale Zelle gesprungen.

    Tabelle mit Gitternetz

        Beispiel:

        \tablehead{\hline Tag & Bedeutung \\ \hline}
        \begin{supertabular}{|l|p{10cm}|}
            \tag{name} & Der Name des Pakete \\
            \tag{short} & Eine Kurzbeschreibung (max 60 Zeichen). Dieser Tag darf nicht nochmals der Name des Paketes enthalten. \\
            \tag{version} &Die Version des Paketes (siehe \jump{versiontag}{version-Tag}) \\
            \hline
        \end{supertabular}

        \hline f"ugt eine horizontale Linie ein.

        Das "{|l|p{10cm}|}" in der ersten Zeile bedeutet: Vertikale Linie, _l_inks ausgerichteter Text, vertikale Linie, 10cm Spaltenbreite, vertikale Linie

        Mit "&" wird in die naechste horizontale Zelle gesprungen.

Ergebnis anschauen

    Komplette Doku erstellen

        $ make devdoc.pdf

        (Output im selben Verzeichnis)

        bzw.

        $ make devdoc.html

        (Output im Verzeichnis './output/')

    Nur ein bestimmtes Kapitel erstellen

        z.B. nur scripts.tex

        $ make script.pdf

        (Output im Verzeichnis './output/scripts.pdf')

        bzw.

        $ make scripts.html

        (Output im Verzeichnis './output/scripts/')

Fabian Wolter <fabian@eisfair.org>, 27. November 2004