diff options
Diffstat (limited to 'Master/texmf-dist/source/latex')
| -rw-r--r-- | Master/texmf-dist/source/latex/fei/fei.dtx | 260 |
1 files changed, 176 insertions, 84 deletions
diff --git a/Master/texmf-dist/source/latex/fei/fei.dtx b/Master/texmf-dist/source/latex/fei/fei.dtx index be623bde546..60b93ba5e78 100644 --- a/Master/texmf-dist/source/latex/fei/fei.dtx +++ b/Master/texmf-dist/source/latex/fei/fei.dtx @@ -91,7 +91,17 @@ fei.cls. % \fi % \iffalse %<*driver> -\documentclass[rascunho,xindy,oneside,symbols,acronym]{\jobname} +\begin{filecontents*}{\jobname.xmpdata} +\Title {Classe LaTeX FEI} +\Author {Douglas De Rizzo Meneghetti} +\Copyright {Copyright \copyright\ 2019 "Douglas De Rizzo Meneghetti"} +\Keywords {manual\sep latex\sep tipografia} +\Publisher {Baking International} +\Language {pt-BR} +\Subject {This is where you put the abstract.} +\end{filecontents*} + +\documentclass[xindy,oneside,symbols,acronym]{\jobname} \usepackage{multicol} \usepackage{listings} \lstset{ @@ -131,10 +141,10 @@ literate= \newacronym{fei}{FEI}{Fundação Educacional Inaciana} \newacronym{abnt}{ABNT}{Associação Brasileira de Normas Técnicas} -\newacronym{abntex}{abn\TeX}{\textit{Absurd Norms for \TeX}} +\newacronym{abntex}{abn\TeX}{\emph{Absurd Norms for \TeX}} \newacronym{cqd}{CQD}{como se queria demonstrar} \newacronym[user1=\emph{quod erat demonstrandum}]{qed}{QED}{como se queria demonstrar} -\newacronym{ctan}{CTAN}{\textit{Comprehensive \TeX{} Archive Network}} +\newacronym{ctan}{CTAN}{\emph{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}} @@ -186,9 +196,9 @@ literate= \glsaddall -Inspirado nas diversas normas da \index{ABNT}\gls{abnt} para produção de trabalhos acadêmicos, a biblioteca do Centro Universitário \index{FEI}\gls{fei} criou um guia, cuja última versão data de 2016, 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. +Inspirado nas diversas normas da \index{ABNT}\gls{abnt} para produção de trabalhos acadêmicos, a biblioteca do Centro Universitário \index{FEI}\gls{fei} criou um guia, cuja última versão data de 2016, o qual dita as regras que os alunos devem seguir na formatação de suas monografias, dissertações e teses. Através deste guia (e algumas dúzias de trabalhos corrigidos pelas bibliotecárias), nasceu a classe \LaTeX{} da \gls{fei}, especializada na criação de trabalhos acadêmicos sob as normas da biblioteca da \gls{fei}. Com ela, os alunos podem utilizar seus conhecimentos em \LaTeX{} para criar seus documentos, deixando a maior parte da 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. +A escrita da classe que formata o texto foi realizada tendo-se como referência principal o guia disponível pela biblioteca. 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. @@ -214,15 +224,15 @@ Alternativamente, é possível utilizar o gerenciador de pacotes do Mik\TeX{} pa \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}. Recomenda-se optar pela instalação completa, através do pacote \texttt{texlive-full}. +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{} \emph{Live} através do \texttt{apt-get}. Recomenda-se optar pela instalação completa, através do pacote \texttt{texlive-full}. -É 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/}. +É necessário enfatizar que a versão do \TeX{} \emph{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{} \emph{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}. +Com a versão mais recente do \TeX{} \emph{Live} instalada, é possível usar o \emph{\TeX{} Live Manager}, o gerenciador de pacotes do \TeX{} \emph{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. +No Mac, o \LaTeX{} pode ser instalado através do Mac\TeX{} (\url{http://tug.org/mactex/}), uma compilação completa do \TeX{} \emph{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 \gls{ctan} ou da página do projeto no GitHub. @@ -234,7 +244,7 @@ O processo de compilação requer que todas as dependências da classe já estej \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/}. +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{} \emph{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}; @@ -248,7 +258,7 @@ Após isso, é necessário utilizar a opção \texttt{arial} na declaração da A partir da versão 3, aclasse da FEI foi criada tendo a classe \texttt{memoir} como base, o que permitiu com que a classe da FEI fosse personalizada, em sua maioria, através do uso de comandos nativos do \LaTeX{}, reduzindo o número de pacotes do qual ela depende. -No entanto, ainda é necessário enfatizar a necessidade de instalação de alguns 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). +No entanto, ainda é necessário enfatizar a necessidade de instalação de alguns 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{} \emph{Live} (para Linux e Mac OS). \begin{enumerate} \item\texttt{algorithm2e}: provê comandos para a escrita de algoritmos; @@ -272,6 +282,7 @@ No entanto, ainda é necessário enfatizar a necessidade de instalação de algu \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{pdfx}: gera um PDF sob o padrão PDF/A (mais informações na seção \ref{subsec:pdfa}); \item\texttt{thmtools}: conjunto de macros para o pacote \texttt{amsthm}; \item\texttt{times}: carrega fonte Times New Roman; \item\texttt{uarial}: carrega fonte URW Arial. @@ -287,6 +298,27 @@ Este capítulo descreve os comandos disponibilizados pela classe. Ele é separad 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{Metadados PDF/A} \label{subsec:pdfa} + +A partir de 2017, os trabalhos depositados na biblioteca da instituição devem aderir ao padrão PDF/A, um formato específico para o arquivamento de documentos PDF e disponibilização dos metadados do documento para buscas. Para realizar o depósito do trabalho na biblioteca, é necessário que o trabalho esteja no padrão PDF/A. + +Para que o arquivo PDF seja gerado com os metadados relevantes, um arquivo com o nome do arquivo \texttt{.tex} principal, porém com extensão \texttt{.xmpdata}, deve existir no diretório-raiz do projeto contendo tais metadados. Os usuários da classe da FEI não precisam criar este documento manualmente, podendo apenas inserir as seguintes linhas antes do comando \lstinline+\documentclass+, modificando os metadados de interesse. + +\begin{lstlisting} +\begin{filecontents*}{\jobname.xmpdata} +\Title {Minha tese-dissertação-monografia} +\Author {Meu Nome\sep Nome Do Outro Integrante\sep Nome do Terceiro} +\Copyright {Copyright \copyright\ 2019 "Douglas De Rizzo Meneghetti"} +\Keywords {manual\sep latex\sep tipografia} +\Language {pt-BR} +\Subject {Resumo vai aqui em uma única linha corrida.} +\end{filecontents*} +\end{lstlisting} + +Uma lista com mais opções de metadados está disponível em \url{https://www.mathstat.dal.ca/~selinger/pdfa/sample.xmpdata}. + +Antes de depositar a versão final do trabalho, recomenda-se checar se o arquivo PDF adere ao formato PDF/A. O software padrão, que também é gratuito e multiplafatorma, para realizar a checagem é o \emph{veraPDF}\footnote{\url{https://verapdf.org/software/}}. Também é possível usar o Adobe Acrobat Pro. + \subsection{Declaração da classe} \label{subsec:documentclass} A declaração da classe é feita da seguinte forma: @@ -298,7 +330,9 @@ A declaração da classe é feita da seguinte forma: 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{draft}: Essa opção simplifica o processo de compilação do PDF para que ele seja realizado mais rapidamente. A opção beneficia especialmente a compilação de trabalhos com um número elevado de imagens ou que incluam imagens cujos arquivos sejam grandes, uma vez que as imagens não são adicionadas ao PDF. \emph{Hyperlinks} internos (\emph{e.g. links} para seções, citações, símbolos, abreviaturas, figuras, tabelas) também não são inseridos\footnote{Para uma lista mais completa das mudanças advindas do uso da opção \texttt{draft}, cheque o seguinte tópico no StackExchange: \url{https://tex.stackexchange.com/q/49277/30998}.}; + \item \texttt{nopdfa}: desabilita a geração do documento no formato PDF/A. Essa função é disponibilizada para fins de compatibilidade, para que trabalhos antigos que possivelmente sejam corrompidos durante o processo de compilação devido ao padrão PDF/A ainda possam ser compilados; + \item \texttt{deposito}: Procura por arquivos PDF referentes à ficha catalográfica e folha de aprovação no diretório do documento e os insere nos locais em que \lstinline+\fichacatalografica+ e \lstinline+\folhadeaprovacao+ são chamados. Caso contrário, insere páginas indicativas, para fins de contagem de número de páginas; \item \texttt{xindy}: configura o \bigvindex{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; @@ -309,7 +343,7 @@ A classe da FEI pode receber as seguintes opções: \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{} \lstinline+\author{autor}+ e \lstinline+\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 \lstinline+\and+ ou \lstinline+\\+, como no exemplo: +O nome do autor e o título da obra são inseridos utilizando os comandos nativos do \LaTeX{} \lstinline+\author{author}+ e \lstinline+\title{title}+. 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 \lstinline+\and+ ou \lstinline+\\+, como no exemplo: \begin{lstlisting} \author{Leonardo \and Douglas} @@ -349,9 +383,7 @@ Elétrica, orientado pelo Prof. Dr. Nome do Orientador. \subsection{Ficha catalográfica e folha de aprovação} -Os comandos \lstinline+\fichacatalografica+ e \lstinline+\folhadeaprovacao+ inserem, respectivamente, a ficha catalográfica e a folha de aprovação do trabalho no local onde o comando foi chamado. O comando \lstinline+\folhadeaprovacao+ procura pelo arquivo \texttt{ata.pdf} na pasta raiz do arquivo \texttt{tex} e o insere no documento. O comando \lstinline+\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: \lstinline+\documentclass[rascunho]{fei}+. +Os comandos \lstinline+\fichacatalografica+ e \lstinline+\folhadeaprovacao+ inserem páginas indicativas dos locais onde a ficha catalográfica e a folha de aprovação serão inseridas no trabalho. Caso a opção \lstinline+deposito+ seja passada à classe, o comando \lstinline+\folhadeaprovacao+ procura pelo arquivo \texttt{ata.pdf} na pasta raiz do arquivo \texttt{tex} e o insere no documento. O comando \lstinline+\fichacatalografica+ executa uma função semelhante, procurando pelo arquivo \texttt{ficha.pdf}. \subsection{Dedicatória} @@ -478,11 +510,23 @@ O código abaixo exemplifica a criação de uma tabela. Um exemplo de tabela cri \subsubsection{Outras ilustrações} -Além de figuras, a lista de ilustrações prevê a inclusão de novos tipos de \emph{floats}, como desenhos, esquemas, fotografias, gráficos, mapas, organogramas, plantas, quadros, retratos e outros. A classe da FEI disponibiliza uma série de ambientes que podem ser utilizados para declaração de tais \emph{floats}, os quais são inclusos na lista de ilustrações. +Além de figuras, a lista de ilustrações prevê a inclusão de outros tipos de \emph{floats}, os quais são representados pelos seguintes ambientes: -Os novos tipos de \emph{floats} disponibilizados pela classe da FEI incluem \texttt{desenho}, \texttt{esquema}, \texttt{fotografia}, \texttt{gráfico}, \texttt{mapa}, \texttt{organograma}, \texttt{planta}, \texttt{quadro} e \texttt{retrato}. Cada um deles é numerado separadamente e todos são listados na lista de ilustrações, como prevê o guia da biblioteca. +\begin{enumerate} + \item desenho; + \item esquema; + \item fotografia; + \item gráfico; + \item mapa; + \item diagrama; + \item fluxograma; + \item organograma; + \item planta; + \item quadro; + \item retrato. +\end{enumerate} -A inserção de um desses \emph{floats} é feita de maneira igual à inserção de um \texttt{figure} ou \texttt{table}, porém chamando-se o nome do ambiente desejado. Exemplos destes \emph{floats} sendo utilizados podem ser vistos no gráfico \ref{gra:grafico1}, mapa \ref{map:mapa} e gráfico \ref{gra:grafico2}. +A inserção de um desses \emph{floats} é feita de maneira igual à inserção de um \texttt{figure} ou \texttt{table}, porém chamando-se o nome do ambiente desejado. Por exemplo, para criar uma ilustração que será listada como um diagrama na lista de ilustrações, deve-se utilizar o ambiente \texttt{diagrama} ao invés de \texttt{figure}. Apesar de serem inseridos na mesma lista, cada \emph{float} é numerado separadamente, como prevê o guia da biblioteca. Exemplos destes \emph{floats} sendo utilizados podem ser vistos no gráfico \ref{gra:grafico1}, mapa \ref{map:mapa} e gráfico \ref{gra:grafico2}. O apêndice A ensina a criar novas categorias de \emph{floats} conforme necessário. @@ -627,12 +671,12 @@ A lista de referências bibliográficas, contidas em um ou mais arquivos \texttt O \LaTeX{} possui o comando nativo \lstinline+\appendix+ que, quando utilizado, transforma os capítulos subsequentes em apêndices. \begin{lstlisting} -\chapter{Último capítulo} +\chapter{ÚLTIMO CAPÍTULO} ... \appendix -\chapter{Primeiro apêndice} +\chapter{PRIMEIRO APÊNDICE} ... -\chapter{Segundo apêndice} +\chapter{SEGUNDO APÊNDICE} ... \end{lstlisting} @@ -701,7 +745,7 @@ Para citar o ano de uma obra, utilize \lstinline+\citeyear{obra}+. No caso das citações que devem ser feitas em \emph{floats}, como ilustrações e tabelas, foi criado o comando \lstinline+\citefloat{}+ um comando específico que reflete as recomendações da biblioteca. O objetivo principal deste comando é ser utilizado dentro de \lstinline+\smallcaption{}+, para que a fonte do \emph{float} seja referenciada corretamente. -\lstinline+Fonte: \citefloat{kernighan1988}.+ \(\to\) Fonte: \citefloat{kernighan1988}. +\lstinline+Fonte: \citefloat{Kernighan1988}.+ \(\to\) Fonte: \citefloat{Kernighan1988}. % \section{OUTROS EXEMPLOS} % @@ -721,14 +765,24 @@ No caso das citações que devem ser feitas em \emph{floats}, como ilustrações \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). +De acordo com o guia da biblioteca, a citação direta com mais de 3 linhas 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 no início do parágrafo. O \index{Latex@\LaTeX}\LaTeX{} já disponibiliza os ambientes \texttt{quote}, para citações de um parágrafo, e \texttt{quotation}, para citações com mais de um parágrafo. Para conseguir a formatação especificada pela biblioteca, os usuários da classe da FEI devem utilizar o ambiente \texttt{quote}. O ambiente \texttt{quotation} também foi reestruturado para ficar similar à formatação do ambiente \texttt{quote}, porém, como não há instruções para a realização de citações com mais de um parágrafo no guia da biblioteca, não existe recomendação para seu uso. -Exemplo: +Exemplo do ambiente \texttt{quote}: \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{turing50} \end{quote} +Exemplo do ambiente \texttt{quotation}: + +\begin{quotation} + The computing world has undergone a revolution since the publication of The C Programming Language in 1978. Big computers are much bigger, and personal computers have capabilities that rival mainframes of a decade ago. During this time, C has changed too, although only modestly, and it has spread far beyond its origins as the language of the UNIX operating system. + + The growing popularity of C, the changes in the language over the years, and the creation of compilers by groups not involved in its design, combined to demonstrate a need for a more precise and more contemporary definition of the language than the first edition of this book provided. In 1983, the American National Standards Institute (ANSI) established a committee whose goal was to produce ``an unambiguous and machine-independent definition of the language C'', while still retaining its spirit. The result is the ANSI standard for C. + + The standard formalizes constructions that were hinted but not described in the first edition, particularly structure assignment and enumerations. It provides a new form of function declaration that permits cross-checking of definition with use. It specifies a standard library, with an extensive set of functions for performing input and output, memory management, string manipulation, and similar tasks. It makes precise the behavior of features that were not spelled out in the original definition, and at the same time states explicitly which aspects of the language remain machine-dependent. \cite{Kernighan1988} +\end{quotation} + \section{CITAÇÕES DE MÚLTIPLAS OBRAS COM MESMO AUTOR} Essa seção demonstra a formatação de citações quando o(s) primeiro(s) autor(es) de uma obra é(são) o(s) mesmo(s). @@ -1256,15 +1310,24 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % \fi %<*class> \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{fei}[2018/12/17 4.3.1 Modelo da FEI] +\ProvidesClass{fei}[2019/05/31 4.5.1 Modelo da FEI] +% passa a opção draft para a classe +\DeclareOption{draft}{ + \PassOptionsToClass{\CurrentOption}{memoir} +} +% passa a opção final para a classe +\DeclareOption{final}{ + \PassOptionsToClass{\CurrentOption}{memoir} +} % passa a opção do xindy pros pacotes que podem utilizá-lo \DeclareOption{xindy}{ \PassOptionsToPackage{\CurrentOption}{imakeidx} \PassOptionsToPackage{\CurrentOption}{glossaries-extra} } -%------------------------------------------------------------ +%--------------------------------------------------------------- +% opções relacionadas aos pacotes glossaries e glossaries-extra \newif\ifglossaries \glossariesfalse % opção para configurar a lista de símbolos @@ -1281,13 +1344,13 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \newif\ifsublist \sublistfalse \DeclareOption{sublist}{\sublisttrue} -%------------------------------------------------------------ +%--------------------------------------------------------------- -% opções rascunho e final controlam a exibição da folha +% opção deposito controla a exibição da folha % de aprovação e ficha catalográfica -\newif\ifrascunho -\rascunhofalse -\DeclareOption{rascunho}{\rascunhotrue} +\newif\ifdeposito +\depositofalse +\DeclareOption{deposito}{\depositotrue} \newif\ifarial \DeclareOption{arial}{\arialtrue} @@ -1299,6 +1362,13 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \DeclareOption{algo-as-figure}{\PassOptionsToPackage{figure}{algorithm2e}}% +\newif\ifpdfa +\pdfatrue +% opção para configurar a lista de símbolos +\DeclareOption{nopdfa}{ + \pdfafalse +} + % Assume that any unknown option will be understood by the base class: % \DeclareOption*{% % \ClassWarning{fei}{fei class doesn't recognize \CurrentOption. Passing it to memoir.} @@ -1307,7 +1377,7 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % https://tex.stackexchange.com/questions/229355/algorithm-algorithmic-algorithmicx-algorithm2e-algpseudocode-confused -\PassOptionsToClass{a4paper}{memoir} +\PassOptionsToClass{a4paper,12pt}{memoir} % processa opções-padrão % oneside é padrão na classe da FEI, apesar de twoside ser padrão na classe base, memoir @@ -1339,33 +1409,34 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % A POLEMICA DO ESPACAMENTO DE "UM E MEIO" %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% these are the commands provided by memoir +% os seguintes comandos são disponibilizados pela classe memoir % \OnehalfSpacing % \DoubleSpacing -% these commands exist natively on LaTeX -% the values below are magically recommended for one half and double spacing -% more on their values here https://en.wikibooks.org/wiki/LaTeX/Text_Formatting#Line_Spacing +% esses comandos existem nativamente no LaTeX +% os valores abaixo são recomendados magicamente para espaçamento de 1,5 e duplo, respectivamente +% mais sobre esses valores em https://en.wikibooks.org/wiki/LaTeX/Text_Formatting#Line_Spacing % \linespread{1.3} % \linespread{1.6} -% another option is the setspace package -% to use it with memoir, these lines must be added +% outra opção é usar o pacote setspace +% para usá-lo com memoir, precisa-se usar a seguinte configuração % \DisemulatePackage{setspace} % \usepackage{setspace} -% these command are provided by setspace, which seem promising +% esses comandos são disponibilizados pelo setspace % \spacing{1.5} % \onehalfspacing % \doublespacing -% here is a comparison of the different commands -% \OnehalfSpacing = setspace + \linespread{1.25} -% \linespread{1.5} = setspace + \spacing{1.5} -% \DoubleSpacing = setspace + \onehalfspacing +% aqui está uma comparação entre os diferentes métodos +% \OnehalfSpacing = setspace com \linespread{1.25} +% \linespread{1.5} = setspace com \spacing{1.5} +% \DoubleSpacing = setspace com \onehalfspacing -% this is the value I visually found closer to Word one-half spacing -% it also adds no extra dependencies +% esse é o valor que eu considerei que visualmente se parece +% mais com o espaçamento de 1,5 do Word +% o comando não possui dependências \linespread{1.5} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -1524,6 +1595,22 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \renewcommand*{\cftmapaaftersnum}{\hfill--\hfill} \setfloatlocations{mapa}{hbtp} % configurando posicionamento padrão +\newcommand{\diagramaname}{Diagrama} +\newfloat[chapter]{diagrama}{lof}{\diagramaname} +\newlistentry{diagrama}{lof}{0} +\counterwithout{diagrama}{chapter} +\renewcommand{\cftdiagramaname}{\diagramaname\space} +\renewcommand*{\cftdiagramaaftersnum}{\hfill--\hfill} +\setfloatlocations{diagrama}{hbtp} % configurando posicionamento padrão + +\newcommand{\fluxogramaname}{Fluxograma} +\newfloat[chapter]{fluxograma}{lof}{\fluxogramaname} +\newlistentry{fluxograma}{lof}{0} +\counterwithout{fluxograma}{chapter} +\renewcommand{\cftfluxogramaname}{\fluxogramaname\space} +\renewcommand*{\cftfluxogramaaftersnum}{\hfill--\hfill} +\setfloatlocations{fluxograma}{hbtp} % configurando posicionamento padrão + \newcommand{\organogramaname}{Organograma} \newfloat[chapter]{organograma}{lof}{\organogramaname} \newlistentry{organograma}{lof}{0} @@ -1577,11 +1664,11 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % 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}{\cleardoublepage\pagestyle{plain}% - \@startsection{chapter}{0}{0pt}{1pt}{1pt}{\fontsize{12pt}{14.4pt}\bfseries\MakeUppercase}} + \@startsection{chapter}{0}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\bfseries}} % demais níveis de seção possuem distância de 1,5 linhas do parágrafo sucessor e predecessor \renewcommand{\section}{% - \@startsection{section}{1}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\MakeUppercase}} + \@startsection{section}{1}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}}} \renewcommand{\subsection}{% \@startsection{subsection}{2}{0pt}{\baselineskip}{\baselineskip}{\fontsize{12pt}{14.4pt}\bfseries}} @@ -1691,7 +1778,10 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \textbf{\MakeUppercase{\@title}}\ifthenelse{\isundefined{\@subtitulo}}{}{: \@subtitulo} \vfill \begin{flushright} - \begin{minipage}{0.55\textwidth}}{\end{minipage}{} + \begin{minipage}{\textwidth - 8cm} + \normalsize + \begin{SingleSpace} + }{\end{SingleSpace}\end{minipage}{} \end{flushright} \vfill \@cidade\\[0.5em] @@ -1700,15 +1790,15 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \clearpage } -% folha de aprovação: procura o arquivo *ata.pdf* e inclui no texto -% se a classe recebeu a opção rascunho, deixa um texto no lugar falando que pagina é essa +% folha de aprovação: deixa um texto no lugar falando que pagina é essa +% se a classe recebeu a opção deposito, procura o arquivo *ata.pdf* e inclui no texto \RequirePackage{pdfpages} \RequirePackage{ifthen} \newcommand{\folhadeaprovacao}{ - \ifrascunho - \thispagestyle{empty}\mbox{}\vfill\begin{center}\begin{Huge}Folha de aprova\c{c}\~{a}o\end{Huge}\vfill\end{center}\cleardoublepage - \else + \ifdeposito \includepdf{ata.pdf}\cleardoublepage + \else + \thispagestyle{empty}\mbox{}\vfill\begin{center}\begin{Huge}Folha de aprova\c{c}\~{a}o\end{Huge}\vfill\end{center}\cleardoublepage \fi } @@ -1719,10 +1809,10 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % se não for frente e verso, a ficha catalográfica não é contada no verso da folha de rosto \addtocounter{page}{-1} \fi - \ifrascunho - \thispagestyle{empty}\mbox{}\vfill\begin{center}\begin{Huge}Ficha catalogr\'{a}fica\end{Huge}\vfill\end{center}\cleardoublepage - \else + \ifdeposito \includepdf{ficha.pdf}\cleardoublepage + \else + \thispagestyle{empty}\mbox{}\vfill\begin{center}\begin{Huge}Ficha catalogr\'{a}fica\end{Huge}\vfill\end{center}\cleardoublepage \fi } @@ -1796,23 +1886,23 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \oldprintindex% }% -% \begin{filecontents*}{\jobname.xmpdata} -% \Title {Classe LaTeX FEI} -% \Author {Douglas De Rizzo Meneghetti} -% \Copyright {Copyright \copyright\ 2018 "Douglas De Rizzo Meneghetti"} -% \Keywords {manual\sep -% latex\sep -% tipografia} -% \Publisher {Baking International} -% \Subject {This is where you put the abstract.} -% \end{filecontents*} - -% \usepackage[a-1b]{pdfx} - -% hyperlinks entre partes do documento -% deveria ser o último a ser carregado, porém... +% antigamente, aqui era carregado o pacote hyperref +% como, a partir de 2017, a biblioteca exige que os documentos sejam gerados sob o padrão +% PDF/A, o pacote pdfx é usado no lugar do hyperref por padrão +% em teoria, o pacote hyperref deveria ser o último a ser carregado, porém % funcionou posicionado antes do glossaries, possibilitando links das variaveis para lista de simbolos -\RequirePackage[pdftex,pdfborder={0 0 0},colorlinks={false}]{hyperref} +\ifpdfa + \RequirePackage[a-1b]{pdfx} +\else + \RequirePackage{hyperref} +\fi + +% o pacote pdfx carrega o hyperref, então as opções do hyperref são passadas assim agora +\hypersetup{% + pdftex,% + pdfborder={0 0 0},% + colorlinks={false}% +} % pacote para gerar listas (símbolos, abreviaturas, etc) % glossaries-extra é usado pois permite incluir abreviaturas em seus idiomas originais @@ -1959,18 +2049,20 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % modifica ambiente quote para citações de um parágrafo com mais de 3 linhas \renewenvironment{quote} -{\begin{SingleSpace}\list{}{% - \fontsize{10pt}{1em}% - \leftmargin=4cm}% - \item\relax\ignorespaces} - {\endlist\end{SingleSpace}} +{\begin{flushright} + \begin{minipage}{\textwidth - 4cm} + \fontsize{10pt}{1em} + \begin{SingleSpace} + }{\end{SingleSpace}\end{minipage}{} + \end{flushright}} + % quotation é igual a quote, porém para citações com mais de um parágrafo. \renewenvironment{quotation} -{\begin{SingleSpace}\list{}{% - \fontsize{10pt}{1em}% - \leftmargin=2cm \rightmargin=2cm% - \listparindent .5cm \itemindent}% - \item\relax} - {\endlist\end{SingleSpace}} +{\begin{center} + \begin{minipage}{\textwidth - 4cm} + \fontsize{10pt}{1em} + \begin{SingleSpace}\setlength{\parindent}{1cm} + }{\end{SingleSpace}\end{minipage}{} +\end{center}} %</class> |