Capitalize Symbol in Glossary Print only using a New Entry Field

beamercapitalizationglossariesglossaries-extrasymbols

How can I forced the Symbol to be printed in capitalized form or full uppercase in the glossary print only (with non capitalized form declared in the field symbol)?

The best solution for me would be to have like a new field symbolname when declaring a new glossary entry, this field will be used by LaTeX for printing the symbol in the glossary print only. The symbol declared in the field symbol will be used in the document text only. In other words, I would like to have – for symbol field -, the same result given when I use the name field and the text field, which permits to dissociate the use in glossary print from the use in text…

Here a MWE,

\documentclass{article}
\usepackage[style=tree]{glossaries-extra}

\makenoidxglossaries

\newglossaryentry{subsytem}{name={Subssytems},description={\glspar},sort={4}}
\newglossaryentry{compressor}
{
  name={Compressor},
  text={compressor},
  sort={compressor},
  description={Air Compressor},
  symbol={cp},
  parent=subsytem
}
\newglossaryentry{compressor_motor}
{
  name={Compressor Motor},
  sort={compressor motor},
  text={compressor motor},
  description={Motor of the \Gls{compressor}},
  symbol={cm},
  parent=subsytem
}


\begin{document}
\gls{compressor_motor}
\gls{compressor}
\printnoidxglossary
\end{document}

Instead of this result :

I would like something like that ("Compressor (Cp)" instead of "Compressor (cp)" and "Compressor Motor (CM)" instead of "Compressor Motor (cm)") :

But again, I would like the symbol to be declared in lowercase in the symbol field (cp or cm) as shown in the non-working exemple below :

\newglossaryentry{subsytem}{name={Subssytems},description={\glspar},sort={4}}
\newglossaryentry{compressor}
{
  name={Compressor},
  text={compressor},
  sort={compressor},
  description={Air Compressor},
  symbolname={Cp},%!!!!!!!!!!!!!!!!!!!!!!!!!
  symbol={cp},
  parent=subsytem
}
\newglossaryentry{compressor_motor}
{
  name={Compressor Motor},
  sort={compressor motor},
  text={compressor motor},
  description={Motor of the \Gls{compressor}},
  symbolname={CM},%!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  symbol={cm},
  parent=subsytem
}
\begin{document}
\gls{compressor_motor}
\gls{compressor}
\printnoidxglossary
\end{document}

Why I want lowercase in symbol field?

Because I use the lowercase symbol form to declare other "math entries" like below the use of \glssymbol{compressor} in the name field:

\usepackage{amsmath,bm,times}
\newglossaryentry{PQ}{name={Physical Quantities},description={\glspar},sort={5}}
\newglossaryentry{Qcp}
{
  name={$\mathbf{\bm{Q}}_{\glssymbol{compressor},out}$},
  sort={Qcpout},
  text={\Glssymbol{compressor} Air Outlet Mass Flow Rate},
  description={Compressor Air Outlet Mass Flow Rate},
  parent=PQ
}

