diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex | 235 |
1 files changed, 202 insertions, 33 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex index e041fe1f146..e770711e475 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex @@ -210,13 +210,13 @@ styles (glossaries):>#1={\protect\ttfamily#1}|main}} \DeleteShortVerb{\|} \MakeShortVerb{"} - \title{glossaries-extra.sty v1.24: + \title{glossaries-extra.sty v1.25: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2017-11-14} + \date{2017-11-24} \maketitle \begin{abstract} @@ -2535,7 +2535,15 @@ the command \cs{glsxtrbookindexcolspread} \end{definition} isn't empty then it's supplied as the optional argument -following \verb|\begin{multicols}|\marg{n}. +following \verb|\begin{multicols}|\marg{n}. You can switch from +\env{multicols} to \env{multicols*} by redefining +\begin{definition}[\DescribeMacro\glsxtrbookindexmulticolsenv] +\cs{glsxtrbookindexmulticolsenv} +\end{definition} +For example +\begin{verbatim} +\renewcommand{\glsxtrbookindexmulticolsenv}{multicols*} +\end{verbatim} Each top-level entry is displayed using \begin{definition}[\DescribeMacro\glsxtrbookindexname] @@ -2845,6 +2853,13 @@ the \qt{symbol} category: \newcommand*{\glsxtrpostnamesymbol}{\space (\glsentrysymbol{\glscurrententrylabel})} \end{verbatim} +As from version 1.25, the post-name hook also does +\begin{definition}[\DescribeMacro\glsextrapostnamehook] +\cs{glsextrapostnamehook}\marg{label} +\end{definition} +(before \cs{glsxtrpostname}\meta{category}) +to allow for additional non-category related code. This does nothing +by default. The post-description code used within the glossary is modified so that it also does @@ -3998,7 +4013,19 @@ defined with any of these styles. \begin{description} \item[\abbrstyledef{short-nolong}] This only displays the short form on \gls{firstuse}. The \gloskey{name} -is set to the short form. The \gloskey{description} is set to the +is set to the short form through the command +\begin{definition}[\DescribeMacro\glsxtrshortnolongname] +\cs{glsxtrshortnolongname} +\end{definition} +(Similarly for the other +\texttt{short}\meta{modifier}\texttt{-nolong}\meta{modifier} styles, +unless indicated otherwise.) +This command is expanded as the entry is defined, so any +redefinition must be done before \cs{newabbreviation} (or +\cs{newacronym}) for it to take effect. Make sure to \cs{protect} +any formatting commands (or anything else that shouldn't be expanded). + +The \gloskey{description} is set to the long form. The inline full form displays \meta{short} (\meta{long}). The long form on its own can be displayed through commands like \ics{glsxtrlong}. @@ -4017,7 +4044,10 @@ use \ics{glsabbrvscfont} (which defaults to \cs{textsc}). \item[\abbrstyledef{nolong-short-sc}] Like \abbrstyle{short-sc-nolong} but the inline full form displays -\meta{long} (\meta{short}). +\meta{long} (\meta{short}). The name is still obtained from +\cs{glsxtrshortnolongname} (similarly for the other +\texttt{nolong}\meta{modifier}\texttt{-short}\meta{modifier} styles, +unless indicated otherwise). \item[\abbrstyledef{short-sm-nolong}] Like \abbrstyle{short-nolong} but redefines \cs{glsabbrvfont} to @@ -4041,7 +4071,17 @@ but the inline full form displays \item[\abbrstyledef{short-nolong-desc}] Like the \abbrstyle{short-nolong} style, but the \gloskey{name} is set to -the full form and the \gloskey{description} must be supplied by the +the full form obtained by expanding +\begin{definition}[\DescribeMacro\glsxtrshortdescname] +\cs{glsxtrshortdescname} +\end{definition} +(Similarly for the other +\texttt{short}\meta{modifier}\texttt{-nolong}\meta{modifier}\texttt{-desc} +styles, unless indicated otherwise.) This command is expanded when the entry is defined, so +\cs{protect} fragile and formatting commands and only redefine this +command before \cs{newabbreviation} (or \cs{newacronym}). + +The \gloskey{description} must be supplied by the user. You may prefer to use the \abbrstyle{short-nolong} style with the post-description hook set to display the long form and override the \gloskey{description} key. (See the sample file @@ -4077,8 +4117,18 @@ subsequent use of commands \ics{gls}. The short form may be accessed through commands like \ics{glsxtrshort}. The inline full form displays \meta{long} (\meta{short}). -The \gloskey{name} and \gloskey{sort} keys are set to the long form and the -\gloskey{description} must be provided by the user. The predefined +The \gloskey{sort} key are set to the long form. +The \gloskey{name} key is also set to the long form, but this is +done by expanding +\begin{definition}[\DescribeMacro\glsxtrlongnoshortdescname] +\cs{glsxtrlongnoshortdescname} +\end{definition} +(Similarly for the other +\texttt{long}\meta{modifier}\texttt{-noshort}\meta{modifier}\texttt{-desc} +styles, unless indicated otherwise.) This command should only be redefined before abbreviations +are defined, and any fragile or formatting commands within it need protecting. + +The \gloskey{description} must be provided by the user. The predefined glossary styles won't display the short form. You can use the post-description hook to automatically append the short form to the description. The inline full form will display \meta{long} @@ -4116,10 +4166,19 @@ New to version 1.04, like \abbrstyle{long-noshort-desc} but redefines \item[\abbrstyledef{long-noshort}] This style doesn't really make sense if you don't use the short form anywhere in the document, but is provided for completeness. -This is like the \abbrstyle{long-noshort-desc} style, but the \gloskey{name} -and \gloskey{sort} keys are -set to the short form and the \gloskey{description} is set to the -long form. +This is like the \abbrstyle{long-noshort-desc} style, but +the \gloskey{sort} key is set to the short form. The \gloskey{name} +key is also set to the short form, but this is done by expanding +\begin{definition}[\DescribeMacro\glsxtrlongnoshortname] +\cs{glsxtrlongnoshortname} +\end{definition} +(Similarly for other +\texttt{long}\meta{modifier}\texttt{-noshort}\meta{modifier} styles, +unless indicated otherwise.) +This command should only be redefined before abbreviations are +defined, and fragile or formatting commands should be protected. + +The \gloskey{description} is set to the long form. \item[\abbrstyledef{long}] A synonym for \abbrstyle{long-noshort} @@ -4167,11 +4226,22 @@ Other attributes may also be set, depending on the style. \begin{description} \item[\abbrstyledef{long-short}] On \gls{firstuse}, this style uses the format \meta{long} (\meta{short}). -The inline and display full forms are the same. The \gloskey{name} -and \gloskey{sort} keys are set to the short form. (The -\gloskey{name} key additionally includes the font command -\cs{glsabbrvfont}.) The -\gloskey{description} is set to the long form. The long and short +The inline and display full forms are the same. The + \gloskey{sort} key is set to the short form. The \gloskey{name} is +also set to the short form through +\begin{definition}[\DescribeMacro\glsxtrlongshortname] +\cs{glsxtrlongshortname} +\end{definition} +(Similarly for other +\texttt{long}\meta{modifier}\texttt{-short}\meta{modifier} styles, +unless indicated otherwise.) +Any redefinition of this command must come before the abbreviations +are defined as it expands on definition. Make sure you protect +any commands that shouldn't be expanded. The long form can be +referenced with \cs{the}\cs{glslongtok} and the short form +can be referenced with \cs{the}\cs{glsshorttok}. + +The \gloskey{description} is set to the long form. The long and short forms are separated by \cs{glsxtrfullsep}. If you want to insert material within the parentheses (such as a~translation), try the \abbrstyle{long-short-user} style. @@ -4196,12 +4266,30 @@ use \ics{glsfirstlongemfont}. New to version 1.17, this style only shows the long form on first use and only shows the short form on subsequent use. The inline full form \cs{glsxtrfull} shows the long form -followed by the short form in parentheses. +followed by the short form in parentheses. The \gloskey{name} +field is obtained from +\begin{definition}[\DescribeMacro\glsxtronlyname] +\cs{glsxtronlyname} +\end{definition} +Any redefinition of this command must come before the abbreviations +are defined as it expands on definition. Make sure you protect +any commands that shouldn't be expanded. The long form can be +referenced with \cs{the}\cs{glslongtok} and the short form +can be referenced with \cs{the}\cs{glsshorttok}. \item[\abbrstyledef{long-only-short-only-desc}] New to version 1.17, this style is like \abbrstyle{long-only-short-only} but the user must supply the -description. +description. The \gloskey{name} +field is obtained from +\begin{definition}[\DescribeMacro\glsxtronlydescname] +\cs{glsxtronlydescname} +\end{definition} +Any redefinition of this command must come before the abbreviations +are defined as it expands on definition. Make sure you protect +any commands that shouldn't be expanded. The long form can be +referenced with \cs{the}\cs{glslongtok} and the short form +can be referenced with \cs{the}\cs{glsshorttok}. \item[\abbrstyledef{long-em-noshort-em-noreg}] New to version 1.17, this style is like @@ -4232,6 +4320,8 @@ where \meta{text} is the short form (for the a space using \cs{glsxtrfullsep} and then the parenthetical content (using \ics{glsxtrparen}). +The \gloskey{name} is obtained by expanding +\cs{glsxtrlongshortname} (see above). The \meta{text} argument includes the font formatting command, \cs{glsfirstabbrvfont}\marg{short} in the case of the \abbrstyle{long-short-user} style and @@ -4298,7 +4388,19 @@ For example: \renewcommand*{\glsxtrlongshortdescsort}{\the\glsshorttok} \end{verbatim} The \gloskey{description} must be supplied by the user. -The long and short forms are separated by \cs{glsxtrfullsep}. +The long and short forms are separated by \cs{glsxtrfullsep}. The \gloskey{name} +field is obtained from +\begin{definition}[\DescribeMacro\glsxtrlongshortdescname] +\cs{glsxtrlongshortdescname} +\end{definition} +(Similarly for other +\texttt{long}\meta{modifier}\texttt{-short}\meta{modifier}\texttt{-desc} +styles, unless indicated otherwise.) +Any redefinition of this command must come before the abbreviations +are defined as it expands on definition. Make sure you protect +any commands that shouldn't be expanded. The long form can be +referenced with \cs{the}\cs{glslongtok} and the short form +can be referenced with \cs{the}\cs{glsshorttok}. \item[\abbrstyledef{long-short-sc-desc}] Like \abbrstyle{long-short-desc} but redefines \cs{glsabbrvfont} to @@ -4326,8 +4428,15 @@ doesn't set the \catattr{regular} attribute. New to version 1.04, this style is like a~cross between the \abbrstyle{long-short-desc} style and the \abbrstyle{long-short-user} style. The display and inline forms are -as for \abbrstyle{long-short-user} and the \gloskey{name} key is as -\abbrstyle{long-short-desc}. The \gloskey{description} key must be +as for \abbrstyle{long-short-user} and the \gloskey{name} key is +obtained from +\begin{definition}[\DescribeMacro\glsxtrlongshortuserdescname] +\cs{glsxtrlongshortuserdescname} +\end{definition} +Again, this should only be redefined before \cs{newabbreviation} (or +\cs{newacronym}), and fragile and formatting commands need protecting. + +The \gloskey{description} key must be supplied in the optional argument of \cs{newabbreviation} (or \cs{newacronym}). The \gloskey{sort} key is set to \meta{long} (\meta{short}) as per the \abbrstyle{long-short-desc} style. @@ -4350,6 +4459,20 @@ If you want to insert material within the parentheses (such as a~translation), try the \abbrstyle{short-long-user} style. +The \gloskey{name} field is obtained from +\begin{definition}[\DescribeMacro\glsxtrshortlongname] +\cs{glsxtrshortlongname} +\end{definition} +(Similarly for other +\texttt{short}\meta{modifier}\texttt{-long}\meta{modifier} styles, +unless indicated otherwise.) +Any redefinition of this command must come before the abbreviations +are defined as it expands on definition. Make sure you protect +any commands that shouldn't be expanded. The long form can be +referenced with \cs{the}\cs{glslongtok} and the short form +can be referenced with \cs{the}\cs{glsshorttok}. + + \item[\abbrstyledef{short-sc-long}] Like \abbrstyle{short-long} but redefines \cs{glsabbrvfont} to use \ics{glsabbrvscfont}. @@ -4371,7 +4494,14 @@ New to version 1.04. This style is like the \abbrstyle{long-short-user} style but with the long and short forms switched. The parenthetical material is governed by the same command \ics{glsxtruserparen}, but the first argument supplied to it is -the long form instead of the short form. +the long form instead of the short form. The \gloskey{name} field is +obtained by expanding +\begin{definition}[\DescribeMacro\glsxtrshortlongname] +\cs{glsxtrshortlongname} +\end{definition} +Again, this should only be redefined before \cs{newabbreviation} (or +\cs{newacronym}) and commands that should be expanded need to be +protected. \item[\abbrstyledef{short-nolong-desc-noreg}] This style is like \abbrstyle{short-nolong-desc} but it doesn't @@ -4382,7 +4512,19 @@ On \gls{firstuse}, this style uses the format \meta{short} (\meta{long}). The inline and display full forms are the same. The \gloskey{name} is set to the full form. The \gloskey{description} must be supplied by the user. -The short and long forms are separated by \cs{glsxtrfullsep}. +The short and long forms are separated by \cs{glsxtrfullsep}. The \gloskey{name} +field is obtained from +\begin{definition}[\DescribeMacro\glsxtrshortlongdescname] +\cs{glsxtrshortlongdescname} +\end{definition} +(Similarly for other +\texttt{short}\meta{modifier}\texttt{-long}\meta{modifier}\texttt{-desc} +styles, unless indicated otherwise.) +Any redefinition of this command must come before the abbreviations +are defined as it expands on definition. Make sure you protect +any commands that shouldn't be expanded. The long form can be +referenced with \cs{the}\cs{glslongtok} and the short form +can be referenced with \cs{the}\cs{glsshorttok}. \item[\abbrstyledef{short-sc-long-desc}] Like \abbrstyle{short-long-desc} but redefines \cs{glsabbrvfont} to @@ -4404,8 +4546,15 @@ use \ics{glsfirstlongemfont}. New to version 1.04, this style is like a~cross between the \abbrstyle{short-long-desc} style and the \abbrstyle{short-long-user} style. The display and inline forms are -as for \abbrstyle{short-long-user} and the \gloskey{name} key is as -\abbrstyle{short-long-desc}. The \gloskey{description} key must be +as for \abbrstyle{short-long-user}, but the \gloskey{name} key is +obtained from +\begin{definition}[\DescribeMacro\glsxtrshortlonguserdescname] +\cs{glsxtrshortlonguserdescname} +\end{definition} +Again, this should only be redefined before \cs{newabbreviation} (or +\cs{newacronym}), and fragile and formatting commands need protecting. + +The \gloskey{description} key must be supplied in the optional argument of \cs{newabbreviation} (or \cs{newacronym}). @@ -4418,7 +4567,16 @@ marker may be, if the \sty{hyperref} package is used). The inline full form uses the \meta{short} (\meta{long}) style. The \gloskey{name} is set to the short form. -The \gloskey{description} is set to the long form. +The \gloskey{description} is set to the long form. The +\gloskey{name} key is obtained by expanding +\begin{definition}[\DescribeMacro\glsxtrfootnotename] +\cs{glsxtrfootnotename} +\end{definition} +(Similarly for other +\texttt{short\meta{modifier}-\meta{modifier}footnote} styles, unless +indicated otherwise.) Again, this command should only be redefined +before \cs{newabbreviation} (or \cs{newacronym}), and fragile or +formatting commands should be protected from expansion. As from version 1.05, all the footnote styles use: \begin{definition}[\DescribeMacro\glsfirstlongfootnotefont] @@ -4522,12 +4680,14 @@ This style was introduced in version 1.12. It's like the material to after the link-text. This means that you don't have such a long hyperlink (which can cause problems for the DVI \LaTeX\ format) and it also means that the user supplied material can include a -hyperlink to another location. +hyperlink to another location. The \gloskey{name} key is obtained +from \cs{glsxtrshortlongname}. \item[\abbrstyledef{short-postlong-user-desc}] This style was introduced in version 1.12. It's like the above \abbrstyle{short-postlong-user} style but the \gloskey{description} -must be specified. +must be specified. The \gloskey{name} is obtained from +\cs{glsxtrshortlonguserdescname}. \item[\abbrstyledef{long-postshort-user}] This style was introduced in version 1.12. It's like the above @@ -4538,7 +4698,8 @@ first and the short form is in the parenthetical material (as for \item[\abbrstyledef{long-postshort-user-desc}] This style was introduced in version 1.12. It's like the above \abbrstyle{long-postshort-user} style but the \gloskey{description} -must be specified. +must be specified. The \gloskey{name} is obtained from +\cs{glsxtrlongshortuserdescname}. \item[\abbrstyledef{long-hyphen-short-hyphen}] This style (new to v1.17) is designed to work with the \catattr{markwords} @@ -4553,6 +4714,7 @@ locally redefines \ics{glsxtrwordsep} to a hyphen, which means that if the \catattr{markwords} attribute is set then the long form will become hyphenated. (If this attribute isn't set, there's no alteration to the way the long form is displayed.) +The \gloskey{name} key is obtained from \cs{glsxtrlongshortname}. Unlike the other \meta{long} (\meta{short}) type of styles, such as \abbrstyle{long-short}, this style @@ -4637,6 +4799,7 @@ on subsequent use. The short form can be accessed with \cs{glsxtrshort} but just uses the default abbreviation font. There's no regular version of this style as the regular form doesn't have the flexibility to deal with the hyphen switch. +The \gloskey{name} is obtained from \cs{glsxtrlongnoshortdescname}. \item[\abbrstyledef{long-hyphen-noshort-noreg}] New to version 1.17, this style is like @@ -4648,7 +4811,8 @@ form. New to version 1.17. This is similar to \abbrstyle{long-hyphen-short-hyphen} but the user -supplies the description. +supplies the description. The \gloskey{name} is obtained from +\cs{glsxtrlongshortdescname}. \item[\abbrstyledef{long-hyphen-postshort-hyphen}] @@ -4699,7 +4863,8 @@ if you want to ensure the full format. New to version 1.17. This is similar to \abbrstyle{long-hyphen-postshort-hyphen} but the -user supplies the description. +user supplies the description. The \gloskey{name} is obtained from +\cs{glsxtrlongshortdescname}. \item[\abbrstyledef{short-hyphen-long-hyphen}] @@ -4710,12 +4875,14 @@ is displayed first followed by the long form in parentheses. The full form is fo \cs{glsxtrshorthyphenlong}\marg{label}\marg{short}\marg{long}\marg{insert} \end{definition} which behaves in an analogous way to \cs{glsxtrlonghyphenshort}. +The \gloskey{name} is obtained from \cs{glsxtrshortlongname}. \item[\abbrstyledef{short-hyphen-long-hyphen-desc}] New to version 1.17. This is similar to \abbrstyle{short-hyphen-long-hyphen} but the user supplies the description. +The \gloskey{name} is obtained from \cs{glsxtrshortlongdescname}. \item[\abbrstyledef{short-hyphen-postlong-hyphen}] This style (new to v1.17) is like @@ -4732,6 +4899,7 @@ where \end{definition} is in the post-link hook. These commands behave in an analogous manner to those used with \abbrstyle{long-hyphen-postshort-hyphen}. +The \gloskey{name} is obtained from \cs{glsxtrshortlongname}. \begin{important} Don't use \cs{gls} in the \meta{insert} part for commands @@ -4747,7 +4915,8 @@ if you want to ensure the full format. New to version 1.17. This is similar to \abbrstyle{short-hyphen-postlong-hyphen} but the -user supplies the description. +user supplies the description. The \gloskey{name} is obtained from +\cs{glsxtrshortlongdescname}. \end{description} |