Latex - How to create a glossary?
To ease the reading of your technical reports, that usually end up being crowded with abbreviations, it’s good to add a glossary to them. Here is an example of how to add a glossary to a LaTeX file. In this case, the glossary chapter is not numbered (\chapter*) but is listed in the table of contents (\addcontentsline{toc}{chapter}{Glossary}).
-
\makeglossary
-
\begin{document}
-
-
This website is done in PHP\glossary{[PHP] PHP Hypertext Preprocessor}.
-
-
%%%%%%%%%%%
-
%debut du glossaire%
-
%%%%%%%%%%%
-
-
\chapter*{Glossary}\label{glossary}\addcontentsline{toc}{chapter}{Glossary}
-
-
\begin{itemize}
-
\input{Glossary}
-
\end{itemize}
-
\end{document}
Next is a script you can add in TexShop (MacOSX) to generate the glossary files properly. Click on Macros>Open Macros Editor. Chose “New Item” and copy the script below. You can also associate it to a keyboard shortcut to run it easily after every compilation. To get the glossary in your pdf file, compile your LaTeX files, compile the glossary and recompile your LaTeX files.
-
–AppleScript direct
-
-
set fileName to #NAMEPATH#
-
set n to (number of characters of contents of fileName)
-
set fileNamequoted to quoted form of fileName
-
set baseName to do shell script "basename " & fileNamequoted
-
set m to (number of characters of contents of baseName)
-
set dirName to quoted form of (characters 1 thru (n-m-1) of fileName as string)
-
-
set shellScript to "cd " & dirName & ";"
-
set shellScript to shellScript & "./script.sh;"
-
do shell script shellScript
Note that the script above requires a file named “script.sh” in the folder containing your .tex files. This file uses a PERL script named “writeglossary.prl” (cf. the end of this post) to create an item list from the glossary data. The entries are then sorted in alphabetical order and deletes the duplicates. Remember to replace “Paper.glo” in the script with ‘Your file’.glo.
-
#!/bin/tcsh
-
perl writeglossary.prl Paper.glo > Glossary.tmp
-
#perl script.pl
-
perl -e ‘while(<>) {push @lines, $_;}warn "\nSorted $. lines in ascending alphabetical order, ignoring case\n\n";print sort {lc($a) cmp lc($b)}@lines’ Glossary.tmp > Glossary.tex
And here is the file “writeglossary.prl”:
-
# Simple perl script for converting glossary data (*.glo) files produced by
-
# Latex and converting them to a form suitable for including
-
# as a Glossary.tex file in a report.
-
#
-
# To use: perl writeglossary.prl filename.glo > Glossary.tex
-
# Then, in your Latex report file, set up a "description" environment using \begin{description}
-
# and use \input{Glossary} to import the formatted glossary items.
-
# (See me310report.tex for example.)
-
#
-
# Started 2 August 2006 -mrc
-
# Note: Macs and Linux usually have perl installed by default. On Windows you might need
-
# to install it or else use Visual Basic or simply use find/replace in MS Word to
-
# accomplish the same string replacements as done by this perl script.
-
-
############
-
# Main loop: keep reading new lines until end of file.
-
# Next line always goes into $_ and pattern matching is done
-
# on $_ by default.
-
line: while (<>) {
-
-
# Replace any instance of "glossaryentry{" with "item " on every line.
-
# /g is for global matching (as many times as applies)
-
s/glossaryentry{/item /g;
-
-
#Then take what comes before "}" and throw away the rest.
-
if(/}/){
-
$_ = $`;
-
}
-
-
#Append a newline and print to the output.
-
-
} # end while(<>)
