LaTeX

Multe documente tehnice folosesc termeni sau acronime necunoscuți populației generale. Se obișnuiește să adăugați glosare în care explicați aceste cuvinte.

Pachetul glossaries a fost creat pentru a ajuta utilizatorii să întocmească glosare. Oferă suport pentru mai multe glosare în același document, acronime și simboluri.

Înlocuiește pachetul glossary și poate fi folosit în locul pachetului nomencl.

Utilizarea pachetului glossaries

Pentru a activa utilizarea pachetului glossaries, trebuie să-l încărcați, scriind în preambulul documentului:

\usepackage{glossaries}

Dacă veți folosi programul xindy (recomandat) în locul makeindex, trebuie să specificați opțiunea xindy:

\usepackage[xindy]{glossaries}

Pentru ca glosarul să apară în Cuprins, trebuie să adăugați și opțiunea toc:

\usepackage[toc]{glossaries}

Indexul glosarului nu va fi generat până când nu adăugați următoarea comandă în preambulul documentului:

\makeglossaries

Notați că linkurile din glosarul generat nu vor fi "accesabile" decât dacă includeți acest pachet "după" hyperref.

Definirea intrărilor din glosar

Pentru a utiliza o intrare din glosar trebuie mai întâi s-o definiți. Sunt mai multe moduri în care puteți defini o intrare, în funcție de ce definiți și cum urmează să fie folosită intrarea.

Notați că o intrare definită nu va fi inclusă în glosarul afișat decât dacă este utilizată în document. Acest lucru vă permite să creați un glosar de termeni generali pe care puteți să-l includeți cu comanda \include în toate documentele.

Definirea de termeni

Pentru a defini un termen în glosar, folosiți macrocomanda \newglossaryentry:

\newglossaryentry{<etichetă>}{<setări>}

Eticheta reprezintă un identificator unic pentru o intrare din glosar, iar setările sunt perechi cheie=valoare separate prin virgulă, utilizate la definirea unei intrări.

Spre exemplu, pentru a defini o intrare denumită calculator:

\newglossaryentry{calculator} { name=calculator, description={este o mașină programabilă ce primește input, păstrează și manipulează date, și generează output într-un format util} }

Exemplul de mai sus definește o intrare cu aceeași etichetă și denumire. Acestea pot să difere, ca în exemplul următor:

