diff options
author | Norbert Preining <norbert@preining.info> | 2023-10-01 03:01:18 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2023-10-01 03:01:18 +0000 |
commit | 8a05034cb5d7ae61b2de6857258caa3e43b496aa (patch) | |
tree | b9c266e7f98a034ed060178b3c0c162598e68948 /macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex | |
parent | 61bc2520e547446bddedc290572684496c9347a0 (diff) |
CTAN sync 202310010301
Diffstat (limited to 'macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex')
-rw-r--r-- | macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex | 138 |
1 files changed, 77 insertions, 61 deletions
diff --git a/macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex b/macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex index dfd7af3abc..87c2ea1351 100644 --- a/macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex +++ b/macros/latex/contrib/glossaries-extra/glossaries-extra-manual.tex @@ -459,6 +459,9 @@ First plural: \gls{glspl}\oarg{prereset}\marg{ex}[-insert].^^J% % example-glossaries-brief.bib \gfile{example\dhyphen glossaries\dhyphen brief.bib}% {\providedby{\sty{glossaries-extra} v1.19+}}% + % example-glossaries-utf8.bib + \gfile{example\dhyphen glossaries\dhyphen utf8.bib}% + {\providedby{\sty{glossaries-extra} v1.53+}}% % example-glossaries-parent.bib \gfile{example\dhyphen glossaries\dhyphen parent.bib}% {\providedby{\sty{glossaries-extra} v1.19+}}% @@ -21791,13 +21794,13 @@ now takes additional values} } } -\title{\styfmt{glossaries-extra.sty} v1.52: +\title{\styfmt{glossaries-extra.sty} v1.53: an extension to the \styfmt{glossaries} package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \href{https://www.dickimaw-books.com/}{\nolinkurl{dickimaw-books.com}}} -\date{2023-06-28 +\date{2023-09-29 } \begin{document} \maketitle @@ -23718,6 +23721,7 @@ Next use: \gls{gls}\marg{xml}, \gls{gls}\marg{clostridium}, \gls{gls}\marg{myris label={ex:multiabbrvstyles} ] {% +\cmd{usepackage}\oarg{T1}\marg{fontenc}^^J% \cmd{usepackage}\marg{glossaries-extra}^^J% \gls{setabbreviationstyle}\marg{long-short-sc}^^J% \gls{setabbreviationstyle}\oarg{genus}\marg{long-only-short-only}^^J% @@ -24138,12 +24142,12 @@ format produced with the \idx{firstuse} of \gls{gls}, and an \gls{glsxtrfull}. For some styles, such as \abbrstyle{long-short}, the \idxc{displayfullform}{display} and \idxc{inlinefullform}{inline} forms are identical. -The example below demonstrates the difference between the +\Exampleref{ex:glsVSfullVSfirst} demonstrates the difference between the \idx{firstuse} of \gls{gls} compared with the \idx{inlinefullform} for the \abbrstyle{footnote} abbreviation style. The example also uses \gls{glsfirst} to demonstrate that it produces an undesirable result with the selected abbreviation style. -\begin{coderesult} +\begin{coderesult}[float] \gls{setabbreviationstyle}\marg{footnote} \gls{newabbreviation}\marg{nasa}\marg{NASA}\marg{National Aeronautics and Space Administration} @@ -24178,7 +24182,7 @@ exploration\cmd{ldots} \gls{glsfirst}\marg{nasa}\oarg{'s} space exploration\cmd{ldots}^^J% } \end{coderesult} -In the above, the \idx{firstuse} of \gls{gls} puts the long form in +In \exampleref{ex:glsVSfullVSfirst}, the \idx{firstuse} of \gls{gls} puts the long form in the footnote but correctly inserts the final optional argument before the footnote marker. The \idx{inlinefullform} (obtained with \gls{glsxtrfull}) doesn't use a footnote, but instead shows the long @@ -28223,32 +28227,32 @@ Text field: \gls{glstext}\marg{sample}. \codepar First use: \gls{gls}\marg{sample}. Next use: \gls{gls}\marg{sample}. \codepar -Force reset: \gls{gls}\oarg{prereset}\marg{sample}. +Force reset: \gls{gls}\oarg{\glsopt{prereset}}\marg{sample}. Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. \codepar -Force reset: \gls{glstext}\oarg{prereset}\marg{sample}. +Force reset: \gls{glstext}\oarg{\glsopt{prereset}}\marg{sample}. Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. \cend{document} \end{codebox} \begin{resultbox} -\createexample[title={Illustrating the \optfmt{prereset} option}, +\createexample*[title={Illustrating the \optfmt{prereset} option}, label={ex:prereset}, description={Example document illustrating the use of the prereset option}] -{\usepackage{glossaries-extra}^^J% -\glsdefpostlink{general}{\glsxtrpostlinkAddDescOnFirstUse}^^J -\newglossaryentry{sample}{name={sample},^^J - first={sample first use},^^J - description={an example}} +{\cmd{usepackage}\marg{glossaries-extra}^^J% +\gls{glsdefpostlink}\marg{general}\marg{\gls{glsxtrpostlinkAddDescOnFirstUse}}^^J +\gls{newglossaryentry}\marg{sample}\marg{name={sample},^^J + first=\marg{sample first use},^^J + description=\marg{an example}} }{% -Text field: \glstext{sample}. - -First use: \gls{sample}. Next use: \gls{sample}. - -Force reset: \gls[prereset]{sample}. -Used? \ifglsused{sample}{Yes}{No}. - -Force reset: \glstext[prereset]{sample}. -Used? \ifglsused{sample}{Yes}{No}. +Text field: \gls{glstext}\marg{sample}. +\codepar +First use: \gls{gls}\marg{sample}. Next use: \gls{gls}\marg{sample}. +\codepar +Force reset: \gls{gls}\oarg{prereset}\marg{sample}. +Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. +\codepar +Force reset: \gls{glstext}\oarg{prereset}\marg{sample}. +Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. } \end{resultbox} Note that \gls{gls} unsets the \idx{firstuseflag} (unless @@ -28279,13 +28283,13 @@ overrides the global reset. \cbeg{document} \gls{gls}\marg{sample}. Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. \codepar -\marg{\gls{glsfirst}\oarg{preunset=local,prereset=global}\marg{sample}. +\marg{\gls{glsfirst}\oarg{\glsoptval{preunset}{local},\glsoptval{prereset}{global}}\marg{sample}. Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. } \codepar Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. \codepar -\marg{\gls{gls}\oarg{preunset=local,prereset=global}\marg{sample}. +\marg{\gls{gls}\oarg{\glsoptval{preunset}{local},\glsoptval{prereset}{global}}\marg{sample}. Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. } \codepar @@ -28293,29 +28297,30 @@ Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. \cend{document} \end{codebox} \begin{resultbox} -\createexample[title={Combining \optfmt{prereset} and \optfmt{preunset}}, +\createexample*[title={Combining \optfmt{prereset} and \optfmt{preunset}}, label={ex:preresetpreunset}, description={Example document illustrating the use of the prereset and preunset options}] -{\usepackage{glossaries-extra}^^J% -\glsdefpostlink{general}{\glsxtrpostlinkAddDescOnFirstUse}^^J -\newglossaryentry{sample}{name={sample},^^J - first={sample first use},^^J - description={an example}} +{\cmd{usepackage}\marg{glossaries-extra}^^J% +\gls{glsdefpostlink}\marg{general}\marg{\gls{glsxtrpostlinkAddDescOnFirstUse}}^^J +\gls{newglossaryentry}\marg{sample}\marg{name=\marg{sample},^^J + first=\marg{sample first use},^^J + description=\marg{an example}} }{% -\gls{sample}. Used? \ifglsused{sample}{Yes}{No}. - -{\glsfirst[preunset=local,prereset=global]{sample}. -Used? \ifglsused{sample}{Yes}{No}. +\gls{gls}\marg{sample}. Used?^^J% +\gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. +\codepar +\marg{\gls{glsfirst}\oarg{preunset=local,prereset=global}\marg{sample}.^^J% +Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. } - -Used? \ifglsused{sample}{Yes}{No}. - -{\gls[preunset=local,prereset=global]{sample}. -Used? \ifglsused{sample}{Yes}{No}. +\codepar +Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. +\codepar +\marg{\gls{gls}\oarg{preunset=local,prereset=global}\marg{sample}.^^J% +Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. } - -Used? \ifglsused{sample}{Yes}{No}. +\codepar +Used? \gls{ifglsused}\marg{sample}\marg{Yes}\marg{No}. } \end{resultbox} Remember that \gls{gls} globally unsets the \idx{firstuseflag} @@ -29974,7 +29979,7 @@ The \idx{postlinkhook} is suppressed by the initialisation command: This is used inside the added outer scoping and is simply defined as: \begin{compactcodebox} -\cmd{newcommand}{\gls{glsxtrpInit}}[2]\marg{\cmd{let}\gls{glspostlinkhook}\cmd{relax}} +\cmd{newcommand}{\gls{glsxtrpInit}}\oarg{2}\marg{\cmd{let}\gls{glspostlinkhook}\cmd{relax}} \end{compactcodebox} It is possible to redefine this command to allow the \idx{glspostlinkhook} to be used, but any look-ahead (such as @@ -35127,7 +35132,7 @@ This example is an alternative way of dealing with nested links \marg{shtml-frag}\marg{shtml}\marg{enabled} \codepar \gls{glssetcategoryattribute}\marg{combinedabbrv}\marg{multioptions} - \marg{\mglsoptval{usedskipothers},\mglsoptval{firstsuffix}{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}}} + \marg{\mglsoptval{usedskipothers},\mglsoptvalm{firstsuffix}{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}}} \codepar \gls{multiglossaryentry} \oarg{\mglsoptval{category}{combinedabbrv}} @@ -35164,27 +35169,32 @@ The resulting document is shown below. description={Example document demonstrating multi-entry sets with elements skipped}, arara={pdflatex,makeglossaries,pdflatex,pdfcrop}] -{\cmd{usepackage}[colorlinks]\marg{hyperref} +{% +\cmd{usepackage}\oarg{T1}\marg{fontenc}^^J% +\cmd{usepackage}[colorlinks]\marg{hyperref}^^J% \cmd{usepackage}[stylemods,style=long]\marg{glossaries-extra} \codepar \gls{makeglossaries} \codepar -\gls{setabbreviationstyle}\marg{long-short-sc} -\gls{newabbreviation}\marg{ssi}\marg{ssi}\marg{server-side includes} +\gls{setabbreviationstyle}\marg{long-short-sc}^^J% +\gls{newabbreviation}\marg{ssi}\marg{ssi}\marg{server-side +includes}^^J% \gls{newabbreviation}\marg{html}\marg{html}\marg{hypertext markup language} \codepar -\gls{setabbreviationstyle}\oarg{combinedabbrv}\marg{long-only-short-sc-only} -\gls{newabbreviation} - \oarg{\gloskeyval{category}{combinedabbrv}, - \gloskeyval{description}{\gls{glsxtrshort}\marg{ssi} enabled \gls{glsxtrshort}\marg{html}}} +\gls{setabbreviationstyle}\oarg{combinedabbrv}\marg{long-only-short-sc-only}^^J% +\gls{newabbreviation}^^J + \oarg{\gloskeyval{category}{combinedabbrv},^^J + \gloskeyval{description}{\gls{glsxtrshort}\marg{ssi} enabled +\gls{glsxtrshort}\marg{html}}}^^J \marg{shtml-frag}\marg{shtml}\marg{enabled} \codepar \gls{glssetcategoryattribute}\marg{combinedabbrv}\marg{multioptions}^^J - \marg{usedskipothers,firstsuffix=\marg{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}}}^^J% + \marg{usedskipothers,firstsuffix=\marg{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}}} \codepar -\gls{multiglossaryentry} - \oarg{category=combinedabbrv} +\gls{multiglossaryentry}^^J + \oarg{category=combinedabbrv}^^J \marg{shtml}\oarg{shtml-frag}\marg{ssi,shtml-frag,html} +\codepar } {Individual elements first use: \gls{gls}\marg{ssi} and \gls{gls}{html}. \codepar @@ -35232,8 +35242,8 @@ The complete set of options are now: \marg{\% \mglsoptval{hyper}{notmainfirst}, \mglsoptval{mglsopts}{\mglsopt{presetlocal},\mglsopt{unsetothers},\mglsoptval{others}{local}}, - \mglsoptval{usedskipothers}, - \mglsoptval{firstsuffix}\marg{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}} + \mglsopt{usedskipothers}, + \mglsoptval{firstsuffix}{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}} } \end{codebox} \begin{resultbox} @@ -35243,7 +35253,9 @@ others)}, description={Example document demonstrating multi-entry sets with elements skipped and unset}, arara={pdflatex,makeglossaries,pdflatex,pdfcrop}] -{\cmd{usepackage}[colorlinks]\marg{hyperref}^^J% +{% +\cmd{usepackage}\oarg{T1}\marg{fontenc}^^J% +\cmd{usepackage}[colorlinks]\marg{hyperref}^^J% \cmd{usepackage}[stylemods,style=long]\marg{glossaries-extra} \codepar \gls{makeglossaries}^^J% @@ -35264,8 +35276,8 @@ includes}^^J% \marg{\%^^J \mglsoptval{hyper}{notmainfirst},^^J \mglsoptval{mglsopts}{\mglsopt{presetlocal},\mglsopt{unsetothers},\mglsoptval{others}{local}},^^J - \mglsoptval{usedskipothers},^^J - \mglsoptval{firstsuffix}\marg{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}}^^J% + \mglsopt{usedskipothers},^^J + \mglsoptval{firstsuffix}{\gls{glsxtrshort}\marg{\gls{mglslastmainlabel}}}^^J% }^^J% \codepar \gls{multiglossaryentry}^^J @@ -35420,7 +35432,9 @@ post-link hooks)}, description={Example document demonstrating multi-entry sets with elements skipped and prefix and post-link hooks}, arara={pdflatex,makeglossaries,pdflatex,pdfcrop}] -{\cmd{usepackage}[colorlinks]\marg{hyperref}^^J% +{% +\cmd{usepackage}\oarg{T1}\marg{fontenc}^^J% +\cmd{usepackage}[colorlinks]\marg{hyperref}^^J% \cmd{usepackage}[stylemods,style=long]\marg{glossaries-extra}^^J% \codepar \gls{makeglossaries}^^J% @@ -44650,12 +44664,12 @@ them. The following commands are defined: For example, with \begin{codebox} \cmd{renewcommand}\marg{\gls{glsxtrresourceinit}}\marg{\comment{} - \cmddef{GlsXtrResourceInitEscSequences} + \gls{GlsXtrResourceInitEscSequences} } \end{codebox} then the earlier example can be written more compactly as: \begin{codebox} -\resourceoptvalm{sort-replace}{\marg{([a-zA-Z])\gls{cs.dot}}\marg{\gls{cs.dollar}1}} +\resourceoptvalm{sort-replace}{\marg{([a-zA-Z])\gls{cs.dot}}\marg{\gls{dollar}1}} \end{codebox} A convenient shortcut for use in the \resourceopt{entry-type-aliases} @@ -46602,6 +46616,8 @@ Corresponds to \filefmt{example-glossaries-symbols.tex} Corresponds to \filefmt{example-glossaries-url.tex} \filedef{example-glossaries-user.bib} Corresponds to \filefmt{example-glossaries-user.tex} +\filedef{example-glossaries-utf8.bib} +Corresponds to \filefmt{example-glossaries-utf8.tex} \filedef{example-glossaries-xr.bib} Corresponds to \filefmt{example-glossaries-xr.tex} |