From cfbdc127e742f1a0758482a6e7c5f00985127ff6 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 6 Dec 2013 22:12:47 +0000 Subject: glossaries (6dec13) git-svn-id: svn://tug.org/texlive/trunk@32341 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 32 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 846506 -> 874535 bytes .../doc/latex/glossaries/glossaries-user.html | 32437 ++++++++++--------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 587040 -> 603048 bytes .../doc/latex/glossaries/glossaries-user.tex | 1678 +- .../doc/latex/glossaries/glossariesbegin.html | 967 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 92321 -> 92421 bytes .../doc/latex/glossaries/glossariesbegin.tex | 25 +- .../doc/latex/glossaries/glossary2glossaries.html | 1733 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 322282 -> 140840 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 14 +- .../doc/latex/glossaries/mfirstuc-manual.html | Bin 22842 -> 14664 bytes .../doc/latex/glossaries/mfirstuc-manual.pdf | Bin 145431 -> 145369 bytes .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 48464 -> 49935 bytes .../doc/latex/glossaries/samples/minimalgls.tex | 22 + .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 0 -> 58845 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53480 -> 53480 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 75487 -> 82221 bytes .../glossaries/samples/sample-custom-acronym.tex | 132 +- .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 36474 -> 36474 bytes .../latex/glossaries/samples/sample-entryfmt.pdf | Bin 0 -> 34915 bytes .../doc/latex/glossaries/samples/sample-index.pdf | Bin 0 -> 43398 bytes .../doc/latex/glossaries/samples/sample-index.tex | 17 +- .../doc/latex/glossaries/samples/sample-inline.pdf | Bin 0 -> 147346 bytes .../latex/glossaries/samples/sample-langdict.pdf | Bin 0 -> 38853 bytes .../latex/glossaries/samples/sample-mfirstuc.pdf | Bin 0 -> 23740 bytes .../latex/glossaries/samples/sample-newkeys.pdf | Bin 0 -> 35496 bytes .../glossaries/samples/sample-nomathhyper.pdf | Bin 0 -> 40532 bytes .../latex/glossaries/samples/sample-numberlist.pdf | Bin 0 -> 41998 bytes .../doc/latex/glossaries/samples/sample-prefix.pdf | Bin 0 -> 43275 bytes .../doc/latex/glossaries/samples/sample-si.pdf | Bin 0 -> 21716 bytes .../doc/latex/glossaries/samples/sample.pdf | Bin 103003 -> 102972 bytes .../doc/latex/glossaries/samples/sample4col.pdf | Bin 43335 -> 43335 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 68668 -> 65684 bytes .../doc/latex/glossaries/samples/sampleAcr.tex | 4 +- .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 67725 -> 65541 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.tex | 8 +- .../latex/glossaries/samples/sampleCustomAcr.pdf | Bin 0 -> 93546 bytes .../latex/glossaries/samples/sampleCustomAcr.tex | 108 + .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 47058 -> 47058 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 48456 -> 48456 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 155671 -> 155714 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169148 -> 169293 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 0 -> 91282 bytes .../latex/glossaries/samples/sampleFnAcrDesc.tex | 74 + .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98970 -> 98036 bytes .../doc/latex/glossaries/samples/samplePeople.pdf | Bin 0 -> 47464 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 65965 -> 65965 bytes .../doc/latex/glossaries/samples/sampleSort.pdf | Bin 0 -> 95320 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 41179 -> 41179 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 64417 -> 64417 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 66946 -> 59840 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 44942 -> 44942 bytes .../glossaries/samples/samplexdy-compatible207.tex | 239 - .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 178847 -> 178726 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 67872 -> 67872 bytes 57 files changed, 19408 insertions(+), 18086 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.tex create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.tex create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf delete mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/samplexdy-compatible207.tex (limited to 'Master/texmf-dist/doc/latex/glossaries') diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 8232bd948bf..5b86944f435 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,37 @@ glossaries change log: +v4.02: + + glossaries.sty: + + * Added nameref value to 'numberedsection' package option + + * New package option: "index" + + * New package option: xindynoglsnumbers (equivalent to + xindy={glsnumbers=false}) + + * Added \newacronymstyle, \setacronymstyle and associated + commands. (Package options "smallcaps", "smaller", + "description", "dua" and "footnote" now deprecated.) + + * New commands \acrfullfmt etc to govern the format of + \acrfull etc. + + * Made \makeglossaries preamble only + + * Bug Fixes: + + - \acrlong, \Acrlong, \ACRlong, \acrlongpl, + \Acrlongpl and \ACRlongpl: removed \acronymfont and + spurious parenthetical text. + + - \glsentryfull, \Glsentryfull, \glsentryfullpl, + and \Glsentryfullpl: added missing \acronymfont + + - Fixed bug in "sanitize" package option (deprecated option, + but still kept for backward compatibility). + v4.01: * Fixed bug in \CustomAcronymFields caused by missing comma. diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 1551f3c2c90..9ac6ec74d77 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v4.01 +LaTeX Package : glossaries v4.02 -Last Modified : 2013-11-16 +Last Modified : 2013-12-05 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf index b1e60621181..b2e082fb472 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index f73ece29260..456b2a06e17 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -4,329 +4,82 @@ -User Manual for glossaries.sty v4.01 +User Manual for glossaries.sty v4.02 - + +
@@ -166,18 +25,18 @@ div.important { border : solid red; }

