summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-02-05 23:41:29 +0000
committerKarl Berry <karl@freefriends.org>2013-02-05 23:41:29 +0000
commit43e8013efcfdb70cd65e67fe1efb27fc1307e106 (patch)
treed9885635a41a19edc1b4eacc358240871403705b /Master/texmf-dist/doc/latex/abntex2/abntex2.tex
parente9a0efc06e926644568e9975bdc6c46044423d36 (diff)
abntex2 (5feb13)
git-svn-id: svn://tug.org/texlive/trunk@29038 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/abntex2/abntex2.tex')
-rw-r--r--Master/texmf-dist/doc/latex/abntex2/abntex2.tex186
1 files changed, 127 insertions, 59 deletions
diff --git a/Master/texmf-dist/doc/latex/abntex2/abntex2.tex b/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
index fce743d5228..837cf7b70a7 100644
--- a/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
+++ b/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
@@ -1,4 +1,4 @@
-%% abtex2.tex, v-1.3 laurocesar
+%% abtex2.tex, v-1.4 laurocesar
%% Copyright 2012-2013 by abnTeX2 group at http://code.google.com/p/abntex2/
%%
%% This work may be distributed and/or modified under the
@@ -17,6 +17,19 @@
%%
%% This work consists of the file abntex2.tex
%%
+%% 2013.2.2 15h0 laurocesar
+%% Adiciona subseções referentes às macros \partanexos e \partapendices
+%%
+%% 2013.2.2 15h0 laurocesar
+%% Adiciona subseções referentes às opções de documentclass.
+%% Adiciona seção referente à codificação UTF8 do documento.
+%%
+%% 2013.1.22 08h31 laurocesar
+%% Adiciona referências a enumitem em Alíneas e Sunalineas
+%%
+%% 2013.1.19 08h03 laurocesar
+%% Revisão do documento
+%%
%% 2013.1.17 19h18 laurocesar
%% Adiciona seção explicativa sobre as fontes.
%% Adiciona \bfseries nos exemplos de capa, folha de rosto e folha de aprovacao
@@ -69,7 +82,7 @@
% COMANDOS PROPRIOS
\newcommand{\abnTeX}{abn\TeX}
\newcommand{\abnTeXForum}{\url{http://groups.google.com/group/abntex2}}
-\newcommand{\abnTeXSite}{\url{http://code.google.com/p/abntex2/}}
+\newcommand{\abnTeXSite}{\url{http://abntex2.googlecode.com/}}
\title{\textbf{A classe \textsf{abntex2}}: \\ \Large{Documentos
@@ -84,7 +97,7 @@ técnicos e científicos brasileiros \\compatíveis com as normas ABNT}}
\and
Lauro César Araujo\\\url{laurocesar@laurocesar.com}}
-\date{\today, v-1.3}
+\date{\today, v-1.4}
\hypersetup{
pdftitle={A classe abntex2},
@@ -254,17 +267,21 @@ diretor do Centro de Pesquisa em Arquitetura da Informação
realizar um \textit{workshop} de \LaTeX\ no âmbito do Terceiro Colóquio de
Arquitetura da Informação promovido pelo CPAI. Durante as apresentações, os
problemas com instalação e distribuição do \abnTeX\ original e as falhas
-normativas em relação às normas vigentes da ABNT foram motivadores adicionais
-para que o novo projeto \abnTeX2 se tornasse urgente.
-Coordenado por Lauro César, o novo projeto, foi iniciado oficialmente em maio de
-2012, com o apoio dos integrantes do grupo \abnTeXForum\ e pelo CPAI. A ideia
-de Gerald e o software já construído do \abnTeX\ original serviriam de ponto de
-partida para o \abnTeX2.
-
+normativas em relação às normas vigentes da ABNT -- uma vez que tinham se
+passado quase 10 anos desde a criação do \abnTeX -- foram motivadores adicionais
+para que o novo projeto \abnTeX2 se tornasse urgente. Então, coordenado por
+Lauro César, o novo projeto, foi iniciado oficialmente em maio de 2012, com o
+apoio dos integrantes do grupo \abnTeXForum. A ideia de Gerald e o
+software já construído do \abnTeX\ original serviriam de ponto de partida para
+o \abnTeX2.
A primeira versão do \abnTeX2 foi concluída em dezembro de 2012 e
disponibilizada ao público em janeiro de 2013. O portal do projeto atual é
-\abnTeXSite.
+\abnTeXSite. O \abnTeX2 foi disponibilizado ao CTAN, \emph{The Comprehensive TEX
+Archive Network}, em 2 de janeiro de 2013 e pode ser consultado em
+\url{http://www.ctan.org/pkg/abntex2}. As principais distribuições
+\LaTeX\footnote{Como TeX Live, MiKTeX, MacTeX e proTeXt} são construídas à
+partir de pacotes e classes do CTAN.
O software é mantido desde então pela comunidade de indivíduos e de
organizações que adotam e/ou investem em software livre.
@@ -278,41 +295,47 @@ organizações que adotam e/ou investem em software livre.
\subsection{O que o \abnTeX2 traz de novo em relação ao \abnTeX1?}
-A suíte \abnTeX2 é composta por três elementos principais\footnote{Somam-se a
-esses elementos a documentação e os Modelos canônicos
-\cite{abntex2modelo,abntex2modelo-artigo,abntex2modelo-relatorio}, todos distribuídos de forma
-conjunta.}:
+A suíte \abnTeX2 é composta por quatro elementos principais\footnote{Somam-se a
+esses elementos a documentação da classe e do pacote citação.}:
\begin{itemize}
\item a classe de formação de trabalhos acadêmicos \textsf{abntex2}, descrita
neste manual;
\item o pacote de citações bibliográficas \textsf{abntex2cite}; e
\item as especificações de formatação de referências bibliográficas
- |abntex2-num.bst| e |abntex2-alf.sty|.
+ |abntex2-num.bst| e |abntex2-alf.sty|;
+ \item os modelos canônicos de uso do \abnTeX2;
+\cite{abntex2modelo,abntex2modelo-artigo,abntex2modelo-relatorio,abntex2modelo-projeto-pesquisa}
\end{itemize}
-Esta versão do \abnTeX2 fornece uma classe para produção de trabalhos acadêmicos
-completamente nova em relação à utilizada pelo projeto anterior. A classe
-anterior, chamada \textsf{abnt}, não está mais disponível e não é distribuída
-nesta versão.
+Esta versão do \abnTeX2 fornece uma classe para produção de um vasto número de
+documentos técnicos e científicos, como trabalhos acadêmicos, artigos científicos,
+relatórios técnicos, projetos de pesquisa e outros do gênero. A classe utilizada
+por este projeto é completamente nova em relação à utilizada pelo projeto
+anterior, que não tinha a intenção de produzir um número menor de documentos.
+A classe anterior, chamada \textsf{abnt}, não está mais disponível e não é
+distribuída nesta versão.
Já o pacote de citações bibliográficas e as especificações de formatação de
referências bibliográficas são quase que uma cópia da versão anterior. Por
enquanto apenas algumas novas funcionalidades foram incluídas, como a
possibilidade de uso do pacote \textsf{backref} (\autoref{sec-referencias}) e
-outros pequenos aperfeiçoamentos. Para referências ao pacote de citações
-\textsf{abntex2cite}, inclusive sobre conformidade com as normas, consulte
+outros aperfeiçoamentos e correções de erros. Para referência ao pacote de
+citações \textsf{abntex2cite}, inclusive sobre conformidade com as normas, consulte
\citeonline{abntex2cite} e \citeonline{abntex2cite-alf}.
+Os modelos canônicos não estavam presentes no abnTeX original. Eles são exemplos
+de uso do \abnTeX2 e são distribuídos junto com a instalação padrão.
+
\subsection{Compatibilidade entre as versões 1 e 2 do \abnTeX}
As duas versões do \abnTeX\ são compatíveis entre si, ou seja, não há
-incompatibilidade mútua entre elas de tal modo que você pode ter as duas
-versões do \abnTeX\ instaladas simultaneamente no mesmo computador. Desse modo, documentos
-escritos com a versão anterior do \abnTeX\ continuarão a serem compilados com a
-classe e os pacotes anteriores. Apenas documentos escritos conforme este manual
-utilizarão a nova classe e os novos pacotes de citação e formatação de
-referências bibliográficas.
+incompatibilidade mútua entre elas de tal modo que você pode ter as duas versões
+do \abnTeX\ instaladas simultaneamente no mesmo computador. Desse modo,
+documentos escritos com a versão anterior do \abnTeX\ continuarão a serem
+compilados com a classe e os pacotes anteriores. Apenas documentos escritos
+conforme este manual utilizarão a nova classe e os novos pacotes de citação e
+formatação de referências bibliográficas.
Com base neste manual você provavelmente não terá dificuldades em converter os
trabalhos escritos em \abnTeX1 para o novo \abnTeX2.
@@ -329,18 +352,20 @@ License''\footnote{\url{http://www.latex-project.org/lppl.txt}}.
Encorajamos que customizações específicas para universidades sejam realizadas
--- como capas, folha de aprovação, etc. Porém, recomendamos que ao invés de se
-alterar diretamente os arquivos do \abnTeX2, distribua-se aos estudantes
-arquivos com as respectivas customizações. Isso permite que futuras versões do
-\abnTeX2 não se tornem automaticamente incompatíveis com as customizações
-promovidas.
+alterar diretamente os arquivos do \abnTeX2, distribua-se arquivos com as
+respectivas customizações. Isso permite que futuras versões do \abnTeX2 não se
+tornem automaticamente incompatíveis com as customizações promovidas.
% ------
-\section{Estrutura de trabalhos acadêmicos brasileiros}\label{sec-estrutura}
+\section{Estrutura geral de documentos técnicos e científicos brasileiros}\label{sec-estrutura}
% ------
A seção 4 da ABNT NBR 14724:2011 estabelece que a estrutura de trabalhos
acadêmicos compreende duas partes: a externa e a interna, que aparecem no texto
-na seguinte ordem:
+na ordem que segue. Essa norma pode ser considerada uma norma geral de estrutura
+de documentos técnicos e científicos porque compartilha com as demais uma
+estrutura comum. Os demais parágrafos desta seção descrevem as semelhanças e
+diferenças entre as outras normas.
\begin{description}
\item[Parte externa]\ \\
@@ -414,12 +439,24 @@ de artigo científico elaborado com a classe \textsf{abntex2}.
\section{Configurações gerais}\label{sec-configgerais}
% ------
+% ---
+\subsection{Codificação dos arquivos: UTF8}
+% ---
+
+A codificação de todos os arquivos do \abnTeX2 é \texttt{UTF8}. É necessário que
+você utilize a mesma codificação nos documentos que escrever, inclusive nos
+arquivos de base bibliográficas |.bib|.
+
+% ---
+\subsection{A classe \textsf{abntex} como extensão de \textsf{memoir}}
+% ---
+
\DescribeMacro{\documentclass}
A classe \textsf{abntex2} foi criada como um conjunto de configurações da classe
-\textsf{memoir}\footnote{A versão anterior do \abnTeX~era baseada na
-classe \textsf{report}.}. Desse modo, todas as opções do \textsf{memoir} estão
-disponíveis, como por exemplo, |12pt,openright,twoside,a4paper,artile|. Consulte
-o manual do \textsf{memoir} para outras opções.
+\textsf{memoir}\footnote{A versão anterior do \abnTeX~era baseada na classe
+\textsf{report}.} \cite{memoir}. Desse modo, todas as opções do \textsf{memoir}
+estão disponíveis, como por exemplo, |12pt,openright,twoside,a4paper,article|.
+Consulte o manual do \textsf{memoir} para outras opções.
As opções mais comuns de inicialização do texto do trabalho são:
@@ -427,10 +464,27 @@ As opções mais comuns de inicialização do texto do trabalho são:
\documentclass[12pt,openright,twoside,a4paper]{abntex2}
\end{verbatim}
+% ---
+\subsubsection{O tamanho do papel}
+% ---
+
+O tamanho do papel pode ser alterado modificando a opção |a4paper| para
+|a5paper|, por exemplo. Porém, o tamanho definido pela ABNT NBR 14724:2011 é A4.
+A lista completa de opções disponíveis pode ser consultada em
+\citeonline[p.~1]{memoir}.
+
+% ---
+\subsubsection{Impressão em anverso e verso}
+% ---
+
É interessante observar que a ABNT NBR 14724:2011 (seção 5.1) recomenda que os
trabalhos sejam impressos no anverso e no verso das folhas. Isso é obtido com a
opção |twoside|.
+% ---
+\subsubsection{Opção \texttt{article}}
+% ---
+
\DescribeMacro{article}\DescribeMacro{\counterwithout}
A opção |article| é útil para produção de artigos com \abnTeX2.
Nesse caso, a maioria dos elementos pré-textuais descritos na
@@ -450,25 +504,32 @@ corretamente sequenciados:
\counterwithout{table}{chapter}
\end{verbatim}
-A macro |\part| também é permitida em |article|
+A macro |\part| também é permitida em |article|.
-\DescribeMacro{\ABNTEXfontereduzida}\DescribeMacro{\footnotesize}
+% ---
+\subsubsection{As opções de tamanho de fonte e o tamanho ``menor e uniforme''}
+% ---
+
+\DescribeMacro{\ABNTEXfontereduzida}\DescribeMacro{\footnotesize}\DescribeEnv{12pt}
A seção 5.1 da ABNT NBR 14724:2011 também estabelece que o tamanho fonte seja 12
para todo o trabalho (obtida com a opção |12pt|), ``inclusive capa,
excetuando-se citações com mais de três linhas, notas de rodapé, paginação,
dados internacionais de catalogação-na-publicação, legendas e fontes das
-ilustrações e das tabelas, que devem ser em tamanho menor e uniforme''. O
-tamanho ``menor e uniforme'' para citações com mais de três linhas, paginação e
-dados internacionais de catalogação-na-pulicação é estabelecido pela macro
-|\ABNTEXfontereduzida| e o valor padrão utilizado é o mesmo da macro
-|\footnotesize|. Os demais elementos são controlados diretamente pela macro
-|\footnotesize|. Você pode alterar o valor de |\ABNTEXfontereduzida| para
-|\small|, por exemplo, com o seguinte comando:
+ilustrações e das tabelas, que devem ser em tamanho menor e uniforme''. O
+tamanho ``menor e uniforme'' é estabelecido pela macro |\ABNTEXfontereduzida| e
+o valor padrão utilizado é o mesmo da macro |\footnotesize|. Você pode alterar o
+valor de |\ABNTEXfontereduzida| para |\small|, por exemplo, com o seguinte
+comando:
\begin{verbatim}
\renewcommand{\footnotesize}{\small}
\end{verbatim}
+Caso deseje utilizar outro tamanho de fonte para o documento, substitua a opção
+|12pt| pelo tamanho desejado, como por exemplo, |10pt|, ou |14pt|. A lista
+completa de opções disponíveis pode ser consultada em
+\citeonline[p.~2-3]{memoir}.
+
% ---
\subsection{Espaçamentos entre parágrafos e linhas}
% ---
@@ -591,12 +652,12 @@ para numeração por capítulos, por exemplo, use:
\subsection{Índice do PDF com pacote \textsf{bookmark}}\label{sec-bookmark}
% ---
-O índice da estrutura do documento é automaticamente inserida no PDF final do
+O índice da estrutura do documento é automaticamente inserido no PDF final do
documento por meio do pacote
\textsf{bookmark}\footnote{\url{http://www.ctan.org/pkg/bookmark}}. Neste
documento este índice será identificado como ``\textsf{bookmark} do PDF''.
-Com excessão da Ficha catalográfica (\autoref{sec-fichacatalografica}), todos os
+Com exceção da Ficha catalográfica (\autoref{sec-fichacatalografica}), todos os
elementos pré-textuais descritos na \autoref{sec-pretextuais} e as divisões dos
documentos, como |\part|, |\chapter|, |\section|, etc., são automaticamente
inseridos tanto no Sumário (\autoref{sec-sumario}) quanto no \textsf{bookmark}
@@ -639,6 +700,9 @@ criar capítulos sem numeração, que não aparecem no Sumário, mas que são
automaticamente adicionados ao \textsf{bookmark} do PDF e alteram o cabeçalho
da página. Consulte a \autoref{sec-formatacaocapitulos} para mais detalhes.
+Informações adicionais sobre configuração dos \textsf{bookmarks} podem ser
+obtidas em \citeonline{oberdiek2011}.
+
% ---
\subsection{Fontes de texto}
% ---
@@ -1765,6 +1829,10 @@ subalínea, caso em que devem ser finalizadas com dois pontos (:); a segunda e a
seguintes linhas do texto da alínea começa sob a primeira letra do texto da
própria alínea.
+Os ambientes descritos nesta seção são criados com o pacote \textsf{enumitem}.
+Consulte a documentação do pacote em \citeonline{enumitem} para obter detalhes e
+opções adicionais de configuração.
+
\DescribeEnv{alineas}
A classe \textsf{abntex2} fornece o ambiente |alineas|, que cria listas conforme
o padrão estipulado pela norma. Veja o exemplo:
@@ -1960,11 +2028,11 @@ Os apêndices devem ser iniciados com a macro |\chapter|\marg{nome do apêndice}
que imprime o nome do apêndice precedido do conteúdo da macro |\apendicename|,
cujo conteúdo padrão é |AP\^ENDICE|.
-\DescribeMacro{\apendicesname}\DescribeMacro{\appendixpage}
-No contexto dos apêndices, a macro |\appendixpage| imprime o conteúdo da macro
-|\apendicesname| como se fosse uma divisão de partes obtida com |\part| não
-numerada. A variante |\appendixpage*| não inclui divisão no Sumário nem no
-\textsf{bookmark} do PDF.
+\DescribeMacro{\apendicesname}\DescribeMacro{\partpage}\DescribeMacro{\partapendices}
+No contexto dos apêndices, a macro |\partpage| e seu sinônimo |\partapendices|
+imprimem o conteúdo da macro |\apendicesname| como se fosse uma divisão de
+partes obtida com |\part| não numerada. A variante |\partapendices*| não inclui
+divisão no Sumário nem no \textsf{bookmark} do PDF.
% ---
\subsection{Anexos (opcional)}
@@ -1981,11 +2049,11 @@ Os anexos devem ser iniciados com a macro |\chapter|\marg{nome do anexo},
que imprime o nome do anexo precedido do conteúdo da macro |\anexoname|, cujo
conteúdo padrão é |ANEXO|.
-\DescribeMacro{\anexosname}\DescribeMacro{\appendixpage}
-No contexto dos anexos, a macro |\appendixpage| imprime o conteúdo da macro
-|\apendicesname| como se fosse uma divisão de partes obtida com |\part| não
-numerada. A variante |\appendixpage*| não inclui a divisão no Sumário nem no
-\textsf{bookmark} do PDF.
+\DescribeMacro{\anexosname}\DescribeMacro{\partpage}\DescribeMacro{\partanexos}
+No contexto dos anexos, a macro |\partpage| e seu sinônimo |\partanexos|
+imprimem o conteúdo da macro |\anexosname| como se fosse uma divisão de partes
+obtida com |\part| não numerada. A variante |\anexosname*| não inclui a divisão
+no Sumário nem no \textsf{bookmark} do PDF.
% ---
\subsection{Índice (opcional)}