summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/glossaries/glossaries-user-examples/glossaries-user-example001.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/glossaries/glossaries-user-examples/glossaries-user-example001.tex')
-rw-r--r--macros/latex/contrib/glossaries/glossaries-user-examples/glossaries-user-example001.tex43
1 files changed, 43 insertions, 0 deletions
diff --git a/macros/latex/contrib/glossaries/glossaries-user-examples/glossaries-user-example001.tex b/macros/latex/contrib/glossaries/glossaries-user-examples/glossaries-user-example001.tex
new file mode 100644
index 0000000000..f0d7f9cd06
--- /dev/null
+++ b/macros/latex/contrib/glossaries/glossaries-user-examples/glossaries-user-example001.tex
@@ -0,0 +1,43 @@
+% This file is embedded in glossaries-user.pdf
+% Example 1 Simple document with no glossary
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[
+ sort=none % no sorting or indexing required
+ ] {glossaries}
+
+\newglossaryentry
+{cafe}% label
+ {% definition:
+ name={café},
+ description={small restaurant selling refreshments}
+}
+
+\setacronymstyle{long-short} \newacronym
+{html}% label
+ {HTML}% short form
+ {hypertext markup language}% long form
+
+
+\newglossaryentry
+{pi}% label
+ {% definition:
+ name={\ensuremath{\pi}},
+ description={Archimedes' Constant}
+}
+
+% This is a trivial example. For a real document I recommend you use siunitx for units
+ \newglossaryentry
+ {distance}% label
+ {% definition:
+ name={distance},
+ description={the length between two points},
+ symbol={m}
+ }
+\begin{document}
+First use: \gls{cafe}, \gls{html}, \gls{pi}. Next use: \gls{cafe}, \gls{html}, \gls{pi}.
+
+\Gls{distance} (\glsentrydesc{distance}) is measured in \glssymbol{distance}.
+\end{document}