summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/abntex2/abntex2.tex')
-rw-r--r--Master/texmf-dist/doc/latex/abntex2/abntex2.tex188
1 files changed, 152 insertions, 36 deletions
diff --git a/Master/texmf-dist/doc/latex/abntex2/abntex2.tex b/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
index 72fa8b0fd83..ed145b6373c 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.8 laurocesar
+%% abtex2.tex, v-1.9 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,15 @@
%%
%% This work consists of the file abntex2.tex
%%
+%% 2013.10.26 17h45 laurocesar
+%% Atualiza o documento para adicionar a marcro \phantompart
+%%
+%% 2013.10.12 10h47 laurocesar
+%% Adiciona documentação das opções de sumário
+%%
+%% 2013.9.27 19h00 laurocesar
+%% Ajusta exemplos de capa, de folha de rosto e de folha de aprovação
+%%
%% 2013.8.20 8h42 laurocesar
%% Descreve macros \IBGEtab e \legenda e informações do modeo de livro
%%
@@ -140,6 +149,8 @@
\usepackage[utf8]{inputenc} % determina a codificação utiizada (conversão automática dos acentos)
\usepackage{hyperref} % controla a formação do índice
\usepackage{parskip} % espaçamento entre os parágrafos
+\usepackage{microtype} % para melhorias de justificação
+\usepackage{morefloats} % permite mais floats
% Babel e ajustes
@@ -156,6 +167,7 @@
\renewcommand{\subsectionautorefname}{subse{\c c}\~ao}
\renewcommand{\paragraphautorefname}{par\'agrafo}
\renewcommand{\subsubsectionautorefname}{subse{\c c}\~ao}
+ \renewcommand{\paragraphautorefname}{subse{\c c}\~ao}
}
\usepackage{color}
@@ -209,12 +221,11 @@ técnicos e científicos brasileiros \\compatíveis com as normas ABNT}}
% se referete ao \textsf{abntex2} versão \fileversion,
% de \filedate.}
-
-\author{Equipe \abnTeX2\\\abnTeXSite
-\and
-Lauro César Araujo\\\url{laurocesar@laurocesar.com}}
+\author{Lauro César Araujo\\\url{laurocesar@laurocesar.com}
+\and
+Equipe \abnTeX2\\\abnTeXSite}
-\date{\today, v-1.8}
+\date{\today, v-1.9}
\hypersetup{
pdftitle={A classe abntex2},
@@ -617,6 +628,9 @@ As opções mais comuns de inicialização do texto do documento são:
\documentclass[12pt,openright,twoside,a4paper,brazil]{abntex2}
\end{verbatim}
+Veja a \autoref{sec-sumario}, a \autoref{sec-opcoes-tamanho-fonte} e a
+\autoref{sec-opcoes-tamanho-titulo} para outras opções.
+
% ---
\subsubsection{O tamanho do papel}
% ---
@@ -661,6 +675,7 @@ A macro |\part| também é permitida em |article|.
% ---
\subsubsection{As opções de tamanho de fonte e o tamanho ``menor e uniforme''}
+\label{sec-opcoes-tamanho-fonte}
% ---
\DescribeMacro{\ABNTEXfontereduzida}\DescribeMacro{\footnotesize}\DescribeEnv{12pt}
@@ -686,6 +701,7 @@ completa de opções disponíveis pode ser consultada em
% ---
\subsubsection{Opções específicas da classe \textsf{abntex2}: títulos de
divisões em letras maiúsculas}
+\label{sec-opcoes-tamanho-titulo}
% ---
\begin{description}
@@ -695,11 +711,11 @@ Altera para caixa alta (letras maiúsculas) os \emph{títulos} dos
capítulos e o títulos de todos os elementos pré e pós textuais escritos com o
mesmo nível que capítulos.
-\item {\texttt{section=TITLE}, \texttt{section=TITLE},
-\texttt{subsubsection=TITLE}}
+\item {\texttt{section=TITLE}, \texttt{subsection=TITLE},
+\texttt{subsubsection=TITLE}, \texttt{subsubsubsection=TITLE}}
Altera para caixa alta (letras maiúsculas) os \emph{títulos} das seções,
-subseções, subsubseções, respectivamente.
+subseções, subsubseções e subsubsubseções, respectivamente.
\end{description}
Essas opções \emph{não controlam o formato dos items} no sumário, lista de
@@ -714,10 +730,19 @@ Exemplo de uso:
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 em letras maiúsculas
+ subsubsubsection=TITLE, % títulos de subsubsubseções em letras maiúsculas
english,french,spanish,brazil]{abntex2}
\end{verbatim}
% ---
+\subsubsection{Opções específicas da classe \textsf{abntex2}: alternativas de
+sumário}
+% ---
+
+A \autoref{sec-sumario} contém opções adicionais de configuração do sumário.
+
+
+% ---
\subsection{Espaçamentos entre parágrafos e linhas}
% ---
@@ -832,9 +857,9 @@ Para alterar o cabeçalho da página automaticamente com o comando
Para inserir uma divisão com * no sumário, consulte \autoref{sec-sumario}.
\DescribeMacro{\phantomsection}
-A macro |\phantomsection| pode ser útil imediatamente antes de |\pdfbookmark|
+A macro |\phantomsection| pode ser útil imediatamente antes de |\pdfbookmark|,
quando o texto adicionado ao bookmark não estiver próxima a uma divisão do
-documento. Nesse caso, o comando fica assim:
+documento. Nesse caso, o comando deve ser usado assim:
\begin{verbatim}
\phantomsection\pdfbookmark[0]{Capítulo}{texto-qualquer2}
@@ -1058,7 +1083,9 @@ Algumas alterações foram realizadas nos nomes padronizados pelo pacote
\hline
|\subsubsectionautorefname| & ``Subsubseção'' & ``subseção'' \\
\hline
- |\paragraphautorefname| & ``Parágrafo'' & ``parágrafo'' \\
+ |\paragraphautorefname| & ``Parágrafo'' & ``subseção''\footnote{Ver
+ \autoref{sec-sumario}.}
+ \\
\hline
\hline
\end{tabular}
@@ -1130,7 +1157,7 @@ no mamual do pacote \textsf{babel} \cite{babel}:
\renewcommand{\sectionautorefname}{section}
\renewcommand{\subsectionautorefname}{subsection}
\renewcommand{\subsubsectionautorefname}{subsubsection}
- \renewcommand{\paragraphautorefname}{paragraph}
+ \renewcommand{\paragraphautorefname}{subsubsubsection}
}
\end{verbatim}
@@ -1348,6 +1375,43 @@ de alterações realizadas na \autoref{sec-internacional-babel-alteracoes}. As r
a capítulo, parte, figura, tabela e demais não foram alteradas, e serão
impressas com letras maiúsculas.
+% ---
+\subsection{Finalização de partes com \texttt{phantompart}}
+\label{sec-phantompart}
+% ---
+
+\DescribeMacro{\phantompart}
+A classe \textsf{abntex2} fornece a macro |\phantompart|, que
+simula a finalização de uma parte criada com |\part|. A macro automaticamente
+faz com que o próximo capítulo se inicie na raiz do índice do PDF
+(\autoref{sec-bookmark}), e caso a opção |abnt-6027-2012| (\autoref{sec-sumario})
+esteja habilitada, também adiciona ao Sumário (\autoref{sec-sumario}) um espaço
+vertical equivalente ao espaço do início de uma parte. A macro |\phantompart|
+deve ser usada sempre que um novo capítulo não fizer parte do contexto da parte
+em que os capítulos anteriores estavam, mas que não seja o caso de se criar uma
+nova parte para o novo capítulo. Desse modo, não é necessário usar
+|\phantompart| no início de partes subsequentes. Exemplo correto de uso:
+
+\begin{verbatim}
+\phantompart
+
+\chapter*[Conclusão]{Conclusão}
+\addcontentsline{toc}{chapter}{Conclusão}
+
+\phantompart
+\printindex
+\end{verbatim}
+
+Exemplo INCORRETO de uso:
+
+\begin{verbatim}
+\phantompart
+\part{Nova parte em que phantompart foi usado incorretamente}
+\end{verbatim}
+
+A macro |\phantompart| é executado automaticamente em |\postextual|
+(\autoref{sec-postextual}).
+
% ------
\section{Elementos pré-textuais e Parte externa}\label{sec-pretextuais}
% ------
@@ -1393,15 +1457,19 @@ com base no ambiente |capa|, conforme o exemplo:
\renewcommand{\imprimircapa}{%
\begin{capa}%
\center
+ \ABNTEXchapterfont\Large UNIVERSIDADE QUE TORNA OS DOCUMENTOS AINDA MAIS ESTRANHOS
+
+ \vspace*{1cm}
+
{\ABNTEXchapterfont\large\imprimirautor}
- \vspace*{\fill}
- {\ABNTEXchapterfont\bfseries\LARGE\imprimirtitulo}
- \vspace*{\fill}
+ \vfill
+ \ABNTEXchapterfont\bfseries\LARGE\imprimirtitulo
+ \vfill
- {\large\imprimirlocal}
- \par
- {\large\imprimirdata}
+ \large\imprimirlocal
+
+ \large\imprimirdata
\vspace*{1cm}
\end{capa}
@@ -1437,13 +1505,15 @@ reescreva a macro |\folhaderostocontent|, conforme o exemplo:
\begin{verbatim}
\makeatletter
-\newcommand{\folhaderostocontent}{
+\renewcommand{\folhaderostocontent}{
\begin{center}
{\ABNTEXchapterfont\large\imprimirautor}
\vspace*{\fill}\vspace*{\fill}
- {\ABNTEXchapterfont\bfseries\Large\imprimirtitulo}
+ \begin{center}
+ \ABNTEXchapterfont\bfseries\Large\imprimirtitulo
+ \end{center}
\vspace*{\fill}
\abntex@ifnotempty{\imprimirpreambulo}{%
@@ -1611,7 +1681,9 @@ aprovação final do trabalho:
{\ABNTEXchapterfont\large\imprimirautor}
\vspace*{\fill}\vspace*{\fill}
- {\ABNTEXchapterfont\bfseries\Large\imprimirtitulo}
+ \begin{center}
+ \ABNTEXchapterfont\bfseries\Large\imprimirtitulo
+ \end{center}
\vspace*{\fill}
\hspace{.45\textwidth}
@@ -1998,9 +2070,29 @@ informações.
\DescribeMacro{\tableofcontents}
O Sumário é um elemento obrigatório da ABNT NBR 14724:2011, seção
-4.2.1.13, que pode ser criada por meio da macro padrão |\tableofcontents|. O
-sumário deve ser construído conforme a ABNT NBR 6027:2012.
+4.2.1.13, que pode ser criada por meio da macro padrão |\tableofcontents|.
+
+\DescribeMacro{\subsubsubsection}
+Conforme a referida norma, os itens do sumário são numerados até o quinto nível.
+Por isso, adicionou-se ao \abnTeX2 o comando |\subsubsubsection|\marg{divisão de
+quinto nível}.
+\DescribeMacro{sumario=abnt-6027-2012}\DescribeMacro{sumario=tradicional}
+A classe \textsf{abntex2} produz um sumário construído similar ao exemplo
+recomendado pela ABNT NBR 6027:2012. O sumário customizado é ativado
+automaticamente, mas pode ser controlado por meio da opção
+|sumario=| da declação |\documentclass|. Desse modo, a opção
+
+\begin{description}
+ \item[|sumario=abnt-6027-2012|] formata o sumário
+ conforme as recomendações da ABNT NBR 6027:2012. É a opção padrão, de modo que
+ não é necessário informá-la;
+ \item[|sumario=tradicional|] usa o estilo tradicional
+ de sumários do \textsf{memoir}. Recomenda-se que se use esta opção no caso de
+ customizações adicionais do sumário.
+\end{description}
+
+\DescribeMacro{\tableofcontents}\DescribeMacro{\pdfbookmark}
Nem a classe \textsf{memoir}, nem a classe \textsf{abntex2} incluem
automaticamente o capítulo criado pela macro |\tableofcontents| no
\textsf{bookmark} do PDF. Caso deseje que o título do capítulo seja
@@ -2053,6 +2145,15 @@ Sumário. Veja mais informações na \autoref{sec-elementostextuais}.
Consulte a \autoref{sec-bookmark} para obter informações sobre o
\textsf{bookmark}, índice da estrutura do documento no PDF.
+\DescribeMacro{\addtocontents}
+O comando |\addtocontents{toc}{\vspace{\cftbeforepartskip}}| pode ser usado para
+adicionar um espaço vertical no Sumário do mesmo tamanho do espaço usado na
+separação de |\part|. Isso é útil, por exemplo, para indicar no sumário que um
+novo capítulo não faz parte da parte anterior.
+
+Consulte a \autoref{sec-phantompart} para obter informações sobre a macro
+|\phantompart|.
+
\DescribeMacro{KeepFromToc}
O ambiente |KeepFromToc| pode ser utilizada para que um divisão não seja
incluída no Sumário. Esse ambiente é equivalente à macro |\ProximoForaDoSumario|
@@ -2170,6 +2271,7 @@ utilizado por padrão:
\DescribeMacro{\ABNTEXsectionfont}\DescribeMacro{\ABNTEXsectionfontsize}
\DescribeMacro{\ABNTEXsubsectionfont}\DescribeMacro{\ABNTEXsubsectionfontsize}
\DescribeMacro{\ABNTEXsubsubsectionfont}\DescribeMacro{\ABNTEXsubsubsectionfontsize}
+\DescribeMacro{\ABNTEXsubsubsubsectionfont}\DescribeMacro{\ABNTEXsubsubsubsectionfontsize}
As fontes e o tamanho das fontes obtidas com as divisões |\part|\marg{nome da
parte}, |\chapter|\marg{nome do capítulo}, |\section|\marg{nome da seção},
@@ -2210,6 +2312,12 @@ comando |\renewcommand|.
\hline
|\ABNTEXsubsubsectionfontsize| & |\normalsize| \\
\hline
+
+ |\ABNTEXsubsubsubsectionfont| & |\ABNTEXsubsectionfont| \\
+ \hline
+ |\ABNTEXsubsubsubsectionfontsize| & |\normalsize| \\
+ \hline
+
\hline
\end{tabular}
@@ -2456,10 +2564,11 @@ da legenda}, criada para atender requisitos descritos por \citeonline{ibge1993}.
Nome e rótulo devem ser criados com |\caption|\marg{Nome a ser impresso acima do
objeto} e |\label|\marg{Nome do rótulo}, respectivamente. O rótulo é usado por
|\autoref|\marg{Nome do rótulo} para referenciar o elemento criado. O conteúdo
-da tabela pode ser criado com os ambientes |tabular|, |table|, |longtable| ou
-mesmo ser uma figura importada no ambiente |figure|. O conteúdo da legenda pode
-ser criado com a macro |\legend| e |\namedlegend|, padrões do \textsf{memoir},
-ou, preferencialmente, com |\fonte| e |\nota|.
+da tabela pode ser criado com os ambientes |tabular|, |table|, ou
+mesmo ser uma figura importada no ambiente |figure|. O desenvolvimento do
+|\IBGEtab| prevê o uso do |longtable|, mas não funciona com ele ainda.
+O conteúdo da legenda pode ser criado com a macro |\legend| e |\namedlegend|,
+padrões do \textsf{memoir}, ou, preferencialmente, com |\fonte| e |\nota|.
\DescribeMacro{\fonte}
A macro |\fonte|\oarg{Rótulo da fonte. Padrão: ``Fonte''}\marg{Descrição da
@@ -2474,6 +2583,14 @@ descrição} imprime o conteúdo do argumento antecedido da expressão ``Nota:
'', ou do conteúdo do parâmetro opcional, alinhado conforme requisitos do IBGE.
A macro |\nota| pode ser usada no interior de figuras ou de outros ambientes.
+\DescribeMacro{\IBGEtabfontsize}
+O conteúdo do material tabulado usado na macro |\IBGEtab| podem ser globalmente ou
+localmente ajustado através da macro |\IBGEtabfontsize|. A norma diz que o
+conteúdo de tabelas deve ser em fonte reduzida, assim, por padrão, a classe
+faz |\IBGEtabfontsize| como |\ABNTEXfontereduzida|. Para uma adequação às
+normas da instituição este tamanho pode ser modificado via
+|\renewcommand{\IBGEtabfontsize}|\marg{tamanho de fonte desejada}.
+
Desse modo, um exemplo completo de uso das macros |\IBGEtab|, |\fonte| e |\nota|
é:
@@ -2502,18 +2619,17 @@ Desse modo, um exemplo completo de uso das macros |\IBGEtab|, |\fonte| e |\nota|
% ------
-\section{Elementos pós-textuais}
+\section{Elementos pós-textuais}\label{sec-postextual}
% ------
\DescribeMacro{\postextual}\DescribeMacro{\backmatter}
O comando |\postextual| identifica o início dos elementos pós-textuais. Na
-prática não há nenhum comportamento específico, uma vez que as
-normas não prescrevem nenhum requisito para esses elementos. Porém, mesmo
-que para uso futuro, a macro |\postextual| já está criada e recomenda-se que
-seja utilizada. Dessa forma, caso deseje atribuir algum comportamento
-diferenciado aos elementos pós-textuais, faça-o redefinindo a macro. A título de
-coerência, a macro |\backmatter|, padrão do \textsf{memoir}, é reescrita para
-que tenha o mesmo comportamento que |\postextual|.
+prática o único comportamento específico é a execução da macro |\phantompart|
+(\autoref{sec-phantompart}). Dessa forma, caso deseje atribuir algum comportamento
+diferenciado aos elementos pós-textuais, faça-o redefinindo a macro, mas não se
+esqueça de adicionar o comando |\phantompart|. A título de coerência, a macro
+|\backmatter|, padrão do \textsf{memoir}, é reescrita para que tenha o mesmo
+comportamento que |\postextual|.
% ---
\subsection{Referências (obrigatório)}\label{sec-referencias}