<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">\etocsettocdepth.toc{section}%
%
\section{Notations, syntaxe, terminologie et codes couleurs}\label{sec-synt-term-notat}

Ce chapitre prÃ©cise les notations, syntaxe, terminologie et codes couleurs de
la prÃ©sente documentation.


\subsection{Commandes, environnements, clÃ©s, valeurs}\label{sec-comm-envir-cles}

Les commandes, environnements, clÃ©s et valeurs de clÃ©s sont systÃ©matiquement
composÃ©s en fonte Ã&nbsp; chasse fixe. En outre, pour plus facilement les
distinguer, ils figurent avec des couleurs propres :
\begin{itemize}
\item les commandes en bleu : \docAuxCommand*{commande} ;
\item les environnements en \enquote{sarcelle} :
  \docAuxEnvironment*{environnement} ;
\item les clÃ©s en pourpre : \docAuxKey*{clÃ©} ;
\item les valeurs des clÃ©s en violet : \docValue*{valeur}.
\end{itemize}

\subsection{Arguments gÃ©nÃ©riques}
\label{sec-arguments-generiques}

Pour expliquer le rÃ´le d'une commande, il est parfois nÃ©cessaire d'indiquer
Ã&nbsp; quoi celle-ci s'applique, autrement dit quel en est l'argument gÃ©nÃ©rique.
Un tel argument est composÃ© :
\begin{itemize}
\item en fonte Ã&nbsp; chasse fixe ;
\item en italique ;
\item entre chevrons simples ;
\end{itemize}
le tout en marron, ainsi : \meta{argument gÃ©nÃ©rique}.

\subsection{Liens hypertextes}
\label{sec-liens-hypertextes}

Les liens hypertextes figurent en couleur, ainsi :
\href{http://gte.univ-littoral.fr/members/dbitouze/pub/latex}{lien hypertexte}.
La plupart des rÃ©fÃ©rences aux commandes, environnements et clÃ©s dÃ©finis dans la
prÃ©sente documentation, sont des liens hypertextes, surmontÃ©s du numÃ©ro de page
oÃ¹ se trouve la cible correspondante (sauf si elle se situe sur la mÃªme page) :
\begin{itemize}
\item \refCom{author} ;
\item \refEnv{abstract}.
\end{itemize}


\subsection{Ã‰lÃ©ments \enquote{obligatoires}}
\label{sec-comm-oblig}

L'icÃ´ne \mandatory{}, figurant en regard de certains Ã©lÃ©ments (commandes ou
environnements), indique que ceux-ci sont \enquote{obligatoires}.

\subsection{Codes sources}
\label{sec-codes-sources}

Les exemples qui illustrent la prÃ©sente documentation sont constituÃ©s de codes
sources et, le cas Ã©chÃ©ant, des \enquote{copies d'Ã©cran} correspondantes.
% Ceux-ci proviennent le plus souvent du spÃ©cimen de document composÃ© avec la
% \yatcl, fourni avec l'ensemble de la classe
% (cf. \vref{sec-specimen-arborescence}).

Ces codes sources figurent dans des cadres de couleur bleu :
\begin{itemize}
\item non ombrÃ©s s'ils doivent Ãªtre saisis dans le corps du document ;
\item ombrÃ©s s'ils doivent Ãªtre saisis en prÃ©ambule du fichier (maÃ®tre).
\end{itemize}
Ces cadres pourront en outre comporter d'Ã©ventuels titres :
\begin{multicols}{2}
\begin{bodycode}
"\meta{code source}"
\end{bodycode}
\begin{bodycode}[title=\meta{titre}]
"\meta{code source}"
\end{bodycode}
\begin{preamblecode}
"\meta{code source Ã&nbsp; insÃ©rer en prÃ©ambule}"
\end{preamblecode}
\begin{preamblecode}[title=\meta{titre}]
"\meta{code source Ã&nbsp; insÃ©rer en prÃ©ambule}"
\end{preamblecode}
\end{multicols}

\subsection{Espaces dans les codes sources}
\label{sec-espaces-dans-les}

Pour Ã©viter certaines confusions, les espaces dans les codes sources devant
Ãªtre saisis au clavier sont parfois matÃ©rialisÃ©s au moyen de la marque
\lstinline[showspaces]+ +.

\subsection{Options}
\label{sec-options}

La prÃ©sente classe, ainsi que certaines de ses commandes et certains de ses
environnements, peuvent Ãªtre modulÃ©s au moyen d'options, ou listes d'options
(sÃ©parÃ©es par des virgules). Ces options se prÃ©sentent sous la forme
\meta{clÃ©}|=|\meta{valeur} et la \meta{valeur} passÃ©e Ã&nbsp; une \meta{clÃ©} peut
Ãªtre :
%^^A \begin{description}
%^^A \item[ne prennent pas de valeur.] Une telle option, par exemple nommÃ©e
%^^A   \refKey{option}, est alors documentÃ©e selon la syntaxe suivante:
%^^A     \begin{docKey*}{option}{}{\meta{valeurs par dÃ©faut et initiale}}
%^^A       \meta{Description de \refKey{option}}
%^^A     \end{docKey*}
%^^A \item[prennent des valeurs.] Une telle option se prÃ©sente alors sous la forme
%^^A   \meta{clÃ©}"="\meta{valeur}. Les valeurs passÃ©es Ã&nbsp; une clÃ© peuvent Ãªtre :
\begin{description}
\item[libre.] Si une telle \meta{clÃ©} est (pour l'exemple) nommÃ©e
  \refKey{freekey}, elle est alors documentÃ©e selon la syntaxe suivante :
  \begin{docKey*}{freekey}{=\meta{valeur}}{\meta{valeurs par dÃ©faut et initiale}}
    \meta{Description de \refKey{freekey}}
  \end{docKey*}
\item[imposÃ©e] (parmi une liste de valeurs possibles). Si une telle \meta{clÃ©} est
   (pour l'exemple) nommÃ©e \refKey{choicekey} et de valeurs imposÃ©es
  \docValue*{valeur1}, \docValue*{valeur2}, ..., \docValue*{valeurN}, elle est alors
  documentÃ©e selon la syntaxe suivante\footnote{Comme souvent en informatique,
    la barre verticale sÃ©parant les valeurs possibles signifie \enquote{ou}.} :
  \begin{docKey*}{choicekey}{=\docValue*{valeur1}\textbar\docValue*{valeur2}\textbar...\textbar\docValue*{valeurN}}{\meta{valeurs par dÃ©faut et initiale}}
    \meta{Description de \refKey{choicekey} et de ses valeurs possibles}
  \end{docKey*}
\end{description}
%^^A \end{description}

Les \meta{valeurs par dÃ©faut et initiale} d'une clÃ© sont souvent prÃ©cisÃ©es
(entre parenthÃ¨ses en fin de ligne). Elles indiquent ce que la clÃ© vaut :
\begin{description}
\item[par dÃ©faut] c'est-Ã&nbsp;-dire lorsque la clÃ© \emph{est} employÃ©e, mais
  \emph{seule} c'est-Ã&nbsp;-dire sans qu'une valeur explicite lui soit passÃ©e ;
\item[initialement] c'est-Ã&nbsp;-dire lorsque la clÃ© \emph{n'est pas} employÃ©e.
\end{description}

%%% Local Variables:
%%% mode: latex
%%% eval: (latex-mode)
%%% ispell-local-dictionary: "fr_FR"
%%% TeX-master: "../gzt-fr.tex"
%%% End:
</pre></body></html>