Début de l'indexation

This commit is contained in:
Guyot 2015-12-31 12:41:57 +01:00
parent d3b162af8f
commit 02ffeb764d
4 changed files with 34 additions and 99 deletions

View File

@ -2,33 +2,33 @@
\section{Motivations et Objectifs}
\subsection{Motivations}
Désormais l'utilisation de \LaTeX{} au lycée fait partie des connaissances que doivent acquérir les élèves qui on choisi des options techniques. Si de telles connaissances sont absolument nécessaire pour ces élèves, en considérant le résultat fourni, d'autres élèves font régulièrement la demande pour pouvoir utiliser \LaTeX{} pour leur travail de fin d'étude, nommé travail de maturité en Suisse. Or, leur familiarité avec \LaTeX{} est parfois trop peu importante pour que ce travail puisse se faire sans un véritable soutient des enseignants.
Désormais l'utilisation de \LaTeX{} au lycée fait partie des connaissances que doivent acquérir les élèves qui on choisi des options techniques. De telles connaissances sont absolument nécessaire pour ces élèves. Mais en considérant le résultat fourni, d'autres élèves font régulièrement la demande pour pouvoir utiliser \LaTeX{} pour leur travail de fin d'étude, nommé travail de maturité en Suisse. Or, leur familiarité avec \LaTeX{} est parfois trop peu importante pour que ce travail puisse se faire sans un véritable soutient des enseignants.
Force est de constater que la majorité des enseignants en est incapable. Et ce n'est pas dû à \LaTeX{} uniquement. Avec d'autres traitement de texte plus connus, c'est souvent la même chose.
\subsection{Objectifs}
Une solution à ce problème est constitué par le présent travail. Il s'agit d'un modèle de travail de maturité, simplement configurable, permettant de mettre à disposition des élèves ayant des connaissances de base en \LaTeX{} tous les outils nécessaires pour leur travail.
Une solution à ce problème est constitué par le présent travail. Il s'agit d'un modèle de travail de maturité, simplement configurable, permettant de mettre à disposition des élèves ayant déjà des connaissances de base en \LaTeX{} tous les outils nécessaires pour leur travail.
\section{Organisation}
Pour obtenir la plus grande simplicité possible, ce modèle a été conçu autour de trois fichiers.
\begin{enumerate}
\item main.tex
\item TM.sty
\item config.tex
\item main.tex\index{main.tex}
\item TM.sty\index{TM.sty}
\item config.tex\index{config.tex}
\end{enumerate}
Le premier est simplement destiné à la compilation. Il contient la structure générale du travail. \emph{Il ne doit pas être modifié}.
Le second règle tous les détails techniques. Il se compose essentiellement de code \LaTeX{} complexe et \emph{ne doit pas être modifié}.
Le dernier est le fichier de configuration du travail. C'est lui qui donne accès au divers outils mis à disposition, tels que titre, préface, nombre de chapitres, postface, index, etc.
Le dernier est le fichier de configuration du travail. C'est lui qui donne accès au divers outils mis à disposition, tels que titre\index{titre}, préface\index{préface}, nombre de chapitres\index{chapitre}, postface\index{postface}, index\index{index}, etc.
\section{Documentation}
Le présent texte constitue à la fois la documentation concernant le modèle de travail de maturité et le modèle lui-même. Il contient la plupart des aspects que peut revêtir un travail de maturité et il donne un exemple de texte de travail de maturité à modifier. Une version PDF de cette documentation est présente dans le dossier \apath{documentation} du zip contenant touts les fichiers du modèle.
Le présent texte constitue à la fois la documentation concernant le modèle de travail de maturité et le modèle lui-même. Il contient la plupart des aspects que peut revêtir un travail de maturité et il donne un exemple de texte de travail de maturité à modifier. Une version PDF de cette documentation est présente dans le dossier \apath{documentation}\index{documentation} du zip contenant touts les fichiers du modèle.
\section{Rédaction}
La rédaction du travail de maturité peut donc être réalisée directement à partir d'une copie de l'ensemble des fichiers du projet regroupés dans l'archive \apath{TM.zip}. Il suffit de la décompresser, de remplir les rubriques du fichier \apath{config.tex} et les différentes pages constituant le travail de maturité comme les chapitres ou les pages annexes. En modifiant progressivement ces fichiers et en compilant le fichier \apath{main.tex} au fur et à mesure, on obtient petit à petit son propre travail de maturité.
La rédaction du travail de maturité peut donc être réalisée directement à partir d'une copie de l'ensemble des fichiers du projet regroupés dans l'archive \apath{TM.zip}\index{TM.zip}. Il suffit de la décompresser, de remplir les rubriques du fichier \apath{config.tex}\index{config.tex} et les différentes pages constituant le travail de maturité comme les chapitres\index{chapitre} ou les pages annexes\index{annexe}. En modifiant progressivement ces fichiers et en compilant\index{compiler} le fichier \apath{main.tex}\index{main.tex} au fur et à mesure, on obtient petit à petit son propre travail de maturité.
Remarquons, que plutôt que d'effacer les instructions se trouvant dans les pages qu'on souhaite modifier, il est recommandé en premier lieu de les commenter à l'aide du signe \% ou pour celles se trouvant sur plusieurs lignes d'utiliser l'environnement de commentaire présenté dans le code \listingref{listing:commentlong}.
Remarquons, que plutôt que d'effacer les instructions se trouvant dans les pages qu'on souhaite modifier, il est recommandé en premier lieu de les commenter\index{commenter} à l'aide du signe \% ou pour celles se trouvant sur plusieurs lignes d'utiliser l'environnement de commentaire\index{environnement de commentaire} présenté dans le code \listingref{listing:commentlong}.
De manière générale, il est préférable de commenter les instructions qu'on estime inutiles, de compiler et de voir si des problèmes apparaissent. Si ce n'est pas le cas, on peut alors les effacer définitivement.

