diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/fei/fei.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/fei/fei.dtx | 1111 |
1 files changed, 564 insertions, 547 deletions
diff --git a/Master/texmf-dist/source/latex/fei/fei.dtx b/Master/texmf-dist/source/latex/fei/fei.dtx index a125e396bc6..9312214a8a5 100644 --- a/Master/texmf-dist/source/latex/fei/fei.dtx +++ b/Master/texmf-dist/source/latex/fei/fei.dtx @@ -17,14 +17,14 @@ fei is a class created by graduate students and LaTeX enthusiasts that allow stu fei is loosely based in the Brazilian National Standards Organization (Associação Brasileira de Normas Técnicas, ABNT) standards for the creation of academic works, such as ABNT NBR 10520:2002 (Citations) and ABNT NBR 6023:2002 (Bibligraphic References). -In the manual (fei.pdf), users will find detailed information regarding the class commands, environments and best practices to create a an academic text of good quality. We also made available a template file (fei-template.tex) which students may use as a starting point for their texts. +In the manual, users will find detailed information regarding the class commands, environments and best practices to create an academic text of good quality. We also made available a few template files which students may use as a starting point for their texts. ##License Released under the LaTeX Project Public License v1.3c or later See http://www.latex-project.org/lppl.txt ##Latest releases and version control -To get the newest version of fei.cls, as well as to know the change we are doing to the class and its functionalities, visit https://github.com/OpenFEI/Classe-Latex-FEI/. +To get the newest version of the class, as well as to know the changes we are doing to the class and its functionalities, visit https://douglasrizzo.github.io/Classe-Latex-FEI/. %</readme> %<*internal> \fi @@ -49,7 +49,7 @@ See http://www.latex-project.org/lppl.txt \endpreamble \postamble -Copyright (C) 2014 by Douglas De Rizzo Meneghetti <douglasrizzo@fei.edu.br> +Copyright (C) 2015 by Douglas De Rizzo Meneghetti <douglasrizzo@fei.edu.br> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -91,12 +91,11 @@ and the derived files fei.pdf and % \fi % \iffalse %<*driver> -\documentclass[rascunho,xindy,twoside]{\jobname} -\usepackage[utf8]{inputenc} +\documentclass[rascunho,xindy]{\jobname} \usepackage{multicol} \author{Douglas De Rizzo Meneghetti} -\title{Classe \LaTeX\ da FEI para criação de trabalhos acadêmicos} +\title{Classe \LaTeX{} da FEI para criação de trabalhos acadêmicos} \subtitulo{de acordo com o guia de 2015 da biblioteca} % \advisor{Donald Knuth} % \curso{Formatação e Tipografia} @@ -109,7 +108,7 @@ and the derived files fei.pdf and \newacronym{abntex}{abn\TeX}{\textit{Absurd Norms for \TeX}} \newacronym{cqd}{CQD}{como se queria demonstrar} \newacronym{qed}{QED}{\textit{quod erat demonstrandum}} -\newacronym{ctan}{CTAN}{\textit{Comprehensive \TeX\ Archive Network}} +\newacronym{ctan}{CTAN}{\textit{Comprehensive \TeX{} Archive Network}} \newglossaryentry{h}{type=symbols, name={\ensuremath{H}}, sort=h, description={Esquema}} \newglossaryentry{t}{type=symbols, name={\ensuremath{t}}, sort=t, description={Geração}} @@ -128,19 +127,19 @@ and the derived files fei.pdf and \maketitle \begin{folhaderosto} -Classe \LaTeX\ da FEI para criação de trabalhos acadêmicos de acordo com o guia de 2015 da biblioteca +Classe \LaTeX{} da FEI para criação de trabalhos acadêmicos de acordo com o guia de 2015 da biblioteca \end{folhaderosto} \fichacatalografica \folhadeaprovacao \dedicatoria{Esta dedicatória está aqui para que a função de dedicatória seja testada.} \begin{agradecimentos} -Agradecemos a Donald Knuth pela criação do \TeX, a Leslie Lamport pelo \LaTeX\ e a toda a comunidade de desenvolvedores que continua dando suporte e criando pacotes para melhorar a qualidade dos documentos escritos. +Agradecemos a Donald Knuth pela criação do \TeX{}, a Leslie Lamport pelo \LaTeX{} e a toda a comunidade de desenvolvedores que continua dando suporte e criando pacotes para melhorar a qualidade dos documentos escritos. \end{agradecimentos} \epigrafe{A good scientist is a person with original ideas. A good engineer is a person who makes a design that works with as few original ideas as possible. There are no prima donnas in engineering.}{Freeman Dyson \nocite{dyson_disturbing_1979}} \begin{resumo} -O \TeX\ é um sistema de formatação de textos baseado em uma \emph{mark-up language}, criado em 1978 por Donald Knuth e ampliado com uma série de macros por Leslie Lamport, dando à luz o \LaTeX. Utilizado com frequência na área acadêmica, foram criadas classes em \LaTeX\ para satisfazer às regras de formatação dos mais variados órgãos, sociedades, institutos e universidades. Baseada nos padrões da ABNT, a biblioteca da FEI criou seu próprio guia para formatação de trabalhos acadêmicos, o qual originou, extra-oficialmente, a classe \texttt{fei.cls}. Neste guia, os usuários serão guiados no uso dessa classe, desde a criação de elementos pré-textuais (capa, folha de rosto, ficha catalográfica, epígrafe, dedicatória, sumário, listas de figuras, tabelas, algoritmos, siglas e símbolos), passando pelo corpo do texto e elementos pós-textuais (índice remissivo, referências bibliográficas, apêndices e anexos) e terminando com uma explicação referente à instalação dos pré-requisitos e compilação de um trabalho dissertativo com todos os recursos que a classe pode oferecer. -\keywords{\LaTeX. FEI.} +O \TeX{} é um sistema de formatação de textos baseado em uma \emph{mark-up language}, criado em 1978 por Donald Knuth e ampliado com uma série de macros por Leslie Lamport, dando à luz o \LaTeX{}. Utilizado com frequência na área acadêmica, foram criadas classes em \LaTeX{} para satisfazer às regras de formatação dos mais variados órgãos, sociedades, institutos e universidades. Baseada nos padrões da ABNT, a biblioteca da FEI criou seu próprio guia para formatação de trabalhos acadêmicos, o qual originou, extra-oficialmente, a classe \texttt{fei.cls}. Neste guia, os usuários serão guiados no uso dessa classe, desde a criação de elementos pré-textuais (capa, folha de rosto, ficha catalográfica, epígrafe, dedicatória, sumário, listas de figuras, tabelas, algoritmos, siglas e símbolos), passando pelo corpo do texto e elementos pós-textuais (índice remissivo, referências bibliográficas, apêndices e anexos) e terminando com uma explicação referente à instalação dos pré-requisitos e compilação de um trabalho dissertativo com todos os recursos que a classe pode oferecer. +\keywords{\LaTeX{}. FEI.} \end{resumo} \begin{abstract} @@ -157,150 +156,204 @@ Abstract goes here. \chapter{INTRODUÇÃO} -Inspirado nas diversas normas da \index{ABNT}\gls{abnt} para produção de trabalhos acadêmicos, a biblioteca do Centro Universitário da \index{FEI}\gls{fei} criou um guia, cuja última versão data de 2015, o qual dita as regras que os alunos devem seguir na formatação de suas monografias, dissertações e teses. Guiados por este manual (e mais uma dezena de dissertações corrigidas pelas bibliotecárias), nasceu o arquivo \texttt{fei.cls}, uma classe de documentos \LaTeX\ especializada na criação de trabalhos acadêmicos para alunos da \gls{fei}. Com ela, os alunos podem utilizar seus conhecimentos em \LaTeX para criar seus documentos, deixando a formatação complexa do documento a cargo da classe. - -A versão mais recente da classe, assim como este manual, estão disponíveis através do \emph{GitHub} \url{http://openfei.github.io/Classe-Latex-FEI}. O único arquivo necessário é a classe \texttt{fei.cls}, a qual deve ser referenciada pelo arquivo \texttt{tex} do trabalho do aluno. +Inspirado nas diversas normas da \index{ABNT}\gls{abnt} para produção de trabalhos acadêmicos, a biblioteca do Centro Universitário da \index{FEI}\gls{fei} criou um guia, cuja última versão data de 2015, o qual dita as regras que os alunos devem seguir na formatação de suas monografias, dissertações e teses. Guiados por este manual (e mais uma dezena de dissertações corrigidas pelas bibliotecárias), nasceu o arquivo \texttt{fei.cls}, uma classe de documentos \LaTeX{} especializada na criação de trabalhos acadêmicos para alunos da \gls{fei}. Com ela, os alunos podem utilizar seus conhecimentos em \LaTeX{} para criar seus documentos, deixando a formatação complexa do documento a cargo da classe. A escrita da classe que formata o texto foi realizada tendo-se como referência principal o guia disponível pela biblioteca (nesta versão, o guia utilizado desde 2015). Trabalhos corrigidos e reuniões subsequentes com as bibliotecárias também serviram de referencial para refinar algumas funcionalidades da classe, assim como realizar adições não cobertas pelo guia, como algoritmos e teoremas. Para facilitar a escrita do texto final, alguns comandos/ambientes já existentes foram modificados e novos comandos e ambientes foram adicionados. Desta forma, espera-se que o autor tenha menos trabalho com a formatação do texto do que com a escrita do mesmo. -O texto é organizado da seguinte forma: este capítulo termina enumerando os pacotes dos quais a classe depende para formatar o texto; o capítulo \ref{chap:comandos} enumera os comandos e ambientes, tanto novos quanto redefinidos do \LaTeX, necessários para a criação do corpo do trabalho acadêmico; o capítulo \ref{chap:referencia} explica o uso do abn\TeX\ e exemplifica o uso de seus diversos comandos de citação; o capítulo \ref{chap:indice} disserta sobre os programas necessários para a criação do índice remissivo e os comandos utilizados para se indexar termos no decorrer do texto; o capítulo \ref{chap:listas} explica ao autor como criar listas de abreviaturas e símbolos; o capítulo \ref{chap:compilando} ensina a compilar um projeto utilizando a classe \texttt{fei.cls} com todas as suas funcionalidades; o capítulo \ref{chap:instalacao} aponta o autor às principais distribuições de \TeX\ para diferentes sistemas operacionais. O apêndice A explica cada um dos arquivos criados pelo processo de compilação, com o propósito de instruir e exemplificar o uso de um apêndice. Já o apêndice B disponibiliza uma lista dos principais símbolos matemáticos disponíveis no \TeX. +O texto é organizado da seguinte forma: a seção \ref{chap:instalacao} lista os passos para instalação do \LaTeX{}, da classe e de suas dependências nos principais sistemas operacionais; a seção \ref{chap:comandos} enumera os comandos e ambientes, tanto novos quanto redefinidos do \LaTeX{}, necessários para a criação do corpo do trabalho acadêmico; a seção \ref{chap:referencia} explica o uso do abn\TeX{} e exemplifica o uso de seus diversos comandos de citação; o capítulo \ref{chap:indice} disserta sobre os programas necessários para a criação do índice remissivo e os comandos utilizados para se indexar termos no decorrer do texto; a seção \ref{chap:listas} explica ao autor como criar listas de abreviaturas e símbolos; a seção \ref{chap:compilando} ensina a compilar um projeto utilizando a classe \texttt{fei.cls} com todas as suas funcionalidades. O apêndice A explica cada um dos arquivos criados pelo processo de compilação, com o propósito de instruir e exemplificar o uso de um apêndice. Já o apêndice B disponibiliza uma lista dos principais símbolos matemáticos disponíveis no \TeX{}. + +\section{INSTALAÇÃO} \label{chap:instalacao} + +Esta seção guia o leitor na instalação do \LaTeX{}, da classe e dos diferentes pacotes e programas necessários para utilizar todas as funcionalidades dela. + +\subsection{Windows} + +A opção mais simples para instalação do \LaTeX{} no Windows é o aplicativo Mik\TeX{} (\url{http://miktex.org}). Tenha certeza de escolher a opção que permite ao software baixar pacotes em falta do repositório online e, na primeira vez que compilar seu projeto, todos os pacotes serão baixados. Tanto a classe da FEI como todas suas dependências estão disponíveis no Mik\TeX{}. + +Alternativamente, é possível utilizar o gerenciador de pacotes do Mik\TeX{} para selecionar os pacotes a serem baixados. A lista destes pacotes está disponível na seção \ref{sec:dependencias}. + +\subsection{Linux} + +O \LaTeX~é frequentemente disponibilizado para as maiores distribuições Linux por meio de seus gerenciadores de pacotes. No Ubuntu, por exemplo, é necessária a instalação do \TeX{} Live através do \texttt{apt-get}. O usuário pode optar pela instalação completa, através do pacote \texttt{texlive-full}, ou instalar apenas os seguintes pacotes necessários: + +\begin{enumerate} +\item \texttt{texlive}: pacotes essenciais do \TeX{} Live; +\item \texttt{texlive-science}: instala pacotes científicos, como \texttt{algorithm2e} e \texttt{mathtools}; +\item \texttt{texlive-lang-portuguese}: idioma português do \texttt{babel}; +\item \texttt{texlive-publishers}: pacote \texttt{abntex2cite} da \gls{abntex}; +\item \index{xindy@\emph{xindy}}\texttt{xindy}: o indexador \emph{xindy}. +\end{enumerate} + +É necessário enfatizar que a versão do \TeX{} Live disponível nos repositórios do sistema operacional nem sempre é a versão mais recente, a qual pode sempre ser encontrada na página oficial do \TeX{} Live, \url{https://www.tug.org/texlive/}. + +Com a versão mais recente do \TeX{} Live instalada, é possível usar o \textit{\TeX{} Live Manager}, o gerenciador de pacotes do \TeX{} Live, para baixar todos os pacotes necessários, inclusive a classe da FEI, sob o nome \texttt{fei}. + +\subsection{Mac OS} + +No Mac, o \LaTeX{} pode ser instalado através do Mac\TeX{} (\url{http://tug.org/mactex/}), uma compilação completa do \TeX{} Live para Mac. + +O Mac\TeX{} nem sempre possui a versão mais recente dos pacotes do repositório oficial do \TeX{}. Nesse caso, a opção é baixar a classe diretamente do repositório oficial ou da página do projeto no GitHub. + +\subsection{Compilando do código-fonte} + +A classe também pode ser baixada diretamente do GitHub, ou compilada do código-fonte. O repositório do projeto \footnote{\url{http://github.com/douglasrizzo/Classe-Latex-FEI}} possui todos os aruqivos necessários para o procedimento: + +\begin{enumerate} + \item o arquivo-fonte \texttt{fei.dtx}; + \item um Makefile para compilação do arquivo-fonte, através do comando \texttt{make}; + \item a classe \texttt{fei.cls}, pré-compilada. +\end{enumerate} + +O processo de compilação requer que todas as dependências da classe já estejam instaladas. O único arquivo necessário para formatação dos trabalhos acadêmicos é a classe \texttt{fei.cls}, a qual deve ser mantida no mesmo diretório do arquivo \texttt{tex} do trabalho do aluno. + +\section{FONTE ARIAL} + +Por ser uma fonte True Type de autoria da Microsoft, as fontes da família Arial não são disponibilizadas nativamente por distribuições \LaTeX{} como o Mik\TeX{} e o \TeX{} Live. Para utilizá-las, é necessário instalá-las separadamente. As instruções para instalação das fontes estão disponíveis no site do \TeX \emph{Users Group}\footnote{http://tug.org/fonts/getnonfreefonts/}. + +\begin{itemize} +\item Fazer download do script\footnote{http://tug.org/fonts/getnonfreefonts/install-getnonfreefonts}; +\item Instalar o script usando o aplicativo \texttt{texlua}: \verb+texlua install-getnonfreefonts+; +\item Rodar o script: \verb+getnonfreefonts --all+. +\end{itemize} + +Após isso, é necessário utilizar a opção \texttt{arial} na declaração da classe, no início do arquivo \texttt{tex}: \verb+\documentclass[arial]{fei}+. \section{DEPENDÊNCIAS}\label{sec:dependencias} -Toda a formatação foi realizada a partir da importação e configuração de pacotes já existentes e disponíveis nas diversas distribuições de \index{Latex@\LaTeX}\LaTeX\ existentes. Durante o desenvolvimento desta classe, buscou-se utilizar o menor número de pacotes possíveis e sempre os mais comuns de serem encontrados. É necessário enfatizar a necessidade de instalação destes pacotes, listados e descritos mais abaixo, dos quais a classe \texttt{fei.cls} depende para seu funcionamento correto. Estes pacotes estão disponíveis nas distribuições do Mik\TeX\ (para Windows), Mac\TeX\ (para Mac OS) e \TeX\ Live (para Linux e Mac OS). - - \begin{enumerate} - \item\texttt{abntex2cite}: formata citações e referências de acordo com o padrão \index{ABNT}\gls{abnt} 6023; - \item\texttt{algorithm2e}: provê comandos para a escrita de algoritmos; - \item\texttt{amsthm}: possibilita criação de teoremas (e derivados); - \item\texttt{babel}: escolha de línguas (importado pacote para português e inglês); - \item\texttt{caption}: altera a formatação de certas legendas; - \item\texttt{chngcntr}: redefine a numeração dos \emph{floats} -- tabelas, figuras, algoritmos e equações; - \item\texttt{enumitem}: formatação de alíneas; - \item\texttt{fancyhdr}: formatação dos cabeçalhos; - \item\texttt{fontenc}: codificação 8 bits para as fontes de saída do PDF (normalmente, elas têm 7 bits); - \item\texttt{geometry}: mudança do tamanho das margens; - \item\texttt{glossaries}\index{glossaries@\emph{glossaries}}: permite a criação de listas de símbolos e abreviaturas; - \item\texttt{graphicx}: importação e utilização de imagens; - \item\texttt{hyperref}: gera os links entre referências no PDF; - \item\texttt{icomma}: define a vírgula como separador de decimais no ambiente matemático (padrão português brasileiro); - \item\texttt{ifthen}: permite a utilização de condições na geração do texto; - \item\texttt{imakeidx}: permite a criação de um índice remissivo ao fim do texto; - \item\texttt{lmodern}: carrega a família de fontes \emph{Latin Modern}, que possui maior abrangência de caracteres; - \item\texttt{mathtools}: extensões para facilitar a escrita de fórmulas matemáticas (inclui o pacote \texttt{amsmath}); - \item\texttt{morewrites}: permite ao LaTeX escrever em mais de 16 arquivos auxiliares simultaneamente; - \item\texttt{pdfpages}: faz a inclusão de páginas em PDF no documento final; - \item\texttt{setspace}: espaçamento entre linhas aproximado de 1,5 linhas; - \item\texttt{thmtools}: conjunto de macros para o pacote \texttt{amsthm}; - \item\texttt{times}: carrega fonte Times New Roman; - \item\texttt{tocloft}: permite melhor personalização de itens do sumário, lista de figuras e tabelas; - \item\texttt{uarial}: carrega fonte URW Arial. - \end{enumerate} - - Ainda é necessário importar o pacote \texttt{inputenc}, responsável pela codificação dos arquivos \texttt{tex} de entrada (normalmente \texttt{latin1} ou \texttt{utf8}). - - Os scripts de alguns programas \TeX\, como o \texttt{makeglossaries}, são dependentes da linguagem \index{Perl}Perl, a qual vem instalada por padrão em alguns sistemas operacionais. Para os usuários de Windows, no entanto, o Perl deve ser instalado separadamente e pode ser encontrado em \url{https://www.perl.org/}. +Toda a formatação foi realizada a partir da importação e configuração de pacotes já existentes e disponíveis nas diversas distribuições de \index{Latex@\LaTeX}\LaTeX{} existentes. Durante o desenvolvimento desta classe, buscou-se utilizar o menor número de pacotes possíveis e sempre os mais comuns de serem encontrados. É necessário enfatizar a necessidade de instalação destes pacotes, listados e descritos mais abaixo, dos quais a classe \texttt{fei.cls} depende para seu funcionamento correto. Estes pacotes estão disponíveis nas distribuições do Mik\TeX{} (para Windows), Mac\TeX{} (para Mac OS) e \TeX{} Live (para Linux e Mac OS). + +\begin{enumerate} + \item\texttt{abntex2cite}: formata citações e referências de acordo com o padrão \index{ABNT}\gls{abnt} 6023; + \item\texttt{algorithm2e}: provê comandos para a escrita de algoritmos; + \item\texttt{amsthm}: possibilita criação de teoremas (e derivados); + \item\texttt{babel}: escolha de línguas (importado pacote para português e inglês); + \item\texttt{caption}: altera a formatação de certas legendas; + \item\texttt{chngcntr}: redefine a numeração dos \emph{floats} -- tabelas, figuras, algoritmos e equações; + \item\texttt{enumitem}: formatação de alíneas; + \item\texttt{fancyhdr}: formatação dos cabeçalhos; + \item\texttt{fontenc}: codificação 8 bits para as fontes de saída do PDF (normalmente, elas têm 7 bits); + \item\texttt{geometry}: mudança do tamanho das margens; + \item\texttt{glossaries}\index{glossaries@\emph{glossaries}}: permite a criação de listas de símbolos e abreviaturas; + \item\texttt{graphicx}: importação e utilização de imagens; + \item\texttt{hyperref}: gera os links entre referências no PDF; + \item\texttt{icomma}: define a vírgula como separador de decimais no ambiente matemático (padrão português brasileiro); + \item\texttt{ifthen}: permite a utilização de condições na geração do texto; + \item\texttt{imakeidx}: permite a criação de um índice remissivo ao fim do texto; + \item\texttt{lmodern}: carrega a família de fontes \emph{Latin Modern}, que possui maior abrangência de caracteres; + \item\texttt{mathtools}: extensões para facilitar a escrita de fórmulas matemáticas (inclui o pacote \texttt{amsmath}); + \item\texttt{morewrites}: permite ao LaTeX escrever em mais de 16 arquivos auxiliares simultaneamente; + \item\texttt{pdfpages}: faz a inclusão de páginas em PDF no documento final; + \item\texttt{setspace}: espaçamento entre linhas aproximado de 1,5 linhas; + \item\texttt{thmtools}: conjunto de macros para o pacote \texttt{amsthm}; + \item\texttt{times}: carrega fonte Times New Roman; + \item\texttt{tocloft}: permite melhor personalização de itens do sumário, lista de figuras e tabelas; + \item\texttt{uarial}: carrega fonte URW Arial. +\end{enumerate} + +Ainda é necessário importar o pacote \texttt{inputenc}, responsável pela codificação dos arquivos \texttt{tex} de entrada (normalmente \texttt{latin1} ou \texttt{utf8}). + +Os scripts de alguns programas \TeX{}, como o \texttt{makeglossaries}, são dependentes da linguagem \index{Perl}Perl, a qual vem instalada por padrão em alguns sistemas operacionais. Para os usuários de Windows, no entanto, o Perl deve ser instalado separadamente e pode ser encontrado em \url{https://www.perl.org/}. \chapter{COMANDOS E AMBIENTES}\label{chap:comandos} Este capítulo descreve os comandos disponibilizados pela classe. Ele é separado em quatro seções: a seção \ref{sec:preambulo} disserta sobre os comandos a serem utilizados antes do início do texto; a seção \ref{sec:pretexto} auxilia na declaração dos elementos pré-textuais do documento; a seção \ref{sec:texto} descreve a estrutura do texto e outros elementos a serem utilizados durante a produção deste, como \emph{floats}; a seção \ref{sec:postexto} disserta sobre os elementos pós-textuais, a saber, referências, apêndices, anexos e índice remissivo. - - \section{PREÂMBULO}\label{sec:preambulo} - No preâmbulo do texto são declaradas as propriedades globais do documento, como a classe que rege a formatação geral do texto e novos comandos a serem utilizados no decorrer do texto. O preâmbulo da classe \texttt{fei.cls} contém os seguintes elementos que devem ser declarados no preâmbulo: - - \subsection{Declaração da classe} +\section{PREÂMBULO}\label{sec:preambulo} + +No preâmbulo do texto são declaradas as propriedades globais do documento, como a classe que rege a formatação geral do texto e novos comandos a serem utilizados no decorrer do texto. O preâmbulo da classe \texttt{fei.cls} contém os seguintes elementos que devem ser declarados no preâmbulo: + +\subsection{Declaração da classe} A declaração da classe é feita da seguinte forma: \begin{verbatim} \documentclass[opções]{fei} \end{verbatim} - - A classe da FEI pode receber as seguintes opções: - - \begin{enumerate} - \item \texttt{rascunho}: Caso o autor ainda não possua a folha de aprovação e a ficha catalográfica, esta opção insere páginas demarcando o local que estes documentos tomarão; - \item \texttt{xindy}: configura o \index{xindy@\emph{xindy}}\emph{xindy} como programa de indexação a ser utilizado (mais sobre isso no capítulo \ref{chap:indice}); - \item \texttt{sublist}: configura o pacote \texttt{glossaries} para que sub-listas de símbolos sejam usadas. Mais sobre sub-listas na seção \ref{sec:sublist}; - \item \texttt{algo-as-figure}: configura o pacote \texttt{algorithm2e} para que algoritmos sejam listados na lista de ilustrações. Essa configuração é preferível, uma vez que a formatação das legendas e da lista de algoritmos, no presente, não condiz com as recomendações do guia da biblioteca; - % \item \texttt{bacharelado}, \texttt{especializacao}, \texttt{mestrado}, \texttt{doutorado}: realiza as modificações necessárias nos textos das folhas de rosto e de aprovação; - % \item \texttt{male-author}/\texttt{female-author}: esta opção altera o texto de páginas geradas automaticamente para que reflitam o gênero do autor/autora; - % \item \texttt{male-advisor}/\texttt{female-advisor}: esta opção altera o texto de páginas geradas automaticamente para que reflitam o gênero do orientador/orientadora; - \item \texttt{twoside}: a atualização de 2015 do guia da biblioteca recomenda que trabalhos acadêmicos com mais de 100 páginas sejam impressos em formato \index{frente-e-verso}frente-e-verso. Por ser derivada da classe \texttt{report}, a classe da FEI pode receber algumas opções nativas de \texttt{report}. Um exemplo de opção que pode ser útil é \texttt{twoside}, a qual alterna o tamanho das margens direita e esquerda das páginas, assim como a posição da numeração, permitindo realizar uma impressão frente-e-verso de melhor qualidade. Alterações adicionais foram realizadas para que todos os elementos pré-textuais sejam corretamente iniciados nas páginas ímpares, como recomenda o guia e a norma. É importante reparar, contudo, que a utilização de \texttt{twoside} acarreta no aumento do número de páginas, uma vez que os versos de algumas páginas no pré-texto podem ser deixados em branco em prol da norma. - \end{enumerate} - - \subsection{Nome do autor, e título} - - O nome do autor e o título da obra são inseridos utilizando os comandos nativos do \LaTeX\ \verb+\author{autor}+ e \verb+\title{titulo}+. Eles são posteriormente utilizados na criação da capa e folha de rosto do trabalho, formatados sob as normas da biblioteca. Para trabalhos com mais de um autor, os nomes dos autores devem ser separados pelo comando \verb+\and+ ou \verb+\\+, como no exemplo: - + +A classe da FEI pode receber as seguintes opções: + +\begin{enumerate} +\item \texttt{rascunho}: Caso o autor ainda não possua a folha de aprovação e a ficha catalográfica, esta opção insere páginas demarcando o local que estes documentos tomarão; +\item \texttt{xindy}: configura o \index{xindy@\emph{xindy}}\emph{xindy} como programa de indexação a ser utilizado (mais sobre isso no capítulo \ref{chap:indice}); +\item \texttt{sublist}: configura o pacote \texttt{glossaries} para que sub-listas de símbolos sejam usadas. Mais sobre sub-listas na seção \ref{sec:sublist}; +\item \texttt{algo-as-figure}: configura o pacote \texttt{algorithm2e} para que algoritmos sejam listados na lista de ilustrações. Essa configuração é preferível, uma vez que a formatação das legendas e da lista de algoritmos, no presente, não condiz com as recomendações do guia da biblioteca; +% \item \texttt{bacharelado}, \texttt{especializacao}, \texttt{mestrado}, \texttt{doutorado}: realiza as modificações necessárias nos textos das folhas de rosto e de aprovação; +% \item \texttt{male-author}/\texttt{female-author}: esta opção altera o texto de páginas geradas automaticamente para que reflitam o gênero do autor/autora; +% \item \texttt{male-advisor}/\texttt{female-advisor}: esta opção altera o texto de páginas geradas automaticamente para que reflitam o gênero do orientador/orientadora; +\item \texttt{twoside}: a atualização de 2015 do guia da biblioteca recomenda que trabalhos acadêmicos com mais de 100 páginas sejam impressos em formato \index{frente-e-verso}frente-e-verso. Por ser derivada da classe \texttt{report}, a classe da FEI pode receber algumas opções nativas de \texttt{report}. Um exemplo de opção que pode ser útil é \texttt{twoside}, a qual alterna o tamanho das margens direita e esquerda das páginas, assim como a posição da numeração, permitindo realizar uma impressão frente-e-verso de melhor qualidade. Alterações adicionais foram realizadas para que todos os elementos pré-textuais sejam corretamente iniciados nas páginas ímpares, como recomenda o guia e a norma. É importante reparar, contudo, que a utilização de \texttt{twoside} acarreta no aumento do número de páginas, uma vez que os versos de algumas páginas no pré-texto podem ser deixados em branco em prol da norma. +\end{enumerate} + +\subsection{Nome do autor, e título} + +O nome do autor e o título da obra são inseridos utilizando os comandos nativos do \LaTeX{} \verb+\author{autor}+ e \verb+\title{titulo}+. Eles são posteriormente utilizados na criação da capa e folha de rosto do trabalho, formatados sob as normas da biblioteca. Para trabalhos com mais de um autor, os nomes dos autores devem ser separados pelo comando \verb+\and+ ou \verb+\\+, como no exemplo: + \begin{verbatim} \author{Leonardo \and Douglas} \end{verbatim} - \subsection{Subtítulo (opcional)} - - Uma vez que as normas da biblioteca demandam formatações específicas para o título e subtítulo do documento (título em letras maiúsculas na capa, seguido do subtítulo em letras normais, separados por ``:''), foi criado o comando \verb+\subtitulo{}+, o qual recebe o texto referente ao subtítulo do texto. Este comando pode ser usado, preferencialmente, após o comando \verb+\title{}+ no preâmbulo do documento. Título e subtítulo também aparecem na folha de rosto. - - \subsection{Cidade e Instituição (opcionais)} - Os comandos \verb+\cidade{}+ e \verb+\instituicao{}+ recebem os nomes da cidade e instituição de ensino para substituí-los na capa e folha de rosto. São comandos opcionais criados por questão de compatibilidade, ou caso outras instituições queiram usar a classe. Seus valores-padrão são ``São Bernardo do Campo'' e ``Centro Universitário da FEI'', respectivamente. - - \section{PRÉ-TEXTO}\label{sec:pretexto} +\subsection{Subtítulo (opcional)} - O pré-texto do documento engloba todos os elementos textuais que precedem o corpo da obra. A seguir são listados os elementos pré-textuais suportados pela classe \texttt{fei.cls} e os respectivos comandos para a criação de cada um deles. +Uma vez que as normas da biblioteca demandam formatações específicas para o título e subtítulo do documento (título em letras maiúsculas na capa, seguido do subtítulo em letras normais, separados por ``:''), foi criado o comando \verb+\subtitulo{}+, o qual recebe o texto referente ao subtítulo do texto. Este comando pode ser usado, preferencialmente, após o comando \verb+\title{}+ no preâmbulo do documento. Título e subtítulo também aparecem na folha de rosto. - \subsection{Capa} +\subsection{Cidade e Instituição (opcionais)} +Os comandos \verb+\cidade{}+ e \verb+\instituicao{}+ recebem os nomes da cidade e instituição de ensino para substituí-los na capa e folha de rosto. São comandos opcionais criados por questão de compatibilidade, ou caso outras instituições queiram usar a classe. Seus valores-padrão são ``São Bernardo do Campo'' e ``Centro Universitário FEI'', respectivamente. - A capa do trabalho é inserida através do comando \verb+\maketitle+, o qual foi modificado para criar uma página no formato da biblioteca. O comando utiliza o nome fornecido em \verb+\author{}+, o título em \verb+\title{}+, o subtítulo de \verb+\subtitulo{}+ juntamente com o ano corrente para gerar a capa. +\section{PRÉ-TEXTO}\label{sec:pretexto} - \subsection{Folha de rosto} - - A folha de rosto recebe um texto pré-definido, de acordo com o nível do trabalho escrito (monografia, dissertação ou tese). Este texto pode ser encontrado no guia da biblioteca e deve ser colocado dentro do ambiente \texttt{folhaderosto}. Por exemplo, - \begin{verbatim} - \begin{folhaderosto} - Dissertação de Mestrado apresentada ao Centro Universitário - da FEI para obtenção do título de Mestre em Engenharia - Elétrica, orientado pelo Prof. Dr. Nome do Orientador. - \end{folhaderosto} - \end{verbatim} +O pré-texto do documento engloba todos os elementos textuais que precedem o corpo da obra. A seguir são listados os elementos pré-textuais suportados pela classe \texttt{fei.cls} e os respectivos comandos para a criação de cada um deles. + +\subsection{Capa} + +A capa do trabalho é inserida através do comando \verb+\maketitle+, o qual foi modificado para criar uma página no formato da biblioteca. O comando utiliza o nome fornecido em \verb+\author{}+, o título em \verb+\title{}+, o subtítulo de \verb+\subtitulo{}+ juntamente com o ano corrente para gerar a capa. + +\subsection{Folha de rosto} - \subsection{Ficha catalográfica e folha de aprovação} - - Os comandos \verb+\fichacatalografica+ e \verb+\folhadeaprovacao+ inserem, respectivamente, a ficha catalográfica e a folha de aprovação do trabalho no local onde o comando foi chamado. O comando \verb+\folhadeaprovacao+ procura pelo arquivo \texttt{ata.pdf} na pasta raiz do arquivo \texttt{tex} e o insere no documento. O comando \verb+\fichacatalografica+ executa uma função semelhante, procurando pelo arquivo \texttt{ficha.pdf}. - - Caso você ainda não possua estes arquivos, mas queira visualizar o documento com páginas que demarquem a posição das futuras folha de aprovação e ficha catalográfica, é possível compilar o projeto passando a opção \texttt{rascunho} na declaração da classe, da seguinte forma: \verb+\documentclass[rascunho]{fei}+. - - \subsection{Dedicatória} - - O comando \verb+\dedicatoria{}+ recebe um argumento com a dedicatória desejada e o insere na posição especificada pelo guia da biblioteca. Por exemplo: \\ \verb+\dedicatoria{A quem eu quero dedicar o texto}+. - - \subsection{Agradecimentos} - - O ambiente de agradecimentos não possui nenhuma propriedade especial, somente centraliza o título e deixa o texto que se encontra entre seu \texttt{begin} e \texttt{end} na formatação esperada. - -\begin{verbatim} +A folha de rosto recebe um texto pré-definido, de acordo com o nível do trabalho escrito (monografia, dissertação ou tese). Este texto pode ser encontrado no guia da biblioteca e deve ser colocado dentro do ambiente \texttt{folhaderosto}. Por exemplo, +\begin{verbatim} +\begin{folhaderosto} +Dissertação de Mestrado apresentada ao Centro Universitário +da FEI para obtenção do título de Mestre em Engenharia +Elétrica, orientado pelo Prof. Dr. Nome do Orientador. +\end{folhaderosto} +\end{verbatim} + +\subsection{Ficha catalográfica e folha de aprovação} + +Os comandos \verb+\fichacatalografica+ e \verb+\folhadeaprovacao+ inserem, respectivamente, a ficha catalográfica e a folha de aprovação do trabalho no local onde o comando foi chamado. O comando \verb+\folhadeaprovacao+ procura pelo arquivo \texttt{ata.pdf} na pasta raiz do arquivo \texttt{tex} e o insere no documento. O comando \verb+\fichacatalografica+ executa uma função semelhante, procurando pelo arquivo \texttt{ficha.pdf}. + +Caso você ainda não possua estes arquivos, mas queira visualizar o documento com páginas que demarquem a posição das futuras folha de aprovação e ficha catalográfica, é possível compilar o projeto passando a opção \texttt{rascunho} na declaração da classe, da seguinte forma: \verb+\documentclass[rascunho]{fei}+. + +\subsection{Dedicatória} + +O comando \verb+\dedicatoria{}+ recebe um argumento com a dedicatória desejada e o insere na posição especificada pelo guia da biblioteca. Por exemplo: \\ \verb+\dedicatoria{A quem eu quero dedicar o texto}+. + +\subsection{Agradecimentos} + +O ambiente de agradecimentos não possui nenhuma propriedade especial, somente centraliza o título e deixa o texto que se encontra entre seu \texttt{begin} e \texttt{end} na formatação esperada. + +\begin{verbatim} \begin{agradecimentos} A quem se deseja agradecer. \end{agradecimentos} \end{verbatim} - - \subsection{Epígrafe} - A epígrafe possui um formato especial, da mesma forma que a dedicatória. Este comando recebe dois parâmetros, sendo o primeiro a epígrafe e o segundo o autor da mesma. - - \emph{Nota:} O guia da FEI requer que a referência da epígrafe esteja presente no final do trabalho. O comando \verb+\nocite{obra}+ pode ser usado para que a referência apareça ao final do texto, sem aparecer na epígrafe. - - Exemplo: \verb+\epigrafe{Haw-Haw!}{Nelson Muntz \nocite{muntz_book}}+ - - \subsection{Resumo e \emph{abstract}} - - O ambiente \texttt{resumo} é destinado à inserção do resumo em português do trabalho, enquanto o ambiente \texttt{abstract} contém o resumo em inglês. A única diferença entre os dois ambientes está no fato de \texttt{abstract} possuir o comando \verb+\selectlanguage{english}+ no início, enquanto \texttt{resumo} utiliza \verb+\selectlanguage{portuges}+. Palavras-chave podem ser inseridas ao final desses ambientes utilizando, no resumo, o comando \verb+\palavraschave{...}+ e no \emph{abstract}, o comando \verb+\keyword{...}+. Lembrando que as palavras-chave devem ser separadas por ponto final. + +\subsection{Epígrafe} +A epígrafe possui um formato especial, da mesma forma que a dedicatória. Este comando recebe dois parâmetros, sendo o primeiro a epígrafe e o segundo o autor da mesma. + +\emph{Nota:} O guia da FEI requer que a referência da epígrafe esteja presente no final do trabalho. O comando \verb+\nocite{obra}+ pode ser usado para que a referência apareça ao final do texto, sem aparecer na epígrafe. + +Exemplo: \verb+\epigrafe{Haw-Haw!}{Nelson Muntz \nocite{muntz_book}}+ + +\subsection{Resumo e \emph{abstract}} + +O ambiente \texttt{resumo} é destinado à inserção do resumo em português do trabalho, enquanto o ambiente \texttt{abstract} contém o resumo em inglês. A única diferença entre os dois ambientes está no fato de \texttt{abstract} possuir o comando \verb+\selectlanguage{english}+ no início, enquanto \texttt{resumo} utiliza \verb+\selectlanguage{portuges}+. Palavras-chave podem ser inseridas ao final desses ambientes utilizando, no resumo, o comando \verb+\palavraschave{...}+ e no \emph{abstract}, o comando \verb+\keyword{...}+. Lembrando que as palavras-chave devem ser separadas por ponto final. \begin{verbatim} \begin{resumo} Resumo vem aqui. -\palavraschave{\LaTeX. FEI.} +\palavraschave{\LaTeX{}. FEI.} \end{resumo} \begin{abstract} @@ -309,58 +362,58 @@ Abstract goes here. \end{abstract} \end{verbatim} - \subsection{Listas e sumário} - - A classe da FEI permite a impressão de listas de figuras, tabelas, algoritmos, teoremas, abreviaturas e símbolos usando os comandos nativos do \LaTeX, redefinidos para aderirem aos padrões da biblioteca. Também é possível inserir um sumário. A tabela \ref{tbl:substituicoes} enumera os comandos para inserção das listas e do sumário. - +\subsection{Listas e sumário} + +A classe da FEI permite a impressão de listas de figuras, tabelas, algoritmos, teoremas, abreviaturas e símbolos usando os comandos nativos do \LaTeX{}, redefinidos para aderirem aos padrões da biblioteca. Também é possível inserir um sumário. A tabela \ref{tbl:substituicoes} enumera os comandos para inserção das listas e do sumário. + \begin{table}[ht!] - \caption{Listas e os comandos para imprimi-las} \label{tbl:substituicoes} - \centering - \begin{tabular}{|c|c|} - \hline - \textbf{Elemento} & \textbf{Comando} \\ - \hline - Sumário & \verb+\tableofcontents+ \\ - \hline - Lista de Figuras & \verb+\listoffigures+ \\ - \hline - Lista de Tabelas & \verb+\listoftables+ \\ - \hline - Lista de Algoritmos & \verb+\listofalgorithms+ \\ - \hline - Lista de Teoremas & \verb+\listoftheorems+ \\ - \hline - Listas de Abreviaturas e Símbolos & \verb+\printglossaries+ \\ - \hline - \end{tabular} - \smallcaption{Fonte: Autor} + \caption{Listas e os comandos para imprimi-las} \label{tbl:substituicoes} + \centering + \begin{tabular}{|c|c|} + \hline + \textbf{Elemento} & \textbf{Comando} \\ + \hline + Sumário & \verb+\tableofcontents+ \\ + \hline + Lista de Figuras & \verb+\listoffigures+ \\ + \hline + Lista de Tabelas & \verb+\listoftables+ \\ + \hline + Lista de Algoritmos & \verb+\listofalgorithms+ \\ + \hline + Lista de Teoremas & \verb+\listoftheorems+ \\ + \hline + Listas de Abreviaturas e Símbolos & \verb+\printglossaries+ \\ + \hline + \end{tabular} + \smallcaption{Fonte: Autor} \end{table} - \section{TEXTO}\label{sec:texto} +\section{TEXTO}\label{sec:texto} - Sob a nomenclatura do guia da biblioteca, o texto pode ser estruturado utilizando até 5 níveis de títulos de seção. Isso se traduz no uso dos 5 níveis disponibilizados nativamente pelo \LaTeX: capítulo, seção, subseção, subsubseção e parágrafo. Para isso, são usados os comandos nativos do \LaTeX\ para divisão do texto: \verb+\chapter{...}+, \verb+\section{...}+, \verb+\subsection{...}+, \verb+\subsubsection{...}+ e \verb+\paragraph{...}+. Estes comandos inserem os títulos de suas respectivas divisões de acordo com o guia e são usados posteriormente na criação automática do sumário. +Sob a nomenclatura do guia da biblioteca, o texto pode ser estruturado utilizando até 5 níveis de títulos de seção. Isso se traduz no uso dos 5 níveis disponibilizados nativamente pelo \LaTeX: capítulo, seção, subseção, subsubseção e parágrafo. Para isso, são usados os comandos nativos do \LaTeX{} para divisão do texto: \verb+\chapter{...}+, \verb+\section{...}+, \verb+\subsection{...}+, \verb+\subsubsection{...}+ e \verb+\paragraph{...}+. Estes comandos inserem os títulos de suas respectivas divisões de acordo com o guia e são usados posteriormente na criação automática do sumário. - \subsection{\emph{Floats}} - - As regras da biblioteca definem formatações distintas para os diferentes tipos de \emph{float} disponibilizados pelo \LaTeX. A seguir, serão descritas as diferentes formas de utilizar cada um deles. - - \subsubsection{Figuras} - - A partir de 2015, o guia de formatação da biblioteca padroniza as legendas de figuras e tabelas com a mesma formatação. Na parte superior da figura, coloca-se seu título, numeração e legenda em tamanho padrão 12 e, abaixo da figura, coloca-se sua fonte em tamanho 10. Para a criação da legenda superior da figura, utiliza-se o comando \verb+\caption{}+, enquanto que, para a legenda inferior, foi criado o comando \verb+\smallcaption{}+, o qual constitui uma interface simples para a formatação diferenciada da legenda inferior e, caso desejado, pode ser substituído por: +\subsection{\emph{Floats}} - \begin{verbatim} +As regras da biblioteca definem formatações distintas para os diferentes tipos de \emph{float} disponibilizados pelo \LaTeX{}. A seguir, serão descritas as diferentes formas de utilizar cada um deles. + +\subsubsection{Figuras} + +A partir de 2015, o guia de formatação da biblioteca padroniza as legendas de figuras e tabelas com a mesma formatação. Na parte superior da figura, coloca-se seu título, numeração e legenda em tamanho padrão 12 e, abaixo da figura, coloca-se sua fonte em tamanho 10. Para a criação da legenda superior da figura, utiliza-se o comando \verb+\caption{}+, enquanto que, para a legenda inferior, foi criado o comando \verb+\smallcaption{}+, o qual constitui uma interface simples para a formatação diferenciada da legenda inferior e, caso desejado, pode ser substituído por: + +\begin{verbatim} \captionsetup{font=small} \caption*{...} - \end{verbatim} +\end{verbatim} - A figura \ref{fig:exemplo} demonstra a inserção de uma figura usando o \LaTeX~, assim como o a inserção das legendas superior e inferior utilizando a formatação nativa. +A figura \ref{fig:exemplo} demonstra a inserção de uma figura usando o \LaTeX~, assim como o a inserção das legendas superior e inferior utilizando a formatação nativa. - \begin{figure} - \centering - \caption{Exemplo de figura com sua fonte.} - \rule{2cm}{2cm} - \smallcaption{Fonte: \citefloat{lamport1994latex}.}\label{fig:exemplo} - \end{figure} +\begin{figure} +\centering +\caption{Exemplo de figura com sua fonte.} +\rule{2cm}{2cm} +\smallcaption{Fonte: \citefloat{lamport1994latex}.}\label{fig:exemplo} +\end{figure} \begin{verbatim} \begin{figure} @@ -369,11 +422,11 @@ Abstract goes here. \includegraphics[...]{...} \smallcaption{Fonte: Autor.} \end{figure} -\end{verbatim} - - \subsubsection{Tabelas} +\end{verbatim} - Da mesma forma que figuras, o guia da biblioteca é bem específico quanto às legendas de tabelas: legenda principal em cima da tabela e fonte abaixo. Para satisfazer esta regra, deve-se utilizar o mesmo processo descrito para as figuras. Um exemplo pode ser visto na tabela \ref{tbl:exemplo}. +\subsubsection{Tabelas} + +Da mesma forma que figuras, o guia da biblioteca é bem específico quanto às legendas de tabelas: legenda principal em cima da tabela e fonte abaixo. Para satisfazer esta regra, deve-se utilizar o mesmo processo descrito para as figuras. Um exemplo pode ser visto na tabela \ref{tbl:exemplo}. \begin{verbatim} \begin{table}[ht!] @@ -386,27 +439,27 @@ Abstract goes here. \end{verbatim} \begin{table}[ht!] - \caption{Exemplo de tabela com legenda acima e fonte abaixo} \label{tbl:exemplo} - \centering - \begin{tabular}{|c|c|c|c|} - \hline - & \(x_1\) & \(x_2\) & \(x_3\) \\ - \hline - \(y_1\) & 1 & 0 & 0 \\ - \hline - \(y_2\) & 0 & 1 & 0 \\ - \hline - \(y_3\) & 0 & 0 & 1 \\ - \hline - \end{tabular} - \smallcaption{Fonte: Autor} + \caption{Exemplo de tabela com legenda acima e fonte abaixo} \label{tbl:exemplo} + \centering + \begin{tabular}{|c|c|c|c|} + \hline + & \(x_1\) & \(x_2\) & \(x_3\) \\ + \hline + \(y_1\) & 1 & 0 & 0 \\ + \hline + \(y_2\) & 0 & 1 & 0 \\ + \hline + \(y_3\) & 0 & 0 & 1 \\ + \hline + \end{tabular} + \smallcaption{Fonte: Autor} \end{table} - - \subsubsection{Algoritmos} - - Apesar de estar ausente no guia, a biblioteca permite a inserção de algoritmos no corpo do texto. O pacote \texttt{algorithm2e} fornece diversos comandos para a escrita e formatação de pseudo-códigos em diversos idiomas. A formatação configurada na classe da FEI reflete as recomendações da biblioteca e padrões encontrados na literatura. - A lista a seguir contém todos os comandos do \texttt{algorithm2e} que foram traduzidos para o português e, logo após, um exemplo de como usar alguns desses comandos. Para mais informações, consulte o manual do \texttt{algorithm2e}. - + +\subsubsection{Algoritmos} + +Apesar de estar ausente no guia, a biblioteca permite a inserção de algoritmos no corpo do texto. O pacote \texttt{algorithm2e} fornece diversos comandos para a escrita e formatação de pseudo-códigos em diversos idiomas. A formatação configurada na classe da FEI reflete as recomendações da biblioteca e padrões encontrados na literatura. +A lista a seguir contém todos os comandos do \texttt{algorithm2e} que foram traduzidos para o português e, logo após, um exemplo de como usar alguns desses comandos. Para mais informações, consulte o manual do \texttt{algorithm2e}. + \begin{verbatim} \SetKwInput{Entrada}{Entrada} \SetKwInput{Saida}{Sa\'ida} @@ -426,7 +479,7 @@ Abstract goes here. \SetKwFor{Enqto}{enquanto}{fa\c{c}a}{fim enqto} \SetKwRepeat{Repita}{repita}{at\'e} \end{verbatim} - + Exemplo: \begin{verbatim} @@ -441,7 +494,7 @@ Abstract goes here. \label{lst:alg} \end{algorithm} \end{verbatim} - + \begin{algorithm} \Entrada{Vetor \(X\)} \Saida{Vetor \(Y\)} @@ -455,27 +508,27 @@ Abstract goes here. \Retorna \(Y\) \caption{Exemplo de algoritmo usando algorithm2e em português.}\label{lst:alg} \end{algorithm} - - \subsubsection{Equações} - - O guia da biblioteca também dita que todas as equações devem vir acompanhadas de numeração entre parênteses. O ambiente \texttt{equation} insere essa numeração à direita da equação. Adicionalmente, o pacote \texttt{mathtools} permite que uma equação seja referenciada durante o texto utilizando o comando \verb+\eqref{label_da_equacao}+, cuja funcionalidade é semelhante à do comando \verb+\ref{}+, porém com a adição dos parênteses. - - \begin{equation} \label{eq:euler} - e^{i\pi}+1=0 - \end{equation} - - A equação \eqref{eq:euler} foi criada utilizando o seguinte código: - - \begin{verbatim} - \begin{equation} \label{eq:euler} - e^{i\pi}+1=0 - \end{equation} - \end{verbatim} - - \subsubsection{Teoremas} - - É comum encontrar, na literatura de exatas, teoremas e seus derivados, tipografados de maneira diferenciada. Em \LaTeX, a classe \texttt{amsthm} permite que teoremas sejam escritos em seus próprios ambientes e formatados de acordo, como no seguinte exemplo: - + +\subsubsection{Equações} + +O guia da biblioteca também dita que todas as equações devem vir acompanhadas de numeração entre parênteses. O ambiente \texttt{equation} insere essa numeração à direita da equação. Adicionalmente, o pacote \texttt{mathtools} permite que uma equação seja referenciada durante o texto utilizando o comando \verb+\eqref{label_da_equacao}+, cuja funcionalidade é semelhante à do comando \verb+\ref{}+, porém com a adição dos parênteses. + +\begin{equation} \label{eq:euler} +e^{i\pi}+1=0 +\end{equation} + +A equação \eqref{eq:euler} foi criada utilizando o seguinte código: + +\begin{verbatim} +\begin{equation} \label{eq:euler} +e^{i\pi}+1=0 +\end{equation} +\end{verbatim} + +\subsubsection{Teoremas} + +É comum encontrar, na literatura de exatas, teoremas e seus derivados, tipografados de maneira diferenciada. Em \LaTeX{}, a classe \texttt{amsthm} permite que teoremas sejam escritos em seus próprios ambientes e formatados de acordo, como no seguinte exemplo: + \begin{verbatim} \begin{teorema} Exemplo de teorema. @@ -497,11 +550,10 @@ Em qualquer triângulo retângulo, o quadrado do comprimento da hipotenusa é ig \end{teorema} A classe da FEI disponibiliza os ambientes \emph{axioma, teorema, lema, hipotese, proposicao, conjectura, paradoxo, corolario, definicao} e \emph{exemplo}, com chamada e numeração em negrito e texto com formatação padrão, como nos teoremas \ref{thm:ex1} e \ref{thm:ex2}. Também há o ambiente \emph{prova}, utilizado para se demonstrar alguma propriedade mencionada, o qual não é numerado e tem sua chamada em itálico. O término de um teorema, denominado ``como se queria demonstrar'' (CQD), do latim \gls{qed}, é representado pelo símbolo \qedsymbol, denominado ``lápide''. - - \subsection{Alíneas} - - Segundo o padrão da biblioteca, ``se houver necessidade de enumerar diversos assuntos dentro de uma seção, deve-se utilizar alíneas -ordenadas alfabeticamente por letras minúsculas seguidas de parênteses com margem de 1,25 cm''. Para que não houvesse problemas de formatação, o ambiente \texttt{itemize} foi redirecionado para utilizar o \texttt{enumerate} e este passa a utilizar letras para a sequência de items (como utilizado na seção~\ref{sec:dependencias}). Alíneas em segundo nível são iniciadas pelo caractere \emph{en dash} (--). + +\subsection{Alíneas} + +Segundo o padrão da biblioteca, ``se houver necessidade de enumerar diversos assuntos dentro de uma seção, deve-se utilizar alíneas ordenadas alfabeticamente por letras minúsculas seguidas de parênteses com margem de 1,25 cm''. Para que não houvesse problemas de formatação, o ambiente \texttt{itemize} foi redirecionado para utilizar o \texttt{enumerate} e este passa a utilizar letras para a sequência de items (como utilizado na seção~\ref{sec:dependencias}). Alíneas em segundo nível são iniciadas pelo caractere \emph{en dash} (--). \begin{enumerate} \item Primeiro item; @@ -513,20 +565,20 @@ ordenadas alfabeticamente por letras minúsculas seguidas de parênteses com mar \item Terceiro item. \end{enumerate} - \section{PÓS-TEXTO}\label{sec:postexto} - - Fazem parte dos elementos pós-textuais as referências bibliográficas, apêndices, anexos e o índice remissivo. Este capítulo descreve os comandos para \emph{inserção} destes elementos. Os capítulos seguintes instruirão como \emph{criá-los}. - - \subsection{Referências bibliográficas} - - Para formatar o título da página de referências e adicioná-la ao sumário, utiliza-se o comando \verb+\bibliography{}+, que recebe como parâmetro o caminho para o arquivo \texttt{bib} e formata o título da página como pede o guia da biblioteca. - - Exemplo: \verb+\bibliography{minha_bibliografia.bib}+ - - \subsection{Apêndices e anexos} - - O \LaTeX\ possui o comando nativo \verb+\appendix+ que, quando utilizado, transforma os capítulos subsequentes em apêndices. - +\section{PÓS-TEXTO}\label{sec:postexto} + +Fazem parte dos elementos pós-textuais as referências bibliográficas, apêndices, anexos e o índice remissivo. Este capítulo descreve os comandos para \emph{inserção} destes elementos. Os capítulos seguintes instruirão como \emph{criá-los}. + +\subsection{Referências bibliográficas} + +Para formatar o título da página de referências e adicioná-la ao sumário, utiliza-se o comando \verb+\bibliography{}+, que recebe como parâmetro o caminho para o arquivo \texttt{bib} e formata o título da página como pede o guia da biblioteca. + +Exemplo: \verb+\bibliography{minha_bibliografia.bib}+ + +\subsection{Apêndices e anexos} + +O \LaTeX{} possui o comando nativo \verb+\appendix+ que, quando utilizado, transforma os capítulos subsequentes em apêndices. + \begin{verbatim} \chapter{Último capítulo} ... @@ -536,9 +588,9 @@ ordenadas alfabeticamente por letras minúsculas seguidas de parênteses com mar \chapter{Segundo apêndice} ... \end{verbatim} - - Ao contrário dos apêndices, o \LaTeX\ não possui um comando nativo para declarar anexos. Para isso, foi criado o comando \verb+\anexos+ que transforma os capítulos subsequentes em anexos. - + +Ao contrário dos apêndices, o \LaTeX{} não possui um comando nativo para declarar anexos. Para isso, foi criado o comando \verb+\anexos+ que transforma os capítulos subsequentes em anexos. + \begin{verbatim} \chapter{Último capítulo ou anexo} ... @@ -548,196 +600,196 @@ ordenadas alfabeticamente por letras minúsculas seguidas de parênteses com mar \chapter{Segundo anexo} ... \end{verbatim} - - \subsection{Índice} - - A biblioteca permite a criação de um índice remissivo de palavras, para que estas sejam encontradas com maior facilidade no decorrer do trabalho. O capítulo, \ref{chap:indice} explica com detalhes os diferentes programas e comandos envolvidos na indexação de palavras e compilação dos arquivos de índices, mas, por motivos de completude, o comando para se imprimir o índice é \verb+\printindex+. - - \chapter{CITAÇÕES USANDO O abn\TeX}\label{chap:referencia} - - O \gls{abntex} (\url{https://code.google.com/p/ABNTex2/}) é um conjunto de macros (comandos e ambientes) que busca seguir as normas da \index{ABNT}\gls{abnt} para formatos acadêmicos. O pacote completo do \gls{abntex}~fornece tanto uma classe para a formatação do texto quanto um pacote para a formatação das referências bibliográficas. Para a formatação correta das citações e referências de acordo com o padrão da biblioteca da \index{FEI}\gls{fei}, foi importado o pacote \texttt{abntex2cite-alf}, que utiliza o modelo autor-data. - - As seções a seguir disponibilizam exemplos dos comandos mais comuns. Para uma lista detalhada, o leitor é referenciado ao manual do \texttt{abntex2cite-alf}. - - \section{CITAÇÃO NO FINAL DE LINHA} - A citação no final de linha deve deixar os nomes dos autores, seguido do ano, entre parenteses e em letras maiúsculas. Este resultado pode ser obtido utilizando o comando \verb+\cite{obra}+. - - Exemplo: Este texto deveria ser uma referência \verb+\cite{j:turing50}+. $\to$ Este texto deveria ser uma referência \cite{j:turing50}. - - \section{CITAÇÃO DURANTE O TEXTO} - Para que a citação seja feita durante o texto, o nome do autor é formatado somente com as iniciais maiúsculas e o ano entre parenteses. O pacote da \gls{abntex}~fornece o comando \verb+\citeonline{obra}+ para este caso. - - Exemplo: Segundo \verb+\citeonline{haykin99a}+, este texto deveria ser uma referência. $\to$ Segundo \citeonline{haykin99a}, este texto deveria ser uma referência. - - \section{CITAÇÃO INDIRETA} - Quando se deseja citar uma obra a qual o autor não possui acesso direto a ela, pode-se citar uma outra obra que, por sua vez, cita a primeira. O \gls{abntex}~disponibiliza esse tipo de citação através do comando \verb+\apud{obra_inacessivel}{obra_acessivel}+. - - Exemplo: \verb+\apud{Mcc43}{russell_artificial_2010}+ formata a citação de forma semelhante a \apud{Mcc43}{russell_artificial_2010}. - - \section{CITAÇÃO NO RODAPÉ} - - Citações no rodapé\footciteref{j:turing50} são feitas usando o comando \verb+\footciteref{obra}+. - - \section{CITAÇÕES MÚLTIPLAS} - - Os comandos \verb+\cite{obra_1,...,obra_n}+ e \verb+\citeonline{obra_1,...,obra_m}+ também possibilitam a utilização de citações múltiplas. - - Exemplos: - - \verb+\cite{Mcc43,russell_artificial_2010,haykin99a}+ \(\to\) \cite{Mcc43,russell_artificial_2010,haykin99a}. - - \verb+\citeonline{Mcc43,russell_artificial_2010,haykin99a}+ \(\to\) \citeonline{Mcc43,russell_artificial_2010,haykin99a}. - - \section{CITAÇÕES DE CAMPOS ESPECÍFICOS} - - Para citar o nome do autor em linha, utilize o comando \verb+\citeauthoronline{obra}+. - - \verb+\citeauthoronline{galilei_dialogue_1953}+ \(\to\) \citeauthoronline{galilei_dialogue_1953} - - Para citar o nome do autor em letras maiúsculas, utilize\verb+\citeauthor{obra}+. - - \verb+\citeauthor{galilei_dialogue_1953}+ \(\to\) \citeauthor{galilei_dialogue_1953} - - Para citar o ano de uma obra, utilize \verb+\citeyear{obra}+. - - \verb+\citeyear{galilei_dialogue_1953}+ \(\to\) \citeyear{galilei_dialogue_1953} - - \section{CITAÇÃO PARA \emph{FLOATS}} - - No caso das citações que devem ser feitas em \emph{floats}, como ilustrações e tabelas, foi criado o comando \verb+\citefloat{}+ um comando específico que reflete as recomendações da biblioteca. O objetivo principal deste comando é ser utilizado dentro de \verb+\smallcaption{}+, para que a fonte do \emph{float} seja referenciada corretamente. - - \verb+Fonte: \citefloat{galilei_dialogue_1953}.+ \(\to\) Fonte: \citefloat{galilei_dialogue_1953}. - - \section{OUTROS EXEMPLOS} - - \verb+\Idem[p.~2]{j:turing50}+ \(\to\) \Idem[p.~2]{j:turing50} - - \verb+\Ibidem[p.~2]{j:turing50}+ \(\to\) \Ibidem[p.~2]{j:turing50} - - \verb+\opcit[p.~2]{j:turing50}+ \(\to\) \opcit[p.~2]{j:turing50} - - \verb+\passim{j:turing50}+ \(\to\) \passim{j:turing50} - - \verb+\loccit{j:turing50}+ \(\to\) \loccit{j:turing50} - - \verb+\cfcite[p.~2]{j:turing50}+ \(\to\) \cfcite[p.~2]{j:turing50} - - \verb+\etseq[p.~2]{j:turing50}+ \(\to\) \etseq[p.~2]{j:turing50} - - \section{CITAÇÕES COM MAIS DE TRÊS LINHAS} - - O único tipo de citação que independe do pacote \texttt{abntex2cite} é a citação com mais de três linhas. De acordo com o guia da biblioteca, ela deve ter recuo de 4 cm da margem esquerda, letra de tamanho 10 pt, espaçamento simples e não deve conter aspas nem recuo ao início do parágrafo. No \index{Latex@\LaTeX}\LaTeX, os ambientes responsáveis por tais citações são \texttt{quote} (para citações de um parágrafo) e \texttt{quotation} (para citações com mais de um parágrafo). - - Exemplo: - - \begin{quote} - I propose to consider the question, `Can machines think?' This should begin with definitions of the meaning of the terms `machine' and `think'. The definitions might be framed so as to reflect so far as possible the normal use of the words, but this attitude is dangerous. If the meaning of the words `machine' and `think' are to be found by examining how they are commonly used it is difficult to escape the conclusion that the meaning and the answer to the question, `Can machines think?' is to be sought in a statistical survey such as a Gallup poll. But this is absurd. Instead of attempting such a definition I shall replace the question by another, which is closely related to it and is expressed in relatively unambiguous words. \cite{j:turing50} - \end{quote} - - \chapter{ÍNDICES}\label{chap:indice} - - Assim como as referências são geradas por um programa a parte (o Bib\TeX), a criação de índices remissivos também o é. Neste quesito, o \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex} é o programa pioneiro na geração de índices e é parte integrante de todas as instalações do \LaTeX. Contudo, o \emph{MakeIndex} foi codificado com suporte apenas para o idioma inglês, o que significa que palavras que contêm caracteres mais exóticos -- como acentos ou cedilha -- não serão organizados corretamente. Para solucionar este problema, usuários de Linux possuem como opção secundária o \index{xindy@\emph{xindy}}\emph{xindy}, um outro gerador de índices que possui as mesmas funcionalidades e aceita os mesmos comandos do \emph{MakeIndex}, porém com suporte a uma infinidade de idiomas. - - Para ambos os casos, foi importado o pacote \texttt{imakeidx}, o qual permite selecionar entre o \emph{MakeIndex} e o \emph{xindy} em suas opções. O \emph{MakeIndex} é o motor padrão de indexação; para utilizar o \emph{xindy}, é necessário declarar esta opção ao carregar a classe, da seguinte forma: \verb+\documentclass[xindy]{fei}+ - - Como o \emph{xindy} não é parte integrante do \LaTeX, ensinamos como instalá-lo no capítulo \ref{chap:instalacao}. Também é necessário executar um passo adicional na compilação do projeto, o qual é explicado no capítulo \ref{chap:compilando}. - - \section{SINALIZANDO A CRIAÇÃO DOS ARQUIVOS DE ÍNDICE} - - Para que o LaTeX crie os arquivos auxiliares que serão lidos pelo \emph{MakeIndex}, é necessário sinalizar o compilador para que essa criação seja feita. Isso é feito adicionando o comando \verb+\makeindex+ ao preâmbulo de seu texto. - - \section{INDEXANDO PALAVRAS} - - Para que uma palavra apareça posteriormente no índice, é necessário indexá-la. Para isso, usa-se o comando \verb+\index{palavra}+, o qual inclui ``palavra'' no arquivo auxiliar de indexação. - - Exemplo: [\ldots] a biblioteca do Centro Universitário da \verb+\index{FEI}+\index{FEI}\gls{fei} utiliza um modelo baseado na norma da \verb+\index{ABNT}+\index{ABNT}\gls{abnt} [\ldots] - - É possível indexar uma palavra mais de uma vez, para que todas as páginas nas quais esta palavra apareceu apareçam no índice. - - Para aprender dicas avançadas na criação de índices mais complexos, recomenda-se a leitura da documentação do \emph{MakeIndex} (\url{http://www.ctan.org/pkg/makeindex}) assim como de \citeonline{mittelbach_latex_2004}, que disserta tanto sobre o \emph{xindy} como \emph{MakeIndex}. - - \section{IMPRIMINDO O ÍNDICE} - - A impressão do índice é feita utilizando o comando \verb+\printindex+, o qual, além de imprimir o índice, inclui uma entrada para o mesmo no sumário. - - \chapter{LISTAS DE SÍMBOLOS E ABREVIATURAS} \label{chap:listas} - - Para a criação das listas de símbolos e abreviaturas, foi utilizado o pacote \index{glossaries@\emph{glossaries}}\emph{glossaries}, responsável por indexar termos de diferentes categorias e gerar listas destes termos. Ao contrário do índice, que indexa as palavras no decorrer do texto, o pacote \emph{glossaries} exige que os termos sejam declarados antes de serem referenciados durante o texto. Uma boa prática para organizar tais termos consiste em declará-los ao início do documento, ou em um documento separado, o qual pode ser chamado utilizando os comandos \verb+\input+ ou \verb+\include+. Estas opções ficam a cargo do leitor. As próximas duas seções ensinarão os comandos básicos para indexação de símbolos e abreviaturas. - - \emph{Nota:} assim como descrito no capítulo \ref{chap:indice}, o pacote \emph{glossaries} depende das ferramentas \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex}. - - \section{SINALIZANDO A CRIAÇÃO DOS ARQUIVOS DE LISTAS DE SÍMBOLOS E ABREVIATURAS} - - Para que o LaTeX crie os arquivos auxiliares que serão lidos pelo \emph{glossaries}, é necessário sinalizar o compilador para que essa criação seja feita. Isso é feito adicionando o comando \verb+\makeglossaries+ ao preâmbulo de seu texto. - - \section{INDEXANDO ABREVIATURAS} - - A indexação de abreviaturas é feita utilizando o comando - - \verb+\newacronym[longplural=1]{2}{3}{4}+, onde: - - \begin{enumerate} - \item 1: o significado a abreviatura no plural, escrito por extenso (\emph{opcional}); - \item 2: código que será utilizado para referenciar a abreviatura no decorrer do texto; - \item 3: a abreviatura em si; - \item 4: o significado a abreviatura, escrito por extenso. - \end{enumerate} - - Exemplo: \verb+\newacronym[longplural=Associações+ - - \verb+Brasileiras de Normas Técnicas]+ - - \verb+{abnt}{ABNT}{Associação Brasileira de Normas Técnicas}+ - - \section{INDEXANDO SÍMBOLOS} - - A indexação de símbolos é feita utilizando o comando - - \verb+\newglossaryentry{1}{parent={2},type=symbols,+ - - \verb+name={3},sort={4},description={5}}+, onde: - - \begin{enumerate} - \item 1: código que será utilizado para referenciar a abreviatura no decorrer do texto); - \item 2: tipo do símbolo; usado para separar letras gregas e subscritos das demais (Cf. exemplo abaixo); - \item 3: o símbolo; caso a notação matemática seja necessária, use \verb+\ensuremath{2}+ (Cf. exemplo abaixo); - \item 4: uma sequência de caracteres para indicar a ordenação alfabética do símbolo na lista; - \item 5: a descrição do símbolo, que aparecerá na lista. - \end{enumerate} - - Exemplo: \verb+\newglossaryentry{pi}{parent=greek,type=symbols,+ - - \verb+name={\ensuremath{\pi}},sort=p,+ - - \verb+description={número irracional que representa [...]}}+ - - \section{UTILIZANDO ABREVIATURAS E SÍMBOLOS INDEXADOS} - - O pacote \index{glossaries@\emph{glossaries}}\emph{glossaries} disponibiliza os seguintes comandos para chamar os itens indexados durante o texto: - - \begin{enumerate} - \item \verb+\gls{<rotulo>}+: imprime a entrada em letras minúsculas; - \item \verb+\Gls{<rotulo>}+: imprime a entrada em letras maiúsculas; - \item \verb+\glspl{<rotulo>}+: imprime a entrada no plural; - \item \verb+\Glspl{<rotulo>}+: imprime a entrada no plural e em letras maiúsculas. - \end{enumerate} - - As siglas possuem alguns comandos únicos para serem referenciadas: - - \begin{enumerate} - \item \verb+\acrfull{<rotulo>}+ imprime a abreviatura completa \(\to\) \acrfull{fei}; - \item \verb+\acrlong{<rotulo>}+ imprime a parte por extenso da abreviatura \(\to\) \acrlong{fei}; - \item \verb+\acrshort{<rotulo>}+ imprime apenas a abreviatura \(\to\) \acrshort{fei}. - \end{enumerate} - - Repare que, no caso das siglas, quando estas são usadas pela primeira vez, são impressas a definição seguida da sigla entre parênteses. Nas demais vezes, a sigla aparecerá sozinha. Já os símbolos podem ser utilizados dentro de equações, ou na definição de outros símbolos, como no seguinte exemplo \cite{Goldberg1989}, \[ \operatorname{E}(\gls{m}(\gls{h},\gls{t}+1)) \geq {\gls{m}(\gls{h},\gls{t}) \gls{f}(\gls{h}) \over \gls{at}}[1-\gls{p}], \] onde \[ p = \frac{\gls{delta}(\gls{h})}{\gls{l}-1}\gls{pc} + \gls{oh}(\gls{h}) \gls{pm}. \] Os símbolos utilizados nas equações são cadastrados no início do arquivo, inseridos com o comando \verb+\gls{}+ e consequentemente, adicionados na lista de símbolos. - - É importante ressaltar que o pacote \index{glossaries@\emph{glossaries}}\emph{glossaries} adiciona às listas somente os termos que foram utilizados durante o texto. Para que todos os termos declarados apareçam, basta usar o comando \verb+\glsaddall+ no corpo do texto. - - \section{HIERARQUIA DE SÍMBOLOS}\label{sec:sublist} - Atendendo à demanda de alunos que utilizam uma quantidade muito extensa de símbolos em seus trabalhos, a classe da FEI passou a suportar o uso de listas se símbolos que permitam a ordenação hierárquica dos símbolos. Esta adição foi feita através do uso do estilo \texttt{alttree} do pacote \texttt{glossaries}. Para que este estilo seja utilizado no documento, a opção \texttt{sublist} deve ser passada à classe. - - O exemplo abaixo demonstra como criar uma categoria de símbolos e inserir um símbolo nela. Mais de uma categoria de símbolos pode ser criada. Para mais exemplos, consulte os arquivos de exemplo do repositório ou o manual do pacote \texttt{glossaries}. + +\subsection{Índice} + +A biblioteca permite a criação de um índice remissivo de palavras, para que estas sejam encontradas com maior facilidade no decorrer do trabalho. O capítulo, \ref{chap:indice} explica com detalhes os diferentes programas e comandos envolvidos na indexação de palavras e compilação dos arquivos de índices, mas, por motivos de completude, o comando para se imprimir o índice é \verb+\printindex+. + +\chapter{CITAÇÕES USANDO O abn\TeX}\label{chap:referencia} + +O \gls{abntex} (\url{https://code.google.com/p/ABNTex2/}) é um conjunto de macros (comandos e ambientes) que busca seguir as normas da \index{ABNT}\gls{abnt} para formatos acadêmicos. O pacote completo do \gls{abntex}~fornece tanto uma classe para a formatação do texto quanto um pacote para a formatação das referências bibliográficas. Para a formatação correta das citações e referências de acordo com o padrão da biblioteca da \index{FEI}\gls{fei}, foi importado o pacote \texttt{abntex2cite-alf}, que utiliza o modelo autor-data. + +As seções a seguir disponibilizam exemplos dos comandos mais comuns. Para uma lista detalhada, o leitor é referenciado ao manual do \texttt{abntex2cite-alf}. + +\section{CITAÇÃO NO FINAL DE LINHA} +A citação no final de linha deve deixar os nomes dos autores, seguido do ano, entre parenteses e em letras maiúsculas. Este resultado pode ser obtido utilizando o comando \verb+\cite{obra}+. + +Exemplo: Este texto deveria ser uma referência \verb+\cite{j:turing50}+. $\to$ Este texto deveria ser uma referência \cite{j:turing50}. + +\section{CITAÇÃO DURANTE O TEXTO} +Para que a citação seja feita durante o texto, o nome do autor é formatado somente com as iniciais maiúsculas e o ano entre parenteses. O pacote da \gls{abntex}~fornece o comando \verb+\citeonline{obra}+ para este caso. + +Exemplo: Segundo \verb+\citeonline{haykin99a}+, este texto deveria ser uma referência. $\to$ Segundo \citeonline{haykin99a}, este texto deveria ser uma referência. + +\section{CITAÇÃO INDIRETA} +Quando se deseja citar uma obra a qual o autor não possui acesso direto a ela, pode-se citar uma outra obra que, por sua vez, cita a primeira. O \gls{abntex}~disponibiliza esse tipo de citação através do comando \verb+\apud{obra_inacessivel}{obra_acessivel}+. + +Exemplo: \verb+\apud{Mcc43}{russell_artificial_2010}+ formata a citação de forma semelhante a \apud{Mcc43}{russell_artificial_2010}. + +\section{CITAÇÃO NO RODAPÉ} + +Citações no rodapé\footciteref{j:turing50} são feitas usando o comando \verb+\footciteref{obra}+. + +\section{CITAÇÕES MÚLTIPLAS} + +Os comandos \verb+\cite{obra_1,...,obra_n}+ e \verb+\citeonline{obra_1,...,obra_m}+ também possibilitam a utilização de citações múltiplas. + +Exemplos: + +\verb+\cite{Mcc43,russell_artificial_2010,haykin99a}+ \(\to\) \cite{Mcc43,russell_artificial_2010,haykin99a}. + +\verb+\citeonline{Mcc43,russell_artificial_2010,haykin99a}+ \(\to\) \citeonline{Mcc43,russell_artificial_2010,haykin99a}. + +\section{CITAÇÕES DE CAMPOS ESPECÍFICOS} + +Para citar o nome do autor em linha, utilize o comando \verb+\citeauthoronline{obra}+. + +\verb+\citeauthoronline{galilei_dialogue_1953}+ \(\to\) \citeauthoronline{galilei_dialogue_1953} + +Para citar o nome do autor em letras maiúsculas, utilize\verb+\citeauthor{obra}+. + +\verb+\citeauthor{galilei_dialogue_1953}+ \(\to\) \citeauthor{galilei_dialogue_1953} + +Para citar o ano de uma obra, utilize \verb+\citeyear{obra}+. + +\verb+\citeyear{galilei_dialogue_1953}+ \(\to\) \citeyear{galilei_dialogue_1953} + +\section{CITAÇÃO PARA \emph{FLOATS}} + +No caso das citações que devem ser feitas em \emph{floats}, como ilustrações e tabelas, foi criado o comando \verb+\citefloat{}+ um comando específico que reflete as recomendações da biblioteca. O objetivo principal deste comando é ser utilizado dentro de \verb+\smallcaption{}+, para que a fonte do \emph{float} seja referenciada corretamente. + +\verb+Fonte: \citefloat{galilei_dialogue_1953}.+ \(\to\) Fonte: \citefloat{galilei_dialogue_1953}. + +\section{OUTROS EXEMPLOS} + +\verb+\Idem[p.~2]{j:turing50}+ \(\to\) \Idem[p.~2]{j:turing50} + +\verb+\Ibidem[p.~2]{j:turing50}+ \(\to\) \Ibidem[p.~2]{j:turing50} + +\verb+\opcit[p.~2]{j:turing50}+ \(\to\) \opcit[p.~2]{j:turing50} + +\verb+\passim{j:turing50}+ \(\to\) \passim{j:turing50} + +\verb+\loccit{j:turing50}+ \(\to\) \loccit{j:turing50} + +\verb+\cfcite[p.~2]{j:turing50}+ \(\to\) \cfcite[p.~2]{j:turing50} + +\verb+\etseq[p.~2]{j:turing50}+ \(\to\) \etseq[p.~2]{j:turing50} + +\section{CITAÇÕES COM MAIS DE TRÊS LINHAS} + +O único tipo de citação que independe do pacote \texttt{abntex2cite} é a citação com mais de três linhas. De acordo com o guia da biblioteca, ela deve ter recuo de 4 cm da margem esquerda, letra de tamanho 10 pt, espaçamento simples e não deve conter aspas nem recuo ao início do parágrafo. No \index{Latex@\LaTeX}\LaTeX{}, os ambientes responsáveis por tais citações são \texttt{quote} (para citações de um parágrafo) e \texttt{quotation} (para citações com mais de um parágrafo). + +Exemplo: + +\begin{quote} +I propose to consider the question, `Can machines think?' This should begin with definitions of the meaning of the terms `machine' and `think'. The definitions might be framed so as to reflect so far as possible the normal use of the words, but this attitude is dangerous. If the meaning of the words `machine' and `think' are to be found by examining how they are commonly used it is difficult to escape the conclusion that the meaning and the answer to the question, `Can machines think?' is to be sought in a statistical survey such as a Gallup poll. But this is absurd. Instead of attempting such a definition I shall replace the question by another, which is closely related to it and is expressed in relatively unambiguous words. \cite{j:turing50} +\end{quote} + +\chapter{ÍNDICES}\label{chap:indice} + +Assim como as referências são geradas por um programa a parte (o Bib\TeX), a criação de índices remissivos também o é. Neste quesito, o \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex} é o programa pioneiro na geração de índices e é parte integrante de todas as instalações do \LaTeX{}. Contudo, o \emph{MakeIndex} foi codificado com suporte apenas para o idioma inglês, o que significa que palavras que contêm caracteres mais exóticos -- como acentos ou cedilha -- não serão organizados corretamente. Para solucionar este problema, usuários de Linux possuem como opção secundária o \index{xindy@\emph{xindy}}\emph{xindy}, um outro gerador de índices que possui as mesmas funcionalidades e aceita os mesmos comandos do \emph{MakeIndex}, porém com suporte a uma infinidade de idiomas. + +Para ambos os casos, foi importado o pacote \texttt{imakeidx}, o qual permite selecionar entre o \emph{MakeIndex} e o \emph{xindy} em suas opções. O \emph{MakeIndex} é o motor padrão de indexação; para utilizar o \emph{xindy}, é necessário declarar esta opção ao carregar a classe, da seguinte forma: \verb+\documentclass[xindy]{fei}+ + +Como o \emph{xindy} não é parte integrante do \LaTeX{}, ensinamos como instalá-lo no capítulo \ref{chap:instalacao}. Também é necessário executar um passo adicional na compilação do projeto, o qual é explicado no capítulo \ref{chap:compilando}. + +\section{SINALIZANDO A CRIAÇÃO DOS ARQUIVOS DE ÍNDICE} + +Para que o LaTeX crie os arquivos auxiliares que serão lidos pelo \emph{MakeIndex}, é necessário sinalizar o compilador para que essa criação seja feita. Isso é feito adicionando o comando \verb+\makeindex+ ao preâmbulo de seu texto. + +\section{INDEXANDO PALAVRAS} + +Para que uma palavra apareça posteriormente no índice, é necessário indexá-la. Para isso, usa-se o comando \verb+\index{palavra}+, o qual inclui ``palavra'' no arquivo auxiliar de indexação. + +Exemplo: [\ldots] a biblioteca do Centro Universitário da \verb+\index{FEI}+\index{FEI}\gls{fei} utiliza um modelo baseado na norma da \verb+\index{ABNT}+\index{ABNT}\gls{abnt} [\ldots] + +É possível indexar uma palavra mais de uma vez, para que todas as páginas nas quais esta palavra apareceu apareçam no índice. + +Para aprender dicas avançadas na criação de índices mais complexos, recomenda-se a leitura da documentação do \emph{MakeIndex} (\url{http://www.ctan.org/pkg/makeindex}) assim como de \citeonline{mittelbach_latex_2004}, que disserta tanto sobre o \emph{xindy} como \emph{MakeIndex}. + +\section{IMPRIMINDO O ÍNDICE} + +A impressão do índice é feita utilizando o comando \verb+\printindex+, o qual, além de imprimir o índice, inclui uma entrada para o mesmo no sumário. + +\chapter{LISTAS DE SÍMBOLOS E ABREVIATURAS} \label{chap:listas} + +Para a criação das listas de símbolos e abreviaturas, foi utilizado o pacote \index{glossaries@\emph{glossaries}}\emph{glossaries}, responsável por indexar termos de diferentes categorias e gerar listas destes termos. Ao contrário do índice, que indexa as palavras no decorrer do texto, o pacote \emph{glossaries} exige que os termos sejam declarados antes de serem referenciados durante o texto. Uma boa prática para organizar tais termos consiste em declará-los ao início do documento, ou em um documento separado, o qual pode ser chamado utilizando os comandos \verb+\input+ ou \verb+\include+. Estas opções ficam a cargo do leitor. As próximas duas seções ensinarão os comandos básicos para indexação de símbolos e abreviaturas. + +\emph{Nota:} assim como descrito no capítulo \ref{chap:indice}, o pacote \emph{glossaries} depende das ferramentas \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex}. + +\section{SINALIZANDO A CRIAÇÃO DOS ARQUIVOS DE LISTAS DE SÍMBOLOS E ABREVIATURAS} + +Para que o LaTeX crie os arquivos auxiliares que serão lidos pelo \emph{glossaries}, é necessário sinalizar o compilador para que essa criação seja feita. Isso é feito adicionando o comando \verb+\makeglossaries+ ao preâmbulo de seu texto. + +\section{INDEXANDO ABREVIATURAS} + +A indexação de abreviaturas é feita utilizando o comando + +\verb+\newacronym[longplural=1]{2}{3}{4}+, onde: + +\begin{enumerate} +\item 1: o significado a abreviatura no plural, escrito por extenso (\emph{opcional}); +\item 2: código que será utilizado para referenciar a abreviatura no decorrer do texto; +\item 3: a abreviatura em si; +\item 4: o significado a abreviatura, escrito por extenso. +\end{enumerate} + +Exemplo: \verb+\newacronym[longplural=Associações+ + + \verb+Brasileiras de Normas Técnicas]+ + + \verb+{abnt}{ABNT}{Associação Brasileira de Normas Técnicas}+ + +\section{INDEXANDO SÍMBOLOS} + +A indexação de símbolos é feita utilizando o comando + +\verb+\newglossaryentry{1}{parent={2},type=symbols,+ + +\verb+name={3},sort={4},description={5}}+, onde: + +\begin{enumerate} +\item 1: código que será utilizado para referenciar a abreviatura no decorrer do texto); +\item 2: tipo do símbolo; usado para separar letras gregas e subscritos das demais (Cf. exemplo abaixo); +\item 3: o símbolo; caso a notação matemática seja necessária, use \verb+\ensuremath{2}+ (Cf. exemplo abaixo); +\item 4: uma sequência de caracteres para indicar a ordenação alfabética do símbolo na lista; +\item 5: a descrição do símbolo, que aparecerá na lista. +\end{enumerate} + +Exemplo: \verb+\newglossaryentry{pi}{parent=greek,type=symbols,+ + + \verb+name={\ensuremath{\pi}},sort=p,+ + + \verb+description={número irracional que representa [...]}}+ + +\section{UTILIZANDO ABREVIATURAS E SÍMBOLOS INDEXADOS} + +O pacote \index{glossaries@\emph{glossaries}}\emph{glossaries} disponibiliza os seguintes comandos para chamar os itens indexados durante o texto: + +\begin{enumerate} +\item \verb+\gls{<rotulo>}+: imprime a entrada em letras minúsculas; +\item \verb+\Gls{<rotulo>}+: imprime a entrada em letras maiúsculas; +\item \verb+\glspl{<rotulo>}+: imprime a entrada no plural; +\item \verb+\Glspl{<rotulo>}+: imprime a entrada no plural e em letras maiúsculas. +\end{enumerate} + +As siglas possuem alguns comandos únicos para serem referenciadas: + +\begin{enumerate} +\item \verb+\acrfull{<rotulo>}+ imprime a abreviatura completa \(\to\) \acrfull{fei}; +\item \verb+\acrlong{<rotulo>}+ imprime a parte por extenso da abreviatura \(\to\) \acrlong{fei}; +\item \verb+\acrshort{<rotulo>}+ imprime apenas a abreviatura \(\to\) \acrshort{fei}. +\end{enumerate} + +Repare que, no caso das siglas, quando estas são usadas pela primeira vez, são impressas a definição seguida da sigla entre parênteses. Nas demais vezes, a sigla aparecerá sozinha. Já os símbolos podem ser utilizados dentro de equações, ou na definição de outros símbolos, como no seguinte exemplo \cite{Goldberg1989}, \[ \operatorname{E}(\gls{m}(\gls{h},\gls{t}+1)) \geq {\gls{m}(\gls{h},\gls{t}) \gls{f}(\gls{h}) \over \gls{at}}[1-\gls{p}], \] onde \[ p = \frac{\gls{delta}(\gls{h})}{\gls{l}-1}\gls{pc} + \gls{oh}(\gls{h}) \gls{pm}. \] Os símbolos utilizados nas equações são cadastrados no início do arquivo, inseridos com o comando \verb+\gls{}+ e consequentemente, adicionados na lista de símbolos. + +É importante ressaltar que o pacote \index{glossaries@\emph{glossaries}}\emph{glossaries} adiciona às listas somente os termos que foram utilizados durante o texto. Para que todos os termos declarados apareçam, basta usar o comando \verb+\glsaddall+ no corpo do texto. + +\section{HIERARQUIA DE SÍMBOLOS}\label{sec:sublist} +Atendendo à demanda de alunos que utilizam uma quantidade muito extensa de símbolos em seus trabalhos, a classe da FEI passou a suportar o uso de listas se símbolos que permitam a ordenação hierárquica dos símbolos. Esta adição foi feita através do uso do estilo \texttt{alttree} do pacote \texttt{glossaries}. Para que este estilo seja utilizado no documento, a opção \texttt{sublist} deve ser passada à classe. + +O exemplo abaixo demonstra como criar uma categoria de símbolos e inserir um símbolo nela. Mais de uma categoria de símbolos pode ser criada. Para mais exemplos, consulte os arquivos de exemplo do repositório ou o manual do pacote \texttt{glossaries}. \begin{verbatim} \newglossaryentry{greek}{name={Letras gregas}, @@ -746,48 +798,48 @@ ordenadas alfabeticamente por letras minúsculas seguidas de parênteses com mar name={\ensuremath{\Delta P}},sort=deltap, description={pressure drop, $Pa$}} \end{verbatim} - - \section{IMPRIMINDO AS LISTAS} - A lista de abreviaturas pode ser impressa através do comando \verb+\printacronyms+. A lista de símbolos pode ser impressa através do comando \verb+\printsymbols+. Todas as listas criadas através do pacote \texttt{glossaries}, inclusive as definidas pelo próprio usuário, podem ser impressas sequencialmente através do comando \verb+\printglossaries+. +\section{IMPRIMINDO AS LISTAS} + +A lista de abreviaturas pode ser impressa através do comando \verb+\printacronyms+. A lista de símbolos pode ser impressa através do comando \verb+\printsymbols+. Todas as listas criadas através do pacote \texttt{glossaries}, inclusive as definidas pelo próprio usuário, podem ser impressas sequencialmente através do comando \verb+\printglossaries+. \chapter{COMPILANDO O PROJETO} \label{chap:compilando} - + Para utilizar todos os recursos que a \texttt{fei.cls} disponibiliza, é necessário compilar o projeto utilizando diferentes programas em ordem específica. Esta sessão descreve estes programas, a ordem na qual eles devem ser utilizados e algumas ferramentas inteligentes que automatizam este processo. \section{O JEITO DIFÍCIL} Para compilar o documento manualmente, é preciso executar os seguintes programas na seguinte ordem\footnote{Para uma descrição referente a todos os arquivos gerados no processo de compilação, vide apêndices}. - - \[\operatorname*{\text{pdf\LaTeX}}_a \to \operatorname*{\text{Bib\TeX}}_b \to \operatorname*{\text{MakeGlossaries}}_c \to \operatorname*{\text{pdf\LaTeX}}_d \to \operatorname*{\text{MakeIndex}}_e \to \operatorname*{\text{pdf\LaTeX}}_f\] - - onde: - - \begin{enumerate} - \item gera arquivos auxiliares básicos, utilizados pelos demais programas, e uma versão inicial do PDF; - \item gera a bibliografia lendo o arquivo \texttt{bib} utilizado. Necessário apenas se citações e referências forem usadas no texto; - \item cria um ou mais arquivos de listas (de símbolos e siglas). Necessário apenas se houve indexação e utilização de símbolos e abreviaturas no texto; - \item atualiza todas as referências através do texto, utilizando os arquivos gerados em \emph{b}, \emph{c} e \emph{d} (\emph{desnecessário se os passos b -- d não foram realizados}); - \item cria um ou mais arquivos de índice. Necessário apenas se houver indexação de palavras para serem adicionadas ao índice; - \item gera o PDF final (\emph{desnecessário se os passos b -- e não foram realizados}), incluindo o índice gerado no passo anterior. - \end{enumerate} - - Um exemplo de comando que executa todas essas funções é o seguinte: - - \begin{verbatim} + +\[\operatorname*{\text{pdf\LaTeX}}_a \to \operatorname*{\text{Bib\TeX}}_b \to \operatorname*{\text{MakeGlossaries}}_c \to \operatorname*{\text{pdf\LaTeX}}_d \to \operatorname*{\text{MakeIndex}}_e \to \operatorname*{\text{pdf\LaTeX}}_f\] + +onde: + +\begin{enumerate} +\item gera arquivos auxiliares básicos, utilizados pelos demais programas, e uma versão inicial do PDF; +\item gera a bibliografia lendo o arquivo \texttt{bib} utilizado. Necessário apenas se citações e referências forem usadas no texto; +\item cria um ou mais arquivos de listas (de símbolos e siglas). Necessário apenas se houve indexação e utilização de símbolos e abreviaturas no texto; +\item atualiza todas as referências através do texto, utilizando os arquivos gerados em \emph{b}, \emph{c} e \emph{d} (\emph{desnecessário se os passos b -- d não foram realizados}); +\item cria um ou mais arquivos de índice. Necessário apenas se houver indexação de palavras para serem adicionadas ao índice; +\item gera o PDF final (\emph{desnecessário se os passos b -- e não foram realizados}), incluindo o índice gerado no passo anterior. +\end{enumerate} + +Um exemplo de comando que executa todas essas funções é o seguinte: + +\begin{verbatim} pdflatex documento.tex bibtex documento.aux makeglossaries documento pdflatex documento.tex makeindex documento.idx pdflatex documento.tex - \end{verbatim} +\end{verbatim} -Caso o \index{xindy@\emph{xindy}}\emph{xindy} esteja sendo usado como o motor de indexação, é necessário passar o parâmetro \verb+-shell-escape+ ao pdf\LaTeX, para que ele possa executar comandos no \emph{shell} do Linux. +Caso o \index{xindy@\emph{xindy}}\emph{xindy} esteja sendo usado como o motor de indexação, é necessário passar o parâmetro \verb+-shell-escape+ ao pdf\LaTeX{}, para que ele possa executar comandos no \emph{shell} do Linux. \section{O JEITO FÁCIL} -Existem diversas ferramentas que automatizam o processo de compilação de um documento em \LaTeX, abstraindo o usuário da complexidade de utilizar todos os programas menores que geram o arquivo final. Duas dessas ferramentas são o \texttt{latexmk} e o \texttt{rubber}, ambas criadas especificamente para realizar a automatização da compilação de documentos \TeX. Supondo que haja um arquivo chamado \texttt{documento.tex} no diretório atual, os comandos seguintes geram um PDF completo. +Existem diversas ferramentas que automatizam o processo de compilação de um documento em \LaTeX{}, abstraindo o usuário da complexidade de utilizar todos os programas menores que geram o arquivo final. Duas dessas ferramentas são o \texttt{latexmk} e o \texttt{rubber}, ambas criadas especificamente para realizar a automatização da compilação de documentos \TeX{}. Supondo que haja um arquivo chamado \texttt{documento.tex} no diretório atual, os comandos seguintes geram um PDF completo. \begin{enumerate} \item \texttt{latexmk -pdf -interaction=nonstopmode documento} @@ -795,90 +847,52 @@ Existem diversas ferramentas que automatizam o processo de compilação de um do \end{enumerate} Caso haja apenas um arquivo \texttt{tex} no diretório, não é necessário especificar o nome do documento, assim como nunca é necessário deixar explícito tanto ao \texttt{latexmk} quanto ao \texttt{rubber} se o documento sendo compilado possui bibliografia, índices ou listas. Os programas detectam a existência desses construtos adicionais examinando os arquivos auxiliares gerados durante o processo e executam todos os comandos apropriados na ordem certa e o número suficiente de vezes. - - \chapter{INSTALAÇÃO DOS PACOTES E PROGRAMAS} \label{chap:instalacao} - - Este capítulo guia o leitor na instalação dos diferentes pacotes e programas necessários para utilizar todas as funcionalidades da classe \texttt{fei.cls}. - - \section{WINDOWS} - - A opção mais simples para instalação do \LaTeX\ no Windows é o aplicativo Mik\TeX\ (\url{http://miktex.org}). Tenha certeza de escolher a opção que permite ao software baixar pacotes em falta do repositório online e, na primeira vez que compilar seu projeto, todos os pacotes serão baixados. - - Alternativamente, é possível utilizar o gerenciador de pacotes do Mik\TeX\ para selecionar os pacotes a serem baixados. A lista destes pacotes está disponível na seção \ref{sec:dependencias}. - - \section{LINUX} - - O \LaTeX~é frequentemente disponibilizado para as maiores distribuições Linux por meio de seus gerenciadores de pacotes. No Ubuntu, por exemplo, é necessária a instalação do \TeX\ Live através do \texttt{apt-get}. O usuário pode optar pela instalação completa, através do pacote \texttt{texlive-full}, ou instalar apenas os seguintes pacotes necessários: - - \begin{enumerate} - \item \texttt{texlive}: pacotes essenciais do \TeX\ Live; - \item \texttt{texlive-science}: instala pacotes científicos, como \texttt{algorithm2e} e \texttt{mathtools}; - \item \texttt{texlive-lang-portuguese}: idioma português do \texttt{babel}; - \item \texttt{texlive-publishers}: pacote \texttt{abntex2cite} da \gls{abntex}; - \item \index{xindy@\emph{xindy}}\texttt{xindy}: o indexador \emph{xindy}. - \end{enumerate} - - \section{MAC OS} - - No Mac, o \LaTeX\ pode ser instalado através do Mac\TeX\ (\url{http://tug.org/mactex/}), uma compilação completa do \TeX\ Live para Mac. - - \section{FONTE ARIAL} - - Por ser uma fonte True Type de autoria da Microsoft, as fontes da família Arial não são disponibilizadas nativamente por distribuições \LaTeX\ como o Mik\TeX\ e o \TeX\ Live. Para utilizá-las, é necessário instalá-las separadamente. As instruções para instalação das fontes estão disponíveis no site do \TeX \emph{Users Group}\footnote{http://tug.org/fonts/getnonfreefonts/}. - - \begin{itemize} - \item Fazer download do script\footnote{http://tug.org/fonts/getnonfreefonts/install-getnonfreefonts}; - \item Instalar o script usando o aplicativo \texttt{texlua}: \verb+texlua install-getnonfreefonts+; - \item Rodar o script: \verb+getnonfreefonts --all+. - \end{itemize} - - Após isso, é necessário utilizar a opção \texttt{arial} na declaração da classe, no início do arquivo \texttt{tex}: \verb+\documentclass[arial]{fei}+. - - \chapter{LEITURA COMPLEMENTAR} - - \citeonline{lamport1994latex} e \citeonline{mittelbach_latex_2004} descrevem de maneira completa o \LaTeX: seus comandos, funcionalidades e programas adicionais que interagem com ele, como o Bib\TeX, \emph{MakeIndex}, \emph{xindy} entre outros, sendo \citeauthoronline{lamport1994latex} o criador do \LaTeXe e \citeauthoronline{mittelbach_latex_2004} os atuais mantenedores do \LaTeXe\ e do projeto do \LaTeX\ 3. \citeonline{lshort} mantém um guia atualizado de \LaTeX\ em seu site, disponível em PDF para download gratuito. O livro \emph{open-source} de \LaTeX\ no Wikibooks \url{http://en.wikibooks.org/wiki/LaTeX/} também é uma ótima fonte de busca para comandos e pacotes. A \gls{ctan} \url{http://ctan.org} é o repositório online para todos os pacotes utilizados pelo \LaTeX, assim como seus manuais. - - \bibliography{referencias} - - \appendix - - \chapter{ARQUIVOS CRIADOS PELO PROCESSO DE COMPILAÇÃO} \label{chap:arquivos} - - A seguir, as descrições dos arquivos auxiliares gerados durante o processo de compilação de um documento utilizando a classe \texttt{fei.cls} e todos os seus recursos. - - \begin{enumerate} - - \item\verb+pdflatex documento.tex+ - \begin{enumerate} - \item \texttt{alg}: \emph{log} do \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex}; - \item \texttt{aux}: arquivo com as referências a serem processadas pelo \index{Bibtex@Bib\TeX}Bib\TeX; - \item \texttt{glo,acn,sym}: listas de abreviaturas e símbolos. - \item \texttt{idx}: arquivo com os termos a serem adicionados no índice pelo \emph{MakeIndex}; - \item \texttt{loa}: lista de algoritmos; - \item \texttt{out}: atalhos (\emph{bookmarks}) utilizados pelo leitor de PDF. - \item \texttt{toc}: sumário; - \end{enumerate} - - \item\verb+bibtex documento.aux+ - \begin{enumerate} - \item \texttt{bbl}: arquivo contendo as citações utilizadas no texto, prontas a serem incluídas na próxima execução do pdf\LaTeX; - \item \texttt{blg}: \emph{log} do \index{Bibtex@Bib\TeX}Bib\TeX. - \end{enumerate} - - \item\verb+makeindex documento.idx+ - \begin{enumerate} - \item \texttt{ilg}: \emph{log} do MakeIndex. - \item \texttt{ind}: contém, em linguagem \emph{tex}, a formação do índice a ser inserida na chamada a \verb+\printindex+; - \end{enumerate} - - \item\verb+makeglossaries documento+ - \begin{enumerate} - \item \texttt{acr,sbl,gls}: contém, em linguagem \emph{tex}, a formação das listas a serem inseridas na chamada a \verb+\printglossaries+; - \item \texttt{glg}: \emph{log} do \emph{glossaries}. - \end{enumerate} - \end{enumerate} - - \chapter{REFERÊNCIA DE SÍMBOLOS \TeX{}} \label{chap:simbolos} + +\chapter{LEITURA COMPLEMENTAR} + +\citeonline{lamport1994latex} e \citeonline{mittelbach_latex_2004} descrevem de maneira completa o \LaTeX: seus comandos, funcionalidades e programas adicionais que interagem com ele, como o Bib\TeX{}, \emph{MakeIndex}, \emph{xindy} entre outros, sendo \citeauthoronline{lamport1994latex} o criador do \LaTeXe e \citeauthoronline{mittelbach_latex_2004} os atuais mantenedores do \LaTeXe\ e do projeto do \LaTeX{} 3. \citeonline{lshort} mantém um guia atualizado de \LaTeX{} em seu site, disponível em PDF para download gratuito. O livro \emph{open-source} de \LaTeX{} no Wikibooks \url{http://en.wikibooks.org/wiki/LaTeX/} também é uma ótima fonte de busca para comandos e pacotes. A \gls{ctan} \url{http://ctan.org} é o repositório online para todos os pacotes utilizados pelo \LaTeX{}, assim como seus manuais. + +\bibliography{referencias} + +\appendix + +\chapter{ARQUIVOS CRIADOS PELO PROCESSO DE COMPILAÇÃO} \label{chap:arquivos} + +A seguir, as descrições dos arquivos auxiliares gerados durante o processo de compilação de um documento utilizando a classe \texttt{fei.cls} e todos os seus recursos. + +\begin{enumerate} + +\item\verb+pdflatex documento.tex+ +\begin{enumerate} +\item \texttt{alg}: \emph{log} do \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex}; +\item \texttt{aux}: arquivo com as referências a serem processadas pelo \index{Bibtex@Bib\TeX}Bib\TeX; +\item \texttt{glo,acn,sym}: listas de abreviaturas e símbolos. +\item \texttt{idx}: arquivo com os termos a serem adicionados no índice pelo \emph{MakeIndex}; +\item \texttt{loa}: lista de algoritmos; +\item \texttt{out}: atalhos (\emph{bookmarks}) utilizados pelo leitor de PDF. +\item \texttt{toc}: sumário; +\end{enumerate} + +\item\verb+bibtex documento.aux+ +\begin{enumerate} +\item \texttt{bbl}: arquivo contendo as citações utilizadas no texto, prontas a serem incluídas na próxima execução do pdf\LaTeX; +\item \texttt{blg}: \emph{log} do \index{Bibtex@Bib\TeX}Bib\TeX{}. +\end{enumerate} + +\item\verb+makeindex documento.idx+ +\begin{enumerate} +\item \texttt{ilg}: \emph{log} do MakeIndex. +\item \texttt{ind}: contém, em linguagem \emph{tex}, a formação do índice a ser inserida na chamada a \verb+\printindex+; +\end{enumerate} + +\item\verb+makeglossaries documento+ +\begin{enumerate} +\item \texttt{acr,sbl,gls}: contém, em linguagem \emph{tex}, a formação das listas a serem inseridas na chamada a \verb+\printglossaries+; +\item \texttt{glg}: \emph{log} do \emph{glossaries}. +\end{enumerate} +\end{enumerate} + +\chapter{REFERÊNCIA DE SÍMBOLOS \TeX{}} \label{chap:simbolos} \section{LETRAS GREGAS} \begin{multicols}{3} @@ -1096,13 +1110,13 @@ Caso haja apenas um arquivo \texttt{tex} no diretório, não é necessário espe \(\swarrow\) \verb+\swarrow+\\ \end{multicols} -\printindex +\printindex \end{document} %</driver> % \fi %<*class> -\NeedsTeXFormat{LaTeX2e} -\ProvidesClass{fei}[2015/09/10 2.0 Modelo da FEI] +\NeedsTeXFormat{LaTeX2e} +\ProvidesClass{fei}[2016/09/02 2.0.1 Modelo da FEI] \LoadClass{report} % passa a opção do xindy pros pacotes que podem utilizá-lo \DeclareOption{xindy}{ @@ -1207,8 +1221,11 @@ Caso haja apenas um arquivo \texttt{tex} no diretório, não é necessário espe \ProcessOptions\relax % processa todas as opções +\RequirePackage[utf8]{inputenc} +\RequirePackage{csquotes} + % tamanho do papel (A4) e margens -% \setlength{\paperheight}{297mm} +% \setlength{\paperheight}{297mm} % \setlength{\paperwidth}{210mm} \renewcommand{\normalsize}{\fontsize{12pt}{14.4pt}\selectfont} % fonte do texto \renewcommand{\footnotesize}{\fontsize{10pt}{12pt}\selectfont} % fonte das notas de rodapé @@ -1225,7 +1242,7 @@ Caso haja apenas um arquivo \texttt{tex} no diretório, não é necessário espe \setlength{\headheight}{14.4pt} % carrega idiomas e caracteres de saída de 8 bits -\RequirePackage[english,portuges]{babel} +\RequirePackage[english,brazil]{babel} \RequirePackage[T1]{fontenc} % espaçamento do texto @@ -1236,7 +1253,7 @@ Caso haja apenas um arquivo \texttt{tex} no diretório, não é necessário espe \RequirePackage[font={singlespacing},format=hang, justification=raggedright,labelsep=endash,singlelinecheck=false]{caption} % fontes das legendas -\selectlanguage{portuges} % idioma do documento +\selectlanguage{brazil} % idioma do documento % linhas orfas e viuvas (verificar o limite) \widowpenalty=10000 @@ -1323,7 +1340,7 @@ postheadspace=1em \setlist[1]{align=left,labelindent=\parindent,labelwidth=*,labelsep=0.5em,label={\alph*)},ref=\theenumi} \setlist[2]{align=left,labelindent=\parindent,labelwidth=*,labelsep=0.5em,label={--},ref=\theenumii} \renewenvironment{itemize}{\begin{enumerate}}{\end{enumerate}} % troca o itemize pelo enumerate (seguindo o manual da biblioteca) - + \renewcommand{\floatpagefraction}{.8} % página terá apenas floats se o float ocupar pelo menos 80% da página % divisoes do texto @@ -1332,20 +1349,20 @@ postheadspace=1em % não há recuo no título de nenhum nível de nenhuma seção % títulos dos capítulos são em negrito, maiúsculo e com distâncias de 1,5 cm do parágrafo que o sucede -\renewcommand{\chapter}{\clearpage\pagestyle{fancy}% -\@startsection{chapter}{0}{0pt}{0pt}{1.5cm}{\fontsize{12pt}{14.4pt}\bfseries\MakeUppercase}} +\renewcommand{\chapter}{\cleardoublepage\pagestyle{fancy}% +\@startsection{chapter}{0}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\bfseries\MakeUppercase}} % demais níveis de seção possuem distância de 1,5 linhas do parágrafo sucessor e predecessor -\renewcommand{\section}{% +\renewcommand{\section}{% \@startsection{section}{1}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\MakeUppercase}} -\renewcommand{\subsection}{% +\renewcommand{\subsection}{% \@startsection{subsection}{2}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\bfseries}} -\renewcommand{\subsubsection}{% +\renewcommand{\subsubsection}{% \@startsection{subsubsection}{3}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\bfseries\itshape}} -\renewcommand{\paragraph}{% +\renewcommand{\paragraph}{% \@startsection{paragraph}{4}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\it}} \setcounter{secnumdepth}{4} % numerar divisões até o quarto nível (paragraph) @@ -1513,8 +1530,8 @@ postheadspace=1em \def\@cidade{S\~ao Bernardo do Campo} \newcommand{\cidade}[1]{\def\@cidade{#1}} -% instituicao (padrão Centro Universitário da FEI) -\def\@instituicao{Centro Universit\'ario da FEI} +% instituicao (padrão Centro Universitário FEI) +\def\@instituicao{Centro Universit\'ario FEI} \newcommand{\instituicao}[1]{\def\@instituicao{#1}} % nome do orientador com respectivo título (ex Dr. ...) @@ -1554,7 +1571,7 @@ postheadspace=1em \newenvironment{resumo}{\part*{Resumo}\pagestyle{empty}\begin{spacing}{1.1}\noindent\normalsize}{\end{spacing}\cleardoublepage\pagestyle{fancy}} % abstract -\renewenvironment{abstract}{\selectlanguage{english}\part*{Abstract}\pagestyle{empty}\begin{spacing}{1.1}\noindent\normalsize}{\end{spacing}\cleardoublepage\pagestyle{fancy}\selectlanguage{portuges}} +\renewenvironment{abstract}{\selectlanguage{english}\part*{Abstract}\pagestyle{empty}\begin{spacing}{1.1}\noindent\normalsize}{\end{spacing}\cleardoublepage\pagestyle{fancy}\selectlanguage{brazil}} % agradecimentos \newenvironment{agradecimentos}{\part*{Agradecimentos}\pagestyle{empty}}{\cleardoublepage\pagestyle{fancy}} @@ -1584,10 +1601,10 @@ postheadspace=1em \glssetwidest[0]{} % Configuracao de identacao do nivel 1 (a lista de simbolos em si) \glssetwidest[1]{aaaaaaaaaaaa} - + % remove número de página das listas de símbolos e abreviaturas (executado na primeira página) \renewcommand*{\glossarypreamble}{\thispagestyle{empty}\pagestyle{empty}\vspace*{-2\baselineskip}} - + \else \RequirePackage[symbols,nomain,acronym,nonumberlist,nogroupskip]{glossaries} @@ -1608,7 +1625,7 @@ postheadspace=1em \renewcommand*{\glossarypreamble}{\thispagestyle{empty}\pagestyle{empty}} \fi -\addto\captionsportuges{% +\addto\captionsbrazil{% \renewcommand*{\listfigurename}{Lista de Ilustra\c{c}\~oes}% \renewcommand*{\contentsname}{Sum\'ario}% \renewcommand*{\acronymname}{\hfill Lista de Abreviaturas \hfill \mbox{}}% |