Skip to content
Douglas De Rizzo edited this page Sep 20, 2021 · 18 revisions
Clone this wiki locally

FAQ para usuários

Quem fez a classe da FEI?

Eu, durante meu mestrado e doutorado. Antes de mim, um aluno chamado Leonardo Anjoletto. Que Deus o tenha.

A instituição tem algo a ver com o projeto?

Não. A classe não é um material oficial da instituição, mas a biblioteca está ciente que ela existe e me auxiliou tirando eventuais dúvidas de formatação que não eram cobertas pelo guia de formatação. Atualmente, a classe alcançou um nível de maturidade no qual ela preenche todos os requisitos necessários para produzir um trabalho acadêmico de qualidade.

Eu usei a classe da FEI. Meu trabalho será aprovado?

Não necessariamente. Utilizar a classe da FEI não garante a aceitação automática do trabalho pela biblioteca. É preciso tomar alguns cuidados com relação a como o trabalho é escrito (i.e. usar os comandos certos nos lugares certos). A maioria desses cuidados são mencionados no manual da classe.

O que é LaTeX?

https://pt.wikipedia.org/wiki/LaTeX

Como instalo LaTeX?

  • No Windows: MikTeX
  • No Mac: MacTeX
  • No Linux: TeX Live. Eu recomendo o uso do instalador via internet. Não recomendo instalar pelo apt-get, yum, pacman ou afins, visto que essas versões estão sempre desatualizadas.

Como aprendo a programar em LaTeX?

O site que eu consulto para comandos básicos do LaTeX: https://en.wikibooks.org/wiki/LaTeX

Recentemente, o site do Overleaf anda com bons tutoriais: https://www.overleaf.com/learn/latex/Main_Page

Instalei o LaTeX. Como uso a classe da FEI?

Se você compilou seu documento e uma mensagem de erro indicou que a classe não existe em seu computador, siga os passos a seguir para baixá-la.

Instalando pelo gerenciador de pacotes do LaTeX

  • Usuários de Windows/Mac: o gerenciador de pacotes do MikTeX chama-se Package Manager. No MacTeX, ele se chama TeX Live Utility. Abra este programa, procure pela classe da FEI (chamada fei) e instale-na. No Windows também é possível instalar TeX Live. Caso tenha feito isso, siga as instruções abaixo para Linux.

  • Usuários de Linux: se você baixou e instalou o LaTeX usando o instalador disponível no site do TeX Live, procure pelo programa chamado TeX Live Manager no seu computador (nos menus do sistema ou através do comando tlmgr --gui) e instale a classe da FEI e suas dependências por ali. Senão, instale manualmente como descrito abaixo.

Instalando manualmente

Baixe o zip da versão mais recente da classe neste link e copie o arquivo fei.cls para o diretório onde está o arquivo .tex de seu trabalho.

Depois de instalada...

Se você usou uma instalação do LaTeX para encontrar a classe, baixe este template disponível no CTAN. Ele está pronto para ser compilado e alterado para os fins pessoais de cada um. Se você baixou o zip no GitHub, use um dos templates que vem com o zip. Se você é aventureiro e baixou o repositório, use um dos templates que esão na pasta raiz do repositório

Tenho dúvidas sobre LaTeX. Onde posso saná-las?

Para comandos gerais: https://en.wikibooks.org/wiki/LaTeX.

Para dúvidas extremamente específicas: TeX StackExchange. Primeiro pesquise para ver se sua pergunta já não foi feita.

Sei LaTeX, mas não sei usar a classe da FEI. Você me ajuda?

Primeiro, consulte o manual. Ele cobre todos os comandos disponibilizados pela classe, na ordem correta para se criar um trabalho acadêmico. Se você fizer uma pergunta que está respondida no manual, será apontado para o manual.

Caso o manual não possua a solução, você pode tentar perguntar no Google Groups ou mandar um e-mail para mim. Os issues do GitHub são reservados para reportar problemas na classe.

Não sei porque a classe formata essa coisa específica desse jeito. Você pode alterar?

Se não está nos guias de formatação da faculdade, provavelmente não.

Mas eu posso alterar?

Sim. Você pode tentar criar novos comandos ou redefini-los dentro do seu próprio trabalho, ou alterar o conteúdo do arquivo fei.cls diretamente. Se você instalou a classe da FEI usando algum gerenciador de pacotes, vai precisar de uma cópia do arquivo fei.cls no diretório local do seu documento. O arquivo fei.dtx, disponibilizado no GitHub, contém uma versão comentada do que cada comando faz, que pode ser útil para quem quiser modificar a classe.

A alteração que eu fiz é útil. Posso compartilhar?

Sim. Faça um fork do repositório no GitHub e me mande um pull request. Se você não sabe como, leia isto.

Antes de contribuir, recomendo criar um issue no GitHub para discutir a contribuição e garantir que ela é correta e será útil para todos.

Eu criei alguns testes que podem ser rodados através do comando make tests. Antes de fazer o merge, precisamos garantir que os testes passem, que os templates sejam compilados com sucesso e que o manual reflita as mudanças realizadas.

Não consigo gerar citações/referências, o que faço?

O problema mais comum de todos os usuários é compilar seus trabalhos usando bibtex. A classe da FEI não usa o bibtex, ela usa o biber. Veja mais abaixo como configurar o TeXStudio para usar o biber.

Consigo gerar citações e referências, mas não sei quais comandos usar. O que faço?