View File

@ -1,47 +1,47 @@
\chapter{Configuration} \label{chapter:configuration}
Ce chapitre présente essentiellement le fichier \src{config.tex} qui permet la configuration générale du travail de maturité.
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} sous différentes sections.
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 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 suivant les cas et dont il ne faut pas changer la structure, mais seulement une partie facilement identifiable.
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] Trois langue sont proposées : français, anglais et 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 par exemple.
\item[La page de titre] S'y trouvent définis les titre et sous-titre du travail, le type de travail, l'auteur, la date et le mentor. Relevez que normalement la page de titre se trouvant sous \apath{pagesspeciales/pagetitre.tex} n'a pas à être modifiée. Les différents évoqués ci-dessus suffisent pour la définir, exception faite d'une éventuelle image de titre.
\item[Le pied de page] S'y trouvent définis le domaine, c'est-à-dire l'option spécifique ou complémentaire ou autre, du travail ainsi que le nom et l'adresse de l'école.
\item[Citations, remerciements, acronymes, licence, site officiel, cdrom, index] On peut choisir ici de mettre une page contenant une pensée ou citation, une page contenant un préambule, une dédicace, des remerciements, une page contenant un résumé, une page d'acronymes, une page présentant la licence du travail, une page présentant le site associé au travail, une autre le cdrom associé et enfin une page d'index.
\item[Chapitres] On définit ici le nombre de chapitres qu'on désire. Des fichiers \apath{chapter1.tex}, \apath{chapter2.tex} \dots{} \apath{chapter9.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.
\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 é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 est chapitre à part entière, il se trouve dans un fichier éponyme situé sous \apath{chapitres/conclusion.tex}.
\item[Listes des figures, tables et listings] On définit ici la présence d'une page contenant la lise des figures et/ou la liste des tables et/ou la liste des listings. 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. Le point correspond au répertoire ou se trouve le fichier \apath{main.tex}.
\item[Insertion de code : listings] Le package listings permet d'insérer du code dans latex. Plusieurs langages sont disponibles, par exemple HTML et PHP. Mais seul latex est appelé par défaut. On peut charger d'autres languages pour les listings selon le modèle de la ligne suivante :
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 sur le modèle suivant : \lstinline!\lstloadlanguages{Python}! suivi de \lstinline!\lstset{language=Python,escapechar=|}!
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 \lstinline!\label{}! qui permet d'avoir accès au numéro de la ligne dans le texte via \lstinline!\ref{}!.
\item[Version provisoire] Si vous travaillez avec une version provisoire, cette commande imprime un filigrane en haut à gauche de chaque page. Commentez la pour la version finale.
\item[Le texte] Se règle ici l'indentation de la première ligne de chaque paragraphe. Différentes possiblilité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.
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}
\section{Version provisoire\index{version provisoire}}
Pendant la rédaction et par défaut le modèle est placé en mode \og draft\fg. Ce mode offre différents outils pour faciliter la rédaction.
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 sont équivalent en anglais ou allemand) en filigrane en haut à gauche et changer la date sur la page de titre pour y mettre un indication portant le jour, alors que dans la version finale celle-ci n'apparaît pas.
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 un 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 et les codes sources pour accélérer la compilation tout en indiquant leur place.
Il va aussi permettre de repérer les lignes ou la césure a été difficile par l'indication d'un carré noir en regard des lignes trop longues.
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.
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| est activé par l'option 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à ou 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 deux fois le modèle !
Il va aussi permettre de repérer les lignes ou 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à ou 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 du travail. Pour les désactiver, c'est-à-dire retirer le filigrane et les notes de marge notamment, il suffit de retirer l'option \verb|draft| de la première ligne déclarant la classe de document dans le fichier \apath{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) pour désactivée (commentée). Attention, seule une ligne peut être décommentée.
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) pour 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}