The glossaries package: a guide for beginners

Nicola L.C. Talbot

+class="cmr-12x-x-120">Nicola L.C. Talbot

2013-11-16
+class="cmr-12x-x-120">2013-12-05
-

This document is a brief guide to the glossaries package for - beginners who nd the size of the main user manual daunting and, - as such, it only covers the basics. For more advanced topics, see the -

This document is a brief guide to the glossaries package for + beginners who find the size of the main user manual daunting + and, as such, it only covers the basics. For more advanced topics, + see the main user manual.

@@ -189,7 +48,7 @@ href="#x1-20001" id="QQ2-1-2">What Do I Need?
2 Getting Started
3 Dening a Term or Symbol +href="#x1-40003" id="QQ2-1-4">Defining a Term or Symbol
4 Using a Term
5 Displaying the Glossary or List of Acronyms

-

1 1 What Do I Need?

You need to have the glossaries package installed. You also need to have the following -packages installed: ifthenglossaries package installed. You also need to have the +following packages installed: datatool, xkeyval (at least version 2.5f), xfor, amsgen and etoolbox. -You may also need longtable, supertabularifthen, xkeyval (at least version 2.5f), +xfor, amsgen and etoolbox. You may also need longtable, array or multicol, depending on what -glossary style you want to use. All these packages can be downloaded from CTAN if -you don't have them installed. See Installing things on a (La)TeX System for further +class="cmss-10x-x-109">supertabular, +array or multicol, depending on what glossary style you want to use. +All these packages can be downloaded from CTAN if you don’t have +them installed. See “Installing things on a (La)TeX System” for further assistance.

In addition, you need an indexing application. The glossaries package is congured -to use either makeindex or xindy. Makeindex should be available on all -TEX systems. It's possible you may not have xindy installed, but it can be -downloaded from the xindy home page. MiKTeX users may nd the Xindy for MiKTeX -thread on the LaTeX Community Forum helpful. +class="cmss-10x-x-109">glossaries package is +configured to use either makeindex or xindy. Makeindex should be available on +all TEX systems. It’s possible you may not have xindy installed, but +it can be downloaded from the xindy home page. MiKTeX users may +find the Xindy for MiKTeX thread on the LaTeX Community Forum +helpful.

The glossaries package provides a helper Perl script called makeglossaries which -will act as an interface to makeindex or xindy. If you want to use makeglossaries or +class="cmss-10x-x-109">glossaries package provides a helper Perl script called makeglossaries +which will act as an interface to makeindex or xindy. If you want to use +makeglossaries or xindy, you need to have Perl installed. If you don’t have +Perl installed, you can still use glossaries but you can only use it with xindy, you need to have Perl installed. If you don't have Perl installed, you can still -use glossaries but you can only use it with makeindex. +class="cmtt-10x-x-109">makeindex.

Top

2 Top

2 Getting Started

The most obvious things to do is to remember to load the glossaries package: +class="cmss-10x-x-109">glossaries +package:

@@ -282,494 +147,522 @@ class="ecss-1095">glossaries

Note that the glossaries package must be loaded after the hyperrefglossaries package must be loaded after the hyperref package (contrary to the general advice that hyperrefhyperref should be loaded last). The glossariesglossaries package should also be loaded after htmlhtml, inputencinputenc, babelbabel and ngermanngerman. -
-

