diff options
author | Karl Berry <karl@freefriends.org> | 2020-02-10 22:11:52 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-02-10 22:11:52 +0000 |
commit | 7c0aaaf9015ab6effaa6536b5906ea9cf44eaee9 (patch) | |
tree | 08cc66c267b84fb6029c5ecbdfd7af1d3579bca2 /Master/texmf-dist | |
parent | 3b5ef52b5110c41d0435ee83f597785ccf7f8e8e (diff) |
fei (10feb20)
git-svn-id: svn://tug.org/texlive/trunk@53748 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist')
-rw-r--r-- | Master/texmf-dist/doc/latex/fei/fei-template-sublist.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/fei/fei-template.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/fei/fei.pdf | bin | 439956 -> 440464 bytes | |||
-rw-r--r-- | Master/texmf-dist/source/latex/fei/fei.dtx | 109 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/fei/fei.cls | 12 |
5 files changed, 61 insertions, 64 deletions
diff --git a/Master/texmf-dist/doc/latex/fei/fei-template-sublist.tex b/Master/texmf-dist/doc/latex/fei/fei-template-sublist.tex index 344dea299f7..b228dcb5659 100644 --- a/Master/texmf-dist/doc/latex/fei/fei-template-sublist.tex +++ b/Master/texmf-dist/doc/latex/fei/fei-template-sublist.tex @@ -8,7 +8,7 @@ \Subject {Resumo vai aqui em uma única linha corrida.} \end{filecontents*} -\documentclass[xindy,acronym,symbols,sublist]{fei} +\documentclass[acronym,symbols,sublist]{fei} \usepackage[utf8]{inputenc} diff --git a/Master/texmf-dist/doc/latex/fei/fei-template.tex b/Master/texmf-dist/doc/latex/fei/fei-template.tex index cef47bc5044..71fd5aca726 100644 --- a/Master/texmf-dist/doc/latex/fei/fei-template.tex +++ b/Master/texmf-dist/doc/latex/fei/fei-template.tex @@ -1,5 +1,5 @@ -\documentclass[xindy,acronym,symbols]{fei} +\documentclass[acronym,symbols]{fei} \usepackage[utf8]{inputenc} diff --git a/Master/texmf-dist/doc/latex/fei/fei.pdf b/Master/texmf-dist/doc/latex/fei/fei.pdf Binary files differindex 6f035f5c9f4..f35c2c74242 100644 --- a/Master/texmf-dist/doc/latex/fei/fei.pdf +++ b/Master/texmf-dist/doc/latex/fei/fei.pdf diff --git a/Master/texmf-dist/source/latex/fei/fei.dtx b/Master/texmf-dist/source/latex/fei/fei.dtx index 3fae8c81a87..fae4eba53a5 100644 --- a/Master/texmf-dist/source/latex/fei/fei.dtx +++ b/Master/texmf-dist/source/latex/fei/fei.dtx @@ -101,7 +101,7 @@ fei.cls. \Subject {This is where you put the abstract.} \end{filecontents*} -\documentclass[xindy,oneside,symbols,acronym]{\jobname} +\documentclass[oneside,symbols,acronym]{\jobname} \usepackage{multicol} \usepackage{listings} \lstset{ @@ -182,7 +182,7 @@ literate= % \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. + 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 \LaTeX{} da FEI. 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} @@ -208,7 +208,7 @@ A escrita da classe que formata o texto foi realizada tendo-se como referência 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: 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{}. +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 \LaTeX{} da FEI 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{NOTA AOS USUÁRIOS ANTIGOS DA CLASSE} @@ -246,7 +246,7 @@ O Mac\TeX{} nem sempre possui a versão mais recente dos pacotes do repositório 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 arquivos necessários para o procedimento. Para tanto, clone o repositório para um diretório e compile-o usando o Makefile disponível. -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. +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 \LaTeX{} da FEI, a qual deve ser mantida no mesmo diretório do arquivo \texttt{tex} do trabalho do aluno. \section{FONTE ARIAL} @@ -264,13 +264,13 @@ 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{} \emph{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 \LaTeX{} da FEI 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; \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{biblatex}: pacote que substitui o Bib\TeX{} no tratamento de referências bibliográficas; + \item\texttt{biblatex}: pacote avançado para o tratamento de referências bibliográficas; \item\texttt{biblatex-abnt}: formata citações e referências de acordo com o padrão \index{ABNT}\gls{abnt} 6023; \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; @@ -302,7 +302,7 @@ Este capítulo descreve os comandos disponibilizados pela classe. Ele é separad \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: +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 \LaTeX{} da FEI contém os seguintes elementos que devem ser declarados no preâmbulo: \subsection{Metadados PDF/A} \label{subsec:pdfa} @@ -339,7 +339,6 @@ A classe da FEI pode receber as seguintes opções: \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; \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{memoir}, a classe da FEI pode receber algumas opções nativas de \texttt{memoir}. 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. @@ -371,7 +370,7 @@ Para saber como imprimir a lista de referências bibliográficas na seção pós \section{PRÉ-TEXTO}\label{sec:pretexto} -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. +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 \LaTeX{} da FEI e os respectivos comandos para a criação de cada um deles. \subsection{Capa} @@ -808,15 +807,13 @@ Já nos trabalhos de \textcite{duan2012large,duan2012reduced,duan2014functional} \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 \bigvindex{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. +Assim como as referências são geradas por um programa a parte (o Biber), a criação de índices remissivos também o é. Neste quesito, a classe da FEI faz uso do programa \bigvindex{xindy} como gerador de índices. Mais especificamente, os programas \texttt{xindy} e \texttt{texindy} são necessários para geração de índices remissivos. O xindy foi selecionado como gerador de índices para a classe da FEI devido ao suporte a diversos e idiomas e indexação de palavras com caracteres mais exóticos -- como acentos ou cedilha. -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: \lstinline+\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}. +Em suma, a geração de índices remissivos tem como dependências os programas \texttt{xindy} e \texttt{texindy} e o pacote \texttt{imakeidx} do \LaTeX{}. 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 \lstinline+\makeindex+ ao preâmbulo de seu texto. +Para que o \LaTeX{} crie os arquivos auxiliares que serão lidos pelo \emph{xindy}, é necessário sinalizar o compilador para que essa criação seja feita. Isso é feito adicionando o comando \lstinline+\makeindex+ ao preâmbulo de seu texto. \section{INDEXANDO PALAVRAS} @@ -826,11 +823,11 @@ Exemplo: [\ldots] a biblioteca do Centro Universitário \lstinline+\index{FEI}+\ É 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 \textcite{mittelbach_latex_2004}, que disserta tanto sobre o \emph{xindy} como \emph{MakeIndex}. +Para aprender dicas avançadas na criação de índices mais complexos, recomenda-se a leitura da documentação do pacote \emph{MakeIndex} (\url{http://www.ctan.org/pkg/makeindex}), o pacote original de geração de índices do \LaTeX{}, \textcite{mittelbach_latex_2004} também é uma leitura recomendada, pois disserta tanto sobre o \emph{xindy} como o \emph{MakeIndex}. \section{IMPRIMINDO O ÍNDICE} -A impressão do índice é feita utilizando o comando \lstinline+\printindex+, o qual, além de imprimir o índice, inclui uma entrada para o mesmo no sumário. +A impressão do índice é feita utilizando o comando \lstinline+\printindex+, o qual também inclui uma entrada para o mesmo no sumário do documento. \chapter{LISTAS DE SÍMBOLOS E ABREVIATURAS} \label{chap:listas} @@ -927,49 +924,58 @@ A lista de abreviaturas pode ser impressa através do comando \lstinline+\printa \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. +Para utilizar todos os recursos que a \texttt{fei.cls} disponibiliza, é necessário compilar o projeto utilizando diferentes programas. Esta sessão descreve tanto uma maneira automatizada de se compilar o projeto, usando o latexmk, assim como os programas que podem ser chamados manualmente, para fins de depuração.. + +\section{COMPILAÇÃO AUTOMATIZADA} \label{sec:latexmk} + +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. Dentre as ferramentas mais conhecidas estão o \texttt{latexmk}, \texttt{rubber} e \texttt{arara}, criadas especificamente para realizar a automatização da compilação de documentos \TeX{}. Para a classe da FEI, recomenda-se o uso do \texttt{latexmk}. As configurações necessárias são disponibilizadas no arquivo \texttt{.latexmkrc}, o qual deve ser colocado no mesmo diretório que o arquivo \texttt{.tex} principal do documento. O \texttt{latexmk} pode então ser chamado da seguinte forma (supondo que haja um arquivo chamado \texttt{documento.tex} no diretório atual): + +\begin{enumerate} + \item \texttt{latexmk -pdf documento.tex} +\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. + +\section{COMPILAÇÃO MANUAL} \label{sec:dificil} + +A compilação manual do projeto depende dos seguintes programas: + +\begin{enumerate} + \item \texttt{pdflatex}: gera todos os arquivos auxiliares, utilizados pelos demais programas, assim como uma versão do PDF com os elementos compilados até o momento; + \item \texttt{biber}: gera a bibliografia lendo o arquivo \texttt{bib} utilizado. Necessário apenas se citações e referências forem usadas no texto; + \item \texttt{makeglossaries}: cria um ou mais arquivos de listas (de símbolos e abreviaturas). Necessário apenas se houve indexação e utilização de símbolos e abreviaturas no texto; + \item \texttt{texindy}: cria um ou mais arquivos de índice. Necessário apenas se houver indexação de palavras para serem adicionadas ao índice; + \item \texttt{bib2gls}: transforma uma lista de abreviaturas e símbolos, criada utilizando um arquivo \texttt{bib}, em listas de símbolos e abreviaturas a serem processadas pelo \texttt{makeglossaries}. +\end{enumerate} -\section{O JEITO DIFÍCIL} \label{sec:dificil} +A ordem na qual os programas devem ser executados depende de quais funcionalidades da classe da FEI forma utilizadas no documento: a ausência de referências bibliográficas torna desnecessário o uso do \texttt{biber}; a ausência de abreviaturas e símbolos torna denecessário o uso do \texttt{makeglossaries} e a ausência de índice remissivo torna desnecessário o uso do \texttt{texindy}. Ademais, se compilações anteriores modificam a localização de certos elementos já posicionados do texto (e.g. uma palavra indexada na página 30 é ``empurrada'' para a página 31 depois que as citações bibliográficas são inseridas no texto), os programas talvez tenham que ser executados diversas vezes até alcançar-se um PDF correto e estável. Essas preocupações são desnecessárias caso o \texttt{latexmk} seja usado, como descrito na sessão~\ref{sec:latexmk}. -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}. +Uma ordem comum para se compilar o projeto é a seguinte: -\[\operatorname*{\text{pdf\LaTeX}}_a \to \operatorname*{\text{Biber}}_b \to \operatorname*{\text{MakeGlossaries}}_c \to \operatorname*{\text{pdf\LaTeX}}_d \to \operatorname*{\text{MakeIndex}}_e \to \operatorname*{\text{pdf\LaTeX}}_f\] +\[\operatorname*{\text{pdf\LaTeX}}_a \to \operatorname*{\text{Biber}}_b \to \operatorname*{\text{MakeGlossaries}}_c \to \operatorname*{\text{pdf\LaTeX}}_d \to \operatorname*{\text{texindy}}_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 cria um ou mais arquivos de listas (de símbolos e abreviaturas). 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: +Os comandos equivalentes num terminal no Linux ou Mac OS são os seguintes: \begin{lstlisting} -pdflatex documento.tex +pdflatex --shell-escape documento.tex biber documento makeglossaries documento -pdflatex documento.tex -makeindex documento.idx -pdflatex documento.tex +pdflatex --shell-escape documento.tex +texindy documento.idx +pdflatex --shell-escape documento.tex \end{lstlisting} -Caso o \bigvindex{xindy} esteja sendo usado como o motor de indexação, é necessário passar o parâmetro \lstinline+-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. - -\begin{enumerate} - \item \texttt{latexmk -pdf -interaction=nonstopmode documento} - \item \texttt{rubber -d documento} -\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{LEITURA COMPLEMENTAR} \textcite{lamport1994latex} e \textcite{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 \citeauthor*{lamport1994latex} o criador do \LaTeXe e \citeauthor*{mittelbach_latex_2004} os atuais mantenedores do \LaTeXe\ e do projeto do \LaTeX{} 3. \textcite{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. @@ -1068,14 +1074,14 @@ Para criar uma nova categoria de \emph{float}, a qual será listada na lista de \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. +A seguir, as descrições dos arquivos auxiliares gerados durante o processo de compilação de um documento utilizando a classe \LaTeX{} da FEI e todos os seus recursos. \begin{enumerate} \item\lstinline+pdflatex documento.tex+ \begin{enumerate} \item \texttt{alg}: \emph{log} do \index{makeindex@\emph{MakeIndex}}\emph{MakeIndex}; - \item \texttt{bcf}: arquivo com as referências a serem processadas pelo \index{Bibtex@Bib\TeX}Bib\TeX; + \item \texttt{bcf}: arquivo com as referências a serem processadas pelo Biber; \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; @@ -1085,13 +1091,13 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \item\lstinline+biber documento.aux+ \begin{enumerate} + \item \texttt{bcf}: arquivo de controle do Biber; \item \texttt{bbl}: arquivo contendo as citações utilizadas no texto, prontas a serem incluídas na próxima execução do pdf\LaTeX. \end{enumerate} - \item\lstinline+makeindex documento.idx+ + \item\lstinline+texindy 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 \lstinline+\printindex+; + \item \texttt{ind}: contém, em linguagem \emph{tex}, a formação do índice a ser inserida na chamada a \lstinline+\printindex+. \end{enumerate} \item\lstinline+makeglossaries documento+ @@ -1325,7 +1331,7 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % \fi %<*class> \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{fei}[2019/10/03 4.6 Modelo da FEI] +\ProvidesClass{fei}[2020/02/09 4.7 Modelo da FEI] % passa a opção draft para a classe \DeclareOption{draft}{ @@ -1335,11 +1341,6 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \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 @@ -1355,7 +1356,7 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \glossariestrue \PassOptionsToPackage{\CurrentOption}{glossaries-extra} } -% opção para configurar a lista de abreviaturas +% opção para configurar a lista de símbolos como um arquivo .bib \DeclareOption{record}{ \glossariestrue \PassOptionsToPackage{\CurrentOption}{glossaries-extra} @@ -1891,7 +1892,7 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \newenvironment{agradecimentos}{\part*{Agradecimentos}\pagestyle{empty}}{\cleardoublepage\pagestyle{plain}} % índice -\RequirePackage{imakeidx} +\RequirePackage[xindy]{imakeidx} \indexsetup{level=\part*} \addto\captionsbrazil{% \renewcommand{\indexname}{\'Indice}% @@ -1928,7 +1929,7 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de % este foi o problema que eu resolvi com ele: https://tex.stackexchange.com/a/77561/30998 \ifglossaries \ifsublist - \RequirePackage[nomain,nonumberlist,section=part]{glossaries-extra} + \RequirePackage[xindy,nomain,nonumberlist,section=part]{glossaries-extra} % estilo usado como base \setglossarystyle{alttree} % Configuracao de identacao do nivel 0 (titulos) @@ -1940,7 +1941,7 @@ A seguir, as descrições dos arquivos auxiliares gerados durante o processo de \renewcommand*{\glossarypreamble}{\thispagestyle{empty}\pagestyle{empty}\vspace*{-2\baselineskip}} \else - \RequirePackage[nomain,nonumberlist,section=part,nogroupskip]{glossaries-extra} + \RequirePackage[xindy,nomain,nonumberlist,section=part,nogroupskip]{glossaries-extra} \newglossarystyle{mylong}{% \setglossarystyle{long}% base this style on the long style diff --git a/Master/texmf-dist/tex/latex/fei/fei.cls b/Master/texmf-dist/tex/latex/fei/fei.cls index cdc7b919c4a..c3ad4f858b3 100644 --- a/Master/texmf-dist/tex/latex/fei/fei.cls +++ b/Master/texmf-dist/tex/latex/fei/fei.cls @@ -14,7 +14,7 @@ %% See http://www.latex-project.org/lppl.txt %% ----------------------------------------------------------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{fei}[2019/10/03 4.6 Modelo da FEI] +\ProvidesClass{fei}[2020/02/09 4.7 Modelo da FEI] \DeclareOption{draft}{ \PassOptionsToClass{\CurrentOption}{memoir} @@ -22,10 +22,6 @@ \DeclareOption{final}{ \PassOptionsToClass{\CurrentOption}{memoir} } -\DeclareOption{xindy}{ -\PassOptionsToPackage{\CurrentOption}{imakeidx} -\PassOptionsToPackage{\CurrentOption}{glossaries-extra} -} \newif\ifglossaries \glossariesfalse @@ -465,7 +461,7 @@ postheadspace=1em \newenvironment{agradecimentos}{\part*{Agradecimentos}\pagestyle{empty}}{\cleardoublepage\pagestyle{plain}} -\RequirePackage{imakeidx} +\RequirePackage[xindy]{imakeidx} \indexsetup{level=\part*} \addto\captionsbrazil{% \renewcommand{\indexname}{\'Indice}% @@ -492,7 +488,7 @@ colorlinks={false}% \ifglossaries \ifsublist -\RequirePackage[nomain,nonumberlist,section=part]{glossaries-extra} +\RequirePackage[xindy,nomain,nonumberlist,section=part]{glossaries-extra} \setglossarystyle{alttree} \glssetwidest[0]{} \glssetwidest[1]{aaaaaaaaaaaa} @@ -500,7 +496,7 @@ colorlinks={false}% \renewcommand*{\glossarypreamble}{\thispagestyle{empty}\pagestyle{empty}\vspace*{-2\baselineskip}} \else -\RequirePackage[nomain,nonumberlist,section=part,nogroupskip]{glossaries-extra} +\RequirePackage[xindy,nomain,nonumberlist,section=part,nogroupskip]{glossaries-extra} \newglossarystyle{mylong}{% \setglossarystyle{long}% base this style on the long style |