summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-03-07 19:18:57 +0000
committerKarl Berry <karl@freefriends.org>2008-03-07 19:18:57 +0000
commit65df837d29600b7980f1e49aa2bcee6da454bae0 (patch)
treedbd621ac42ed498c32fc49fb0bbe77753f1c32c1 /Master/texmf-dist/doc/latex/glossaries/samples/sample.tex
parentb253317283f1d4cbf2a8c292bf3814b714e43ab3 (diff)
glossaries update, including makeglossaries.bat in bin/win32 (4mar08)
git-svn-id: svn://tug.org/texlive/trunk@6879 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/samples/sample.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/samples/sample.tex75
1 files changed, 75 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex
new file mode 100644
index 00000000000..f91ab534f8e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex
@@ -0,0 +1,75 @@
+\documentclass[a4paper]{report}
+
+\usepackage[plainpages=false,colorlinks]{hyperref}
+\usepackage[style=altlist]{glossaries}
+
+\makeglossaries
+
+\newglossaryentry{glossary}{name=glossary,
+description={1) list of technical words, 2) collection of
+glosses},
+plural={glossaries}}
+
+\newglossaryentry{Perl}{name=\texttt{Perl},
+sort=Perl, % need a sort key because name contains a command
+description=A scripting language}
+
+\newglossaryentry{pagelist}{name=page list,
+ % description value has to be enclosed in braces
+ % because it contains commas
+description={a list of individual pages or page ranges
+(e.g.\ 1,2,4,7-9)}}
+
+\newglossaryentry{mtrx}{name=matrix,
+description={rectangular array of quantities},
+ % plural is not simply obtained by appending an s, so specify
+plural=matrices}
+
+\newcommand{\pardescription}{distinct section of piece of
+writing.\par Beginning on new, usually indented, line}
+\newglossaryentry{par}{name=paragraph,
+description=\pardescription}
+
+\begin{document}
+
+\title{Sample Document Using glossary Package}
+\author{Nicola Talbot}
+\pagenumbering{alph}% prevent duplicate page link names if using PDF
+\maketitle
+
+\pagenumbering{roman}
+\tableofcontents
+
+\chapter{Introduction}
+\pagenumbering{arabic}
+
+A \gls{glossary} is a very useful addition to any
+technical document, although a \gls{glossary} can
+also simply be a collection of glosses, which is
+another thing entirely. Some documents have
+multiple \glspl{glossary}.
+
+Once you have run your document through \LaTeX, you
+will then need to run the \texttt{.glo} file through
+\texttt{makeindex}. You will need to set the output
+file so that it creates a \texttt{.gls} file instead
+of an \texttt{.ind} file, and change the name of
+the log file so that it doesn't overwrite the index
+log file (if you have an index for your document).
+Rather than having to remember all the command line
+switches, you can call the \gls{Perl} script
+\texttt{makeglossaries} which provides a convenient
+wrapper.
+
+If a comma appears within the name or description, grouping
+must be used, e.g.\ in the description of \gls{pagelist}.
+
+Plurals are assumed to have the letter s appended, but if
+this is not the case, as in \glspl{mtrx}, then you need
+to specify the plural when you define the entry.
+
+\Glspl{par} can cause a problem in commands.
+
+\printglossaries
+
+\end{document}