With these "math entries" I want the symbol \glssymbol{compressor} in lowercase. But when I use the symbol in the text document, sometimes I will use the \GLSsymbol form or \Glssymbol or \glssymbol. But currently in my MWE the symbol is printed in lowercase in the glossary (off course) but I would prefer a Capitalized or uppercase form and it depends on me (it's a case by case choice). This is why I would prefer a solution with a new field (like symbolname) in order to manually choose if I want to print the symbol in capitalisez form (Cp) or uppercase form (CM)…

Best Answer

UPDATE (2) after follow-up question.

There is now a new key-defined symbol name (symbolname) that will be used to print the glossary. You can use any other "symbol" you want, not just uppercase, as shown in this example.

If symbolname is not defined it will be use the symbol value to print the glossary. (new) <<

A new entry compressor_valve was added to show this default behavior.

\documentclass{article}
\usepackage[style=tree]{glossaries-extra}

\usepackage{xcolor}
\usepackage{tikz}

%*************************************** added <<<<<<<<<<<<<<<<<<
\glsaddkey*% 
{symbolname}% key
{\glsentrysymbol{\glslabel}}% default value CHANGED <<<<<<<<<<<<<<<<<<
{\glsentrysymbolname}% command analogous to \glsentrytext
{\Glsentrysymbolname}% command analogous to \Glsentrytext
{\glssymbolname}% command analogous to \glstext
{\Glssymbolname}% command analogous to \Glstext
{\GLSsymbolname}% command analogous to \GLStext 

 \renewcommand{\subglossentry}[3]{%  <<<<<<<<<<<<<<<<
    \hangindent#1\glstreeindent\relax
    \parindent#1\glstreeindent\relax
    \ifnum#1=1\relax
    \glssubentryitem{#2}%
    \fi
    \glstreenamefmt{\glstarget{#2}{\glossentryname{#2}}}%
    \ifglshassymbol{#2}{\space(\glsentrysymbolname{#2})}{}%
    \glstreechildpredesc\glossentrydesc{#2}\glspostdescription\space #3\par
}%

% *******************************************

\usepackage{amsmath,bm,times}   

\makenoidxglossaries

\newglossaryentry{subsytem}{name={Subssytems},description={\glspar},sort={4}}   
\newglossaryentry{compressor}
{
    name={Compressor},
    text={compressor},
    sort={compressor},
    description={Air Compressor},
    symbol={cp},
    symbolname={\textcolor{red}{123Cpxx}},% added <<<<<<<<<<<<<<<<<<<
    parent=subsytem
}

\newglossaryentry{compressor_motor}
{
    name={Compressor Motor},
    sort={compressor motor},
    text={compressor motor},
    description={Motor of the \Gls{compressor}},
    symbol={cm},
    symbolname={456CMxx},% added <<<<<<<<<<<<<<<<<<<
    parent=subsytem
}

\newglossaryentry{compressor_valve}% symbolname is not defined <<<<<<<<<<<<
{
    name={Compressor Valve},
    sort={compressor valve},
    text={compressor valve},
    description={Valve of the \Gls{compressor}},
    symbol={vv},
    parent=subsytem
}

\newglossaryentry{PQ}{name={Physical Quantities},description={\glspar},sort={5}}
\newglossaryentry{Qcp}
{
    name={$\mathbf{\bm{Q}}_{\glssymbol{compressor},out}$},
    sort={Qcpout},
    text={\Glssymbol{compressor} Air Outlet Mass Flow Rate},
    description={Compressor Air Outlet Mass Flow Rate},
    symbol={cp},
    symbolname={FlowRate},% added <<<<<<<<<<<<<<<<<<<
    parent=PQ
}

\begin{document}
    
    \gls{compressor_valve};
    \gls{compressor_motor};
    \gls{compressor}
    
    \bigskip    
    
    \gls{Qcp}
    
    \printnoidxglossary
\end{document}

Check using beamer class

% !TeX TS-program = pdflatex

\documentclass[11pt]{beamer}

....

\begin{document}

    \begin{frame}[plain]
        \maketitle
    \end{frame}
    
    \begin{frame}
        \frametitle{}       
        \gls{compressor_valve};
        \gls{compressor_motor};
        \gls{compressor}        
        \bigskip    
        
        \gls{Qcp}
    \end{frame}

    \begin{frame}
    \frametitle{Glossary}       
    \printnoidxglossary
    \end{frame}

\end{document}

Related Solutions

[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:

[Tex/LaTex] Unusual sorting of greek letters and math mode symbols when using glossaries package

The \makenoidxglossaries method isn't suitable for entries that contain commands within the name key. It's a method of last resort, and I really don't recommend it unless for some reason you absolutely can't use an external tool.

Table 1.1: Glossary Options: Pros and Cons in the glossaries user manual compares each of the available options. "Option 1" indicates the "noidx" method (\makenoidxglossaries and \printnoidxglossary) and it compares very poorly against the other methods: it doesn't have an efficient sort method, it has problematic sort values and sets sanitizesort=false, which means fragile commands cause a problem.

If you really want to use \makenoidxglossaries, then you must supply a sort key for all entries that have commands within the name field. (See glossaries: No printed glossaries when switching to \makenoidxglossaries.)

Ideally these would be alphabetical latin (with \mathcal{E} included with E), then alphabetical greek, but I'll settle for anything that makes sense.

With \makenoidxglossaries you'll have to work out the appropriate sort values that would ensure this. For example, prefix the Latin values with 1. and the Greek with 2.:

\newglossaryentry{L0}
{type=los,
sort={1.L0},
name={$L_0$},
description={Width of Inhomogeneity/low barrier region (nm)}
}

\newglossaryentry{Delta}
{type=los,
sort={2.D},
name={$\Delta$},
description={Difference between the mean barrier height and the barrier height of the inhomogeneity/low barrier region (V)}
}

However, with this level of intervention (and given that you don't need a number list), you may just as well use Option 5 instead, which doesn't perform any sorting but uses \printunsrtglossary to display all defined entries in order of definition (regardless of whether they've been used in the document). You then need to make sure that you define all the entries in the appropriate order. This gives you absolute control over the order, but you have to do it manually.

If you want a fully automated solution that doesn't require you to set the sort key, then you need Option 4 (bib2gls) instead. None of the other options (including makeindex and xindy) can provide appropriate ordering for entries that have commands in the name (such as name={$\phi$}) without requiring manual intervention. bib2gls recognises most of the standard mathematical symbol commands and has some support for siunitx and a few other symbol packages. For unrecognised symbols, you have the option to sort according to the description field instead (which may be more appropriate if there isn't a natural ordering).

With bib2gls you first need to convert your los.tex file to .bib format. For example,

\newglossaryentry{ec}
{type=los,
name={$E_C$},
description={Conduction Band Minimum (eV)}
}

needs to be changed to

@entry{ec,
  name={$E_C$},
  description={Conduction Band Minimum (eV)}
}

The document needs a few modifications:

\documentclass{article}

\usepackage[top=2cm,bottom=2.4cm, inner=4cm, outer=2.5cm]{geometry}
\usepackage[record,% using bib2gls
  nogroupskip,style=super]{glossaries-extra}

\newglossary*{los}{List of Symbols}

\GlsXtrLoadResources[
  src={los},% entries in the file 'los.bib'
  sort={letter-nocase},
  type={los},% put the entries in the 'los' glossary
  save-locations=false% the location lists aren't required
]

\begin{document}
\printunsrtglossary[type=los]

\section{other}

\subsection{glossary stuff}

\gls{phi}
\gls{L0}
\gls{Delta}
\gls{ecm}
\gls{q}
\gls{ND}
\gls{phibn}
\gls{ly}
\gls{h}
\gls{permittivity}
\gls{relativepermittivity}
\gls{V}
\gls{x}
\gls{y}
\gls{z}
\gls{phin}
\gls{phibi}
\gls{WD}
\gls{efield}
\gls{emaxthin}
\gls{emax}
\gls{phiIFL}
\gls{vbr}
\gls{ebr}
\gls{j}
\gls{richardsonconstant}
\gls{T}
\gls{k}
\gls{dn}
\gls{n}
\gls{NC}
\gls{efn}
\gls{zs}
\gls{I}
\gls{Itot}
\gls{a1}
\gls{a2}
\gls{Isheet}
\gls{Aeff}
\gls{phibeff}
\gls{Iline}
\gls{EMT1}
\gls{EMT2}
\gls{EMTS}

\end{document}

If the document is called myDoc.tex then the document build is:

pdflatex myDoc
bib2gls myDoc
pdflatex myDoc

Page 1:

Page 2:

Best Answer

Related Solutions

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

[Tex/LaTex] Unusual sorting of greek letters and math mode symbols when using glossaries package

Related Question