-

If you want to use xindy rather than makeindex to sort the glossaries, you need to -specify this in the package options: +If you are using babel I recommend you use the glossaries package option +translate=babel:

+\usepackage{babel} + 
\usepackage[translate=babel]{glossaries} +
+

+

+

If you want to use xindy rather than makeindex to sort the glossaries, you +need to specify this in the package options: + + +

+
\usepackage[xindy]{glossaries}
-

Other package options are described in

Other package options are described in Package Options in the main glossaries user -manual. -

Next, you need to enable the creation of the various external les that are required -by the indexing application. This is done using: -


\makeglossaries

-

-

+class="cmss-10x-x-109">glossaries +user manual. +

Next, you need to enable the creation of the various external files that are +required by the indexing application. This is done using: +


\makeglossaries

+

+

-

Top

3 Dening a Term or Symbol

-

You must dene terms or symbols before you can use them in the document. This is -best done in the preamble. Each term is dened using: -


\newglossaryentry{hlabeli}{hsettingsi}

-

+

Top

3 Defining a Term or Symbol

+

You must define terms or symbols before you can use them in the document. +This is best done in the preamble. Each term is defined using: +


\newglossaryentry{<label>}{<settings>}

+

where hlabeli is a unique label used to identify the term. The second argument, +class="cmmi-10x-x-109"><label> is a unique label used to identify the term. The second argument, hsettingsi, is a key=value comma separated list that is used to set the required +class="cmmi-10x-x-109"><settings>, is a key=value comma separated list that is used to set the required information for the term. A full list of available keys can be found in Dening +href="glossaries-user.html#sec:newglosentry" >Defining Glossary Entries in the main glossariesglossaries user manual. The principle keys are name and -descriptionname +and description. -

For example, to dene the term electrolyte: +

For example, to define the term “electrolyte”:

-
+
\newglossaryentry{electrolyte}{name=electrolyte,  
description={solution able to conduct electric current}}
-

In the above example, the label and the name happen to be the same. In the next -example, the name contains a ligature but the label doesn't: +

In the above example, the label and the name happen to be the same. In the +next example, the name contains a ligature but the label doesn’t:

-
+
\newglossaryentry{oesophagus}{name=\oe sophagus,  
description={canal from mouth to stomach},  
plural=\oe sophagi}
-

In this case the label is oesophagus. Note that in this case, the plural has to be -specied using the plural key since it isn't formed by simply appending the letter -s. -

When you dene terms, it is important to remember that they will be sorted by an -external application that doesn't interpret LAT

In this case the label is oesophagus. Note that in this case, the plural has to be +specified using the plural key since it isn’t formed by simply appending the letter +“s”. +

When you define terms, it is important to remember that they will be sorted +by an external application that doesn’t interpret LATEX commands. Xindy is a little more -Txindy is a +little more TEX-aware than makeindex, but for this example they will both mis-sort +class="cmtt-10x-x-109">makeindex, but for this example they will both +mis-sort \oe sophagus. Xindy will ignore the \oe␣ part and will sort +it according to sophagus, so it will be placed with the terms starting +with an “s”. makeindex, on the other hand, will sort it according to \oe sophagus. Xindy will ignore the \oe␣ part and will sort it according to -sophagus, so it will be placed with the terms starting with an s. Makeindex, on the -other hand, will sort it according to \oe␣sophagus which starts with a symbol (the -backslash), so it will end up in the symbol group. You therefore need to specify how -to sort the term: +class="cmtt-10x-x-109">\oe␣sophagus which starts with a symbol (the backslash), so it will end +up in the symbol group. You therefore need to specify how to sort the +term:

-
+
\newglossaryentry{oesophagus}{name=\oe sophagus,  
description={canal from mouth to stomach},  
plural=\oe sophagi,  
sort=oesophagus}
-

Note, however, that if you use the inputenc

Note, however, that if you use the inputenc package and xindy, you can use the -encoded character œ rather than \oe and xindy will sort it correctly: +class="cmtt-10x-x-109">xindy, you +can use the encoded character œ rather than \oe and xindy will sort it +correctly:

-
+
\newglossaryentry{oesophagus}{name=œsophagus,  
description={canal from mouth to stomach},  
plural=œsophagi}
-