View File

@ -1,4 +1,4 @@
\chapter{Les outils spécifiques}\label{outils_specifiques}\index{Outils spécifiques}
\chapter{Les outils spécifiques}\label{outils_specifiques}\index{outils spécifiques}
\section{Le texte}

View File

@ -1,65 +0,0 @@
\chapter{Introduction}
\section{Motivations et Objectifs}
\subsection{Motivations}
Désormais l'utilisation de \LaTeX au lycée fait partie des connaissances que doivent acquérir les élèves qui on choisi des options techniques. Si celles-ci sont absolument nécessaire pour ces élèves, en considérant le résultat fourni, d'autres élèves font régulièrement la demande pour pouvoir utiliser \LaTeX pour leur travail de fin d'étude, en Suisse, nommé travail de maturité. Or, leur familiarité avec \LaTeX est parfois trop peu importante pour que ce travail puisse se faire sans un véritable soutient des enseignants.
Force est de constater que la majorité des enseignants en est incapable. Et ce n'est pas dû à \LaTeX uniquement, avec d'autres traitement de texte plus connus, c'est souvent la même chose.
\subsection{Objectifs}
Une solution à ce problème est constitué par le présent travail. Il s'agit d'un modèle de travail de maturité, simplement configurable, permettant de mettre à disposition des élèves ayant des connaissances de base en \LaTeX tous les outils nécessaires pour leur travail.
\medskip
L'article \citeweb{wCHROMEGear} intitulé ``Chrome 12 arrête son support à Google Gears'' a permis un choix décisif en faveur de la seconde solution.
\section{Organisation}
Pour obtenir la plus grande simplicité possible, le modèle a été conçu autour de trois fichiers.
\begin{enumerate}
\item main.tex
\item TM.sty
\item config.tex
\end{enumerate}
Le premier est simplement destiné à la compilation. Il contient la structure générale du travail. IL ne doit pas être modifié. Le second règle tous les détails techniques. Il se compose essentiellement de code \LaTeX complexe et ne doit pas être modifié. Le dernier est le fichier de configuration du travail. C'est lui qui donne accès au divers outils mis à disposition, tels que titre, préface, nombre de chapitres, postface, index, etc.
\section{Notations et Conventions}
\subsection{Documentation}
\section{Rédaction}
\begin{comment}
\begin{itemize}
\item Formatting conventions:
\begin{itemize}
\item \textbf{Bold} and \textit{italic} are used for emphasis and to signify the first use of a term.
\item \url{Sans Serif} is used for web addresses.
\item \src{Code} is used in all Java code and generally for anything that would be typed literally
when programming, including keywords, constants, method names, and variables, class names, and interface names.
\end{itemize}
\item The present report is divided in Chapters. Chapters are broken down into Sections.
Where necessary, sections are further broken down into Subsections, and Subsections may
contain some Paragraphs.
\item \afigurelabel s, \atablelabel s and \alistinglabel s are numbered inside a chapter. For example, a reference
to
\afigurelabel~\textit{j} of Chapter \textit{i} will be noted \textit{\afigurelabel~i.j}.
\item As far as gender is concerned, I systematically select the feminine when possible.
\item Source code is desplayed as follows:
\end{itemize}
\begin{lstlisting}
Matrix3f rotMat = new Matrix3f();
rotMat.fromAngleNormalAxis( FastMath.DEG_TO_RAD * 45.0f, new Vector3f( 1.0f, 0.0f, 0.0f));
box.setLocalRotation( rotMat );
\end{lstlisting}
\end{comment}