summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/abntex2/doc/examples/abntex2-modelo-glossarios.tex
blob: cdef2b8d971b78bbc26b1b3602b03a40660ee689 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
%% abtex2-modelo-glossarios.tex, v-1.9.7 laurocesar
%% Copyright 2012-2018 by abnTeX2 group at http://www.abntex.net.br/
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%   http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This work has the LPPL maintenance status `maintained'.
%%
%% The Current Maintainer of this work is the abnTeX2 team, led
%% by Lauro César Araujo. Further information are available on
%% http://www.abntex.net.br/
%%
%% This work consists of the files abtex2-modelo-glossarios.tex,
%% abntex2-modelo-include-comandos and abntex2-modelo-references.bib
%%
                     
% ------------------------------------------------------------------------
% ------------------------------------------------------------------------
% abnTeX2: Exemplo de glossários com o pacote glossaries e abntex2
% ------------------------------------------------------------------------
% ------------------------------------------------------------------------
 
\documentclass[
	% -- opções da classe memoir --
	12pt,				% tamanho da fonte
	openright,			% capítulos começam em pág ímpar (insere página vazia caso preciso)
	twoside,			% para impressão em recto e verso. Oposto a oneside
	a4paper,			% tamanho do papel. 
	% -- opções da classe abntex2 --
	%chapter=TITLE,		% títulos de capítulos convertidos em letras maiúsculas
	%section=TITLE,		% títulos de seções convertidos em letras maiúsculas
	%subsection=TITLE,	% títulos de subseções convertidos em letras maiúsculas
	%subsubsection=TITLE,% títulos de subsubseções convertidos em letras maiúsculas
	% -- opções do pacote babel --
	english,			% idioma adicional para hifenização
	french,				% idioma adicional para hifenização
	spanish,			% idioma adicional para hifenização
	brazil,				% o último idioma é o principal do documento
	]{abntex2}
 
 
% ---
% PACOTES
% ---
 
% ---
% Pacotes fundamentais
% ---
\usepackage{lmodern}			% Usa a fonte Latin Modern			
\usepackage[T1]{fontenc}		% Selecao de codigos de fonte.
\usepackage[utf8]{inputenc}		% Codificacao do documento (conversão automática dos acentos)
\usepackage{indentfirst}		% Indenta o primeiro parágrafo de cada seção.
\usepackage{color}				% Controle das cores
\usepackage{graphicx}			% Inclusão de gráficos
\usepackage{microtype} 			% para melhorias de justificação
% ---

% ---
% Pacotes glossaries
% ---
\usepackage[subentrycounter,seeautonumberlist,nonumberlist=true]{glossaries}
% para usar o xindy ao invés do makeindex:
%\usepackage[xindy={language=portuguese},subentrycounter,seeautonumberlist,nonumberlist=true]{glossaries}
% ---

% ---
% Pacotes de citações
% ---
\usepackage[brazilian,hyperpageref]{backref}	 % Paginas com as citações na bibl
\usepackage[alf]{abntex2cite}	% Citações padrão ABNT
 
% ---
% Informações de dados para CAPA e FOLHA DE ROSTO
% ---
\titulo{Exemplo de uso de glossário com \abnTeX}
\autor{Equipe \abnTeX}
\local{Brasil}
\data{2015, v-1.9.7}
\orientador{Lauro César Araujo}
\coorientador{Equipe \abnTeX}
\instituicao{%
  Universidade do Brasil -- UBr
  \par
  Faculdade de Arquitetura da Informação
  \par
  Programa de Pós-Graduação}
\tipotrabalho{Tese (Doutorado)}
% O preambulo deve conter o tipo do trabalho, o objetivo,
% o nome da instituição e a área de concentração
\preambulo{Modelo de texto com glossário conforme as
as normas ABNT apresentado à comunidade de usuários \LaTeX.}
% ---
 
 
% ---
% Configurações de aparência do PDF final
 
% alterando o aspecto da cor azul
\definecolor{blue}{RGB}{41,5,195}
 
% informações do PDF
\makeatletter
\hypersetup{
     	%pagebackref=true,
		pdftitle={\@title}, 
		pdfauthor={\@author},
    	pdfsubject={\imprimirpreambulo},
	    pdfcreator={LaTeX with abnTeX2},
		pdfkeywords={abnt}{latex}{abntex}{abntex2}{glossários}, 
		colorlinks=true,       		% false: boxed links; true: colored links
    	linkcolor=blue,          	% color of internal links
    	citecolor=blue,        		% color of links to bibliography
    	filecolor=magenta,      		% color of file links
		urlcolor=blue,
		bookmarksdepth=4
}
\makeatother

% ---
 
% ---
% Espaçamentos entre linhas e parágrafos
% ---
 
% O tamanho do parágrafo é dado por:
\setlength{\parindent}{1.3cm}
 
% Controle do espaçamento entre um parágrafo e outro:
\setlength{\parskip}{0.2cm}  % tente também \onelineskip
 
% ---
% compila o indice
% ---
\makeindex
% ---
 
% ---
% GLOSSARIO
% ---
\makeglossaries
 
% ---
% entradas do glossario
% ---
 \newglossaryentry{pai}{
                name={pai},
                plural={pai},
                description={este é uma entrada pai, que possui outras
                subentradas.} }

 \newglossaryentry{componente}{
                name={componente},
                plural={componentes},
                parent=pai,
                description={descriação da entrada componente.} }
 
 \newglossaryentry{filho}{
                name={filho},
                plural={filhos},
                parent=pai,
                description={isto é uma entrada filha da entrada de nome
                \gls{pai}. Trata-se de uma entrada irmã da entrada
                \gls{componente}.} }
 
\newglossaryentry{equilibrio}{
                name={equilíbrio da configuração},
                see=[veja também]{componente},
                description={consistência entre os \glspl{componente}}
                }

\newglossaryentry{latex}{
                name={LaTeX},
                description={ferramenta de computador para autoria de
                documentos criada por D. E. Knuth} }

\newglossaryentry{abntex2}{
                name={abnTeX2},
                see=latex,
                description={suíte para LaTeX que atende os requisitos das
                normas da ABNT para elaboração de documentos técnicos e científicos brasileiros} }
% ---

% ---
% Exemplo de configurações do glossairo
\renewcommand*{\glsseeformat}[3][\seename]{\textit{#1}  
 \glsseelist{#2}}
% ---
              
                
% ----
% Início do documento
% ----
\begin{document}
 
% Retira espaço extra obsoleto entre as frases.
\frenchspacing
 
% ----------------------------------------------------------
% ELEMENTOS PRÉ-TEXTUAIS
% ----------------------------------------------------------
 
% ---
% Capa
% ---
\imprimircapa
% ---
 
% ---
% inserir o sumario
% ---
\pdfbookmark[0]{\contentsname}{toc}
\tableofcontents*
\cleardoublepage
% ---
  
 
% ----------------------------------------------------------
% ELEMENTOS TEXTUAIS
% ----------------------------------------------------------
\textual
 
% ----------------------------------------------------------
% Introdução
% ----------------------------------------------------------
\chapter*[Introdução]{Introdução}
\addcontentsline{toc}{chapter}{Introdução}
 
Este documento e seu código-fonte são exemplos de referência de uso da classe
\textsf{abntex2} e do pacote \textsf{abntex2cite}. O documento não se trata de
um modelo específico baseado em alguma norma da ABNT, mas exemplifica a
elaboração do elemento ``Glossário'' previsto nas normas ABNT NBR
10719:2015, ABNT NBR 14724:2011 e ABNT NBR 15287:2011, por exemplo. Este
documento deve ser utilizado como complemento aos demais exemplos de uso de
\abnTeX.

A expressão ``Modelo Canônico'' é utilizada para indicar que \abnTeX\ não é
modelo específico de nenhuma universidade ou instituição, mas que implementa tão
somente os requisitos das normas da ABNT. Uma lista completa das normas
observadas pelo \abnTeX\ é apresentada em \citeonline{abntex2classe}.
 
Sinta-se convidado a participar do projeto \abnTeX! Acesse o site do projeto em
\url{http://www.abntex.net.br/}. Também fique livre para conhecer,
estudar, alterar e redistribuir o trabalho do \abnTeX, desde que os arquivos
modificados tenham seus nomes alterados e que os créditos sejam dados aos
autores originais, nos termos da ``The \LaTeX\ Project Public
License''\footnote{\url{http://www.latex-project.org/lppl.txt}}.
 
Encorajamos que sejam realizadas customizações específicas deste exemplo para
universidades e outras instituições --- como capas, folha de aprovação, etc.
Porém, recomendamos que ao invés de se alterar diretamente os arquivos do
\abnTeX, distribua-se arquivos com as respectivas customizações.
Isso permite que futuras versões do \abnTeX~não se tornem automaticamente
incompatíveis com as customizações promovidas. Consulte
\citeonline{abntex2-wiki-como-customizar} para mais informações.
 
Este documento deve ser utilizado como complemento dos manuais do \abnTeX\
\cite{abntex2classe,abntex2cite,abntex2cite-alf} e da classe \textsf{memoir}
\cite{memoir}.
 
Equipe \abnTeX
  
Lauro César Araujo
 
 
% ---
% Capitulo que faz uso de elementos do glossario
% ---
\chapter{Orientações a respeito de glossários}
 
% ---
\section{Usar o glossário no texto}
% ---
 
Você pode definir as entradas do glossário no início do texto. Recomenda-se o
uso de um arquivo separado a ser inserido ainda no preâmbulo. Veja orientações
sobre inclusão de arquivos na \autoref{sec-include}.

No decorrer do texto, use os termos do glossário como na frase:

\begin{citacao}
Esta frase usa a palavra \gls{componente} e o plural de \glspl{filho}, ambas
definidas no glossário como filhas da entrada \gls{pai}. \Gls{equilibrio}
exemplifica o uso de um termo no início da frase. O software \gls{abntex2} é
escrito em \gls{latex}, que é definido no glossário como
\emph{`\glsdesc*{latex}'}.
\end{citacao}


