Glossaris amb el paquet glossaries

Usant makeindex per crear glossaris

En l’article Glossaris amb BibTeX ja vàrem veure com crear glossaris senzills amb l’ajut del paquet gloss i BibTeX   En aquesta ocasió veurem com fer-los amb el paquet glossaries, un paquet molt potent que utilitza la feina que fa en segon terme el paquet makeindex (o xindy) per crear glossaris amb enllaços a les pàgines d’ocurrència.

El paquet es crida al final del preàmbul del document —després d’hyperref— amb diferents opcions, per exemple:

\usepackage[style=treehypergroup,nolong,nosuper,%
%style=nolong,%
%style=nosuper,%
%style=long,%
%style=list,%
%style=super,%
toc,% % surt a la TaulaDeContinguts
translate=false,% % perquè aparegui la traducció catalana
%numberline, % a la TdC alinea al text i no als números
%acronym,% % per l'ús d'acrònims
numberedsection,% % numera (capítol o secció) el Glossari a la TdC
%description,% % permet el camp 'descripció' de les entrades
%footnote,% % posa els textos en notes al peu
%smallcaps,% % escriu els termes en versaletes
]{glossaries}

Ara cal crear les entrades del glossari amb el comandament

\newglossaryentry{etiqueta}{opcions}

per exemple:

\newglossaryentry{etiqueta}{%
name={Nom de l'entrada tal com apareixerà al document},%
description={Breu descripció. Per deixar-ho en blanc escriure description=\nopostdesc. Per fer paràgrafs: \glspar},%
descriptionplural={Plural de la descripció},%
first={Com es veurà l'entrada quan s'utilitzi per primer cop. Si està en blanc s'usa name},%
plural={Com es veu l'entrada quan s'usa \glspl. Si no es diu res s'afegirà al name una s final},%
firstplural={Com es veu l'entrada quan s'usa per primera vegada \glspl},%
symbol={Per associar un símbol a l'entrada, si es deixa en blanc s'associa \relax},%
symbolplural={Per posar el plural del símbol},%
sort={Per indicar com s'ha de classificar alfabèticament},%
type={Etiqueta del glossari al que pertany l'entrada, si no es diu res és el glossari per defecte.},%
see=[vegeu també]{Etiqueta d'una altra entrada per enllaçar-la},%
parent={etiqueta de l'entrada de la que penja pels glossaris en arbre}%
}

A l’exemple següent hem aprofitat el camp symbol per escriure en cursiva el nom científic de l’espècie, hem creat una referència creuada a una altra entrada al camp see i la fem penjar d’una entrada "pare" que recull les entrades d’espècies de rèptils:

\newglossaryentry{tortugaestany}{%
name={tortuga d'estany},%
description={és la tortuga d'aigua autòctona dels Països Catalans i es troba en un estat de conservació de perill d'extinció per culpa de la degradació del seu hàbitat i de la competència d'espècies introduïdes per l'home com la tortuga d'orelles vermelles o la tortuga d'orelles grogues},%
plural={tortugues d'estany},%
symbol={\textit{Emys orbicularis}},%
see=[vegeu també]{tortugarierol},%
parent={reptil}
}

Les entrades es poden posar al preàmbul del propi document, o millor encara, en un document a part que es crida amb el comandament

\loadglsentries{NomFitxerAmbEntradesSenseExtensió}

Finalment activem la creació del glossari amb \makeglossaries, similar al clàssic \makeindex.

Al lloc del document on volem que aparegui el glossari hi posem \printglossary[title=Títol].

El paquet no té traducció catalana per la qual cosa al preàmbul cal fer-ne la traducció dels termes:

\usepackage[catalan]{babel}
\usepackage[catalan]{translator}
\addto\captionscatalan{%
\renewcommand*{\glossaryname}{Glossari}%
\renewcommand*{\acronymname}{Relació d'entrades}%
\renewcommand*{\entryname}{Notació}%
\renewcommand*{\descriptionname}{Descripció}%
\renewcommand*{\symbolname}{Símbol}%
\renewcommand*{\pagelistname}{Pàgina}%
\renewcommand*{\glssymbolsgroupname}{Símbols}%
\renewcommand*{\glsnumbersgroupname}{Nombres}%
}%

Ara ja estem en disposició d’utilitzar els termes del glossari al document. Quan en el nostre text n’apareix un el podem inserir amb algun d’aquests comandaments:

• \gls{etiqueta} escriurà el contingut del camp name tal com està definit. 
• \Gls{etiqueta} escriurà el contingut del camp name amb la inicial majúscula. 
• \glspl{etiqueta} escriurà el contingut del camp plural tal com està definit. 
• \Glspl{etiqueta} escriurà el contingut del camp plural amb la inicial majúscula. 

Un cop tenim escrit el document hem de seguir aquestes passes per passar-lo a PDF:

1: Processem el document amb

pdflatex NomDelDocument

un parell de cops per crear totes les referències creuades i la TdC.

2: Creem el glossari amb el comandament

makeglossaries NomDelDocument

3: Finalment tornem a processar amb

pdflatex NomDelDocument

Podeu veure el resultat de l’ús del glossari amb l’estil d’arbre (entrades "pare" de la que pengen subentrades) al fitxer PDF adjunt. També trobareu adjunts el document tex font per estudiar-ne el codi o usar-lo de plantilla i el document amb les entrades del glossari.

Publicat per primera vegada el divendres 27 de juliol de 2012.