diff options
Diffstat (limited to 'macros/latex/contrib/abntexto/abntexto-manual.tex')
-rw-r--r-- | macros/latex/contrib/abntexto/abntexto-manual.tex | 254 |
1 files changed, 254 insertions, 0 deletions
diff --git a/macros/latex/contrib/abntexto/abntexto-manual.tex b/macros/latex/contrib/abntexto/abntexto-manual.tex new file mode 100644 index 0000000000..2038eed5d1 --- /dev/null +++ b/macros/latex/contrib/abntexto/abntexto-manual.tex @@ -0,0 +1,254 @@ +\documentclass{abntexto} + +\makeatletter + +\usepackage[brazil]{babel} +\usepackage[T1]{fontenc} +\usepackage[varqu,varl,scale=0.85]{inconsolata} +\usepackage[matchlowercase]{tgheros} \renewcommand\familydefault\sfdefault +\usepackage{lipsum} \def\lip{\lipsum[1][1-2]} +\usepackage{graphicx} +\usepackage{xcolor} +\usepackage[colorlinks]{hyperref} + +% MARKUP DEFS +% ================================================ + +\def\cs#1{{\ttfamily \string#1}} +\def\meta#1{\textsf{⟨\textit{\fontseries{c}\selectfont #1}⟩}} % ⟨#1⟩ +\def\cc#1{{\ttfamily \{\meta{#1}\}}} +\def\kk#1{{\ttfamily [\meta{#1}]}} + +\def\arg{\cc{arg}} +\def\opt{\kk{opt}} +\def\argi{\cc{argi}} +\def\argii{\cc{argii}} +\def\argiii{\cc{argiii}} +\def\opti{\kk{opti}} +\def\optii{\kk{optii}} +\def\optiii{\kk{optiii}} +\def\ccval#1{{\ttfamily \{#1\}}} +\def\kkval#1{{\ttfamily [#1]}} +\def\cls#1{\textsf{\textit{#1}}} +\def\pkg#1{\texttt{#1}} + +% VERBATIM +% ================================================ + +\def\adef#1{\catcode`#1=13 \begingroup \lccode`\~=`#1\lowercase{\endgroup\def~}} +\def\dodef#1{\catcode`#1=12 } +\def\verbcatcodes{\let\do=\dodef \dospecials\obeyspaces\catcode`\%=14 } + +\long\def\verbon{\par\begingroup \verbcatcodes + \catcode`\|=0 % escape char + \adef\^^I{\space\space\space\space}\adef\^^M{\par\leavevmode}% + \startverb +} +{\catcode`\|=0 \catcode`\\=12 + |long|gdef|startverb#1\verboff{|verbbox{#1}|par|endgroup |verbreset} +} +\def\verbbox#1{\def\tnba@placewidth{\hsize \advance\hsize-3cm}% + \ifx\tnba@savedplace\empty \else \vskip\placeabovespace \fi + \parindent=0pt + \ifx\tnba@savedplace\empty\else\tnba@makelegend\fi + \nobreak\par\nointerlineskip \kern10pt + {\verbfont{#1}}% + \nobreak\nointerlineskip + \ifx\tnba@savedsrc\empty \else \tnba@makesrc \vskip\placebelowspace \fi +} +\def\verbreset{% + \let\tnba@savedplace=\empty + \let\tnba@savedlegend=\empty + \let\tnba@savedsrc=\empty + \let\@currentlabel=\relax +} +\long\def\verbfont{\raggedright\leftskip=6pt \singlesp\ttfamily\@noligs\leftframed} +\long\def\leftframed#1{\setbox0=\vtop{#1}% + \hbox{{\color{graybar}\kern1.5cm\vrule width1pt}\box0}% +} + +% PERSONAL DEFS +% ================================================ + +\sizeselectordef\large{14pt}{17pt} +\sizeselectordef\Large{22pt}{25pt} +\sizeselectordef\LARGE{25pt}{30pt} + +\definecolor{graybar}{gray}{0.75} +\definecolor{graycomment}{gray}{0.55} + +\legendplacedef{verb}{Verbatim}{verb.\,#1}{lov} + +\def\me{o autor.} + +\tocilowercase +\sectionlowercase + +\clubpenalty=10000 +\widowpenalty=10000 + +\makeatother + + + +\begin{document} + +\leavevmode\vskip1.9in + +{\centering \LARGE\sffamily\bfseries + abntexto\\[0.4em] \Large\itshape\mdseries + Classe para {\upshape\LaTeX}\\[2em] \normalfont\large + Elayson\\[1ex] + \href{mailto:elaysonabreu@gmail.com}{elaysonabreu@gmail.com}\\[2.5ex] + \today\par} + +\vskip3in + +{\centering \large\ttfamily 1.0.0-alpha\par} + +\newpage + +\maketoc + +\textual + +\section{Apresentação} + +O \cls{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 \href{https://www.ctan.org/pkg/latex-via-exemplos}{\LaTeXe\ Via Exemplos} ou \href{https://www.ctan.org/pkg/latex2e-help-texinfo}{\LaTeXe: An unofficial reference manual}, disponível também em francês. Além disso, também se pode ler \href{https://www.ctan.org/pkg/texbytopic}{\TeX\ by Topic} para aprender sobre o sistema \TeX. + +Já existe uma classe para aplicação das normas ABNT cujo nome é \cls{abntex2}. Mas, diferente desta, o \cls{abntexto} não depende do \cls{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 \cls{abntexto} se propõe a seguir são aquelas em vigor até o momento da criação deste manual. + +\section{Chamando a classe} + +Digite as linhas em \ref{vb:início} e use \cls{abntexto}. + +\legend{verb}{Início} \src\me +\label{vb:início} +\verbon +\documentclass{abntexto} + +\usepackage[brazil]{babel} |% para obter os padrões de hifenização corretos +\usepackage[T1]{fontenc} +\usepackage{newtxtext} |% fontes New TX, com estilo times +\usepackage{newtxmath} + +\begin{document} + Texto +\end{document}% +\verboff + +\section{Fonte tipográfica} + +O tamanho da fonte é 12\,pt de imediato e pode ser configurado com o comando \cs\setfontsize\arg\ sendo que 12\,pt é a única opção disponível. Mas, se você deseja outro tamanho de fonte, crie-o usando \cs\fontsizedef\cc{size}\cc{defs}. Além disso, com os seletores de tamanho \cs\normalsize\ e \cs\small\ que configuram 12\,pt e 10\,pt, nessa ordem, é possível mudar o tamanho da fonte no corpo do documento. + +O espaçamento é de um e meio e pode ser alterado para dois com \cs\spacing\ccval{2}, por exemplo. Os atalhos \cs\singlesp, \cs\onehalfsp\ e \cs\doublesp\ estão disponíveis. Note que o espaçamento simples não tem o mesmo valor que o espaçamento um, portanto, \cs\singlesp\ é diferente de \cs\spacing\ccval{1}! Os atalhos \cs\onehalfsp\ e \cs\doublesp\ tem o mesmo significado de \cs\spacing\ccval{1.5} e \cs\spacing\ccval{2}. + +\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. Todas essas medidas podem ser alteradas com a macro \cs\paper\ que deve ser usada assim: \cs\paper\ccval{left=0cm,right=0cm,top=0cm,botttom=0cm}. + +Além das chaves anteriores também existe \cs{twoside} que é booleana, ou seja, aceita os valores \cs{true} ou \cs{false} e serve para ativar o modo de impressão em duas folhas aonde as medidas das margens horizontais se invertem nas páginas pares. Ao não informar um valor para \cs{twoside} subentende-se que seja \cs{true}, portanto \cs\paper\ccval{twoside} equivale a \cs\paper\ccval{twoside=true} e esse princípio também se aplica a outras chaves booleanas. + +\section{Sumário} + +Os comandos que mudam a fonte das entradas no ToC (Table of Contents, em inglês) são \cs\tocifont, \cs\tociifont, \dots, \cs\tocvfont\ (ver \ref{vb:contents}). + +\legend{verb}{Aparência do sumário} \src\me +\label{vb:contents} +\verbon +\documentclass{abntexto} + +\usepackage{color} + +\tocifont{\color{red}\itshape} +\tociifont{\color{blue}\bfseries} + +\begin{document} + \maketoc + + \section{Título} + \subsection{Título} +\end{document}% +\verboff + +\section{Secionamento} + +A personalização das macros de seção (\cs\section, \cs\subsection\ etc.) é análoga a personalização do sumário e deve ser feita com \cs\sectionfont, \cs\subsectionfont, etc. como exemplificado em \ref{vb:sec}. + +Também há como alterar o espaço vertical acima e abaixo das seções usando \cs\sectionspaces, \cs\subsectionspaces, etc. Por exemplo, \cs\sectionspaces\ccval{2ex}\ccval{1cm} insere um espaço de 2ex acima de \cs\section\ e 1cm abaixo. + +\legend{verb}{Aparência das seções} \src\me +\label{vb:sec} +\verbon +\documentclass{abntexto} + +\usepackage{color} + +\sectionfont{\color{blue}\scshape} +\subsectionfont{\color{red}\slshape} +\subsubsectionfont{\color{yellow}\sffamily} + +\begin{document} + \maketoc + + \section{Texto} + \subsection{Texto} + \subsubsection{Texto} +\end{document}% +\verboff + +\section{Alíneas} + +Use o ambiente \cs{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{vb:topics}. Naturalmente o uso de \cs\label\ é permitido. + +\legend{verb}{Alíneas} \src\me +\label{vb:topics} +\verbon +\begin{topics} + \item \label{alínea:x} 1 + \begin{topics} + \item x + \item y + \item z + \end{topics} + \item \label{alínea:y} 2 + \item 3 +\end{topics}% +\verboff + +\section{Áreas de legenda} + +Use \cs\place\ para inserir áreas de legenda como mostrado em \ref{vb:place}. Mas existem condições: \cs\place\ deve vir por último e \cs\label\ precisa estar depois de \cs\legend. Além disso, existe a possibilidade de alterar o espaço vertical acima e abaixo de uma área de legenda com \cs\placespaces\cc{aboveskip}\cc{belowskip}. + +\legend{verb}{Áreas de legenda} \src\me +\label{vb:place} +\verbon +\usepackage{graphicx} + +\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}% +\verboff + +\section{Formatação de {\ttfamily\protect\textbackslash cite} e referências} + +Até o momento esta classe não possui macros para formatação de \cs\cite\ e referências. Utilize \cs{\usepackage\{abnt2cite\}} ou \cs{\usepackage[style=abnt]\{biblatex\}}. + +\section{Citações} + +Para inserir aspas em citações diretas use \cs\qt\cc{texto}. Mas, se tratando de citações diretas com mais de três linhas, alterne para \cs\quote\ccval{enquoted text \cs\cite\cc{key}}. + +\section{Código-fonte} + +Em progresso\dots + +\end{document} |