diff options
author | Karl Berry <karl@freefriends.org> | 2012-05-21 23:39:22 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-05-21 23:39:22 +0000 |
commit | 18d3ed873290d987fea4820b83615c3f35c44770 (patch) | |
tree | e8bcd6aed2fe7e4915136f79f257a8c0abf94215 /Master/texmf-dist/doc/latex/glossaries/samples | |
parent | dcf30bb52ae0db1fc2f0bef28179723d65e23618 (diff) |
glossaries 3.02 (21may12)
git-svn-id: svn://tug.org/texlive/trunk@26547 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/samples')
26 files changed, 241 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf Binary files differindex 45d37971c60..241b748e430 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf Binary files differindex 1e91f1c3b80..bf36438cc7b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf Binary files differindex ba6e0382fca..58c39506dd3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf Binary files differindex 7db5987f813..b3571c0afb4 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex new file mode 100644 index 00000000000..88ae07a23a1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex @@ -0,0 +1,141 @@ + % This file is public domain +\documentclass[a4paper]{report} + +\usepackage[plainpages=false,colorlinks]{hyperref} +\usepackage[toc,order=word,subentrycounter]{glossaries} + +\usepackage{glossary-inline} + +\renewcommand*{\glossarysection}[2][]{\textbf{#1}: } +\renewcommand{\glsnamefont}[1]{\textsc{#1}} +\glossarystyle{inline} + +\makeglossaries + +\newglossaryentry{Perl}{name=\texttt{Perl}, +sort=Perl, % need a sort key because name contains a command +description=A scripting language} + +\newglossaryentry{glossary}{name=glossary, +description={\nopostdesc}, +plural={glossaries}} + +\newglossaryentry{glossarycol}{ +description={collection of glosses}, +sort={2}, +parent={glossary}} + +\newglossaryentry{glossarylist}{ +description={list of technical words}, +sort={1}, +parent={glossary}} + +\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} + + % entry with a paragraph break in the description + +\newglossaryentry{par}{name=paragraph, +description={distinct section of piece of +writing. Beginning on new, usually indented, line}} + + % entry with two types of plural. Set the plural form to the + % form most likely to be used. If you want to use a different + % plural, you will need to explicity specify it in \glslink +\newglossaryentry{cow}{name=cow, + % this isn't necessary, as this form (appending an s) is + % the default +plural=cows, + % description: +description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult +female of any bovine animal}} + +\newglossaryentry{bravo}{name={bravo}, +description={\nopostdesc}} + +\newglossaryentry{bravo1}{description={cry of approval (pl.\ bravos)}, +sort={1}, +plural={bravos}, +parent=bravo} + +\newglossaryentry{bravo2}{description={hired ruffian or killer (pl.\ bravoes)}, +sort={2}, +plural={bravoes}, +parent=bravo} + +\newglossaryentry{seal}{name=seal,description={sea mammal with +flippers that eats fish}} + +\newglossaryentry{sealion}{name={sea lion}, +description={large seal}} + +\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} + +This document has a glossary in a footnote\footnote{\printglossaries}. + +A \gls{glossarylist} (definition~\glsrefentry{glossarylist}) is a +very useful addition to any technical document, although a +\gls{glossarycol} (definition~\glsrefentry{glossarycol}) can also +simply be a collection of glosses, which is another thing entirely. +Some documents have multiple \glspl{glossarylist}. + +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}. + +\chapter{Plurals and Paragraphs} + +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. If a term may have multiple +plurals (for example \glspl{cow}/\glslink{cow}{kine}) then +define the entry with the plural form most likely to be used and +explicitly specify the alternative form using \verb|\glslink|. +\Glspl{seal} and \glspl{sealion} have regular plural forms. + +\Gls{bravo} is a homograph, but the plural forms are spelt +differently. The plural of \gls{bravo1}, a cry of approval +(definition~\glsrefentry{bravo1}), is \glspl{bravo1}, whereas the +plural of \gls{bravo2}, a hired ruffian or killer +(definition~\glsrefentry{bravo2}), is \glspl{bravo2}. + +\Glspl{par} can cause a problem in commands, so care is needed +when having a paragraph break in a \gls{glossarylist} entry. + +\chapter{Ordering} + +There are two types of ordering: word ordering (which places +``\gls{sealion}'' before ``\gls{seal}'') and letter ordering +(which places ``\gls{seal}'' before ``\gls{sealion}''). + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex new file mode 100644 index 00000000000..f7675f8b6c6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex @@ -0,0 +1,34 @@ +\documentclass[english,french]{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{babel} +\usepackage[nomain]{glossaries} + +\newglossary[glg]{english}{gls}{glo}{English to French} +\newglossary[flg]{french}{fls}{flo}{French to English} + +\makeglossaries + + % \newword{label}{english}{determiner}{french} +\newcommand*{\newword}[4]{% + \newglossaryentry{en-#1}{type=english,name={#2},description={#3 #4}}% + \newglossaryentry{fr-#1}{type=french,name={#3 #4},text={#4},sort={#4},description={#2}}% +} + +\newword{cat}{cat}{le}{chat} +\newword{mat}{mat}{la}{natte} + +\begin{document} +\selectlanguage{english} +The \gls{en-cat} sat on the \gls{en-mat}. + +\selectlanguage{french} +Le \gls{fr-cat} s'est repos\'e sur la \gls{fr-mat}. + +\selectlanguage{english} +\printglossary[type=english] + +\selectlanguage{french} +\printglossary[type=french] +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex new file mode 100644 index 00000000000..71f35e1acbc --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.tex @@ -0,0 +1,29 @@ +\documentclass{article} + +\usepackage{mfirstuc} + +\begin{document} + +\makefirstuc{abc}. + +\makefirstuc{{\em abc}}. + +\makefirstuc{\emph{abc}}. + +\makefirstuc{\ae bc}. + +\makefirstuc{{\ae}bc}. + +\newcommand{\abc}{abc}% +\xmakefirstuc{\abc}. + +\capitalisewords{a book of rhyme.} + +\capitalisewords{a book\space of rhyme.} + +\newcommand{\mytitle}{a book\space of rhyme.} +\capitalisewords{\mytitle} + +\xcapitalisewords{\mytitle} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex new file mode 100644 index 00000000000..32a4bd86cd0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex @@ -0,0 +1,34 @@ +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[savenumberlist,counter=chapter]{glossaries} + +\makeglossaries + +\newglossaryentry{sample}{name=sample,description=an example} + +\begin{document} +\chapter{Introduction} + +This is a \glsentryname{sample} document. \Glsentryplural{sample} +are discussed in chapters~\glsdisplaynumberlist{sample}. + +\chapter{Sample Documents} + +\Gls{sample} documents are provided for testing and illustration +purposes. + +\chapter{More About Samples} + +Here's more information about \glspl{sample}. + +\chapter{Another chapter} + +A chapter about something else. + +\chapter{Another About Samples} + +Here's some more information about \glspl{sample}. + +\printglossaries +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf Binary files differindex 7e1d1836f7a..2b71c655fd0 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf Binary files differindex 63d7d3ec894..589475065e5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf Binary files differindex a0257944f1a..1c77fb0c167 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf Binary files differindex 45ca607ea46..b9f4d756584 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf Binary files differindex bb85b3129b3..65b8dd1857f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf Binary files differindex 6b5e0a870b1..8d19afee2c7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf Binary files differindex 0e06f20f27e..76c003b31d1 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index 53b84ddc551..9cee73eade9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -3,13 +3,15 @@ \usepackage{amsmath} \usepackage[colorlinks]{hyperref} -\usepackage[style=long3colheader,counter=equation]{glossaries} +\usepackage[toc,ucmark,style=long3colheader,counter=equation]{glossaries} \makeglossaries \newcommand{\erf}{\operatorname{erf}} \newcommand{\erfc}{\operatorname{erfc}} +\pagestyle{headings} + % redefine the way hyperref creates the target for equations % so that the glossary links to equation numbers work diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf Binary files differindex 2a9d8729f0b..26ce7ad4228 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf Binary files differindex 7a2fafd4b10..dcffae44862 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf Binary files differindex cb73afc1324..35d002ea02a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf Binary files differindex 54e56908ec4..964e0df5be8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf Binary files differindex c12f12ce23a..8c87013d84d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf Binary files differindex 135bdb35347..5646b7fb7a5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf Binary files differindex 8df50a9cd6e..2fbd57b9f99 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf Binary files differindex 5cddf6b292c..e911938d771 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf Binary files differindex 904e3903344..442fac61dae 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf Binary files differindex 9b250265074..9d12f1b8344 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf |