diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/abntexto/abntexto.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/abntexto/abntexto.tex | 163 |
1 files changed, 135 insertions, 28 deletions
diff --git a/Master/texmf-dist/doc/latex/abntexto/abntexto.tex b/Master/texmf-dist/doc/latex/abntexto/abntexto.tex index a46c613c06a..fc0eed0a045 100644 --- a/Master/texmf-dist/doc/latex/abntexto/abntexto.tex +++ b/Master/texmf-dist/doc/latex/abntexto/abntexto.tex @@ -101,8 +101,8 @@ \clubpenalty=10000 \widowpenalty=10000 -\let\cite=\textcite -\def\bibfont{\bibitemsep=\baselineskip \singlesp} + +\def\bibfont{\raggedright \singlesp \bibitemsep=\baselineskip} \makeatother @@ -121,7 +121,7 @@ \par} \vskip3in -{\centering\large\ttfamily 3.1.1-beta\par} +{\centering\large\ttfamily 3.2.0-beta\par} \newpage \nonum\notoc\section{Sumário} @@ -132,22 +132,22 @@ 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.}. +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 \textcite{viaexemplos}, em português, ou \textcite{latex2eunnoficial}, disponível em inglês, espanhol e francês. Além disso, também se pode ler \textcite{texbytopic}, em inglês, para aprender sobre o sistema \TeX. 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: +As normas ABNT as quais o |abntexto| se propõe a seguir seguem listadas: \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 + \item NBR 14724:2011. Informação e documentação --- Trabalhos acadêmicos --- Apresentação \cite{nbr14724}. + \item NBR 12225:2004. Informação e documentação --- Lombada --- Apresentação \cite{nbr12225}. + \item NBR 6028:2021. Informação e documentação --- Resumo --- Apresentação \cite{nbr6028}. + \item NBR 6027:2012. Informação e documentação --- Sumário --- Apresentação \cite{nbr6027}. + \item NBR 10520:2002. Informação e documentação --- Citações em documentos --- Apresentação \cite{nbr10520}. + \item NBR 6023:2018. Informação e documentação --- Referências --- Elaboração \cite{nbr6023}. + \item NBR 5892:2019. Informação e documentação --- Representação e formatos de tempo --- Datas e horas --- Apresentação \cite{nbr5892}. + \item NBR 6024:2012. Informação e documentação --- Numeração progressiva das seções de um documento --- Apresentação \cite{nbr6024}. + \item IBGE. Normas de apresentação tabular \cite{ibge1993}. \end{topics} \section{Chamando a classe} @@ -176,7 +176,7 @@ Digite as linhas em \ref{cd:início} e use |abntexto|. \end{document} \endverb -O arquivo |exemplo.tex|, disponível no CTAN, mostra como elaborar os elementos pré-textuais. +O arquivo |exemplo.tex|, disponível no diretório da classe no CTAN, mostra como elaborar os elementos pré-textuais. \section{Fonte tipográfica} @@ -190,7 +190,24 @@ A limitação do comando |\spacing| é que ele só pode ser usado após um selet 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 na 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. +Existem dois comandos que configuram o \emph{layout} da página: |\pretextual| e |\textual|. O primeiro executa |\onesidelayout| internamente e remove a numeração de página. O comando |\onesidelayout| configura as páginas para impressão de somente um lado do papel (frente). O comando |\pretextual| é executado automaticamente após |\begin{document}| tendo efeito a partir da primeira página, portanto o usuário não precisa inserí-lo no documento, mas pode redefiní-lo conforme a necessidade. O segundo comando é |\textual|. Este executa |\twosidelayout| e habilita a numeração de página. A instrução |\twosidelayout| habilita as páginas para impressão dos dois lados do papel (frente e verso). O comando |\twosidelayout| não precisa ser inserido pelo usuário, pois ele é iniciado automaticamente pelo primeiro comando secional. O primeiro comando secional é, por padrão, |\section|, mas pode ser alterado conforme o uso de |\usechapters| e |\useparts| (Ver \ref{secionamento}). + +Os trabalhos acadêmicos podem ser disponiblizados num repositório \emph{online}. Neste caso, o usuário pode querer reconfigurar as margens de forma a se ter uma leitura mais confortável em dispositivos eletrônicos. Para isto, existem duas possibilidades. A primeira é, no preâmbulo, redefinir |\pretextual| e |\textual| substituindo as instruções |\onesidelayout| e |\twosidelayout| por |\eletroniclayout|. A segunda possibilidade é, também no preâmbulo, redefinir |\onesidelayout| e |\twosidelayout| diretamente conforme \ref{cod:eletroniclayout}. O comando |\eletroniclayout| centraliza o corpo do texto pondo 2.5\,cm as margens esquerda e direita. + +\legend{code}{\emph{Layout} para dispositivos eletrônicos} +\src\me +\label{cod:eletroniclayout} + +\begverb +\documentclass{abntexto} + +\let\onesidelayout=\eletroniclayout +\let\twosidelayout=\eletroniclayout + +\begin{document} + texto +\end{document} +\endverb \section{Sumário} @@ -217,6 +234,7 @@ Os comandos que configuram a fonte tipográfica das entradas no ToC (Table of Co \endverb \section{Secionamento} +\label{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}. @@ -245,7 +263,78 @@ Também há como alterar o espaço vertical acima e abaixo das seções usando | O usuário pode querer utilizar capítulos no trabalho. O |abntexto| disponibiliza a instrução |\chapter| para capítulos, porém não em conformidade com a Norma, mas no estilo da classe |book|. Para ativá-los é preciso chamar a instrução |\usechapters| no preâmbulo do documento. Também é possível usar |\part| em conjunto com o comando |\useparts|. Este útlimo contém |\usechapters| em sua definição, portanto, ao chamar |\useparts|, você também estará chamando |\usechapters|. -Os níveis secionais |\section|, |\chapter| e |\part| estão sujeitos a |\nonum| que remove a numeração do título e |\notoc| que instrui o título a não ingressar no sumário. +Os níveis secionais |\section|, |\chapter| e |\part| podem ser prefixados com |\nonum| que remove a numeração do título: |\nonum\section|. O títulos não numerados devem ser centralizados como orientado na Norma, portanto |\nonum| centraliza os títulos. Veja um exemplo de uso em \ref{cd:nonum}. + +\legend{code}{Exemplo de título sem numeração} +\src\me +\label{cd:nonum} + +\begverb +\nonum\notoc\section{Resumo} +Texto + +\nonum\notoc\section{Sumário} +\maketoc +\endverb + +Os níveis secionais supracitados também podem ser prefixados com |\notoc| que instrui o título a não ingressar no sumário: |\notoc\section|. Além disso, é possível usar ambos os prefixos ao mesmo tempo, conforme mostrado em \ref{cd:nonum}. + +O primeiro parágrafo após uma seção é indentado por padrão, dispensando, assim, o uso do pacote |indentfirst|. + +Infelizmente, comandos como |\printbibliography|, |\printglossary| e |\printindex| inserem o título internamente. Para que este título seja exibido corretamente no |abntexto|, é necessário usar o ambiente |corrprint|, como demonstrado em \ref{cd:corrprint}. O título aparecerá normalmente no Sumário e, se o pacote |hyperref| estiver carregado, também vai constar na lista de marcadores do visualizador de PDF. + +\legend{code}{Ambiente {\ttfamily corrprint}} +\src\me +\label{cd:corrprint} + +\begverb +\begin{corrprint} + \printbibliography % ou \printglossary, \printindex e semelhantes +\end{corrprint} +\endverb + +Existe a possibilidade de o usuário desejar criar um Índice Remissivo usando o ambiente |theindex| do kernel LaTeX --- embora alternativas automatizadas sejam preferíveis, como a ferramenta |makeindex|, por exemplo. Neste caso, o ambiente |corrprint| funcionará como esperado conforme explicitado em \ref{cd:corrprint-theindex}. De forma semelhante a |theindex|, |corrprint| também pode ser usado em conjunto com |thebibliography|. + +\legend{code}{Ambientes {\ttfamily corrprint} e {{\ttfamily theindex}}} +\src\me +\label{cd:corrprint-theindex} + +\begverb +\begin{corrprint} + \begin{theindex} + \item acorn squash, 1 + \subitem maple baked, 2 + \indexspace + \item bacon, 3 + \subitem maple baked, 4 + \end{theindex} +\end{corrprint} +\endverb + +%\chapter{Lorem} + +%\begin{corrprint} +% \begin{thebibliography}{9} +% \bibitem{latexdps} +% Leslie Lamport. +% \textit{\LaTeX{}: a document preparation system}. +% Addison-Wesley, Reading, Massachusetts, 1993. +% \bibitem{texbook} +% Donald Ervin Knuth. +% \textit{The \TeX book}. +% Addison-Wesley, Reading, Massachusetts, 1983. +% \end{thebibliography} +%\end{corrprint} + +%\begin{corrprint} +% \begin{theindex} +% \item acorn squash, 1 +% \subitem maple baked, 2 +% \indexspace +% \item bacon, 3 +% \subitem maple baked, 4 +% \end{theindex} +%\end{corrprint} \section{Alíneas} @@ -268,7 +357,7 @@ Use o ambiente |topics| para criar alíneas. Ele dispõe de dois níveis sendo q \section{Áreas de legenda} -Use |\place{<obj>}| para inserir áreas de legenda como mostrado em \ref{cd:place}. Mas existem condições: |\place| deve constar em último lugar e |\legend{<tipo de obj>}{<legenda>}| deve preceder |\label|. 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>}|. +Use |\place{<obj>}| para inserir áreas de legenda, |\legend{<tipo de obj>}{<texto>}| para títular e |\src{<texto>}| para inserir a fonte como mostrado em \ref{cd:place}. Mas, existem condições: |\place| deve constar em último lugar e |\legend| deve preceder |\label|. 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} @@ -277,8 +366,9 @@ Use |\place{<obj>}| para inserir áreas de legenda como mostrado em \ref{cd:plac \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 @@ -287,12 +377,11 @@ O leitor pode querer definir uma nova área de legenda usando, por exemplo, a in O |abntexto| também tem suporte nativo para inserção de figuras lado a lado. Elas se comportam como caracteres então podemos usar |\hfil| para centralizá-las. Veja o exemplo no \ref{cd:multiple} e o resultado logo em seguida. -Até o momento, a classe não tem suporte para objetos flutuantes. - \legend{code}{Figuras lado a lado} \src\me \label{cd:multiple} \begverb \legend{figure}{Duas figuras} + \begin{multiplace} \sublegend{figure}{Um título} \src{\texttt{www.site.com.br}. Acesso em 01 jan. 2020.} @@ -308,6 +397,7 @@ Até o momento, a classe não tem suporte para objetos flutuantes. \endverb \legend{figure}{Duas figuras} + \begin{multiplace} \sublegend{figure}{Um título} \src{\texttt{www.site.com.br}. Acesso em 01 jan. 2020.} @@ -321,6 +411,12 @@ Até o momento, a classe não tem suporte para objetos flutuantes. Ver \ref{fig:teste1} e \ref{fig:teste2}. +Há uma legenda principal impressa com |\legend| e duas sublegendas para cada objeto inseridas com |\sublegend|, bem como dois |\subplace's|. Além disso, a ordem das instruções é similar àquela aplicada em |\place|: |\subplace| deve ser posto após |\sublegend|, |\src| e |\label| sendo que |\sublegend| deve preceder |\label|. + +Linhas em branco são proibidas no ambiente |multiplace|. + +Até o momento, esta classe não tem suporte para objetos flutuantes. + \section{Formatação de {\mdseries\ttfamily\textbackslash\lowercase{cite}} e referências} \label{section} @@ -328,9 +424,9 @@ Até o momento o |abntexto| não possui macros para formatação de |\cite| e re \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>}}|. +Pela Norma ABNT, Para inserir aspas duplas em citações diretas, de até três linhas, 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} +\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}). @@ -346,11 +442,21 @@ Com os comandos |\appendix| e |\annex| você pode inserir apêndices e anexos ju \end{document} \endverb -Pode-se alterar a largura dos rótulos das entradas de apêndice/anexo no sumário redefinindo |\appendixlabelwidth|\,/\,|\annexlabelwidth|. +Pode-se alterar a largura dos rótulos das entradas no sumário redefinindo o comando |\appendixlabelwidth|\,/\,|\annexlabelwidth|. + +\section{Limitações e planos para o futuro} + +\begin{topics} + \item No momento não existe suporte para tabelas que se partem entre páginas usando |longtable.sty|. + \item O suporte para objetos flutuantes pode ser implementado, mas não é prioridade, porque não são compatíveis com a Norma. + \item \emph{Hyperlinks} de |\labels's| oriundos de áreas de legenda podem não estar funcionando corretamente. + \item Implementar subitens em listas de figuras e tabelas. + \item Implementar notas gerais e específicas em tabelas. +\end{topics} \newpage -\begin{corrprint}{Referências} +\begin{corrprint} \printbibliography \end{corrprint} @@ -360,6 +466,7 @@ Você pode criar glossários com o pacote |glossaries|, como em \ref{cd:gloss}. \legend{code}{Glossário} \src\me \label{cd:gloss} + \begverb \documentclass{abntexto} @@ -374,8 +481,8 @@ Você pode criar glossários com o pacote |glossaries|, como em \ref{cd:gloss}. \begin{document} O \gls{metalism} e o \gls{lip}. - - \begin{corrprint}{Glossário} + + \begin{corrprint} \printnoidxglossary \end{corrprint} \end{document} @@ -404,7 +511,7 @@ O |glossaries.sty| também serve para criar uma lista de siglas, conforme \ref{c 2ª chamada: \acr{ibge}, \acr{html}. - \begin{corrprint}{Lista de siglas} + \begin{corrprint} \def\acronymname{Lista de siglas} \printnoidxglossary[type=acronym] \end{corrprint} |