\newglossaryentry{naiive} { name=na\"{\i}ve, description={este un cuvânt englezesc împrumutat din franceză (adjectiv, formă a lui naïf) și care înseamnă să ai sau să manifești o lipsă de experiență, înțelegere sau rafinament} }

Când definiți termeni, trebuie să vă amintiți că vor fi sortați cu makeindex sau xindy. Deși xindy are încorporate mai multe cunoștințe despre LaTeX, omite macrocomenzi din LaTeX, cum este (\"{\i}), sortând astfel incorect exemplul de mai sus sub forma nave. makeindex nu va merge mult mai bine, întrucât nu înțelege macrourile TeX, astfel că va interpreta cuvântul exact după cum a fost definit, punându-l în clasa simbolurilor, înaintea cuvintelor ce încep cu naa. De aceea trebuie să extindem exemplul nostru pentru a specifica cum să sortăm cuvântul ce reprezintă denumirea intrării în index:

\newglossaryentry{naiive} { name=na\"{\i}ve, description={este un cuvânt englezesc împrumutat din franceză (adjectiv, formă a lui naïf) și care înseamnă să ai sau să manifești o lipsă de experiență, înțelegere sau rafinament}, sort=naive }

Puteți să specificați și forme de plural, dacă acestea nu se formează adăugând "s" (vom învăța cum să le utilizăm în secțiunea următoare):

\newglossaryentry{Linux} { name=Linux, description={este un termen generic ce semnifică familia sistemelor de operare de tip UNIX și care folosesc kernelul Linux}, plural=Linuces }

Definirea de simboluri

Intrările definite pot fi și simboluri:

\newglossaryentry{pi} { name={\ensuremath{\pi}}, description={raportul dintre circumferința cercului și diametru}, sort=pi }

Puteți de asemenea să definiți atât un nume, cât și un simbol:

\newglossaryentry{nr real} { name={număr real}, description={include atât numere raționale, cum sunt $42$ și $\frac{-23}{129}$, cât și numere iraționale, cum ar fi $\pi$ și radical din 2; sau puteți specifica un număr real printr-o reprezentare cu un număr infinit de zecimale, cum este $2.4871773339\ldots$, în care cifrele continuă cumva; sau numerele reale pot fi considerate puncte pe o linie cu numere infinit de lungă}, symbol={\ensuremath{\mathbb{R}}} }

Notați că nu toate stilurile de glosare afișează simbolurile definite. Pentru a afișa număr real ca trimitere la intrarea din glosar nr real, trebuie să includeți în preambulul documentului:

\PrerenderUnicode{ă}

Definirea de acronime

Acronimele definite pot fi puse în liste separate dacă folosiți opțiunea acronym pentru pachetul glossaries:

\usepackage[acronym]{glossaries}

Pentru a defini un nou acronim, utilizați macroul \newacronym:

\newacronym{<etichetă>}{<abreviere>}{<text>}

unde eticheta identifică în mod unic acronimul, abrevierea este forma prescurtată a acronimului, iar textul reprezintă forma extinsă a acronimului. Spre exemplu:

\newacronym{lvm}{LVM}{Logical Volume Manager}

Utilizarea termenilor definiți

După ce ați definit un termen, puteți să-l folosiți într-un document. Sunt mai multe comenzi ce se pot aplica la termenii din glosar.

Referințe generale

O referință generală se folosește cu comanda \gls. Dacă, spre exemplu, aveți intrări în glosar definite ca mai sus, puteți să le folosiți în felul următor:

Oamenii naivi (\textit{\Gls{naiive} people}) nu au auzit de sisteme de operare alternative pentru \gls{calculator}: \glspl{Linux}, BSD și GNU/Hurd.

Oamenii naivi (Naïve people) nu au auzit de sisteme de operare alternative pentru calculator: Linuces, BSD și GNU/Hurd.

Descrierea comenzilor utilizate în exemplul de mai sus:

\gls{<etichetă>}

Această comandă tipărește termenul asociat cu eticheta pasată ca argument. Dacă ați încărcat pachetul hyperref înainte de glossaries, va lega de asemenea termenul de intrarea din glosar.

\glspl{<etichetă>}

Această comandă afișează pluralul termenului definit, altfel are același efect ca și gls.

\Gls{<etichetă>}

Această comandă afișează forma de singular a termenului, primul caracter fiind scris cu literă mare.

\Glspl{<etichetă>}

Această comandă scrie forma de plural, primul caracter al termenului fiind scris cu literă mare.

Trimiterile la acronime

Acronimele se comportă puțin diferit de ceilalți termeni din glosar. La început, utilizarea comenzii \gls va afișa textul întreg, urmat de abrevierea între paranteze.

\gls{lvm}

Logical Volume Manager (LVM)

Utilizările ulterioare vor afișa numai forma prescurtată.

\gls{lvm}

LVM

Pentru a reseta prima utilizare a acronimului, folosiți comanda:

\glsreset{<etichetă>}

sau, dacă vreți să resetați prima utilizare pentru toate acronimele:

\glsresetall

Afișarea glosarului

Pentru a afișa lista sortată de termeni, trebuie să dați comanda:

\printglossaries

în locul în care vreți să fie afișate glosarul și lista de acronime în document.

Apoi trebuie să urmați trei pași:

Compilați codul sursă LaTeX, generând în felul acesta fișierele utilizate de makeglossaries.
Realizați indexarea/sortarea. Modul recomandat constă în utilizarea makeglossaries (un script ce rulează programele xindy sau makeindex în funcție de opțiunile setate pentru document, cu setările corecte de codificare și limbaj):
```
makeglossaries fișier
```
Compilați din nou fișierul LaTeX pentru a obține documentul cu intrările din glosar.

Dacă intrările folosite sunt legate de altele (unele intrări sunt legate de alte intrări prin intermediul comenzii \gls), va trebui să treceți prin punctele 1 și 2 de două ori, cinci pași în total: 1, 2, 1, 2, 3.

Referințe

Documentația glossaries, http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/

Using LaTeX to Write a PhD Thesis, Nicola L.C. Talbot, http://theoval.cmp.uea.ac.uk/~nlct/latex/thesis/node25.html

Anterior: Indexare

LaTeX

Următor: Algoritmi și pseudocod