Glossário Acrónimos Notação

Glossário

O wikibooks sobre LaTeX explica como construir uma lista de termos no documento. Outro link que explica como usar o pacote glossaries é esta entrada do texblog.

O pacote glossaries facilita a criação de listas e automatiza a formatação. Para informação detalhada, ler a Documentação do pacote glossaries.

Acrónimos

Os acrónimos são declarados na lista de acrónimos: Acronyms-List.tex.

Exemplo:

Declara-se

\newacronym{hello}{hw}{hello world}

No texto, usa-se \gls{hello}.

Pode-se também usar o ambiente de matemática. Por exemplo, declara-se

\newacronym{cophp}{$COP_{HP}$}{Heat Pump Coefficient of Performance}

No texto, usa-se \gls{cophp}.

Notação

A notação usada é declarada na lista de símbolos de notação: Notation-List.tex. Opcionalmente, pode-se usar o antigo formato de notação, declarando em Notation-List_opt.tex (ir para antigo formato).

A notação prevê por defeito a possibilidade das 4 secções standard: Letras Latinas (latinletters), Letras Gregas (greekletters), Índices (subscripts), Taxas / Razões / Grandezas Adimensionais (Rates and Ratios). A cada secção é associado um glossário próprio, declarado no início do ficheiro como, por exemplo:

\newglossary*{latinletters}{Latin Letters}

A adição de glossários pode ser feita com a adição da declaração de novo glossário à secção respectiva do ficheiro Notation-List.tex, cujo a linha de código tem o formato:

\newglossary*{referência}{título}

Note-se que ao comentar a declaração de um glossário desnecessário, exige que se comente a declaração de todas as entradas de notação que lhe estão associadas.

As entradas de notação são declaradas como

\newglossaryentry{referência}{ 
name={<símbolo ou letra a aparecer>}, 
description={Descrição [Unidades]}, 
type=<nome do glossário>}

Por exemplo,

\newglossaryentry{A}{ 
name={\ensuremath{A}}, 
description={Cross-sectional area [\si{\meter\squared}]}, 
type=latinletters}

No texto, usa-se \gls{A}.

O ficheiro contém uma série de entradas de notação que podem ser usadas como exemplo.

Antigo Formato de Notação:

Opcionalmente, é possível seleccionar o formato de notação antigo, comentando a secção referente a Notation-List.tex e descomentando a secção referente a Notation-List_opt.tex, no ficheiro 8.Notation.tex.

A impressão do glossário e respectivas subsecções é feita com

\printglossary[style=mylist,title=Notation]

A notação prevê a possibilidade de 5 secções: Letras Latinas (latinletters), Letras Gregas (greekletters), Índices (subscripts), Taxas (Rates), Razões / Grandezas Adimensionais (Ratios), no código como (versão portuguesa comentada):

\newglossaryentry{latinletters}{name={Latin Letters},description={},sort=a} 
\newglossaryentry{greekletters}{name={Greek Letters},description={},sort=b} 
\newglossaryentry{subscripts}{name={Subscripts},description={},sort=c} 
\newglossaryentry{rates}{name={Rates},description={},sort=d} 
\newglossaryentry{ratios}{name={Ratios},description={},sort=e}

As secções aparecem apenas quando os respectivos termos são adicionados no texto.

O título da secção é alterado no name=título. Novas secções podem ser adicionadas, de acordo com a linha de código abaixo, e atribuindo uma nova letra ao sort (letra para definir ordem), neste caso seria, por exemplo, sort=f:

\newglossaryentry{títuloderef}{name={título},description={},sort=<letra de ref e ordenação>}

As entradas de notação são declaradas como

\newglossaryentry{nomederef}{
sort=<letra de ref secção><letra para ordenação, ex: 1ª letra da palavra>, 
name={símbolo ou \ensuremath{símbolo em ambiente matemático}}, 
description={descrição}, 
parent=títuloderef da secção}

Exemplo: Declara-se

\newglossaryentry{A}{sort=aA, 
name={\ensuremath{A}}, 
description={Cross-sectional area [\si{\meter\squared}]}, 
parent=latinletters}

No texto, usa-se \gls{A}.

Construção dos glossários

Para a listagem dos glossários, o documento tem de ser compilado da seguinte forma. Na linha de comandos, na pasta com o ficheiro tese.tex:

pdflatex tese (nota que o uso do comando latex retorna erro devido ao uso de imagens em pdf)
makeglossaries tese
pdflatex tese (repetir enquanto necessário)

Para grandes listas de acrónimos e notação, com muitas entradas no texto, esta sequência de comandos pode ter de ser repetida várias vezes até se conseguir obter a listagem completa ordenada.

Por defeito, este template usa o xindy para ordenação da lista. No entanto, outros programas podem ser usados (secção abaixo).

Personalização dos glossários

Por defeito, o pacote é carregado com

\usepackage[acronym,xindy]{glossaries}

Ordenação da lista

Para seleccionar outro programa de ordenação da lista e usar makeglossaries na compilação, substituir xindy pelo nome abaixo.

Usar o makeindex na ordenação da lista:

Glossário: makeindex -s tese.ist -t tese.glg -o tese.gls tese.glo
Lista de Acrónimos: makeindex -s tese.ist -t tese.alg -o tese.acr tese.acn

Usar o xindy na ordenação da lista:

xindy  -L portuguese -C utf8 -I xindy -M tese -t tese.glg
     -o tese.gls tese.glo
xindy  -L portuguese -C utf8 -I xindy -M tese -t tese.alg
     -o tese.acr tese.acn
xindy  -L portuguese -C utf8 -I xindy -M tese -t tese.nlg
     -o tese.not tese.ntn