La structure de la documentation est réalisée par les éléments de commandes suivants :
\section{}
\subsection{}
\subsubsection{}
\paragraph{}
\subparagraph{}
Vous indiquez entre les accolades le titre de la section appropriée. Pour voir un exemple concret allez dans la section annexe du paquetage.
Pour créer une liste d'objets trois environnements sont utilisés :
La liste ci-dessous est générée avec le code LATEX :
\begin{itemize} \item Premier point \item Second point \begin{itemize} \item Premier sous-point \item Second sous-point \end{itemize} \end{itemize}
La liste ci-dessous est générée avec le code LATEX :
\begin{enumerate} \item Premier point \item Second point \begin{enumerate} \item Premier sous-point \item Second sous-point \end{enumerate} \end{enumerate}
aaaaaaaa
\config{var var1 ...}{index}{label}{description}
.
Les variables sont indiqués en gras et précédée de la description. En outre si vous créez un Index et un Label, ils seront utilisés pour accéder rapidement à cette variable. Cela peut être représenté comme ceci :
La description suivante est générée avec le code LATEX :
\begin{description} \config{FOO\_N FOO\_x}{FOO\_N}{FOON}{Description de la configuration \var{FOO_N} et \var{FOO_x}} \end{description}
Vous indiquez dans l'Index le mot clé FOO_N et vous pouvez utiliser
\jump{FOON}
pour générer un point de référence.
Pour pouvoir générer correctement une liste pour différentes versions, il est nécessaire que le Label (ici : FOON) soit identique à l'Index (ici FOO_N), mais sans le trait de soulignement.
Donc, Index : FOO\_N => Label~: FOON
.
Si vous devez mettre des guillemés »description» vous devez les placer en une seul fois, si vous décrivez plusieurs variables vous devez placer les guillemés pour chaque variable.
aaaaaaaa
\configlabel{FOO\_x}{FOOx}
.
Cela peut être représenté comme ceci :
\begin{description} \configlabel{FOO\_x}{FOOx} \config{FOO\_N FOO\_x}{FOO\_N}{FOON}{Description de la configuration \var{FOO\_N} et \var{FOO\_x}} \end{description}
\marklabel{sec:fli4lenv}{ \subsection{Commandes spéciales pour la documentation de fli4l} }
\jump{label}{text}
vous pouvez générer une référence
qui sera dans un autre document, par exemple un document html/pdf, il suffira
de cliquer sur ce lien. Donc, si vous voulez générer la variable FOO_x
pour un saut de document, vous devez écrire :
(\jump{FOOx}{\var{FOO\_x}})
Dans le texte le saut sera indiqué ainsi : (FOO_x)
(\smalljump{FOOx}{\var{FOO\_x}})
Dans le texte le saut sera indiqué ainsi : (FOO_x)
\altlink{url}
vous pouvez ajouter une URL dans le
texte par exemple vous pouvez référencer le site fli4l :
http://www.fli4l.de, vous devez gérérer le lien du site de la
manière suivante :
\altlink{http://www.fli4l.de}
Attention : la commande \link{url}
est obsolète et ne doit plus être
utilisé.
\achtung{text}
et \wichtig{text}
vous pouvez mettre en évidence des éléments dans le texte.
Pour \achtung{S'il vous plaît noter que ...}
vous écrivez :
S'il vous plaît noter que ...
Et pour \wichtig{S'il vous plaît noter que ...}
vous écrivez :
Important: S'il vous plaît noter que ...
\email{foo@bar.org}
, dans le texte cela ressemblera à ceci :
courriel : foo@bar.org
\var{FOO\_x}
la forme est
différente. Cela ressemble à ceci : FOO_x par rapport à FOO_x
\begin{example} ... \end{example}
ainsi les
exemples seront affichés uniformément et plus serré avec une police plus petit.