-

If the name starts with an accented character, the rst character must be +

+

If the name starts with an accented character, the first character must be grouped:

-
+
\newglossaryentry{elite}{name={\’e}lite,  
description={select group of people},  
sort=elite}
-

or +

or

-
-\newglossaryentry{elite}{name={é}lite, +
+\newglossaryentry{elite}{name={é}lite,  
description={select group of people}}
-

-

The name can also be a symbol, but you will also need to specify the sort key. For -example: +

+

The name can also be a symbol, but you will also need to specify the sort key. +For example:

-
+
\newglossaryentry{pi}{name={\ensuremath{\pi}},  
description={ratio of circumference of circle to its  
diameter},sort=pi}
-

It's also possible to have a name and a symbol. For example: +

It’s also possible to have a name and a symbol. For example:

-
+
\newglossaryentry{set}{name=set,  
description={a collection of objects},  
symbol={\ensuremath{\mathcal{S}}}}
-

Note, however, that not all glossary styles display the symbol in the glossary. -

+

Note, however, that not all glossary styles display the symbol in the +glossary. +

-

Top

4

Top

4 Using a Term

-

Once you have dened a term, you can use it in the document. The glossaries

Once you have defined a term, you can use it in the document. The glossaries package provides a number of commands that are described in Links to Glossary Entries in the main glossariesglossaries user manual. Here, I shall just cover the main commands: -


\gls{hlabeli}

-

+


\gls{<label>}

+

This prints the term associated with hlabeli. Using the example in the previous +class="cmmi-10x-x-109"><label>. Using the example in the previous section, \gls{oesophagus} will display sophagus. If the hyperref package has also -been loaded, the term will also be hyperlinked to the relevant entry in the +class="cmtt-10x-x-109">\gls{oesophagus} will display œsophagus. If the hyperref package has +also been loaded, the term will also be hyperlinked to the relevant entry in the glossary. -


\glspl{hlabeli}

-

+


\glspl{<label>}

+

This prints the plural of the term associated with hlabeli, so \glspl{oesophagus} -will display sophagi. Again, the text will be a hyperlink to the relevant entry in the -glossary, if hyperlinks are dened. -

There are also versions that convert the rst character to upper case if you need to -start a sentence with a term: -


\Gls{hlabeli}

-

+class="cmmi-10x-x-109"><label>, so \glspl{oesophagus} +will display œsophagi. Again, the text will be a hyperlink to the relevant entry +in the glossary, if hyperlinks are defined. +

There are also versions that convert the first character to upper case if you +need to start a sentence with a term: +


\Gls{<label>}

+

and -


\Glspl{hlabeli}

-

+


\Glspl{<label>}

+

For example:

-
+
\Glspl{electrolyte} usually exist as solutions of salts,  
bases or acids.
-

-

Note that these commands all have two optional arguments that aren't discussed -here, but they are described in Links to Glossary Entries in the main glossaries user -manual. -

Don't use these commands in moving arguments, such as those used by +

+

Note that these commands all have two optional arguments that aren’t +discussed here, but they are described in Links to Glossary Entries in the main +glossaries user manual. +

Don’t use these commands in moving arguments, such as those used by \chapter, \section and \caption.
-

+class="cmtt-10x-x-109">\chapter, \section and \caption.

+

You can, instead, use commands such as -


\glsentrytext{hlabeli}

-

+


\glsentrytext{<label>}

+

See Using Glossary Terms Without Links in the main glossaries user manual. -

+class="cmss-10x-x-109">glossaries user +manual. +

-

Top

5

Top

5 Acronyms

-

The glossaries package also allows you to dene acronyms. By default, acronyms will -be added to the main glossary, but if you use the acronym package option, acronyms -will be placed in a separate list of acronyms: +

The glossaries package also allows you to define acronyms. By default, acronyms +will be added to the main glossary, but if you use the acronym package option, +acronyms will be placed in a separate list of acronyms:

-
+
\usepackage[acronym]{glossaries}
-

There are other options that govern how acronyms appear. For further details, see -Acronyms in the main glossaries user manual. -

Acronyms must be dened before use and are dened using: -


\newacronym{hlabeli}{habbrvi}{hfulli}

-

+

+

Acronyms must be defined before use and are defined using: +


\newacronym{<label>}{<abbrv>}{<full>}

+

where hlabeli is the label identifying the acronym, habbrvi is the abbreviated form -and hfulli is the fully expanded text. For example: +class="cmmi-10x-x-109"><label> is the label identifying the acronym, <abbrv> is the abbreviated +form and <full> is the fully expanded text. For example:

-
+
\newacronym{label}{svm}{support vector machine}
-

-

Once the acronym is dened, it can be used in the same way as any other glossary -term with commands such as \gls and \glspl. On rst use, the default will display -hfulli (habbrvi). On subsequent use, only the abbreviation will appear. For -example: +

+

Once the acronym is defined, it can be used in the same way as any other +glossary term with commands such as \gls and \glspl. On first use, the +default will display <full> (<abbrv>). On subsequent use, only the abbreviation +will appear. For example:

-
+
A \gls{svm} was implemented.
-

If this is the rst time this term has been used, the above would produce: +

If this is the first time this term has been used, the above would produce:
A support vector machine (svm) was implemented.
otherwise it would produce:
A svm was implemented.
-You can reset an acronym so that the next use fully expands it again using: -


\glsreset{hlabeli}

-

+If you prefer a different way of displaying the acronyms (for example, +putting the long form in a footnote on first use) it’s possible to change the +acronym style. For further details, see Acronyms in the main glossaries user +manual. +

You can reset an acronym so that the next use fully expands it again +using: +


\glsreset{<label>}

+

or you can reset all acronyms using -


\glsresetall

-

+


\glsresetall

+

For further details on resetting and unsetting acronyms, see Unsetting and Resetting -Entry Flags in the main glossariesUnsetting and +Resetting Entry Flags in the main glossaries user manual. -

+

-

Top

6

Top

6 Displaying the Glossary or List of Acronyms

-

In order to display the sorted list of terms, you rst need to use -


\printglossaries

-

-at the place where you want the glossary and list of acronyms to appear. Note that -\printglossaries won't produce any text the rst time you create your document, -as an external indexing application needs to be used to sort and collate the -entries. Creating the completed document is therefore at least a three step -process. -

Suppose your document is called myDoc.tex, then you need to: +

In order to display the sorted list of terms, you first need to use +


\printglossaries

+

+at the place where you want the glossary and list of acronyms to appear. Note +that \printglossaries won’t produce any text the first time you create your +document, as an external indexing application needs to be used to sort and +collate the entries. Creating the completed document is therefore at least a three +step process. +

Suppose your document is called myDoc.tex, then you need to: + +

  1. Build/LATEX your document, either by clicking on an appropriate button in - your front-end/text editor or by typing the following at a terminal/command - prompt: +class="E">EX your document, either by clicking on an appropriate + button in your front-end/text editor or by typing the following at a + terminal/command prompt: -
    +
    latex myDoc
    -

    +

  2. Run the indexing application on the external le(s) created by the glossaries - package. If you have used the xindy package option, you must use xindy, - otherwise you must use makeindex. The glossaries package comes with a - convenient Perl wrapper that calls the appropriate indexing application the - required number of times with the required options. If you have Perl installed, - all you need to do is type - - -
    + class="enumerate" id="x1-7004x2">Run the indexing application on the external file(s) created by + the glossaries package. If you have used the xindy package option, + you must use xindy, otherwise you must use makeindex. The + glossaries package comes with a convenient Perl wrapper that calls the + appropriate indexing application the required number of times with the + required options. If you have Perl installed, all you need to do is + type + + +
    makeglossaries myDoc
    -

    in a terminal or command prompt. If you are using a front-end (such as - WinEdt or TeXnicCenter) and you want it to automatically run makeglossaries - when you build your document, you will need to consult the front-end's - documentation. -

    If you don't have Perl installed, you will need to call makeindex or xindy - explicitly. This is more complicated and is described in Generating the - Associated Glossary Files in the main glossaries user manual. +

    in a terminal or command prompt. If you are using a front-end (such as + WinEdt or TeXnicCenter) and you want it to automatically run + makeglossaries when you build your document, you will need to consult + the front-end’s documentation. +

    If you don’t have Perl installed, you will need to call makeindex or + xindy explicitly. This is more complicated and is described in + Generating the Associated Glossary Files in the main glossaries user + manual.

  3. Once you have successfully run the indexing application, you need to build/LATEX your document again (see step 1).
-

Note that sometimes you may have to repeat steps 2 and 3. -

The appearance of the glossary depends on the glossary style in use. The default -style uses the description

Note that sometimes you may have to repeat steps 2 and 3. +

The appearance of the glossary depends on the glossary style in use. The +default style uses the description environment, but there are many other styles available. -These are described in environment, but there are many other styles +available. These are described in Glossary Styles in the main glossaries user manual. By default, -a number or list of numbers will appear after each entry in the glossary. This -indicates the page (or pages) on which the term was used. This list can be suppressed -using the nonumberlist package option: +class="cmss-10x-x-109">glossaries user +manual. By default, a number or list of numbers will appear after each entry +in the glossary. This indicates the page (or pages) on which the term +was used. This list can be suppressed using the nonumberlist package +option:

-
+
\usepackage[nonumberlist]{glossaries}
-

-

Further information can be found in the main glossaries

+

Further information can be found in the main glossaries user manual and there is -also an user manual and +there is also an article on the glossaries package on the LATEX Community's Know How -section. -

EX Community’s +Know How section. +

Top

diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf index 6fb083fa2b4..1354a0ad489 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 266d26c8d43..7c13c105bd2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -13,7 +13,7 @@ \title{The glossaries package: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2013-11-16} +\date{2013-12-05} \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} @@ -36,7 +36,7 @@ such, it only covers the basics. For more advanced topics, see the \label{requirements} You need to have the \styfmt{glossaries} package installed. You also -need to have the following packages installed: \sty{ifthen}, +need to have the following packages installed: \sty{datatool}, \sty{ifthen}, \sty{xkeyval} (at least version 2.5f), \sty{xfor}, \sty{amsgen} and \sty{etoolbox}. You may also need \sty{longtable}, \sty{supertabular}, @@ -74,7 +74,13 @@ Note that the \styfmt{glossaries} package must be loaded \emph{after} the \sty{hyperref} package (contrary to the general advice that \sty{hyperref} should be loaded last). The \sty{glossaries} package should also be loaded after \sty{html}, \sty{inputenc}, -\sty{babel} and \sty{ngerman}. +\sty{babel} and \sty{ngerman}. If you are using \sty{babel} I +recommend you use the \sty{glossaries} package option +\pkgopt[babel]{translate}: +\begin{verbatim} +\usepackage{babel} +\usepackage[translate=babel]{glossaries} +\end{verbatim} \end{important} If you want to use \app{xindy} rather than \app{makeindex} to sort the @@ -129,11 +135,11 @@ since it isn't formed by simply appending the letter \qt{s}. When you define terms, it is important to remember that they will be sorted by an external application that doesn't interpret \LaTeX\ -commands. \app{Xindy} is a little more \TeX-aware than \app{makeindex}, but +commands. \app{xindy} is a little more \TeX-aware than \app{makeindex}, but for this example they will both mis-sort \verb|\oe sophagus|. Xindy will ignore the \verb*|\oe | part and will sort it according to \texttt{sophagus}, so it will be placed with the terms starting -with an \qt{s}. \app{Makeindex}, on the other hand, will sort it according +with an \qt{s}. \app{makeindex}, on the other hand, will sort it according to \verb*|\oe sophagus| which starts with a symbol (the backslash), so it will end up in the symbol group. You therefore need to specify how to sort the term: @@ -246,9 +252,6 @@ placed in a separate list of acronyms: \begin{verbatim} \usepackage[acronym]{glossaries} \end{verbatim} -There are other options that govern how acronyms appear. For further -details, see \xrsectionref{sec:acronyms}{glossaries-user}{Acronyms} -in the main \sty{glossaries} user manual. Acronyms must be defined before use and are defined using: \begin{definition} @@ -278,6 +281,12 @@ otherwise it would produce: \begin{display} A svm was implemented. \end{display} +If you prefer a different way of displaying the acronyms (for +example, putting the long form in a footnote on first use) it's +possible to change the acronym style. For further +details, see \xrsectionref{sec:acronyms}{glossaries-user}{Acronyms} +in the main \sty{glossaries} user manual. + You can reset an acronym so that the next use fully expands it again using: \begin{definition} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 13db02dd60d..53d2c08b8b3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -10,56 +10,67 @@ - +