[Tex/LaTex] macro for glossaries counter

countersglossariesmacros

I want custom my glossaries, and specially I want to have something like

My glossary entry, its signification (see p. 1), if this entry mentioned only once

My glossary entry, its signification (see pp. 1,2), if this entry mentioned several times

So I create command to count the number of item in the list ##2 used by

\newglossarystyle

and another command to print see p. or see pp.

I tested these command outside of the \newglossarystyle definition, it seems to work. But inside this definition the command to count the number of item in the list don't accept the ##2 argument.

Here is my example:

% arara: pdflatex
% arara: makeglossaries
% arara: pdflatex
% arara: makeglossaries
% arara: pdflatex

\documentclass[onecolumn,twoside,openright,a4paper,11pt]{report}    

\usepackage[utf8]{inputenc}     
\usepackage[T1]{fontenc}        

\usepackage{hyperref}       
\usepackage{calc}
\usepackage{pgffor}     % you don't need this if tikz is already included

\usepackage[toc,acronym,xindy,section=section]{glossaries} 



\newcounter{moncompteur}

\newcommand{\Znumlist}[1]{
\setcounter{moncompteur}{0}
    \foreach \e in{#1}{%
    \addtocounter{moncompteur}{1}
    }
\themoncompteur
}

\newcommand{\montest}[1]{%
    \ifnum#1<2%
        \seename\ p.
    \else%
        \seename\ pp.
    \fi%
}
\newglossarystyle{mylist}{  %
    \setglossarystyle{list} % base this style on the list style
    \renewcommand*{\glossentry}[2]{%
    \item[\glsentryitem{##1}%
    \glstarget{##1}{\glossentryname{##1}}]
    %\glossentrydesc{##1}\glspostdescription\space \Znumlist{##2}\montest{\themoncompteur}\space ##2} %
    \glossentrydesc{##1}\glspostdescription\space \Znumlist{##2}\space ##2}
}


\newglossary[ntg]{notation}{not}{ntn}{Glossaire}
\newglossary[slg]{symbols}{sym}{sbl}{Nomenclature}

 \makeglossaries        %




\newglossaryentry{glscard}{ %type=main,
    name=cardinality,
    description={The number of elements in the specified set}}

\newglossaryentry{mesh}{type=notation,
    name={Mesh},
    description={maillage},
    sort={m}}

\newglossaryentry{mbb}{type=symbols,    
    name={\ensuremath{ {M} }},
    text={ {M} },                                 
    description={matrix},               
    sort=m,                             
    see=[see also]{glscard}} 

\begin{document}       % 

\setglossarystyle{mylist}    
\printglossary[toctitle=Lexique,type=main]
\newacronym{pc}{PC}{personal computer}   
\printglossary[toctitle=Acronyms,type=acronym]
\printglossary[type=notation]
\printglossary[type=symbols]

\chapter{Introduction}
\section{ab}

 \gls{pc}; \gls{glscard}; \gls{mbb}; \gls{mesh}; \newpage 
 \gls{mesh}

\Znumlist{1,3,4} \montest{\themoncompteur}

\end{document}

How do I use a argument like ##2 inside a command?

Best Answer

The glossaries package already provides a mechanism for counting the number of times an entry has been used, but it must be enabled using \glsenableentrycount. This was added to version 4.14 and is documented in section 14.1 of the user manual.

Example:

\documentclass{article}

\usepackage{glossaries}

\makeglossaries

\glsenableentrycount

\newglossaryentry{sample}{name={sample},description={an example}}

\newacronym{ab}{AB}{sample abbreviation}

\begin{document}
Number of times ``sample'' was used on the last run:
\glsentryprevcount{sample}.

\gls{sample}. \gls{sample}. \gls{ab}.

Number of times ``sample'' has been used in this run \emph{so far}:
\glsentrycurrcount{sample}.

\newpage

\gls{sample}. \gls{ab}.

\newpage

\printglossaries

\end{document}

This produces (after a second run):

Notes:

\glsenableentrycount must be used before you define your entries.
This mechanism imposes a preamble-only restriction on the use of \newglossaryentry (and, therefore, also \newacronym which internally uses \newglossaryentry).

You can then use \glsentryprevcount in your glossary style:

\newglossarystyle{mylist}
{%
  \setglossarystyle{list}%
  \renewcommand*{\glossentry}[2]{%
    \item[\glsentryitem{##1}%
          \glstarget{##1}{\glossentryname{##1}}]
       \glossentrydesc{##1}\glspostdescription\space
       \ifnum\glsentryprevcount{##1}>1 pp.\else p.\fi\ ##2}%
}

Take care as the previous count value represents the total number of times the entry has been used. This value is reset back to zero with \glsreset and it also doesn't necessarily match the number of locations in the location list. For example, if an entry is used twice on one page but nowhere else in the document, then the location list will have a single location (that page) but the entry count will be 2.

The (currently experimental) glossaries-extra package enhances this feature and provides per-unit counting.

Edit:

Just using glossaries:

% arara: pdflatex
% arara: makeglossaries
% arara: pdflatex
\documentclass{report}    

\usepackage[utf8]{inputenc}     
\usepackage[T1]{fontenc}        

\usepackage[colorlinks]{hyperref}       

\usepackage[toc,acronym,xindy,section=section]{glossaries} 

\newglossarystyle{mylist}{%
  \setglossarystyle{list}% base this style on the list style
  \renewcommand*{\glossentry}[2]{%
  \item[\glsentryitem{##1}%
  \glstarget{##1}{\glossentryname{##1}}]
  \glossentrydesc{##1}\glspostdescription\space
  \ifnum\glsentryprevcount{##1}>1 pp.\else p.\fi\ ##2}%
}


\newglossary[ntg]{notation}{not}{ntn}{Glossaire}
\newglossary[slg]{symbols}{sym}{sbl}{Nomenclature}

\makeglossaries        %

\glsenableentrycount

\newglossaryentry{glscard}{
    name=cardinality,
    description={The number of elements in the specified set}}

\newglossaryentry{mesh}{type=notation,
    name={Mesh},
    description={maillage},
    sort={m}}

\newglossaryentry{mbb}{type=symbols,    
    name={\ensuremath{M}},
    text={M},                                 
    description={matrix},               
    sort=m,                             
    see=[see also]{glscard}} 

\newacronym{pc}{PC}{personal computer}   

\setglossarystyle{mylist}    

\begin{document} 
\printglossary[toctitle=Lexique,type=main]
\printglossary[toctitle=Acronyms,type=acronym]
\printglossary[type=notation]
\printglossary[type=symbols]

\chapter{Introduction}
\section{ab}

\gls{pc}; \gls{pc}; \gls{glscard}; \gls{mbb}; \gls{mesh}; \newpage 
\gls{mesh}

\end{document}

This produces:

This mostly works except for the pc entry which occurs twice on page 2 but not on any other page. Since the total usage for that entry is greater than 1, pp is used instead of p even though there's only a single page in the location list. Below is an alternative solution that uses glossaries-extra.

Caveat: glossaries-extra is still experimental and this may fail in the odd occasions where entries occur in a page-break spanning paragraph due to TeX's asynchronous output routine.

The following adapts your mwe to use glossaries-extra:

% arara: pdflatex
% arara: makeglossaries
% arara: pdflatex
\documentclass{report}    

\usepackage[utf8]{inputenc}     
\usepackage[T1]{fontenc}        

\usepackage[colorlinks]{hyperref}       
\usepackage[nopostdot=false,% put a dot after the descriptions
 abbreviations,% create a separate list of abbreviations
 xindy,section=section]{glossaries-extra} 

\GlsXtrEnableEntryUnitCounting
 {general,abbreviation}% apply to both general and abbreviation categories
 {0}% don't trigger index suppression
 {page}% count per page

\newglossarystyle{mylist}{%
  \setglossarystyle{list}% base this style on the list style
  \renewcommand*{\glossentry}[2]{%
  \item[\glsentryitem{##1}%
  \glstarget{##1}{\glossentryname{##1}}]
  \glossentrydesc{##1}\glspostdescription\space
  \ifnum\glsentryprevtotalcount{##1}>1 pp.\else p.\fi\ ##2}%
}

% In case an entry is used two or more times on one page but not on any of the
% other pages.
\let\ORGglsxtrpostunset\glsxtrpostunset

\renewcommand*{\glsxtrpostunset}[1]{%
  \ifnum\glsentrycurrcount{#1}>0 \else\ORGglsxtrpostunset{#1}\fi
}


\newglossary[ntg]{notation}{not}{ntn}{Glossaire}
\newglossary[slg]{symbols}{sym}{sbl}{Nomenclature}

\makeglossaries

% general entries

\newglossaryentry{glscard}{
    name=cardinality,
    description={The number of elements in the specified set}}

\newglossaryentry{mesh}{type=notation,
    name={Mesh},
    description={maillage},
    sort={m}}

\newglossaryentry{mbb}{type=symbols,    
    name={\ensuremath{M}},
    text={M},                                 
    description={matrix},               
    sort=m,                             
    see=[see also]{glscard}} 

% abbreviations

\newabbreviation{pc}{PC}{personal computer}   

\setglossarystyle{mylist}    

\begin{document} 

\printglossary[toctitle=Lexique,type=main]
\printabbreviations
\printglossary[type=notation]
\printglossary[type=symbols]

\chapter{Introduction}
\section{ab}

 \gls{pc}; \gls{pc}; \gls{glscard}; \gls{mbb}; \gls{mesh}; \newpage 
 \gls{mesh}

\end{document}

This produces:

Notes:

Although the glossaries-extra package internally loads the glossaries package, it sets different defaults (e.g. toc and nopostdot). To illustrate this I've removed the toc option and added nopostdot to emulate the settings of your mwe.
The glossaries-extra package has a different (and better) way of dealing with abbreviations.
With the per unit counting, \glsentrycurrcount and \glsentryprevcount refer to the count for the current unit. So if you have, say, \glsentryprevcount{pc} on page 1, you'll get the number of times the entry was used on page 1 (where the unit counter is page). This means that it's of no use in the glossary style, since you're not interested in how many times the entry has been used in the glossary (which happens to be 0).
The total count (from the previous run) is obtained with \glsentryprevtotalcount so the style tests if this value is greater than one.
To cater for the possibility of an entry being used two or more times on one page of the document but not used at all on any other page, I've adjusted the definition of \glsxtrpostunset. For example, I've used pc twice on one page but nowhere else, which would've set the total count to 2, and "pp" would've appeared in the glossary for the pc entry (as in the previous example). This modification effectively sets a maximum count of 1 per page.

Related Solutions

[Tex/LaTex] Glossary entry not updated

By putting the \newglossaryentry before the \begin{document}, seems to solve the problem. Does this make sense?

\documentclass{article}

% Load the package
\usepackage{glossaries}

% Generate the glossary
\makeglossaries

%Term definitions
\newglossaryentry{ta}{name=Test1, description={Test123}}
\newglossaryentry{tb}{name=Test2, description={Test2456}}
\newglossaryentry{tc}{name=Test3, description={Test3789}}

\begin{document}

% Use the terms
\gls{ta} is three hours behind \gls{tb} and 10 hours ahead of \gls{tc} blblbl.

%Print the glossary
\printglossaries

\end{document}

[Tex/LaTex] Glossary per chapter (not by section)

The problem here is that you're mixing old and new commands. My original answer that you linked to is several years old and uses commands that are now deprecated, such as \glossarystyle and \glossaryentryfield. Your MWE has changed the deprecated \glossarystyle to \setglossarystyle but hasn't changed the deprecated \glossaryentryfield. By using the new \setglossarystyle, the backward-compatibility is removed and \glossaryentryfield isn't used.

To fix it, just replace \glossaryentryfield with the newer \glossentry:

  \renewcommand*{\glossentry}[2]{%
    \edef\doifinlocation{\noexpand\ifinlocation{\thechapter}{##2}}%
    \doifinlocation
    {%
      \item \glossentryname{##1} \glossentrydesc{##1}%
    }%
  }%

Complete MWE:

\documentclass{report}
\usepackage{datatool-base}
\usepackage[counter=chapter,xindy,section=section]{glossaries}
\GlsSetXdyMinRangeLength{0}
\makeglossaries
\newglossaryentry{E}{name={\ensuremath{E}},description={energy}}
\newglossaryentry{m}{name={\ensuremath{m}},description={mass}}
\newglossaryentry{c}{name={\ensuremath{c}},description={speed of light}}
\newglossaryentry{v}{name={\ensuremath{v}},description=velocity}
\newglossarystyle{mystyle}%
{%
  \setglossarystyle{list}%
  \renewcommand*{\glossaryentrynumbers}[1]{\striprelax##1\endstriprelax}%
  \renewcommand*{\glsXchapterXglsnumberformat}[2]{##2}%
  \renewcommand*{\delimR}{,}%
  \renewcommand*{\glossentry}[2]{%
    \edef\doifinlocation{\noexpand\ifinlocation{\thechapter}{##2}}%
    \doifinlocation
    {%
      \item \glossentryname{##1} \glossentrydesc{##1}%
    }%
  }%
}
\newcommand{\ifinlocation}[3]{%
 \DTLifinlist{#1}{#2}{#3}{}%
}
\def\striprelax\relax#1\endstriprelax{#1}
\setglossarystyle{mystyle}

\begin{document}
\chapter{Sample Chapter}
\printglossary
\begin{equation}
\gls{E} = \gls{m}\cdot \gls{c}^2
\end{equation}
\glsresetall 
\chapter{Another Chapter}
\printglossary
\begin{equation}
\gls{E} = \frac{\gls{m}\gls{v}^2}{2}
\end{equation}
\end{document}

First chapter:

Second chapter:

Best Answer

Related Solutions

[Tex/LaTex] Glossary entry not updated

[Tex/LaTex] Glossary per chapter (not by section)

Related Question