diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index fdbd76bfc1f..58e8b5c263e 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -448,11 +448,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.38} + \title{User Manual for glossaries.sty v4.39} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2018-05-10} + \date{2018-05-23} \maketitle \begin{abstract} @@ -537,7 +537,7 @@ package. \item[\url{glossaries-code.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{glossaries} bundle should read -\qt{Documented Code for glossaries v4.38}. +\qt{Documented Code for glossaries v4.39}. \item[INSTALL] Installation instructions. @@ -571,8 +571,7 @@ options provided by \styfmt{glossaries} and \styfmt{glossaries-extra}). (chapter 6). \item -\href{http://www.latex-community.org/know-how/latex/55-latex-general/263-glossaries-nomenclature-lists-of-symbols-and-acronyms}{Glossaries, -Nomenclature, Lists of Symbols and Acronyms} +\href{https://www.dickimaw-books.com/latex/buildglossaries/}{Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build} \item The \href{http://ctan.org/pkg/glossaries-extra}{\styfmt{glossaries-extra} package} @@ -2717,20 +2716,10 @@ the \menu{Start}\submenu{All Programs} menu or \menu{Start}\submenu{All Programs}\submenu{Accessories} menu. Alternatively, your text editor may have the facility to create a -function that will call the required application. The article -\href{http://www.latex-community.org/index.php?option=com_content&view=article\&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{\qt{Glossaries, Nomenclature, List of Symbols and -Acronyms}} -in the \urlfootref{http://www.latex-community.org/}{\LaTeX\ -Community's} Know How section -describes how to do this for TeXnicCenter, and the thread -\href{http://groups.google.com/group/comp.text.tex/browse_thread/thread/edd83831b81b0759?hl=en}{\qt{Executing Glossaries' makeindex from a WinEdt -macro}} on the \texttt{comp.text.tex} newsgroup -describes how to do it for WinEdt. \href{http://www.dickimaw-books.com/latex/thesis/html/build.html}{Section -1.1 (Building Your Document)} -of \urlfootref{http://www.dickimaw-books.com/latex/thesis/}{\qt{Using \LaTeX\ to Write a PhD Thesis}} describes how to do it -for TeXWorks. -For other editors see the editor's -user manual for further details. +function that will call the required application. See +\href{https://www.dickimaw-books.com/latex/buildglossaries/}{Incorporating +makeglossaries or makeglossaries-lite or bib2gls into the document +build}. If any problems occur, remember to check the transcript files (e.g.\ \filetype{.glg} or \filetype{.alg}) for messages. @@ -2850,7 +2839,7 @@ resulting file onto the man path. Alternatively do \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -4.38. +4.39. \end{important} \subsection{Using the makeglossaries-lite Lua Script} @@ -4612,7 +4601,12 @@ New glossary entries are defined using the command: \cs{newglossaryentry}\marg{label}\marg{key=value list} \end{definition} This is a short command, so values in \meta{key-val list} can't -contain any paragraph breaks. If you have a long description that +contain any paragraph breaks. Take care to enclose values containing +any commas (\texttt{,}) or equal signs (\texttt{=}) with braces to hide them +from the key=value list parser. Be careful to ensure that no +spurious spaces are included at the start and end of the braces. + +If you have a long description that needs to span multiple paragraphs, use \begin{definition}[\DescribeMacro{\longnewglossaryentry}] \cs{longnewglossaryentry}\marg{label}\marg{key=value @@ -4622,7 +4616,11 @@ instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. \cs{longnewglossaryentry} will remove trailing spaces in the description (via \cs{unskip}) but won't remove leading spaces (otherwise it would interfere with -commands like \cs{Glsentrydesc}). +commands like \cs{Glsentrydesc}). This command also appends +\cs{nopostdesc} to the end of the description, which suppresses the +post-description hook. The \sty{glossaries-extra} package provides +a starred version of \cs{longnewglossaryentry} that doesn't append +either \cs{unskip} or \cs{nopostdesc}. There are also commands that will only define the entry if it hasn't already been defined: @@ -10927,6 +10925,9 @@ To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine \cs{glspostdescription} before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \ics{nopostdesc} in the entry's description. +Note that \ics{longnewglossaryentry} puts \cs{nopostdesc} at the end +of the description. The \sty{glossaries-extra} package provides a +starred version that doesn't. As from version 3.03 you can now use the package option \pkgopt{nopostdot} to suppress this full stop. This is the better |