summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/abntexto/abntexto.tex
blob: b9210f5b0e60fc65819df3937bd3b1f086452ff9 (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
% !TeX TS-program = lualatex

\documentclass{abntexto}

\usepackage[cmyk]{xcolor}
\usepackage[style=abnt]{biblatex} \addbibresource{abntexto.bib}
\usepackage[brazil]{babel}
\usepackage{fontspec}
\usepackage{unicode-math}
\usepackage[colorlinks,linktoc=page]{hyperref}
\usepackage{listings}

\makeatletter

% VERBATIM
% ================================================

\newcount\verbcount
\newdimen\hh \hh=6pt

\def\adef#1{\catcode`#1=13 \begingroup \lccode`\~=`#1\lowercase{\endgroup\def~}}
\def\setverb{\def\do##1{\catcode`##1=12}\dospecials}

{\catcode`\^^M=13
	\gdef\verbpercent#1^^M{{\bfseries\color{comment}\%#1}^^M}
}

\def\makeverbcount{}

\def\begverb{\par \begingroup\parindent=0pt\parskip=0pt
	\setverb \catcode`\|=0
	\adef{ }{\ }%
	\adef{\^^I}{\ \ \ }%
%	\everypar={\makeverbcount}%
	\def\par##1{\endgraf\ifx##1\par\leavevmode\fi ##1}%
	\obeylines
	\adef{'}{\textquotesingle}%
%	\adef{`}{\`{}}%
	\adef{-}{-\kern0pt }%
	\adef{\%}{\verbpercent}%
	\startverb
}

{\catcode`\^^M=13 \catcode`\|=0 \catcode`\\=12 
	|long|gdef|startverb#1\endverb{|verbbox{#1|endgraf}|endgroup|resetplace}
}

\def\verbbox#1{\place{\verbframe{#1}}}
\def\verbframe#1{%
	\hbox{{\color{leftbar}\vrule width1pt}\kern\hh\vbox{%
		\hbox{\vbox{\advance\hsize-1pt \advance\hsize-\hh \verbfont #1}}%
	}}%
}
\def\verbfont{\sloppy\ttfamily\small\singlesp}

\def\verbchar#1{%
	\ifx\savedttchar\undefined\else \catcode\savedttchar=\savedttcharc \fi
	\chardef\savedttchar=`#1%
	\chardef\savedttcharc=\catcode`#1%
	\bgroup\lccode`\~=`#1%
	\lowercase {\egroup\def~}{\leavevmode\hbox\bgroup\setverb\adef{ }{\ }%
		\ttfamily\readverb}%
	\bgroup\lccode`\~=`#1\lowercase{\egroup\def\readverb ##1~}{##1\egroup}%
	\catcode`#1=13
}
\verbchar{|}

\AddToHook{begindocument}{\adef{<}{\begingroup \setverb\startmeta}}
\def\startmeta#1>{\ttfamily$\langle${\rmfamily\itshape #1\/}$\rangle$\endgroup}

% MISC
% ================================================

\definecolor{leftbar}{gray}{.75}
\definecolor{comment}{gray}{.2}

\setmainfont{texgyretermes}[
	UprightFont    = *-regular,
	BoldFont       = *-bold,
	ItalicFont     = *-italic,
	BoldItalicFont = *-bolditalic,
	Extension      = .otf
]
\setmonofont{InconsolataN-Regular.otf}
\setmathfont{texgyretermes-math.otf}

\def\tocsectionfont#1{\bfseries#1\mdseries}
\def\sectionfont#1{\bfseries#1}
\def\appendixlabelwidth{6.7em}

\def \l@section  {\addpenalty{-300}\addvspace{.5em plus1pt}
				  \extline{0pt}{\toclabelwidth}{\tocsectionfont}}
\def \l@appendix {\addpenalty{-300}\addvspace{.5em plus1pt}%
                  \extline{0pt}{\appendixlabelwidth}{\maintocfont}}
\def \l@annex    {\addpenalty{-300}\addvspace{.5em plus1pt}%
                  \extline{0pt}{\annexlabelwidth}{\maintocfont}}

\definelegendplace{code}{Código}{cód.\,}{loc}
\def\me{o Autor.}

\clubpenalty=10000
\widowpenalty=10000
\let\cite=\textcite
\def\bibfont{\bibitemsep=\baselineskip \singlesp}

\makeatother



\begin{document}

\leavevmode\vskip1.9in

{\centering \LARGE\sffamily\bfseries
	abntexto\\[0.4em] \Large\itshape\mdseries
	Classe para {\upshape\LaTeX}\\[2em] \normalfont\large
	Elayson Abreu\\[1ex]
	\href{mailto:abntexto.classe@gmail.com}{abntexto.classe@gmail.com}\\[2.5ex]
	\today
\par}
\vskip3in

{\centering\large\ttfamily 3.0.2-beta\par}
\newpage

\heading{Sumário}
\maketoc
\newpage

\section{Introdução}

O |abntexto| é uma classe do \LaTeX\ criada para facilitar a utilização das normas da Associação Brasileira de Normas Técnicas (ABNT) em trabalhos acadêmicos (monografias, dissertações, teses).

Este \emph{não} é um manual sobre LaTeX (ou TeX, a ferramenta que o constitui) nem tampouco uma descrição detalhada sobre as normas ABNT. Para aprender sobre LaTeX leia \cite{viaexemplos} ou \cite{latex2eunnoficial}, disponível também em francês. Além disso, também se pode ler \cite{texbytopic} para aprender sobre o sistema \TeX \footnote{Note que os livros referenciados não foram realmente citados e isso não é aceito na Norma, no entanto este não é um trabalho acadêmico real, mas um manual.}.

Já existe uma classe para aplicação das normas ABNT cujo nome é |abntex2|. Mas, diferente desta, o |abntexto| não depende  do |memoir|, uma classe de código-fonte e manual extensos e que implementa funções as quais, em sua maioria, não são pertinentes a um documento que use as diretrizes da ABNT.

As normas ABNT as quais o |abntexto| se propõe a seguir são aquelas em vigor até o momento da criação deste manual. São elas:

\begin{topics}
	\item NBR 14724-2011
	\item NBR 12225-2004
	\item NBR 6028-2003
	\item NBR 6027-2012
	\item NBR 10520-2002
	\item NBR 6023-2018
	\item NBR 10522-1988
	\item NBR 5892-2019
	\item NBR 6024-2012
\end{topics}

\section{Chamando a classe}

Digite as linhas em \ref{cd:início} e use |abntexto|.

\legend{code}{Início} \src\me
\label{cd:início}
\begverb
% !TeX TS-program = lualatex
\documentclass{abntexto}

\usepackage[brazil]{babel}
\usepackage{fontspec}

\setmainfont{texgyretermes}[
	UprightFont    = *-regular,
	BoldFont       = *-bold,
	ItalicFont     = *-italic,
	BoldItalicFont = *-bolditalic,
	Extension      = .otf
]

\begin{document}
	Texto
\end{document}
\endverb

O arquivo exemplo.tex, disponível no CTAN, mostra como elaborar os elementos pré-textuais.

\section{Fonte tipográfica}

O tamanho da fonte é 12\,pt de imediato e pode ser configurado com o comando |\setfontsize{<id>}| sendo que 12\,pt é a única opção disponível. Além disso, com os seletores de tamanho |\normalsize| e |\small| que configuram 12\,pt e 10\,pt, nessa ordem, é possível mudar o tamanho da fonte no corpo do documento.

Mas, se você deseja outro tamanho de fonte, crie-o usando |\definefontsize{<id>}{<definições>}| e |\sizedef<seletor>{<tamanho>}{<entrelinha natural>}|. Em <definições>, o seletor |\normalsize| deve estar presente por meio de |\sizedef|, caso contrário, a classe mostrará um erro.

O espaçamento é de um e meio e pode ser alterado para dois com |\spacing{2}|, por exemplo. Os atalhos |\singlesp|, |\onehalfsp| e |\doublesp| estão disponíveis. Note que o espaçamento simples não tem o mesmo valor que o espaçamento um, portanto, |\singlesp| é diferente de |\spacing{1}|! Os atalhos |\onehalfsp| e |\doublesp| tem o mesmo significado de |\spacing{1.5}| e |\spacing{2}|.

A limitação do comando |\spacing| é que ele só pode ser usado após um seletor de tamanho, porque este redefine a entrelinha. Por exemplo, |\small\onehalfsp| é correto e |\onehalfsp\small| ineficaz.

\section{\emph{Layout}}

A folha é A4 por padrão e as margens esquerda e direita são de 3\,cm, 2\,cm para páginas ímpares e de 2\,cm, 3\,cm para páginas pares, respectivamente. Além disso, as margens superior e inferior têm, nessa ordem, 3\,cm, 2\,cm para todo o documento. As margens foram ajustadas com o pacote |geometry|.

Existem dois comandos que configuram o \emph{layout} da página: |\pretextual| que, além de desabilitar o modo |twoside|, remove a numeração de página e é executado automaticamente logo após |\begin{document}| e o comando |\textual| que também é executado automaticamente logo antes da primeira chamada de |\section| por meio de |\trytextual|. Dessa forma, a numeração de página será posta no topo da página e as margens passarão a ser espelhadas.

\section{Sumário}

Os comandos que mudam a fonte das entradas no ToC (Table of Contents) são |\tocsectionfont|, |\tocsubsectionfont|, \dots, |\tocsubparagraphfont| (ver \ref{cd:contents}).

\legend{code}{Aparência do sumário} \src\me
\label{cd:contents}
\begverb
\documentclass{abntexto}

\usepackage{xcolor}

\def \tocsectionfont    #1{\color{red}\itshape\MakeUppercase{#1}}
\def \tocsubsectionfont #1{\color{blue}\bfseries#1}

\begin{document}
	\heading{Sumário}
	\maketoc

	\section{Título}
	\subsection{Título}
\end{document}
\endverb

\section{Secionamento}

A personalização das macros de seção (|\section|, |\subsection| etc.) é análoga a personalização do sumário e deve ser feita com |\sectionfont|, |\subsectionfont| etc. como exemplificado em \ref{cd:sec}.

Também há como alterar o espaço vertical acima e abaixo das seções usando |\abovesection|, |\belowsection| e semelhantes. Por exemplo, |\def\abovesubsection{2cm}| insere um espaço de 2\,cm acima de |\subsection|.

\legend{code}{Aparência das seções} \src\me
\label{cd:sec}
\begverb
\documentclass{abntexto}

\usepackage{xcolor}

\def \sectionfont       #1{\color{blue}\scshape#1}
\def \subsectionfont    #1{\color{red}\itshape#1}
\def \subsubsectionfont #1{\color{yellow}\sffamily#1}

\begin{document}
	\heading{Sumário}
	\maketoc

	\section{Texto}
	\subsection{Texto}
	\subsubsection{Texto}
\end{document}
\endverb

\section{Alíneas}

Use o ambiente |topics| para criar alíneas. Ele dispõe de dois níveis sendo que o segundo usa um travessão como marcador conforme o exemplo em \ref{cd:topics}. Naturalmente, é permitido usar |\label| após um item.

\legend{code}{Alíneas} \src\me
\label{cd:topics}
\begverb
\begin{topics}
	\item \label{al:x} 1
		\begin{topics}
			\item x
			\item y
			\item z
		\end{topics}
	\item \label{al:y} 2
	\item 3
\end{topics}
\endverb

\section{Áreas de legenda}

Use |\place{<obj>}| para inserir áreas de legenda como mostrado em \ref{cd:place}. Mas existem condições: |\place| deve vir por último e |\label| precisa estar depois de |\legend{<tipo de obj>}{<legenda>}|. Além disso, existe a possibilidade de alterar o espaço vertical acima e abaixo de uma área de legenda com |\def\aboveplace{<valor>}| e |\def\belowplace{<valor>}|.

\legend{code}{Áreas de legenda} \src\me
\label{cd:place}
\begverb
\begin{document}
	\legend{figure}{Um título}
	\src{\texttt{www.site.com.br}. Acesso em 01 jan. 2020.}
	\label{fig:teste}
	\place{\includegraphics[width=0.4\linewidth]{example-image}}

	Ver \ref{fig:teste}.
\end{document}
\endverb

O leitor pode querer definir uma nova área de legenda usando, por exemplo, a instrução |\definelegendplace{diagram}{Diagrama}{diag.\,#1}{lod}| criará o comando |\makelod| para escrever no documento as entradas do arquivo auxiliar .lod.

\section{Formatação de {\ttfamily\textbackslash\lowercase{cite}} e referências}

Até o momento o |abntexto| não possui macros para formatação de |\cite| e referências. Utilize |\usepackage[style=abnt]{biblatex}|.

\section{Citações}

Para inserir aspas em citações diretas use |\enquote{texto}\cite{<key>}|. Mas, se tratando de citações diretas com mais de três linhas, alterne para |\Enquote{texto \cite{<key>}}|.

\section{Apêndice e anexo}

Com os comandos |\appendix| e |\annex| você pode inserir apêndices e anexos junto dos indicativos desejados: “Apêndice 1 --- \dots” ou “Anexo 1 --- \dots” (ver \ref{cd:appendix}).

\legend{code}{Anexos e apêndices} \src\me
\label{cd:appendix}
\begverb
\begin{document}
	\appendix{Lorem}
	\appendix{Lipsum}

	\annex{Lorem}
	\annex{Lipsum}
\end{document}
\endverb

Pode-se alterar a largura dos rótulos das entradas de apêndice/anexo no sumário redefinindo |\appendixlabelwidth|\,/\,|\annexlabelwidth|.

\newpage

\begin{corrprint}{Referências}
	\printbibliography
\end{corrprint}

\newpage

\appendix{Glossário}

Você pode criar glossários com o pacote |glossaries|, como em \ref{cd:gloss}.

\legend{code}{Glossário} \src\me
\label{cd:gloss}
\begverb
\usepackage{lipsum}
\usepackage{glossaries}

\makenoidxglossaries

\newglossaryentry{metalism}{name=metalismo,description={Tipo de sistema monetário cujo valor da moeda, geralmente de uma nação ou de um país, é determinado pela quantidade constante de certo metal (ouro ou prata), desta forma se estabelece um valor fixo de troca entre esses metais e o próprio dinheiro}}

\newglossaryentry{lip}{name=lipsum,description={\lipsum[1]}}

\begin{document}
	O \gls{metalism} e o \gls{lip}.

	\begin{corrprint}{Glossário}
		\printnoidxglossary
	\end{corrprint}
\end{document}
\endverb

\appendix{Lista de siglas}

O |glossaries.sty| também serve para criar uma lista de siglas, conforme \ref{cd:acro}.

\legend{code}{Siglas} \src\me
\label{cd:acro}
\begverb
\usepackage[acronym]{glossaries}

\makenoidxglossaries

\newacronym{ibge}{IBGE}{Instituto Brasileiro de Geografia e Estatística}
\newacronym{html}{HTML}{Hypertext Markup Language}

\def\acr#1{\gls{#1}}

\begin{document}
	1ª chamada: \acr{ibge}, \acr{html}.
	
	2ª chamada: \acr{ibge}, \acr{html}.

	\begin{corrprint}{Lista de siglas}
		\def\acronymname{Lista de siglas}
		\printnoidxglossary[type=acronym]
	\end{corrprint}
\end{document}
\endverb

\appendix{\emph{Feedback}}
Sugestões, relatos de \emph{bugs} e doações são bem-vindas.

Chave PIX: {\ttfamily abntexto.classe@gmail.com}

% MACROS PARA O CÓDIGO-FONTE
% ================================================

\appendix{Código-fonte}

\definecolor{background}{cmyk}{0,0.08,0,0}
\definecolor{comment}{cmyk}{0.9,0,0,0.1}
\definecolor{letter}{cmyk}{0,0,0,.8}

\parskip=0pt plus.2ex minus.1ex

\countsection=0
\def\addtoext#1#2#3{}
\def\sectionfont{\itshape}
\def\sec#1\par{\section{#1}}
\def\verbfont{\raggedright\ttfamily\small\sloppy}
\def\codesep{2mm}
\def\leftsep{5mm}

\lstnewenvironment{code}{\lstset{
	frame=single,
	framerule=0pt,
	framesep=\codesep,
	xleftmargin=\dimexpr\codesep+\leftsep,
	xrightmargin=\codesep,
	framexleftmargin=\leftsep,
	firstnumber=last,
	numbers=left,
	numbersep=6pt,
	numberstyle=\fontsize{8pt}{9pt}\selectfont,
	basicstyle=\verbfont,
	commentstyle=\color{blue}\bfseries,
	comment=[l]{\%},
	columns=fullflexible,
	tabsize=3,
	backgroundcolor=\color{background},
	literate=
		{\ }{ }1 {\^^M\%}{}2
}}{}

{\catcode`\!=14 \catcode`\%=9
	\input abntexto.cls
}

\end{document}