Para exemplos de comandos de citações disponíveis (\cite, \textcite, \apud, \textapud etc), consulte a documentação do biblatex-abnt, o pacote usado pela classe da FEI para formatar citações e referências de acordo com as normas da ABNT.

Não consigo referenciar algo desse jeito específico que somente eu necessito e mais ninguém. O que faço?

Crie seu próprio comando de citação usando os comandos pré-definidos pelo biblatex-abnt.

Os nomes dos autores estão sendo impressos por extenso. O que faço?

Garanta que o nome de um mesmo autor apareça exatamente da mesma forma em todas as entradas no arquivo .bib. Os nomes abaixo serão tomados pelo biber como pessoas distintas que precisam ser desambiguadas e, por isso, vão ter seus nomes impressos por extenso.

  • José Da Silva
  • José da Silva
  • JOSÉ DA SILVA
  • J. da Silva
  • J. Silva
  • J. SILVA
  • José Silva
  • Jozé da Silva

Isso também pode ocorrer quando você possui múltiplas obras do mesmo ano cujos autores possuem o mesmo sobrenome. Por exemplo, um trabalho de 2002 de José da Silva e outro de Jonas da Silva precisam ser desambiguados, então serão citados como (DA SILVA, José; 2002) e (DA SILVA, Jonas; 2002).

Minhas citações e referências estão erradas por motivos crípticos que não consigo decifrar. O que faço?

Leia os erros e warnings e corrija-os. O compilador exibe a maioria dos erros relacionados às referências bibliográficas (entradas mal-formatadas, erradas, duplicadas, com informações faltando etc).

Não crie seu arquivo .bib manualmente. Use um gerenciador de referências. Adicione as referências no programa e exporte-as em formato .bib para garantir que ele não possui problemas em seu formato.

Eu corrigi um problema mas, quando compilo meu documento, nada muda. O que faço?

Apague todos os arquivos temporários na pasta do seu documento. Coisas com extensão .acn .acr .alg .aux .bbl .bcf .blg .dtx .fdb_latexmk .fls .glo .gls .idx .ind .ins .loa .loe .lof .log .lot .mw .out .slg .slo .sls .toc .xdy.

Meu documento não compila, falta uma coisa chamada perl.exe. O que faço?

Primeiro, leia o manual. Depois, instale o Perl (link para Windows).

Qual editor de texto devo usar?

TeXStudio. Disponível para todos os sistemas operacionais e fácil de configurar.

Qual editor de texto devo usar realmente?

Qualquer um, contanto que saiba configurá-lo. Atualmente, eu recomendo o Visual Studio Code. Aqui está uma lista de extensões que eu uso.

Dependendo do editor, será necessário configurar a compilação do PDF. Eu disponibilizo dicas de compilação aqui.

Posso usar o Overleaf?

Sim. Para configurá-lo, baixe o zip da classe da FEI neste link, faça upload dos arquivos fei.cls, fei-template.tex e .latexmkrc para um projeto do Overleaf e utilize o arquivo fei-template.tex como ponto de partida para seu documento. É possível mudar o nome do arquivo, e.g. para documento.tex.

Antes o Overleaf funcionava e agora não funciona mais. O que aconteceu?

  • Motivo 1: A classe da FEI tenta sempre ser compatível com a versão mais recente do TeX Live, a qual pode não ser a mesma que o Overleaf usa.

  • Motivo 2: O Overleaf se recusa a compilar trabalhos que demoram muito tempo para compilar, ou exibir trabalhos com muitas páginas, muitas figuras ou figuras muito pesadas (no sentido do arquivo da figura ser muito grande, em bits). Não existe solução para isso a não ser trabalhar em seções individuais do documento pelo Overleaf, comentando o resto, e depois baixar tudo para compilar a versão final localmente.

Qual gerenciador de referências devo usar?

Zotero. Recomendo usar o addon Better BibTeX. Configure-o para exportar um arquivo no formato Better BibLaTeX e referencie-o no seu documento.

Como insiro as referências no Zotero?

Evite inserir entradas manualmente. Tente inseri-las primeiro usando o DOI, ISBN, arXiv ID, ISSN etc do documento, na opção "Adicionar por identificador" (a varinha mágica).

Uma opção pior é usar o Zotero Connector, o addon para navegador. Se você o fizer, garanta que o Zotero tenha salvo a entrada como um artigo e não uma página da web.

Uma opção pior ainda é encontrar um BibTeX aleatório no Google Scholar. Lá tudo está sempre errado.

Oi, tudo bem?

https://www.nohello.com/

Oi, posso fazer uma pergunta?

https://dontasktoask.com/

Seção para a qual eu envio alunos que pedem para eu fazer o trabalho deles, para eles

Eu escrevi meu trabalho em Word, mas agora meu orientador quer que eu passe tudo para LaTeX por caprichos pessoais dele. Você me ajuda?

Eu escrevi meu trabalho em Word, mas fiz um trabalho horrível e agora estou cogitando passar tudo para LaTeX, na vã esperança de que tudo será melhor e meu trabalho será magicamente formatado, mesmo sem eu ter mudado minha atitude com relação à necessidade de ser metódico na formatação de meu trabalho. Você me ajuda?

Eu ouvi falar desse tal latécs que faz tudo sozinho, mas quando fui usar era muito complicado. Você me ajuda?

Eu negligenciei meu trabalho escrito por anos, tenho 3 dias para imprimir, encadernar e depositar e não consigo terminar. Minha mulher me deixou, eu bati meu carro e estou chorando no banheiro sem esperanças de me formar (desculpa coloquialmente chamada de "pulling a Piva"). Você me ajuda?

Não.