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.

Glossaris amb BibTeX

Tot i que BibTeX gestiona bibliografies, el paquet gloss permet crear glossaris amb la mateixa funcionalitat

BibTeX és una “màquina” molt potent que permet gestionar les bibliografies en l’entorn LaTeX. Parteix d’una base de dades bibliogràfica, que no és altra cosa que un fitxer de text amb extensió bib, on queden recollides les entrades bibliogràfiques. Aquesta bibliografia, després, es crida des del nostre document tex a través de dos comandaments:

• \cite{etiqueta} s’escriu al punt del text on volem fer aparèixer una cita bibliogràfica. Etiqueta és una paraula que identifica cada cita bibliogràfica a la base de dades. 
• \bibliography{basedades} s’escriu al final del document i fa que LaTeX interpreti que hi ha d’escriure, per ordre alfabètic, totes les citacions contingudes a la base de dades basedades sota el títol Bibliografia.  

BibTeX és l’eina que s’encarrega de fer tota la feina d’anar a basedades a cercar les etiquetes que hem citat al nostre document, posar-les en ordre alfabètic, fer els enllaços si convé, etc. I el fitxer de la bibliografia té un contingut tan senzill com aquest, on mostrem un exemple d’entrada:

@article{moodleiconstruc, 
 author = "Joan Queralt", 
 title = "Moodle i el constructivisme social", 
 publisher = "UPF", 
 year = 2006, 
 edition = "Conferència V Jornades de Programari Lliure", 
}

 on moodleiconstruc és l’etiqueta que cridarem al nostre document escrivint \cite{moodleiconstruc}.

El paquet gloss, escrit per Javier Bezos i José Luís Díaz, aprofita la potència de BibTeX per crear glossaris, és a dir, col·leccions de termes definits en una obra.

Parteix d’una base de dades dels termes, també amb extensió bib, on els termes o paraules queden definides com es veu en aquest exemple:

 @gd{elefant, 
 word={elefant}, 
 definition={Proboscidi de grans orelles i un cert sobrepes. Hi ha dues espècies segons el lloc d'origen: l'elefant africà i l'asiàtic.} 
} 

Al document on volem que aparegui el glossari hem d’escriure quatre comandaments:

1. \usepackage{gloss} al preàmbul del document. Podem utilitzar dues opcions, com ara catalan, que catalanitza el títol del glossari, o refpages que farà aparèixer el número de pàgina on s’ha citat la paraula per darrera vegada. Pot quedar així:
2. \usepackage[catalan,refpages]{gloss} 
3. \makegloss també al preàmbul, informa a LaTeX que cal crear el glossari
4. \gloss{etiqueta} s’escriu al punt del text on volen que aparegui la paraula definida al glossari, de manera similar a \cite{etiqueta} quan fem bibliografies.

Per exemple, seguint amb el fitxer de l’exemple anterior podríem escriure: \gloss{elefant} allà on vulguem que hi hagi un enllaç al glossari, on es defineix el terme elefant. \printgloss{basedades} el posem allà on volem el glossari, normalment al final del document. basedades és el nom del fitxer d’extensió bib on hem anat definint els termes del glossari.

Un cop tenim creada la base de dades del glossari, diguem-li basedades.bib, i el document que l’ha d’utilitzar, diguem-li elmeudoc.tex, hem de seguir 3 passes per obtenir el resultat desitjat des de la línia d’ordres (tant se val sigui sota linux o sota windows):

1. compilem el document: latex elmeudoc 
2. fem córrer BibTeX sobre el fitxer gls que ha generat el pas anterior: bibtex elmeudoc.gls 
3. si volem obtenir un PDF compilem ara amb pdflatex elmeudoc un parell de cops per estalviar problemes de referències creuades.

I ja està, obtindrem un document amb una secció final, anomenada Glossari, on apareixen tots els termes desitjats.

Adjunts a aquest article podeu trobar:

• un exemple de fitxer base de dades comprimit en un zip i anomenat provagloss.bib, 
• el document tex que l’utilitza, anomenat prova_gloss.tex i 
• el resultat en format PDF: prova_gloss.pdf.

Publicat per primer cop el dilluns 17 de juliol de 2006