Trabalho de Curso - Ciência da Computação

Projeto de TCC para a graduação em Ciência da Computação.

Links úteis ao trabalhar com LaTeX

• Gerador de Tabelas
• Fórum TEX
• Documentação do Overleaf
• Guia de LaTeX
• Template TCC FGA-UnB - provavelmente nosso trabalho se parecerá com isso :) .
• Vídeo de como instalar o LaTeX no Windows.

📦 Pacotes LaTeX usados

Uma breve explicação do que faz cada pacote adicionado ao arquivo tcc.tex e os links de referência para a documentação oficial do pacote:

• babel - define o idioma do documento.
• changepage - permite alterar a largura das margens de partes específicas do texto.
• csquotes - para colocar texto entre aspas corretamente.
• fontspec - permite utilizar fontes customizadas (fontes do sistema).
• geometry - permite ajustar o layout do documento, definindo as dimensões das margens.
• hyperref - permite criar links clicáveis no documento.
• hyphenat - impede a hifenização automática das palavras no texto.
• microtype - para melhorias de justificação do texto.
• indentfirst - indenta o primeiro parágrafo de cada seção.
• inputenc - codificacao do documento (conversão automática dos acentos).
• sectsty - usado para definir tamanho 12 para os títulos de seções.
• setspace - define o espaçamento entre linhas.
• tocloft - permite personalizar a aparência do sumário.
• abntex2cite - formata citações e referências de acordo com a ABNT.
• tocbibind - para adicionar as referências ao sumário.
• etaremune - possibilita criar listas enumeradas decescentes.
• glossaries - para adicionar glossário.
• enumitem - para remover identação de descrições no sumário.
• acronym - para gerar lista de acrônimos.
• titlesec - permite alterar tamanho da fonte e o espaçamentro dos títulos e subtítulos.

🛠️ Ferramentas auxiliares

GNU Make - Utilizaremos o make para automatizar comandos grandes que podem nos ajudar em alguns momento como formatar o código e remover arquivos desnecessários. Veja os exemplos abaixo.

• make format - formata o código.
• make lint - verifica se o código está formatado mas não aplica mudanças.
• make clean - apaga arquivos desnecessários gerados durante o build do PDF.

Formatador de código

Para formatar o código LaTeX vamos utilizar o tex-fmt, ele nos ajudará a manter a sanidade do código, corrigindo identação e quebrando linhas muito compridas.

O arquivo tex-fmt.toml na raíz do projeto é o arquivo de configuração dessa ferramenta.

Para executar o formatador basta executar o comando abaixo, ele irá procurar e formatar todos os arquivos .tex, .bib, .cls e .sty do projeto.

make format

Note

Sempre antes de realizar um commit é import executar o formatador para garantir que está tudo certo, pois ao realizar um pull request para a branch principal, um workflow será executado para verificar se o código está formatado e caso não esteja, o check do workflow irá falhar.

Extensão LaTeX Workshop

Vamos utilizar a extensão LaTeX Workshop no VS Code para diversas coisas como geração automática do PDF, sugestão de código e umpouco mais.

Important

Como vamos gerar um PDF com fontes customizadas pela extensão no VS Code, precisamos configurar a variável latex-workshop.latex.recipes no arquivo JSON de configuração do VS Code para usar o compilador compatível com fontes customizadas, como no seguinte exemplo:

"latex-workshop.latex.tools": [
       {
           "name": "latexmk",
           "command": "latexmk",
           "args": [
             "-synctex=1",
             "-interaction=nonstopmode",
             "-file-line-error",
             "-pdfxe",
             "-outdir=%OUTDIR%",
             "%DOC%"
           ],
           "env": {}
         },
   ],
   "latex-workshop.latex.recipes": [
       {
           "name": "latexmk (xelatex)",
           "tools": [
               "latexmk"
           ]
       },
   ],