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.tex205
1 files changed, 146 insertions, 59 deletions
diff --git a/Master/texmf-dist/doc/latex/abntex2/abntex2.tex b/Master/texmf-dist/doc/latex/abntex2/abntex2.tex
index 837cf7b70a7..05ab1c72f08 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.4 laurocesar
+%% abtex2.tex, v-1.5 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,20 @@
%%
%% This work consists of the file abntex2.tex
%%
+%% 2013.2.23 13h48 laurocesar
+%% Adiciona lista de siglas e abreviaturas e lista de símbolos
+%%
+%% 2013.2.17 11h09 laurocesar
+%% Inclui informações sobre hifenização em diferentes idiomas na seção sobre
+%% o pacote babel e na seção referente aos resumos.
+%%
+%% 2013.2.6 22h35 laurocesar
+%% Inclui informação de compatibilidade com a versão 2002 da ABNT NBR 6023 e
+%% informação de que os manuais do cite estão desatualizados.
+%% Corrige erro na instrução referente \partanexos* (estava \partname*)
+%% Remove \vspace*{1cm} na parte superior dos exemplos de capa, folha de
+%% rosto e folha de aprovação
+%%
%% 2013.2.2 15h0 laurocesar
%% Adiciona subseções referentes às macros \partanexos e \partapendices
%%
@@ -97,7 +111,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.4}
+\date{\today, v-1.5}
\hypersetup{
pdftitle={A classe abntex2},
@@ -200,12 +214,14 @@ O \abnTeX2 foi desenvolvido com base nos requisitos das seguintes normas ABNT:
\begin{description}
\item[ABNT NBR 6022:2003] Informação e documentação - Artigo em publicação
periódica científica impressa - Apresentação
- \item[ABNT NBR 6023:2000] Informação e documentação - Referência -
- Elaboração\footnote{A versão corrente da ABNT NBR 6023 é a 6023:2002. Porém,
- até este momento, o \abnTeX2 traz os estilos compatíveis com a versão
- anterior da norma. A atualização dos estilos é uma das etapas posteriores do
- projeto. Consulte \citeonline{abntex2cite} e \citeonline{abntex2cite-alf}
- para mais informações.}
+ \item[ABNT NBR 6023:2002] Informação e documentação - Referência -
+ Elaboração\footnote{ O abnTeX2 é compatível com a versão corrente da norma
+ ABNT NBR 6023:2002. Porém, até este momento, os manuais
+ \citeonline{abntex2cite} e \citeonline{abntex2cite-alf} estão atualizados com
+ informações referentes à versão anterior da referida norma, ou seja, com
+ informações sobre a versão 2000. A atualização do manual é uma das atividades
+ em execução do projeto. Consulte
+ \url{https://code.google.com/p/abntex2/issues/list} para outras informações.}
\item[ABNT NBR 6024:2012] Informação e documentação - Numeração
progressiva das seções de um documento - Apresentação
\item[ABNT NBR 6027:2003] Informação e documentação - Sumário -
@@ -317,12 +333,14 @@ 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 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}.
+referências bibliográficas são uma evolução da versão anterior. Novas
+funcionalidades foram incluídas, como a possibilidade de uso do pacote
+\textsf{backref} (\autoref{sec-referencias}), compatibilidade com o
+\textsf{beamer}\footnote{\url{http://www.ctan.org/pkg/beamer}}, entre outros
+aperfeiçoamentos e ajustes de conformidade com a versão 2002 da ABNT NBR 6023.
+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.
@@ -406,9 +424,8 @@ diferenças entre as outras normas.
\end{description}
O \abnTeX2 apresenta instrumentos para produzir todas as partes do documento,
-exceto a Lombada, a Lista de Símbolos e o Glossário, que podem ser produzidos
-por outros pacotes adicionais. As seções seguintes descrevem como cada seção
-pode ser produzida.
+exceto a Lombada e o Glossário, que podem ser produzidos por outros pacotes
+adicionais. As seções seguintes descrevem como cada seção pode ser produzida.
A norma ABNT NBR 10719:2011 \emph{Informação e documentação - Relatório técnico
e-ou científico - Apresentação} apresenta basicamente a mesma estrutura que a
@@ -599,13 +616,48 @@ e podem ser alteradas do seguinte modo:
\end{verbatim}
% ---
-\subsection{Alterações no pacote \textsf{babel}}
+\subsection{Hifenização e alterações no pacote \textsf{babel}}
+\label{babel}
% ---
-Algumas alterações foram realizadas nos nomes padronizados pelo pacote
-\textsf{babel}\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/required/babel/}}
-para atender a requisitos da ABNT NBR 14724:2011, conforme \autoref{tab-babel}.
+Para usar as diferentes hifenizações, inclua nas opções do documento o nome dos
+idiomas que o texto contém. Por exemplo:
+
+\begin{verbatim}
+ \documentclass[12pt,openright,twoside,a4paper,english,french,spanish]{abntex2}
+\end{verbatim}
+
+O idioma português-brasileiro (\texttt{brazil}) é incluído por padrão pela
+classe \textsf{abntex2} e não precisa ser informado.
+
+A lista completa de idiomas suportados, bem como outras opções de hifenização,
+estão disponíveis na documentação do pacote
+\textsf{babel}\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/required/babel/}} \citeonline[p.~5-6]{babel}.
+
+\DescribeMacro{\foreignlanguage}
+A macro |\foreignlanguage|\marg{idioma}\marg{texto a ser inserido} insere um
+texto com a hifenização do idioma informado em \marg{idioma}.
+\DescribeEnv{otherlanguage}\DescribeEnv{otherlanguage*}
+O ambiente |otherlanguage*|\marg{idioma} pode ser usado para o mesmo propósito
+da macro |\foreignlanguage|. A versão com * indica que apenas o esquema de hifenização do
+idioma selecionado deve ser utilizado. Nesse caso, as demais configurações de
+idiomas, como nome da Lista de figuras, rótulos das seções, entre outros, não
+são alterados. Exemplo de uso:
+
+\begin{verbatim}
+ \begin{otherlanguage*}{french}
+ Texte en français.
+ \end{otherlanguage*}
+\end{verbatim}
+
+\DescribeMacro{\selectlanguage}
+A macro |\selectlanguage|\marg{idioma} altera o idioma padrão do documento a
+partir do ponto em que é informado.
+
+Algumas alterações foram realizadas nos nomes padronizados pelo pacote
+\textsf{babel} para atender a requisitos da ABNT NBR 14724:2011, conforme
+\autoref{tab-babel}.
\begin{table}[htb]
\caption{Alterações no pacote \textsf{babel}}
@@ -991,7 +1043,6 @@ com base no ambiente |capa|, conforme o exemplo:
\renewcommand{\imprimircapa}{%
\begin{capa}%
\center
- \vspace*{1cm}
{\ABNTEXchapterfont\large\imprimirautor}
\vspace*{\fill}
@@ -1039,7 +1090,6 @@ reescreva a macro |\folhaderostocontent|, conforme o exemplo:
\newcommand{\folhaderostocontent}{
\begin{center}
- \vspace*{1cm}
{\ABNTEXchapterfont\large\imprimirautor}
\vspace*{\fill}\vspace*{\fill}
@@ -1207,7 +1257,6 @@ aprovação final do trabalho:
\begin{folhadeaprovacao}
\begin{center}
- \vspace*{1cm}
{\ABNTEXchapterfont\large\imprimirautor}
\vspace*{\fill}\vspace*{\fill}
@@ -1351,7 +1400,7 @@ orientação da ABNT NBR 6028. Os elementos podem ser criados por meio do ambien
O valor do parâmetro opcional é utilizado como entrada no \textsf{bookmark} do
PDF (\autoref{sec-bookmark}) e como título do resumo. Caso o parâmetro não seja
informado, o conteúdo de |\resumoname| é utilizado. O parâmetro opcional é útil
-para criação de resumos em diversos idiomas estrangeiros.
+para criação de resumos em diversos idiomas estrangeiros.
Exemplos de uso do ambiente são:
@@ -1366,10 +1415,12 @@ Exemplos de uso do ambiente são:
% --- resumo em francês ---
\begin{resumo}[Résumé]
- Il s'agit d'un résumé en français.
- \vspace{\onelineskip}
- \noindent
- \textbf{Mots-clés}: latex. abntex. publication de textes.
+ \begin{otherlanguage*}{french}
+ Il s'agit d'un résumé en français.
+ \vspace{\onelineskip}
+ \noindent
+ \textbf{Mots-clés}: latex. abntex. publication de textes.
+ \end{otherlanguage*}
\end{resumo}
\end{verbatim}
@@ -1397,19 +1448,23 @@ Exemplos de uso do ambiente são:
\vspace{\onelineskip}
\noindent
\textbf{Palavras-chaves}: latex. abntex. editoração de texto.
-\end{resumo}
+\end{resumoumacoluna}
% --- resumo em francês ---
\renewcommand{\resumoname}{Résumé}
\begin{resumoumacoluna}
- Il s'agit d'un résumé en français.
- \vspace{\onelineskip}
- \noindent
- \textbf{Mots-clés}: latex. abntex. publication de textes.
-\end{resumo}
+ \begin{otherlanguage*}{french}
+ Il s'agit d'un résumé en français.
+ \vspace{\onelineskip}
+ \noindent
+ \textbf{Mots-clés}: latex. abntex. publication de textes.
+ \end{otherlanguage*}
+\end{resumoumacoluna}
] fim de opção de twocolumn
\end{verbatim}
+A \autoref{babel} aborda a macro |otherlanguage*|, responsável pela hifenização
+em diferentes idiomas.
% ---
\subsection{Lista de ilustrações (opcional)}\label{sec-listadeilustracoes}
@@ -1467,18 +1522,38 @@ O exemplo seguinte cria a Lista de tabelas e já a adiciona ao
\label{sec-listadeabreviaturas}
% ---
+\DescribeEnv{siglas}
+A Lista de abreviaturas e siglas é um elemento opcional da ABNT NBR 14724:2011,
+seção 4.2.1.11 e pode ser criada com o ambiente |siglas|:
+
+\begin{verbatim}
+ \begin{siglas}
+ \item[Fig.] Area of the $i^{th}$ component
+ \item[456] Isto é um número
+ \item[123] Isto é outro número
+ \item[lauro cesar] este é o meu nome
+ \end{siglas}
+\end{verbatim}
+
+\DescribeMacro{\listadesiglasname}
+A macro |\listadesiglasname| contém o nome da lista de abreviaturas e siglas.
+
\DescribeMacro{\printnomenclature}
-O \abnTeX2 não traz uma implementação própria para a Lista de abreviaturas e
-siglas, elemento opcional da ABNT NBR 14724:2011, seção 4.2.1.11. Um dos motivos
-da não inclusão desse recurso é a existência de diversos pacotes que o fazem,
-cada um com uma característica diferente.
-
-Uma sugestão é usar o pacote
-\textsf{nomencl}\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/contrib/nomencl/}}.
-Com esse pacote, você pode criar a lista de abreviaturas e siglas seguindo o
-exemplo abaixo, que define algumas siglas, imprime um capítulo com o título
-``Lista de abreviaturas e siglas'' e já o insere no \textsf{bookmark} do PDF
-(\autoref{sec-bookmark}):
+Opcionalmente, é possível usar o pacote
+\textsf{nomencl}\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/contrib/nomencl/}},
+que oferece recursos adicionais na composição de lista de siglas, símbolos e até
+glossários. Com esse pacote crie a lista de abreviaturas e siglas
+seguindo o exemplo:
+
+No preâmbulo:
+
+\begin{verbatim}
+ \usepackage{nomencl}
+
+ \makenomenclature
+\end{verbatim}
+
+No corpo do documento:
\begin{verbatim}
\nomenclature{Fig.}{Figura}
@@ -1488,7 +1563,7 @@ exemplo abaixo, que define algumas siglas, imprime um capítulo com o título
\nomenclature{a}{primeira letra do alfabeto}
\nomenclature{lauro}{este é meu nome}
- \renewcommand{\nomname}{Lista de abreviaturas e siglas}
+ \renewcommand{\nomname}{\listadesiglasname}
\pdfbookmark[0]{\nomname}{las}
\printnomenclature
\cleardoublepage
@@ -1501,25 +1576,37 @@ com \textsf{makeindex}:
makeindex ARQUIVO_PRINCIPAL.nlo -s nomencl.ist -o ARQUIVO_PRINCIPAL.nls
\end{verbatim}
-Após essa compilação com \textsf{makeindex}, compile normalmente o documento.
+Após a compilação com \textsf{makeindex}, compile normalmente o documento com
+|pdflatex|.
-Geralmente os editores possuem formas de automatizar essa compilação.
+Geralmente os editores de documentos \LaTeX\ possuem formas de automatizar essa
+compilação. Porém, caso você opte por usar o ambiente |siglas|, nenhuma
+compilação adicional é necessária.
% ---
\subsection{Lista de símbolos (opcional)}\label{sec-listadesimbolos}
% ---
-Assim como o \abnTeX2 não traz uma implementação própria para a Lista de
-abreviaturas e siglas, uma implementação para Lísta de símbolos também não é
-oferecida. A lista de símbolos é um elemento opcional da ABNT NBR 14724:2011,
-seção 4.2.1.12.
+\DescribeEnv{simbolos}
+A lista de símbolos é um elemento opcional da ABNT NBR 14724:2011,
+seção 4.2.1.12 e pode ser criada com o ambiente |simbolos|:
-Um dos motivos da não inclusão desse recurso é a existência de diversos pacotes
-que o fazem, cada um com uma característica diferente.
+\begin{verbatim}
+ \begin{simbolos}
+ \item[$ \Gamma $] Letra grega Gama
+ \item[$ \Lambda $] Lambda
+ \item[$ \zeta $] Letra grega minúscula zeta
+ \item[$ \in $] Pertence
+ \end{simbolos}
+\end{verbatim}
+
+\DescribeMacro{\listadesimbolosname}
+A macro |\listadesimbolosname| o nome da lista de símbolos.
-Como sugestão, consulte o pacote \textsf{glossaries}, que tanto pode construir a
-Lista de símbolos, como Glossários. A \autoref{sec-glossarios} aborda esse
-tema.
+Opcionalmente, use o pacote \textsf{nomencl} ou \textsf{glossaries}, que tanto
+podem construir a Lista de símbolos, como Glossários. Consulte
+\autoref{sec-listadeabreviaturas} e a \autoref{sec-glossarios} para outras
+informações.
% ---
\subsection{Sumário (obrigatório)}\label{sec-sumario}
@@ -2052,7 +2139,7 @@ conteúdo padrão é |ANEXO|.
\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
+obtida com |\part| não numerada. A variante |\partanexos*| não inclui a divisão
no Sumário nem no \textsf{bookmark} do PDF.
% ---