Now that the main body of the cookbook is starting to look like the way we want it, we will give some attention to what Tex calls the back matter. In this instalment, we will add an index and a glossary. The index will list on what pages certain ingredients are found. If the cook knows what they have on hand, they can find one or more recipes that use that particular ingredient. For cooks with experience of Chinese recipes, the glossary may not be needed, but there may be some cooks who need short explanations about what a particular ingredient is or what a particular method requires.
Maintenant que le corps principal du livre de cuisine commence à ressembler à ce que nous voulons, nous allons accorder une certaine attention à ce que TeX appelle le back matter. Dans cet article, nous ajouterons un index et un glossaire. L’index indiquera sur quelles pages se trouvent certains ingrédients. Si le cuisinier sait ce qu’il a sous la main, il peut trouver une ou plusieurs recettes qui utilisent cet ingrédient particulier. Pour les cuisiniers ayant de l’expérience des recettes chinoises, le glossaire peut ne pas être nécessaire, mais il peut y avoir des cuisiniers qui ont besoin de brèves explications sur ce qu’est un ingrédient particulier ou ce qu’une méthode particulière exige.
Like some other tasks we have already done, making an index requires a few additions to the main cookbook file, and additions to every recipe. The additions to the main cookbook file are quite simple. There are only three new instructions. \usepackage{makeidx} \makeindex Both must appear in the preamble, and \printindex will appear at the location where we want the index to appear. The printindex instruction starts a new page, and puts the chapter title “Index” at the top of the page.
Comme certaines autres tâches que nous avons déjà effectuées, la création d’un index nécessite quelques ajouts au fichier principal du livre de recettes, et des ajouts à chaque recette. Les ajouts au fichier principal du livre de recettes sont assez simples. Il n’y a que trois nouvelles instructions :
\usepackage{makeidx}
\makeindex
Les deux doivent figurer dans le préambule, et
\printindex
apparaîtra à l’endroit où nous voulons que l’index apparaisse. L’instruction printindex démarre une nouvelle page et place le titre du chapitre « Index » en haut de la page.
Words (or phrases) that should be listed in the index are identified using the command \index{…}. Of course, we must put the word or phrase into the curly braces, not the three dots. This is the process that needs to be done in each recipe. The index instruction can be used anywhere on the page where the key word appears. I find it convenient to put it right beside the ingredient name but it can be placed at the beginning or end of the list of ingredients, or even at the beginning or end of the recipe (as long as the recipe fits on one page). The index indicates the page where the key word is found. When the main cookbook file is processed, each recipe file is output in turn. The index instruction makes a file of all the index key words and the page references. This generated file has the same name as the file with the makeindex instruction, and the file extension (file type) is idx. In our case, we get a file called fcm196index.idx. That file has to generate a sorted file which can be used by the printindex instruction to generate the index in the final PDF file. This second generated file has the same name as the idx file, but the file type (file extension) is now ind.
Les mots (ou expressions) qui doivent être répertoriés dans l’index sont identifiés à l’aide de la commande index{…}. Bien sûr, nous devons mettre le mot ou l’expression dans les accolades, pas les trois points, c’est le processus qui doit être fait dans chaque recette. L’instruction index peut être utilisée n’importe où sur la page où le mot clé apparaît. Je trouve commode de le mettre juste à côté du nom de l’ingrédient, mais il peut être placé au début ou à la fin de la liste des ingrédients, ou même au début ou à la fin de la recette (tant que la recette tient sur une page). L’index indique la page où se trouve le mot-clé.
Lorsque le fichier principal du livre de recettes est traité, chaque fichier de recette est produit à son tour. L’instruction index crée un fichier de tous les mots clés de l’index et des références de la page. Ce fichier généré a le même nom que le fichier avec l’instruction makeindex, et l’extension de fichier (type de fichier) est idx. Dans notre cas, nous obtenons un fichier appelé fcm196index.idx. Ce fichier doit générer un fichier trié qui peut être utilisé par l’instruction printindex pour générer l’index dans le fichier PDF final. Ce deuxième fichier généré a le même nom que le fichier idx, mais le type de fichier (extension de fichier) est maintenant ind.
There is a menu item in TexStudio which will generate the necessary ind file. It is called Index, and is in the Tools menu. In Gummi, look in the Document menu for the Make Index item. Other GUIs for Tex should have a similar item somewhere in their menus. After generating the ind file, then process the main file again in order for the printindex instruction to use the ind file and print the index in the chosen location. To summarize: 1/ Compile / process the main file to generate a PDF and an idx file. 2/ Run makeindex to generate an ind file. 3/ Compile / process the main file to generate the final version of the PDF with an index. There are options for the index instruction which will make the index entry look the way you wish. Here are some examples.
Il y a un élément de menu dans TeXStudio qui va générer le fichier ind nécessaire. Il est appelé Index, et se trouve dans le menu Outils. Dans Gummi, recherchez l’élément Make Index dans le menu Document. Les autres interfaces graphiques pour TeX devraient avoir un élément similaire quelque part dans leurs menus.
Après avoir généré le fichier ind, traitez à nouveau le fichier principal afin que l’instruction printindex utilise le fichier ind et imprimer l’index à l’emplacement choisi.
En résumé : 1/ Compilez/traitez le fichier principal pour générer un fichier PDF et un fichier idx.
2/ Exécutez makeindex pour générer un fichier ind.
3/ Compilez/traitez le fichier principal pour générer la version finale du PDF avec un index.
Il y a des options pour l’instruction index qui feront en sorte que l’entrée d’index ressemble à ce que vous voulez. Voici quelques exemples :
\index{flour} will display flour, 4 \index{flour!wholewheat} will indent wholewheat as a sub-entry under flour followed by the page number. Sub-entries can go to a maximum of three levels (two exclamation marks) \index{pork|see{meat}} will give an entry without a page number that points the user to another index entry. ‘See’ can be replaced with ‘seealso’ to get See also in the index. The vertical line before see (or seealso) is required.
\index{flour} affichera flour, 4
\index{flour!wholewheat}
Les sous-entrées peuvent aller jusqu’à un maximum de trois niveaux (deux points d’exclamation).
\index{pork|see{meat}}
donnera une entrée sans numéro de page qui pointe l’utilisateur vers une autre entrée d’index. « Voir » peut être remplacé par « voir aussi » pour obtenir Voir aussi dans l’index. La ligne verticale avant voir (ou voir aussi) est requise.
A number of packages on CTAN have additional functionality beyond that provided by makeidx. I refer you to ctan.org for more information about other packages as well as about other options for formatting index (page ranges, adding colour and text formatting, etc). Glossary In textbooks and other books of instruction, a glossary is a list of words or terms (almost always in alphabetical order) with explanations or definitions. The words or terms listed are often words or terms that occur repeatedly in the text. To define or explain the words or terms over and over would be tedious for the author, and boring for the reader. So those words and terms are gathered together in one section of the book, usually at the end before the index.
Un certain nombre de paquets sur CTAN ont des fonctionnalités supplémentaires au-delà de celles fournies par makeidx. Je vous renvoie à ctan.org pour plus d’informations sur d’autres paquets ainsi que sur d’autres options de formatage de l’index (plages de pages, ajout de couleurs et de formatage de texte, etc.).
Glossaire
Dans les manuels et autres livres d’instruction, un glossaire est une liste de mots ou de termes (presque toujours triée par ordre alphabétique) avec des explications ou des définitions. Les mots ou les termes énumérés sont souvent des mots ou des termes qui se produisent à plusieurs reprises dans le texte. Définir ou expliquer les mots ou les termes encore et encore serait fastidieux pour l’auteur, et ennuyeux pour le lecteur. Donc ces mots et termes sont rassemblés dans une section du livre, généralement à la fin avant l’index.
In Tex / Latex, a glossary is also a list of words or terms with definitions. As far as I can tell from the very limited information available, a Latex glossary is not a separate section in the back matter the way an index is. Instead it is a list of substitutes for acronyms which the user enters in the text. If the user types some instruction when the text is converted to a PDF the instruction expands to its full form. For example, if I use \tlx in several places it might expand to Tex/Latex in this article. For the cookbook to have a traditional glossary, it needs to be set up as a chapter. I have built a separate file, and use the include instruction to add it to the back matter.
Dans TeX/LaTeX, un glossaire est également une liste de mots ou de termes avec des définitions. D’après les informations très limitées disponibles, un glossaire LaTeX n’est pas une section séparée à l’arrière de la matière comme un index. Il s’agit plutôt d’une liste de substituts aux acronymes que l’utilisateur entre dans le texte. Si l’utilisateur saisit une instruction lorsque le texte est converti en PDF, l’instruction prend sa forme complète. Par exemple, si j’utilise tlx à plusieurs endroits, il peut se développer en TeX/LaTeX dans cet article.
Pour que le livre de cuisine ait un glossaire traditionnel, il doit être mis en place comme un chapitre. J’ai construit un fichier séparé, et j'utilise l’instruction include pour l’ajouter à la fin.
There is a separate environment which can be used to show terms and definitions. I have included a screenshot of the glossary chapter tex file so you can see the code. In Latex terms, what I used is a description list. It follows the patterns for the numbered and bulleted lists described in a much earlier article (FCM #181). The begin{} and end {} instructions start and stop the list. In a description list, the item instruction has two parameters: the term and the description. If you use the GUI TexStudio, you will have guidance in building lists and most other Latex instructions. Look at the percent symbol in the glossary. There is a small detail you may have skipped over. In the code, there is a backslash before the percent symbol. Percent symbols can be used to specify certain Latex commands. If you wish to use it as a mathematical symbol, as I did in the glossary, then put the backslash in front of it.
Il existe un environnement distinct qui peut être utilisé pour afficher les termes et les définitions. J’ai inclus une capture d’écran du fichier tex du chapitre glossaire afin que vous puissiez voir le code. En termes LaTeX, ce que j’ai utilisé est une liste de description. Il suit les modèles pour les listes numérotées et à puces décrites dans un article beaucoup plus tôt (FCM #181). Les instructions begin{} et end {} démarrent et arrêtent la liste. Dans une liste de description, l’instruction item a deux paramètres : le terme et la description. Si vous utilisez l’interface graphique TeXStudio, vous aurez des conseils dans les listes de construction et la plupart des autres instructions LaTeX.
Regardez le symbole du pourcentage dans le glossaire. Vous avez peut-être sauté un petit détail. Dans le code, il y a une barre oblique inverse avant le symbole de pourcentage. Les symboles de pourcentage peuvent être utilisés pour spécifier certaines commandes LaTeX. Si vous voulez l’utiliser comme un symbole mathématique, comme je l’ai fait dans le glossaire, alors mettez la barre oblique inverse devant.
Author’s Suggestion If you are serious about using Latex/Tex for your own work, then I strongly urge you to join TUG, the Tex Users Group (tug.org). There is an annual subscription fee of $105 which has a $30 discount for students, seniors and residents of countries with modest economies. There is an additional $30 discount if you want an electronic membership, no materials will be shipped to you. Being a member entitles you to both printed and electronic versions of the latest edition of The Latex Companion. This is a two-volume work which contains more information about Latex than anyone will ever use. Each of the two volumes is about 950 pages, truly doorstop-sized encyclopedias. Even if you do not join TUG, the website has some resources you might use. Do not forget ctan.org has thousands of packages that can modify your installation of Tex/Latex so that it does what you need.
Suggestion de l’auteur
Si vous êtes sérieux au sujet de l’utilisation de LaTeX/TeX pour votre propre travail, alors je vous recommande fortement de rejoindre TUG, le TeX Users Group (tug.org). Il y a un coût d’abonnement annuel de 105 $ qui a un rabais de 30 $ pour les étudiants, les aînés et les résidents de pays à économie modeste. Il y a un rabais supplémentaire de 30 $ si vous voulez un abonnement électronique, aucun matériel ne vous sera expédié. En tant que membre, vous avez droit aux versions imprimées et électroniques de la dernière édition de The LaTeX Companion. Il s’agit d’un travail en deux volumes qui contient plus d’informations sur le LaTeX que quiconque n’utilisera jamais. Chacun des deux volumes compte environ 950 pages, des encyclopédies de la taille d’une porte. Même si vous ne rejoignez pas TUG, le site Web dispose de certaines ressources que vous pourriez utiliser. N’oubliez pas que ctan.org a des milliers de paquets qui peuvent modifier votre installation de TeX/LaTeX pour qu’il fasse ce dont vous avez besoin.