diff options
author | Dr. Clea F. Rees <cfrees@imapmail.org> | 2008-12-28 23:49:33 +0000 |
---|---|---|
committer | Dr. Clea F. Rees <cfrees@imapmail.org> | 2008-12-28 23:49:33 +0000 |
commit | 7051fa90f609a783739882d5f945d4c11bf44c48 (patch) | |
tree | d51c96157c87cc798fa65f22cfec5559d7df9b3a /Master/texmf-dist/doc/latex/glossaries/samples | |
parent | b82fe98b309f7cf832c3dca6f124c2f5c48af80f (diff) |
glossaries update 2008/12/28
git-svn-id: svn://tug.org/texlive/trunk@11739 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/samples')
10 files changed, 1037 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index 768bddf6924..f8ba9ff12ae 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -23,9 +23,9 @@ \documentclass{article} \listfiles -\usepackage{hyperref} - %\usepackage{glossaries} % acronym will go in main glossary - \usepackage[acronym,footnote]{glossaries} % make a separate list of acronyms +\usepackage[colorlinks]{hyperref} + \usepackage{glossaries} % acronym will go in main glossary + %\usepackage[acronym]{glossaries} % make a separate list of acronyms \makeglossaries diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex index f91ab534f8e..39d57b22605 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex @@ -1,15 +1,24 @@ \documentclass[a4paper]{report} \usepackage[plainpages=false,colorlinks]{hyperref} -\usepackage[style=altlist]{glossaries} +\usepackage[toc,style=treenoname,order=word]{glossaries} \makeglossaries \newglossaryentry{glossary}{name=glossary, -description={1) list of technical words, 2) collection of -glosses}, +description={\nopostdesc}, plural={glossaries}} +\newglossaryentry{glossarylist}{ +description={1) list of technical words}, +sort={1}, +parent={glossary}} + +\newglossaryentry{glossarycol}{ +description={2) collection of glosses}, +sort={2}, +parent={glossary}} + \newglossaryentry{Perl}{name=\texttt{Perl}, sort=Perl, % need a sort key because name contains a command description=A scripting language} @@ -25,10 +34,41 @@ 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} + % entry with a paragraph break in the description + \newglossaryentry{par}{name=paragraph, -description=\pardescription} +description={distinct section of piece of +writing.\glspar 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={1) cry of approval (pl.\ bravos)}, +sort={1}, +plural={bravos}, +parent=bravo} + +\newglossaryentry{bravo2}{description={2) 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} @@ -43,11 +83,11 @@ description=\pardescription} \chapter{Introduction} \pagenumbering{arabic} -A \gls{glossary} is a very useful addition to any -technical document, although a \gls{glossary} can +A \gls{glossarylist} is a very useful addition to any +technical document, although a \gls{glossarycol} can also simply be a collection of glosses, which is another thing entirely. Some documents have -multiple \glspl{glossary}. +multiple \glspl{glossarylist}. Once you have run your document through \LaTeX, you will then need to run the \texttt{.glo} file through @@ -64,11 +104,29 @@ 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. +\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, +is \glspl{bravo1}, whereas the plural of \gls{bravo2}, a hired +ruffian or killer, 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} -\Glspl{par} can cause a problem in commands. +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}''). \printglossaries diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex index e8945a270e3..415a58b63e7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex @@ -16,7 +16,7 @@ name={Support vector machine (svm)}% change the default way of displaying the en ]{svm}{svm}{support vector machine} \newacronym[description={Statistical pattern recognition technique -using the ``kernel trick'' (see also SVM)},% acronym's description +using the ``kernel trick'' (see also \glshyperlink[SVM]{svm})},% acronym's description name={Kernel support vector machine (ksvm)}% change the default way of displaying the entry name in the list of acronyms ]{ksvm}{ksvm}{kernel support vector machine} @@ -40,7 +40,8 @@ This is the entry in uppercase: \GLS{svm}. \chapter{Kernel Support Vector Machines} The \gls{ksvm} is \ifglsused{svm}{an}{a} \gls{svm} that uses -the so called ``kernel trick''. +the so called ``kernel trick''. This is the entry's description without +a link: \glsentrydesc{ksvm}. \glsresetall Possessive: \gls{ksvm}['s]. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index 39829705e77..e9ebc9cf811 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -4,10 +4,15 @@ \usepackage[colorlinks]{hyperref} \usepackage[style=long3colheader,counter=equation]{glossaries} +\makeglossaries + \newcommand{\erf}{\operatorname{erf}} \newcommand{\erfc}{\operatorname{erfc}} -\makeglossaries + % redefine the way hyperref creates the target for equations + % so that the glossary links to equation numbers work + +\renewcommand*\theHequation{\thechapter.\arabic{equation}} % Change the glossary headings diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex index 218b1a3fed4..1ec5c196775 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex @@ -1,3 +1,17 @@ + % To ensure that the page numbers are up-to-date: + % + % latex sampleEqPg + % makeglossaries sampleEqPg + % latex sampleEqPg + % makeglossaries sampleEqPg + % latex sampleEqPg + % + % The extra makeglossaries run is required because adding the + % glossary in the second LaTeX run shifts the page numbers on + % which means that the glossary needs to be updated again. + % (Note that this problem is avoided if the page numbering is + % reset after the glossary. For example, if the glossary has + % roman numbering and the subsequent pages have arabic numbering) \documentclass[a4paper,12pt]{report} \usepackage{amsmath} @@ -8,6 +22,11 @@ \newcommand{\erf}{\operatorname{erf}} \newcommand{\erfc}{\operatorname{erfc}} + % redefine the way hyperref creates the target for equations + % so that the glossary links to equation numbers work + +\renewcommand*\theHequation{\thechapter.\arabic{equation}} + \renewcommand{\glossaryname}{Index of Special Functions and Notations} \renewcommand{\glossarypreamble}{Numbers in italic indicate the equation number, diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex index b33269174f6..63fa4c202bd 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex @@ -60,9 +60,6 @@ doesn't have associated numbers. \tableofcontents \printglossaries - %\printglossary - %\setglossarysection{section} - %\printglossary[type=notation] \chapter{Introduction} \pagenumbering{arabic} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex new file mode 100644 index 00000000000..7c6034547f8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex @@ -0,0 +1,64 @@ +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[style=alttreehypergroup]{glossaries} + + % The alttree type of glossary styles need to know the + % widest entry name for each level +\glssetwidest{Roman letters} % level 0 widest name +\glssetwidest[1]{Sigma} % level 1 widest name + +\makeglossaries + +\newglossaryentry{greekletter}{name={Greek letters}, +text={Greek letter}, +description={\nopostdesc}} + +\newglossaryentry{sigma}{name={Sigma}, +text={\ensuremath{\Sigma}}, +first={\ensuremath{\Sigma} (uppercase sigma)}, +symbol={\ensuremath{\Sigma}}, +description={Used to indicate summation}, +parent=greekletter} + +\newglossaryentry{pi}{name={pi}, +text={\ensuremath{\pi}}, +first={\ensuremath{\pi} (lowercase pi)}, +symbol={\ensuremath{\pi}}, +description={Transcendental number}, +parent=greekletter} + +\newglossaryentry{romanletter}{name={Roman letters}, +text={Roman letter}, +description={\nopostdesc}} + +\newglossaryentry{e}{name={e}, +description={Unique real number such that the derivative of +the function $e^x$ is the function itself}, +parent=romanletter} + +\newglossaryentry{C}{name={C}, +description={Euler's constant}, +parent=romanletter} + +\begin{document} +This is a sample document illustrating hierarchical glossary +entries. + +\chapter{Greek Letters Used in Mathematics} + +Some information about \glspl{greekletter}. +The letter \gls{pi} is used to represent the ratio of a circle's +circumference to its diameter. +The letter \gls{sigma} is used to represent summation. + +\chapter{Roman Letters Used in Mathematics} + +Some information about \glspl{romanletter}. +The letter \gls{e} is the unique real number such that +the derivative of the function $e^x$ is the function itself. +The letter \gls{C} represents Euler's constant. + +\printglossaries + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex new file mode 100644 index 00000000000..a134e1a5162 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex @@ -0,0 +1,48 @@ +\documentclass{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage[xindy,nonumberlist,style=listgroup]{glossaries} + +\makeglossaries + +% Note that because the é is the first letter of the +% name, it needs to be grouped or it will cause a +% problem for \makefirstuc due to expansion issues. +\newglossaryentry{elite}{name={{é}lite}, +description={select group or class}} + +\newglossaryentry{elephant}{name=elephant, +description={large animal with trunk and tusks}} + +\newglossaryentry{elk}{name=elk, +description=large deer} + +\newglossaryentry{mannerly}{name=mannerly, +description=polite} + +% The œ is not the first letter, so it doesn't need to +% be grouped. +\newglossaryentry{manoeuvre}{name={manœuvre}, +description=planned and controlled movement} + +\newglossaryentry{manor}{name=manor, +description=large landed estate or its house} + +\newglossaryentry{odometer}{name=odometer, +description=instrument for measuring distance travelled by +a wheeled vehicle} + +\newglossaryentry{oesophagus}{name={{œ}sophagus}, +description={canal from mouth to stomach}} + +\newglossaryentry{ogre}{name=ogre, +description=man-eating giant} + +\begin{document} +\null % ensure that the first run produces some output +\glsaddall + +\printglossaries + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy new file mode 100644 index 00000000000..318205d8ffc --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-mc.xdy @@ -0,0 +1,594 @@ +;; xindy style file for samplexdy.tex that has Mc letter group + +(define-letter-group "A" :prefixes ("")) +(define-letter-group "B" :after "A" :prefixes ("")) +(define-letter-group "C" :after "B" :prefixes ("")) +(define-letter-group "D" :after "C" :prefixes ("")) +(define-letter-group "E" :after "D" :prefixes ("")) +(define-letter-group "F" :after "E" :prefixes ("")) +(define-letter-group "G" :after "F" :prefixes ("")) +(define-letter-group "H" :after "G" :prefixes ("¤")) +(define-letter-group "I" :after "H" :prefixes ("¨")) +(define-letter-group "J" :after "I" :prefixes ("¬")) +(define-letter-group "K" :after "J" :prefixes ("®")) +(define-letter-group "L" :after "K" :prefixes ("´")) +(define-letter-group "Mc" :after "L" :prefixes ("»")) +(define-letter-group "M" :after "Mc" :prefixes ("»")) +(define-letter-group "N" :after "M" :prefixes ("¼")) +(define-letter-group "O" :after "N" :prefixes ("Ã")) +(define-letter-group "P" :after "O" :prefixes ("È")) +(define-letter-group "Q" :after "P" :prefixes ("Ê")) +(define-letter-group "R" :after "Q" :prefixes ("Ë")) +(define-letter-group "S" :after "R" :prefixes ("Ð")) +(define-letter-group "T" :after "S" :prefixes ("Ú")) +(define-letter-group "U" :after "T" :prefixes ("à")) +(define-letter-group "V" :after "U" :prefixes ("å")) +(define-letter-group "W" :after "V" :prefixes ("æ")) +(define-letter-group "X" :after "W" :prefixes ("ë")) +(define-letter-group "Y" :after "X" :prefixes ("í")) +(define-letter-group "È" :after "Y" :prefixes ("ï")) +(define-letter-group "Z" :after "È" :prefixes ("ð")) +(define-letter-group "Ã" :after "Z" :prefixes ("ö")) +(define-letter-group "Æ¿" :after "Ã" :prefixes ("÷")) + +(define-rule-set "en-alphabetize" + + :rules (("à " "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("æ" "" :string) + ("Ã" "" :string) + ("ç" "" :string) + ("ð" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("Ã" "" :string) + ("è" "" :string) + ("ë" "" :string) + ("ê" "" :string) + ("é" "" :string) + ("Ã" "¨" :string) + ("ï" "¨" :string) + ("Ã" "¼" :string) + ("ñ" "¼" :string) + ("Ã" "Ã" :string) + ("Ã" "Ã" :string) + ("ô" "Ã" :string) + ("ö" "Ã" :string) + ("Å" "Ã" :string) + ("Å" "Ã" :string) + ("È" "ï" :string) + ("È" "ï" :string) + ("þ" "ö" :string) + ("Ã" "ö" :string) + ("Ç·" "÷" :string) + ("Æ¿" "÷" :string) + ("a" "" :string) + ("A" "" :string) + ("b" "" :string) + ("B" "" :string) + ("C" "" :string) + ("c" "" :string) + ("d" "" :string) + ("D" "" :string) + ("E" "" :string) + ("e" "" :string) + ("F" "" :string) + ("f" "" :string) + ("g" "" :string) + ("G" "" :string) + ("H" "¤" :string) + ("h" "¤" :string) + ("I" "¨" :string) + ("i" "¨" :string) + ("J" "¬" :string) + ("j" "¬" :string) + ("K" "®" :string) + ("k" "®" :string) + ("L" "´" :string) + ("l" "´" :string) + ("Mc" "»" :string) + ("Mac" "»" :string) + ("M" "»" :string) + ("m" "»" :string) + ("N" "¼" :string) + ("n" "¼" :string) + ("O" "Ã" :string) + ("o" "Ã" :string) + ("P" "È" :string) + ("p" "È" :string) + ("q" "Ê" :string) + ("Q" "Ê" :string) + ("r" "Ë" :string) + ("R" "Ë" :string) + ("S" "Ð" :string) + ("s" "Ð" :string) + ("T" "Ú" :string) + ("t" "Ú" :string) + ("u" "à" :string) + ("U" "à" :string) + ("v" "å" :string) + ("V" "å" :string) + ("w" "æ" :string) + ("W" "æ" :string) + ("X" "ë" :string) + ("x" "ë" :string) + ("Y" "í" :string) + ("y" "í" :string) + ("z" "ð" :string) + ("Z" "ð" :string) + )) + +(define-rule-set "en-resolve-diacritics" + + :rules (("È" "¢" :string) + ("þ" "¢" :string) + ("Ç·" "¢" :string) + ("Ã" "¢" :string) + ("È" "¢" :string) + ("Æ¿" "¢" :string) + ("Ã" "£" :string) + ("Ã" "£" :string) + ("ð" "£" :string) + ("Ã" "£" :string) + ("Ã" "£" :string) + ("Ã" "£" :string) + ("ï" "£" :string) + ("ö" "£" :string) + ("ñ" "£" :string) + ("ç" "£" :string) + ("à " "£" :string) + ("Ã" "£" :string) + ("é" "£" :string) + ("Ã" "£" :string) + ("Ã" "¤" :string) + ("ô" "¤" :string) + ("Ã" "¤" :string) + ("è" "¤" :string) + ("Ã" "¥" :string) + ("ë" "¥" :string) + ("Ã" "¦" :string) + ("ê" "¦" :string) + ("Å" "ÿ" :string) + ("Ã" "ÿ" :string) + ("Å" "ÿ" :string) + ("æ" "ÿ" :string) + ("S" "¢" :string) + ("K" "¢" :string) + ("d" "¢" :string) + ("Y" "¢" :string) + ("E" "¢" :string) + ("y" "¢" :string) + ("g" "¢" :string) + ("e" "¢" :string) + ("J" "¢" :string) + ("q" "¢" :string) + ("D" "¢" :string) + ("b" "¢" :string) + ("z" "¢" :string) + ("w" "¢" :string) + ("Q" "¢" :string) + ("M" "¢" :string) + ("C" "¢" :string) + ("L" "¢" :string) + ("X" "¢" :string) + ("P" "¢" :string) + ("T" "¢" :string) + ("a" "¢" :string) + ("N" "¢" :string) + ("j" "¢" :string) + ("Z" "¢" :string) + ("u" "¢" :string) + ("k" "¢" :string) + ("t" "¢" :string) + ("W" "¢" :string) + ("v" "¢" :string) + ("s" "¢" :string) + ("B" "¢" :string) + ("H" "¢" :string) + ("c" "¢" :string) + ("I" "¢" :string) + ("G" "¢" :string) + ("U" "¢" :string) + ("F" "¢" :string) + ("r" "¢" :string) + ("x" "¢" :string) + ("V" "¢" :string) + ("h" "¢" :string) + ("f" "¢" :string) + ("i" "¢" :string) + ("A" "¢" :string) + ("O" "¢" :string) + ("n" "¢" :string) + ("m" "¢" :string) + ("l" "¢" :string) + ("p" "¢" :string) + ("R" "¢" :string) + ("o" "¢" :string) + )) + +(define-rule-set "en-resolve-case" + + :rules (("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("Ç·" "8" :string) + ("Ã" "8" :string) + ("Ã" "8" :string) + ("È" "8" :string) + ("Ã" "8" :string) + ("Ã" "89" :string) + ("Å" "89" :string) + ("ð" "9" :string) + ("ô" "9" :string) + ("È" "9" :string) + ("ï" "9" :string) + ("ö" "9" :string) + ("ñ" "9" :string) + ("ç" "9" :string) + ("à " "9" :string) + ("þ" "9" :string) + ("è" "9" :string) + ("ë" "9" :string) + ("ê" "9" :string) + ("é" "9" :string) + ("Æ¿" "9" :string) + ("Å" "99" :string) + ("æ" "99" :string) + ("S" "8" :string) + ("K" "8" :string) + ("Y" "8" :string) + ("E" "8" :string) + ("J" "8" :string) + ("D" "8" :string) + ("Q" "8" :string) + ("M" "8" :string) + ("C" "8" :string) + ("L" "8" :string) + ("X" "8" :string) + ("P" "8" :string) + ("T" "8" :string) + ("N" "8" :string) + ("Z" "8" :string) + ("W" "8" :string) + ("B" "8" :string) + ("H" "8" :string) + ("I" "8" :string) + ("G" "8" :string) + ("U" "8" :string) + ("F" "8" :string) + ("V" "8" :string) + ("A" "8" :string) + ("O" "8" :string) + ("R" "8" :string) + ("d" "9" :string) + ("y" "9" :string) + ("g" "9" :string) + ("e" "9" :string) + ("q" "9" :string) + ("b" "9" :string) + ("z" "9" :string) + ("w" "9" :string) + ("a" "9" :string) + ("j" "9" :string) + ("u" "9" :string) + ("k" "9" :string) + ("t" "9" :string) + ("v" "9" :string) + ("s" "9" :string) + ("c" "9" :string) + ("r" "9" :string) + ("x" "9" :string) + ("h" "9" :string) + ("f" "9" :string) + ("i" "9" :string) + ("n" "9" :string) + ("m" "9" :string) + ("l" "9" :string) + ("p" "9" :string) + ("o" "9" :string) + )) + +(define-rule-set "en-ignore-special" + + :rules (("-" "" :string) + ("!" "" :string) + ("{" "" :string) + ("'" "" :string) + ("}" "" :string) + ("?" "" :string) + ("." "" :string) + )) + +(define-rule-set "en-resolve-special" + + :rules (("Ã" "¤" :string) + ("Ã" "¤" :string) + ("ð" "¤" :string) + ("Ã" "¤" :string) + ("Ã" "¤" :string) + ("Ã" "¤" :string) + ("ô" "¤" :string) + ("Ã" "¤" :string) + ("È" "¤" :string) + ("ï" "¤" :string) + ("Ã" "¤" :string) + ("ö" "¤" :string) + ("ñ" "¤" :string) + ("Ã" "¤" :string) + ("ç" "¤" :string) + ("Ã" "¤" :string) + ("à " "¤" :string) + ("þ" "¤" :string) + ("Ç·" "¤" :string) + ("è" "¤" :string) + ("Ã" "¤" :string) + ("ë" "¤" :string) + ("Ã" "¤" :string) + ("ê" "¤" :string) + ("é" "¤" :string) + ("È" "¤" :string) + ("Æ¿" "¤" :string) + ("Ã" "¤" :string) + ("Å" "¤¤" :string) + ("Ã" "¤¤" :string) + ("Å" "¤¤" :string) + ("æ" "¤¤" :string) + ("?" "¡" :string) + ("!" "¢" :string) + ("." "£" :string) + ("S" "¤" :string) + ("K" "¤" :string) + ("d" "¤" :string) + ("Y" "¤" :string) + ("E" "¤" :string) + ("y" "¤" :string) + ("g" "¤" :string) + ("e" "¤" :string) + ("J" "¤" :string) + ("q" "¤" :string) + ("D" "¤" :string) + ("b" "¤" :string) + ("z" "¤" :string) + ("w" "¤" :string) + ("Q" "¤" :string) + ("M" "¤" :string) + ("C" "¤" :string) + ("L" "¤" :string) + ("X" "¤" :string) + ("P" "¤" :string) + ("T" "¤" :string) + ("a" "¤" :string) + ("N" "¤" :string) + ("j" "¤" :string) + ("Z" "¤" :string) + ("u" "¤" :string) + ("k" "¤" :string) + ("t" "¤" :string) + ("W" "¤" :string) + ("v" "¤" :string) + ("s" "¤" :string) + ("B" "¤" :string) + ("H" "¤" :string) + ("c" "¤" :string) + ("I" "¤" :string) + ("G" "¤" :string) + ("U" "¤" :string) + ("F" "¤" :string) + ("r" "¤" :string) + ("x" "¤" :string) + ("V" "¤" :string) + ("h" "¤" :string) + ("f" "¤" :string) + ("i" "¤" :string) + ("A" "¤" :string) + ("O" "¤" :string) + ("n" "¤" :string) + ("m" "¤" :string) + ("l" "¤" :string) + ("p" "¤" :string) + ("R" "¤" :string) + ("o" "¤" :string) + ("-" "¥" :string) + ("'" "¦" :string) + ("{" "§" :string) + ("}" "¨" :string) + )) + +; The following section is customised for samplexdy.tex +; (copied from samplexdy.xdy automatically generated by +; samplexdy.tex) + +; required styles + +(require "tex.xdy") + +; list of allowed attributes (number formats) + +(define-attributes (("default" + "glsnumberformat" + "textrm" + "textsf" + "texttt" + "textbf" + "textmd" + "textit" + "textup" + "textsl" + "textsc" + "emph" + "glshypernumber" + "hyperrm" + "hypersf" + "hypertt" + "hyperbf" + "hypermd" + "hyperit" + "hyperup" + "hypersl" + "hypersc" + "hyperemph" + "hyperbfit"))) + +; user defined alphabets + + + +; location class definitions + +(define-location-class "roman-page-numbers" + ("roman-numbers-lowercase")) +(define-location-class "Roman-page-numbers" + ("roman-numbers-uppercase")) +(define-location-class "arabic-page-numbers" + ("arabic-numbers")) +(define-location-class "alpha-page-numbers" + ("alpha")) +(define-location-class "Alpha-page-numbers" + ("ALPHA")) +(define-location-class "Appendix-page-numbers" + ("ALPHA" :sep "." "arabic-numbers")) +(define-location-class "arabic-section-numbers" + ("arabic-numbers" :sep "." "arabic-numbers")) + +; user defined location classes + +(define-location-class "Numberstring" + (:sep "\protect \Numberstringnum {" "arabic-numbers" :sep "}")) + +; define cross-reference class + +(define-crossref-class "see" :unverified ) +(markup-crossref-list :class "see" + :open "\glsseeformat" :close "{}") + +; define the order of the location classes +(define-location-class-order ( + "roman-page-numbers" + "arabic-page-numbers" + "arabic-section-numbers" + "alpha-page-numbers" + "Roman-page-numbers" + "Alpha-page-numbers" + "Appendix-page-numbers" + "see" )) + +; define the glossary markup + +(markup-index + :open "\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble~n\begin{theglossary}\glossaryheader~n" + :close "~n\end{theglossary}~n\glossarypostamble~n" + :tree) +(markup-letter-group-list :sep "\glsgroupskip~n") +(markup-indexentry :open "~n" :depth 0) +(markup-locclass-list :open "{\glossaryentrynumbers{\relax " + :sep ", " :close "}}") +(markup-locref-list :sep "\delimN ") +(markup-range :sep "\delimR ") + +; define format to use for locations + + +(markup-locref :open "~n\setentrycounter{page}\glsnumberformat{" + :close "}" + :attr "glsnumberformat") +(markup-locref :open "~n\setentrycounter{page}\textrm{" + :close "}" + :attr "textrm") +(markup-locref :open "~n\setentrycounter{page}\textsf{" + :close "}" + :attr "textsf") +(markup-locref :open "~n\setentrycounter{page}\texttt{" + :close "}" + :attr "texttt") +(markup-locref :open "~n\setentrycounter{page}\textbf{" + :close "}" + :attr "textbf") +(markup-locref :open "~n\setentrycounter{page}\textmd{" + :close "}" + :attr "textmd") +(markup-locref :open "~n\setentrycounter{page}\textit{" + :close "}" + :attr "textit") +(markup-locref :open "~n\setentrycounter{page}\textup{" + :close "}" + :attr "textup") +(markup-locref :open "~n\setentrycounter{page}\textsl{" + :close "}" + :attr "textsl") +(markup-locref :open "~n\setentrycounter{page}\textsc{" + :close "}" + :attr "textsc") +(markup-locref :open "~n\setentrycounter{page}\emph{" + :close "}" + :attr "emph") +(markup-locref :open "~n\setentrycounter{page}\glshypernumber{" + :close "}" + :attr "glshypernumber") +(markup-locref :open "~n\setentrycounter{page}\hyperrm{" + :close "}" + :attr "hyperrm") +(markup-locref :open "~n\setentrycounter{page}\hypersf{" + :close "}" + :attr "hypersf") +(markup-locref :open "~n\setentrycounter{page}\hypertt{" + :close "}" + :attr "hypertt") +(markup-locref :open "~n\setentrycounter{page}\hyperbf{" + :close "}" + :attr "hyperbf") +(markup-locref :open "~n\setentrycounter{page}\hypermd{" + :close "}" + :attr "hypermd") +(markup-locref :open "~n\setentrycounter{page}\hyperit{" + :close "}" + :attr "hyperit") +(markup-locref :open "~n\setentrycounter{page}\hyperup{" + :close "}" + :attr "hyperup") +(markup-locref :open "~n\setentrycounter{page}\hypersl{" + :close "}" + :attr "hypersl") +(markup-locref :open "~n\setentrycounter{page}\hypersc{" + :close "}" + :attr "hypersc") +(markup-locref :open "~n\setentrycounter{page}\hyperemph{" + :close "}" + :attr "hyperemph") +(markup-locref :open "~n\setentrycounter{page}\hyperbfit{" + :close "}" + :attr "hyperbfit") + +; define letter group list format + +(markup-letter-group-list :sep "\glsgroupskip~n") + +; letter group headings + +(markup-letter-group :open-head "\glsgroupheading{" + :close-head "}") + +(define-letter-group "glsnumbers" + :prefixes ("0" "1" "2" "3" "4" "5" "6" "7" "8" "9") + :before "A") + +; The following is copied from xindy/lang/english/utf8-lang.xdy + +(define-sort-rule-orientations (forward backward forward forward)) +(use-rule-set :run 0 + :rule-set ("en-alphabetize" "en-ignore-special")) +(use-rule-set :run 1 + :rule-set ("en-resolve-diacritics" "en-ignore-special")) +(use-rule-set :run 2 + :rule-set ("en-resolve-case" "en-ignore-special")) +(use-rule-set :run 3 + :rule-set ("en-resolve-special")) + diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex new file mode 100644 index 00000000000..c66ed0f66d0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex @@ -0,0 +1,229 @@ + % This is a sample document illustrating how to use the + % glossaries package with xindy. To create the document: + % + % latex samplexdy + % makeglossaries samplexdy + % latex samplexdy + % + % If you don't have Perl installed, then use one of the + % following instead of makeglossaries: + % + % If you want to have a separate "Mc" letter group do: + % + % xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo + % + % Otherwise do: + % + % xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo + % +\documentclass{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{fmtcount} + + % remove redefinition of \thepage below if you want to uncomment + % the following line: + % \usepackage[colorlinks]{hyperref} + +\usepackage[xindy,style=altlistgroup]{glossaries} + + % Define a new command to do bold italic (it uses \hyperbf + % rather than \textbf in case I later introduce hyperlinks + % - although I would have to remove the fancy page numbering + % if I wanted to do that): + +\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} + + % Need to add this to the list of attributes in order + % to use it with xindy: + % (This command will have no effect if \noist is used) + +\GlsAddXdyAttribute{hyperbfit} + + % Redefine the page numbers so that they appear as a word: + + \renewcommand*{\thepage}{\Numberstring{page}} + + % Need to add this to the list of location styles. + % \Numberstring{page} gets expanded to + % \protect \Numberstringnum {<n>} (where <n> is the page number) + % so need to define the location in that format: + % (This command will have no effect if \noist is used) + +\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space + \string\Numberstringnum\space\glsopenbrace" + "arabic-numbers" :sep "\glsclosebrace"} + + % To have Mc as a separate group uncomment the following three + % lines: + + %\setStyleFile{samplexdy-mc} % note no extension + %\noist + %\GlsSetXdyLanguage{} + + % The above three lines specify to use samplexdy-mc.xdy (supplied + % with this file) and don't overwrite it. The language is + % unset using \GlsSetXdyLanguage{} as all the language + % dependent information is contained in samplexdy-mc.xdy + % Note that using \noist means that commands like + % \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have + % an effect. + + % Write the style file (if \noist isn't used) + % and activate glossary entries + +\makeglossaries + + % Define glossary entries + % \glshyperlink is used instead of \gls to prevent the glossary + % page numbers also appear in the locations, however I need + % to ensure that the referenced entries are added to the + % glossary via commands that use \glslink, \glsadd or \glssee + +\newglossaryentry{mcadam}{name={McAdam, John Loudon}, +first={John Loudon McAdam},text={McAdam}, +description={Scottish engineer}} + +\newglossaryentry{maclaurin}{name={Maclaurin, Colin}, +first={Colin Maclaurin},text={Maclaurin}, +description={Scottish mathematician best known for the +\gls{maclaurinseries}}} + +\newglossaryentry{maclaurinseries}{name={Maclaurin series}, +description={Series expansion},see={taylorstheorem}} + +\newglossaryentry{taylorstheorem}{name={Taylor's theorem}, +description={Theorem expressing a function $f(x)$ as the sum of +a polynomial and a remainder: +\[f(x) = f(a)+f'(a)(x-a)+f''(a)(x-a^2)/2!+\cdots+R_n\] +If $n\to\infty$ the expansion is a \glshyperlink{taylorseries} +and if $a=0$, the series is called a +\gls{maclaurinseries}}} + +\newglossaryentry{taylorseries}{name={Taylor series}, +description={Series expansion},see={taylorstheorem}} + +\newglossaryentry{taylor}{name={Taylor, Brook}, +first={Brook Taylor},text={Taylor}, +description={English mathematician}} + +\newglossaryentry{mcnemar}{name={McNemar, Quinn}, +first={Quinn McNemar},text={McNemar}, +description={Mathematician who introduced +\gls{mcnemarstest}. This entry has the number list +suppressed},nonumberlist} + +\newglossaryentry{mcnemarstest}{name={McNemar's test}, +description={A nonparametric test introduced by +\gls{mcnemar} in 1947}} + +\newglossaryentry{mach}{name={Mach, Ernst}, +first={Ernst Mach},text={Mach}, + % if using samplexdy-mc.xdy, the following line is needed + % to prevent this entry being put in the "Mc" group +sort={mach, Ernst}, +description={Czech/Austrian physicist and philosopher}} + +\newglossaryentry{machnumber}{name={Mach number}, + % if using samplexdy-mc.xdy, the following line is needed + % to prevent this entry being put in the "Mc" group +sort={mach number}, +description={Ratio of the speed of a body in a fluid to the +speed of sound in that fluid named after \gls{mach}}} + +\newglossaryentry{malthus}{name={Malthus, Thomas Robert}, +first={Thomas Robert Malthus},text={Malthus}, +description={English mathematician, sociologist and classicist}} + +\newglossaryentry{ampereandre}{name={Ampère, André-Marie}, +first={André-Marie Ampère},text={Ampère}, +description={French mathematician and physicist}} + +\newglossaryentry{ampere}{name={ampere}, +description={SI unit of electric current named after +\gls{ampereandre}}} + +\newglossaryentry{archimedes}{name={Archimedes of Syracuse}, +first={Archimedes of Syracuse},text={Archimedes}, +description={Greek mathematician}} + +\newglossaryentry{archimedesprinciple}{name={Archemedes' principle}, +description={Principle that if a body is submerged in a fluid +it experiences upthrust equal to the weight of the displaced +fluid. Named after \gls{archimedes}}} + +\newglossaryentry{galton}{name={Galton, Sir Francis}, +first={Sir Francis Galton},text={Galton}, +description={English anthropologist}} + +\newglossaryentry{gauss}{name={Gauss, Karl Friedrich}, +first={Karl Friedrich Gauss},text={Gauss}, +description={German mathematician}} + +\newglossaryentry{gaussianint}{name={Gaussian integer}, +description={Complex number where both real and imaginary +parts are integers}} + +\newglossaryentry{peano}{name={Peano, Giuseppe}, +first={Giuseppe Peano},text={Peano}, +description={Italian mathematician}} + +\newglossaryentry{peanoscurve}{name={Peano's curve}, +description={A space-filling curve discovered by +\gls{peano}}} + +\newglossaryentry{pearson}{name={Pearson, Karl}, +first={Karl Pearson},text={Pearson}, +description={English mathematician}} + +\newglossaryentry{pearspmcc}{name={Pearson's product moment +correlation coefficient},description={Product moment correlation +coefficient named after \gls{pearson}}} + +\begin{document} +\title{Sample Document Using the Glossaries Package With Xindy} +\author{Nicola Talbot} +\maketitle + +\section{\glsentryfirst{gauss}} + +This is a section on \gls[format=(]{gauss}. This section spans +several pages. + +\newpage + +This page talks about \glspl[format=hyperbfit]{gaussianint}. Since +it's the principle definition, the user-defined hyperbfit format is +used. + +\newpage + +The section on \gls[format=)]{gauss} ends here. + +\section{Series Expansions} + +This section is about series expansions. It mentions +\gls{maclaurin} and \gls{taylor}. It also discusses +\gls{taylorstheorem} which is related to the \gls{taylorseries}. +The \gls{maclaurinseries} is a special case of the +\gls{taylorseries}. + +\section{\glsentryname{archimedesprinciple}} + +This section discusses \gls{archimedesprinciple} which was +introduced by \gls{archimedes}. + +\section{Another section} + +This section covers \gls{mach} who introduced the \gls{machnumber}. +It also mentions \gls{ampereandre} after whom the +SI unit \gls{ampere} is named. It then discusses \gls{galton} +and \gls{malthus}. Finally it mentions \gls{mcadam}. + +\newpage +This page discusses \gls{mcnemar} who introduced +\gls{mcnemarstest} and \gls{peano} who discovered \gls{peanoscurve}. + +\printglossaries +\end{document} |