DO-cartographie/chapitres/chapter2.tex

\chapter{Configuration} \label{chapter:configuration}

Ce chapitre présente essentiellement le fichier \src{config.tex}\index{config.tex} qui permet la configuration générale du travail de maturité.

\section{Config.tex}

Au \squote{c\oe ur} de la configuration du travail de maturité se trouvent une série de questions posées au rédacteur qui permettent de mettre à sa disposition les différents éléments dont il va avoir besoin. Ces questions se trouvent regroupées dans le fichier \apath{config.tex}\index{config.tex} sous différentes sections.

Ici encore les commentaires\index{commenter} jouent un rôle très important. En effet, c'est généralement en décommentant une option et en l'adaptant à ce qu'on désire qu'on peut configurer le modèle. Évidemment, des commentaires (eux-même aussi commentés pas un \%) précisent les lignes qu'il faut décommenter\index{décommenter} suivant les cas et dont il ne faut pas changer la structure, mais seulement une partie facilement identifiable.

\begin{description}
 \item[La langue\index{langue}] Trois langue sont proposées : français\index{français}, anglais\index{anglais} et allemand\index{allemand}. Ce choix est très important. Il va introduire l'adaptation de toute une série de mots clé selon la langue choisie. Généralement, par défaut, les mots qui n'admettent pas de choix sont automatiquement traduits (comme le mot Chapitre qui apparaît dans l'entête). Cependant, il est parfois possible de les changer en utilisant le fichier de configuration. Mais, celui-ci ne va pas tout faire et quand la traduction ne se fait pas automatiquement, c'est que le choix est laissé à l'utilisateur. Alors, le changement est à faire dans les fichiers où se trouve le contenu du travail, comme les chapitres\index{chapitre} par exemple.
 \item[La page de titre\index{page de titre}] S'y trouvent définis les titre et sous-titre\index{sous-titre} du travail, le type de travail\index{type de travail}, l'auteur\index{auteur}, la date\index{date} et le mentor\index{mentor}. Relevez que normalement la page de titre se trouvant sous \apath{pagesspeciales/pagetitre.tex}\index{pagetitre.tex} n'a pas à être modifiée. Les différents éléments évoqués ci-dessus suffisent pour la définir, exception faite d'une éventuelle image de titre\index{image de titre}.
 \item[Le pied de page\index{pied de page}] S'y trouvent définis le domaine\index{domaine}, c'est-à-dire l'option spécifique ou complémentaire ou autre, du travail ainsi que le nom\index{nom de l'école} et l'adresse de l'école\index{adresse de l'école}.
 \item[Citations, remerciements, acronymes, etc] On peut choisir ici de mettre une page contenant une pensée\index{pensée} ou citation\index{citation}, une page contenant un préambule\index{préambule}, une dédicace\index{dédicace}, des remerciements\index{remerciements}, une page contenant un résumé\index{résumé}, une page d'acronymes\index{acronymes}, une page présentant la licence\index{licence} du travail, une page présentant le site associé\index{site associé} au travail, une autre le cdrom associé\index{cdrom associé} et enfin une page d'index\index{index}.
 \item[Chapitres\index{chapitre}] On définit ici le nombre de chapitres qu'on désire. Des fichiers \apath{chapter1.tex}, \apath{chapter2.tex} \dots{} \apath{chapter9.tex}\index{chapterxx.tex} sont déjà présents dans le répertoire associé \apath{chapters}. Il suffit alors de remplir ceux dont on a besoin. Si on veut plus de dix chapitres, il faut simplement copier l'un d'entre eux et en rajouter le bon nombre sous la forme \apath{chapter10.tex}, \apath{chapter11.tex} \dots{} et d'en définir le nombre correctement.
 
 Notez que si la conclusion\index{conclusion} est un chapitre à part entière, il se trouve dans un fichier éponyme situé sous \apath{chapitres/conclusion.tex}\index{conclusion.tex}.
 \item[Listes des figures, tables et listings] On définit ici la présence des page contenant la liste des figures\index{liste des figures} et/ou la liste des tables\index{liste des tables} et/ou la liste des listings\index{liste des listings}\index{liste des codes sources}. Par défaut, tout est activé pour se rendre compte de ce qui est disponibles. Pour désactiver l'un ou l'autre des ces éléments, il faut donc décommenter la ligne qui lui correspond.
 \item[Figures] On définit ici le chemin par défaut vers le répertoire des figures\index{répertoire des figures}. Le point correspond au répertoire ou se trouve le fichier \apath{main.tex}\index{main.tex}.
 \item[Insertion de code : listings] Le package listings\index{listings} permet d'insérer du code\index{code} dans latex. Plusieurs langages\index{langage de code} sont disponibles, par exemple HTML et PHP. Mais seul latex est appelé par défaut. On peut charger d'autres langages pour les listings selon le modèle de la ligne suivante :
 \lstinline!\lstloadlanguages{HTML,PHP,TeX}!.
 
 Aussi on peut mettre du code latex pour référencer le numéro des lignes. Il faut alors avoir recours à un caractère d'échappement\index{caractère d'échappement} sur le modèle suivant : \lstinline!\lstloadlanguages{Python}! suivi de \lstinline!\lstset{language=Python,escapechar=|}!

 Après le caractère d'échappement, on peut alors placer une commande de référencement\index{commande de référencement} \lstinline!\label{}! qui permet d'avoir accès au numéro de la ligne\index{numéro de ligne} dans le texte via \lstinline!\ref{}!.
 \item[Le texte] Se règle ici l'indentation de la première ligne\index{indentation de première ligne} de chaque paragraphe. Différentes possibilités sont présentes et il suffit d'en choisir une en la décommentant.
 \item[Un index] Il n'est pas nécessaire de réaliser un index. Par défaut, il y en a cependant un. Décommentez cette ligne si vous n'en voulez pas. Attention, pour construire le fichier d'index idx, il doit être compilé avec makeindex en ligne de commande ou dans les outils de Texmaker\index{Texmaker}\index{outils de Texmaker}.
\end{description}

\section{Version provisoire\index{version provisoire}}

Pendant la rédaction et par défaut le modèle est placé en mode \og draft\fg\index{draft}. Ce mode offre différents outils pour faciliter la rédaction.

Notamment, il va mettre l'indication \og Version provisoire\fg{} (ou son équivalent en anglais ou allemand) en filigrane\index{filigrane} en haut à gauche et changer la date\index{date} sur la page de titre\index{page de titre} pour y mettre une indication portant le jour, alors que dans la version finale celle-ci n'apparaît pas.

Mais, il va aussi entre autres\endnote{Voir une liste plus complète à l'adresse \url{http://tex.stackexchange.com/questions/49277/what-does-the-draft-mode-change}} ne pas charger les images\index{image} et les codes sources\index{code source} pour accélérer la compilation tout en indiquant leur place.

Il va aussi permettre de repérer les lignes où la césure\index{césure} a été difficile par l'indication d'un carré noir en regard des lignes trop longues\index{ligne longue}.

De plus, pour vous permettre, et éventuellement pour permettre à votre mentor, des remarques, l'évocation des pistes d'approfondissement ou de propositions de modifications, le module \verb|totonotes|\index{module!todonotes} est activé par l'option draft\index{draft}. Il donne la possibilité de mettre en marge de votre document des notes telles que celle-ci\footnote{La présente documentation ne permet pas de voir cette note puisque celle-ci a été réalisée en mode de document final, sans l'option draft (voir plus loin). Pour la voir, il faut simplement compiler le document en mode draft}\todo[line]{À ne pas oublier}. Pour cela, l'instruction toute simple \lstinline!\todo[line]{À ne pas oublier}! est à placer là où on désire que la note soit placée. De multiples options de couleurs notamment ou autre sont disponibles. Voyez pour cela la documentation du module. Notez aussi que pour que la ligne pointant vers le texte soit correctement placée, il est nécessaire de compiler\index{compiler} deux fois le modèle !

\bigskip
L'ensemble de ces comportements par défaut est évidemment incompatible avec la version finale\index{version finale} du travail. Pour les désactiver, c'est-à-dire retirer le filigrane\index{filigrane} et les notes de marge\index{note de marge} notamment, il suffit de retirer l'option \verb|draft|\index{draft} de la première ligne déclarant la classe de document dans le fichier \apath{main.tex}\index{main.tex}. Pour cela, commentez et décommentez les lignes présentées dans le code \ref{listing:optiondraft} pour que suivant les cas seule la ligne comprenant l'option draft soit activée (décommentée), ou désactivée (commentée). Attention, seule une ligne peut être décommentée.

\begin{lstlisting}[float,caption={L'option draft},label={listing:optiondraft}]
\documentclass[12pt,a4paper,idxtotoc,bibtotoc,francais,titlepage,twoside,openright,draft]{book}
%\documentclass[12pt,a4paper,idxtotoc,bibtotoc,francais,titlepage,twoside,openright]{book}
\end{lstlisting}