A frase acima foi produzida com:

\begin{verbatim}
Esta frase usa a palavra \gls{componente} e o plural de \glspl{filho}, ambas
definidas no glossário como filhas da entrada \gls{pai}. \Gls{equilibrio}
exemplifica o uso de um termo no início da frase. O software \gls{abntex2} é
escrito em \gls{latex}, que é definido no glossário como
\emph{`\glsdesc*{latex}'}.
\end{verbatim}

Opcionalmente, incorpore todas as palavras do glossário de uma única vez ao
documento com o comando:

\begin{verbatim}
   \glsaddall
\end{verbatim}
 
A impressão efetiva do glossário é dada com:

\begin{verbatim}
   \printglossaries
\end{verbatim}

A impressão do glossário incorpora o número das páginas em que as entradas foram
citadas. Isso pode ser removido adicionando-se a opção \texttt{nonumberlist} em:

\begin{verbatim}
\usepackage[nonumberlist,style=index]{glossaries}%
\end{verbatim}

% ---
\section{Compilar um documento com glossário}
\label{sec-compilar-glossario}
% ---
 
Para compilar um documento \LaTeX\ com glossário use:

\begin{verbatim}
   pdflatex ARQUIVO_PRINCIPAL.tex
   bibtex ARQUIVO_PRINCIPAL.aux
   makeindex ARQUIVO_PRINCIPAL.idx 
   makeindex ARQUIVO_PRINCIPAL.nlo -s nomencl.ist -o ARQUIVO_PRINCIPAL.nls
   makeglossaries ARQUIVO_PRINCIPAL.aux
   pdflatex ARQUIVO_PRINCIPAL.tex
   pdflatex ARQUIVO_PRINCIPAL.tex
\end{verbatim}
 
O comando \texttt{makeglossaries} é um aplicativo Perl instalado
automaticamente pelas distribuições MacTeX, TeX Live e MiKTeX. Geralmente
usuários de Linux e de Mac OS X já possuem o interpretador Perl\footnote{O Perl
é uma linguagem de programação de scripts muito utilizada pela comunidade de
software livre. Veja o site do projeto em \url{http://www.perl.org/}.} instalado
e configurado e nenhuma configuração adicional é necessária.

Usuários de Windows, por outro lado, precisam instalar a ferramenta Perl para
que seja possível usar \texttt{makeglossaries}. Por sorte isso é simples. Para
obter a instalação do Perl para seu sistema operacional visite \url{http://www.perl.org/get.html}.

Alternativamente ao aplicativo Perl \texttt{makeglossaries}, é possível usar o
aplicativo \texttt{makeglossariesgui}\footnote{O título do aplicativo no CTAN
é \textit{Java GUI alternative to makeglossarires script}.}, que possui uma
interface gráfica baseada em Java. Para isso, consulte
\url{http://www.ctan.org/pkg/makeglossariesgui}. Funciona em Windows,
Linux e Mac OS X.

% ---
\section{Configuração de glossários}
% ---

O pacote \textsf{glossaries}, usado na produção dos glossários deste exemplo,
possui diversas configurações. É possível alterar o estilo da impressão do
glossário, criar campos adicionais, usar diversos glossários em
arquivos separados. Para isso e outras informações, consulte a documentação do
pacote \textsf{glossaries}: \url{http://www.ctan.org/pkg/glossaries}.

Consulte também o livro da WikiBooks sobre a produção de glossários:
\url{http://en.wikibooks.org/wiki/LaTeX/Glossary}.
 

\subsection{Estilos do glossário}

O pacote \textsf{glossaries} traz dezenas de estilos pré-definidos de
glossários. Eles estão disponíveis no capítulo 15 do manual do pacote
\cite{talbot2012}. O capítulo 16 contém instruções sobre como criar um estilo
personalizado.

Os estilos podem ser alterados com:

\begin{verbatim}
   \setglossarystyle{altlisthypergroup}
\end{verbatim}

O estilo \texttt{index} é ideal para construção de glossários com diversos
níveis hierárquicos do tipo pai-filho. Já o modelo \texttt{altlisthypergroup} é
mais adequado para glossários sem hierarquias. Teste também o modelo
\texttt{tree}.

Se desejar um único estilo de glossário padrão no documento, alternativamente
inclua a opção \texttt{style} nas opções da classe, do
seguinte modo:

\begin{verbatim}
   \usepackage[style=index]{glossaries}
\end{verbatim}

% ---
\section{Problemas com a ordem das palavras?}
% ---

Este exemplo do \abnTeX\ utiliza a ferramenta \texttt{makeindex} -- padrão das
distribuições \LaTeX\ mais comuns -- para ordenar as entradas do glossário.
Porém, essa ferramenta não possui opções de \textit{collation} e não funciona
bem para palavras escritas em idiomas que não sejam inglês.
Por isso, pode acontecer que letras acentuadas e outros caracteres
internacionais sejam ordenados de forma incorreta, como no exemplo (palavras não
necessariamente presentes na língua portuguesa):

\begin{alineas}
 \item Amor: ...
 \item Aviar: ...
 \item Avião: ...
 \item Aço: ...
\end{alineas}

Por sorte, é possível substituir o uso do \texttt{makeindex}
pelo \texttt{xindy}\footnote{\url{http://www.xindy.org/}}. Para isso, faça o
seguinte:

\begin{alineas}
  \item Certifique-se de que o Xindy esteja instalado. Em um terminal, digite:
  \texttt{xindy --version}\footnote{Caso o Xindy não esteja presente no sistema, é necessário
    instalá-lo. Usuários Linux Debian/Ubuntu podem usar: \texttt{sudo
    apt-get install xindy}. Usuários Windows e Mac podem acessar a página do
    Xindy, baixá-lo e instalá-lo.};
  \item No código LaTeX, ainda no preâmbulo, inclua a seguinte opção ao pacote glossaries:
  \begin{verbatim}
  \usepackage[xindy={language=portuguese},nonumberlist=true]{glossaries}
  \end{verbatim}
  \item Compile o glossário normalmente, conforme a
  \autoref{sec-compilar-glossario}.
\end{alineas}

% ----------------------------------------------------------
% Capitulo com exemplos de comandos inseridos de arquivo externo 
% ----------------------------------------------------------

\include{abntex2-modelo-include-comandos}
 
 
% ----------------------------------------------------------
% ELEMENTOS PÓS-TEXTUAIS
% ----------------------------------------------------------
\postextual
 
 
% ----------------------------------------------------------
% Referências bibliográficas
% ----------------------------------------------------------
\bibliography{abntex2-modelo-references}
 
% ----------------------------------------------------------
% Glossário
% ----------------------------------------------------------

% ---
% Define nome e preâmbulo do glossário
% ---
\phantompart
\renewcommand{\glossaryname}{Glossário}
\renewcommand{\glossarypreamble}{Esta é a descrição do glossário. Experimente
visualizar outros estilos de glossários, como o \texttt{altlisthypergroup},
por exemplo.\\
\\}

% ---
% Traduções para o ambiente glossaries
% ---
\providetranslation{Glossary}{Glossário}
\providetranslation{Acronyms}{Siglas}
\providetranslation{Notation (glossaries)}{Notação}
\providetranslation{Description (glossaries)}{Descrição}
\providetranslation{Symbol (glossaries)}{Símbolo}
\providetranslation{Page List (glossaries)}{Lista de Páginas}
\providetranslation{Symbols (glossaries)}{Símbolos}
\providetranslation{Numbers (glossaries)}{Números} 
% ---

% ---
% Estilo de glossário
% ---
% \setglossarystyle{index}
% \setglossarystyle{altlisthypergroup}
 \setglossarystyle{tree}


% ---
% Imprime o glossário
% ---
\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{\glossaryname}
\printglossaries
% ---
  
 
% ----------------------------------------------------------
% Apêndices
% ----------------------------------------------------------
 
% ----------------------------------------------------------
% Anexos
% ----------------------------------------------------------
 
%---------------------------------------------------------------------
% INDICE REMISSIVO
%---------------------------------------------------------------------
 
\end{document}