Sous-sections

1.1 Template - Modèle de documentation pour un paquetage

1.1.1 Structure de la documentation

La structure de la documentation est réalisée par les éléments de commandes suivants :

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 :

Avec [itemize] vous générez et détaillez une liste non numérotée, comme ceci :

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}

Avec [enumerate] vous générez et détaillez une liste numérotée, comme ceci :
  1. Premier point
  2. Second point
    1. Premier sous-point
    2. Second sous-point

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}

Avec [description] vous générez une liste non numérotée, donc l'introduction les mots sont imprimés en caractères gras (voir la source de cette documentation).


1.1.2 Commande spéciale pour la documentation de fli4l

Dans la documentation de fli4l les commandes et les environnements sont prédéfinis cela simplifie l'écriture de la documentation et assure une apparence uniforme. Les commandes essentielles sont les suivants :

Avec [config] vous faite une description de la variable de configuration dans le format suivant :


    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 :

FOO_N FOO_x
Description de la configuration de FOO_N et de FOO_x

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.

Avec [configlabel] vous pouvez ajouter un Index et un Label pour la variable. Dans l'exemple ci-dessus nous avons décrit deux variables pour (FOO_N), ici nous allons définir seulement une variable pour l'Index et le Label. Pour FOO_x on doit le paramétrer séparément, en ajoutant la ligne suivante :



    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}

Avec [marklabel] vous pouvez définir un Label pour une référence ailleurs dans le document. Ainsi, vous pouvez par exemple référencer un paragraphe, vous pouvez introduire les paragraphes de la manière suivante :

\marklabel{sec:fli4lenv}{
  \subsection{Commandes spéciales pour la documentation de fli4l}
}

Avec [jump] \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)

Avec [smalljump] »petit saut», la seule différence pour ce saut, les numéros de page ne sont pas ajoutés dans les documents (pdf/ps). Exemple :

(\smalljump{FOOx}{\var{FOO\_x}})

Dans le texte le saut sera indiqué ainsi : (FOO_x)

Avec [altlink] \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é.

Avec [achtung, wichtig] \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 ...

Avec [email] vous pouvez indiquez une Adresse-E-Mail sous la forme \email{foo@bar.org}, dans le texte cela ressemblera à ceci :

courriel : foo@bar.org

Avec [var] une simple variable qui est parsemée dans le texte est tous simplement laid, mais si elle est assemblée \var{FOO\_x} la forme est différente. Cela ressemble à ceci : FOO_x par rapport à FOO_x

Avec [example] les exemples ont tendances à prendre beaucoup d'espace. Vous pouvez utiliser \begin{example} ... \end{example} ainsi les exemples seront affichés uniformément et plus serré avec une police plus petit.

© 2001-2016 L'équipe fli4l - 16 février 2016