Dicas para redação da sua tese/exame/dissertação

Pessoal, agora que recém terminei de escrever a minha tese, vou tomar um tempinho pra dar umas dicas sobre como elaborar a sua tese de doutorado/exame de doutorado/dissertação de mestrado com o LateX.

Infelizmente o IF não possui um modelo padrão para elaborar a tese. O modelo de tese latex que tem circulado entre os alunos há alguns anos foi inicialmente elaborado pelo Irapuan Rodrigues, quando ele escreveu a sua tese em 1999. Posteriormente, quando escrevi a minha dissertação e posteriormente a tese, introduzi algumas pequenas melhorias no template do Irapa. Aos alunos do IF-UFRGS: quem quiser este template com as atualizações, é só me mandar um e-mail.

TESE-MAIN.TEX

O arquivo principal é o tese-main.tex, que delineia a estrutura geral da tese. Nele você define:
- qual o tipo de documento a ser gerado: dissertação (mastersthesis), tese (phdthesis) ou exame (exame)
- quais os pacotes latex que você vai precisar
- informações da tese: título, autor, orientadora etc
Na parte final do arquivo, você define a ordem em que os capítulos e apêndice(s) vão aparecer editando os comandos

\include{tese-capX}

onde tese-capX é o texto contido no arquivo tese-capX.tex. Eu sugiro editar cada capítulo em um arquivo tex separado. Caso um destes arquivos seja corrompido (por exemplo, devido a uma queda de luz), pelo menos a tese toda não é perdida.

ARQUIVOS *.STY, *.CLS

Os arquivos ifnatbib.sty, isolatin1.sty, stdclsdv.sty, iftese.cls, natbib.sty, tocbibind.sty definem as propriedades da formatação da tese. Recomendável não editá-los, a não ser que você realmente saiba o que está fazendo.

BIBLIOGRAFIA USANDO BIBTEX

O arquivo tese-refs.bib contém a bibliografia do documento no formato bibtex. Você vai que copiar e colar neste arquivo a entrada bibtex de cada artigo/livro etc que você cita no corpo da tese. Uma maneira fácil de obter as referência no formato bibtex é acessar a página do ADS, achar o artigo desejado - por exemplo este aqui ;) - e procurar o link "Bibtex entry for this abstract". É possível também listar as entradas bibtex para vários artigos ao mesmo tempo no ADS, selecionando a opção "BIBTEX reference list" no campo FORMAT da página do ADS.

Quando o artigo tiver sido publicado nas revistas usuais da astronomia (ApJ, A&A, MNRAS), tome o cuidado de alterar o campo na entrada bibtex fornecida pelo ADS de

journal = {\mnras}

para

journal = mnras (retire as chaves)

Desta forma, o nome da revista correspondente vai aparecer automaticamente, e você não vai precisar escrever o nome da revista por extenso na entrada bibtex.

Quando você altera o arquivo tese-refs.bib, simplesmente "latequear" a sua tese não vai atualizar a lista de referências resultante no arquivo DVI. É necessário também rodar o comando bibtex e depois latequear. Você pode rodar o shell script make.sh (sh make.sh) que faz isto automaticamente.

Update: Sobre as referências Bibtex, há uma dica quente no post "coletando as referências da sua tese/dissertação de forma eficiente no ADS". (08/7/2009)

SCRIPTS ÚTEIS

Além do make.sh, existem alguns outros scripts que podem ser úteis. Os arquivos *.sh são shell scripts para linux/mac, enquanto os arquivos *.bat são scripts que devem ser executados num prompt de comando do windows.

clean.sh (linux/mac), clean.bat (windows)
"Limpa" o diretório da tese, apagando os arquivos que são gerados quando você "latequeia" a tese.

backup.sh (linux/mac), backup.bat (windows)
Cria uma cópia de segurança dos arquivos da tese, gerando o arquivo backup.tar. No windows é necessário instalar o programa 7-zip e alterar o caminho até o executável deste programa no arquivo .bat.

EDITORES AMIGÁVEIS DE LATEX

Eis as minhas sugestões:

Linux: Kile, Texmaker

Windows: Texmaker, TeXnicCenter

Mac OS X: TeXShop (ver também os editores listados aqui)

É claro que há também Emacs, VI, etc, porém o nome desta seção é editores amigáveis.

DICIONÁRIO DE PORTUGUÊS

É útil ter para fácil consulta um bom dicionário de português durante a escrita da sua tese. Para quem quiser (somente alunos do IF-UFRGS), está disponível a versão eletrônica do Dicionário Aurélio, que roda no windows (e também Linux e Mac OS X via Wine).

CONVERTER FIGURAS PARA FORMATO POSTSCRIPT

É comum você precisar converter figuras de um formato bitmap (e.g. jpeg, bmp, png, gif etc) para o formato postscript (eps, ps). Recomendo fortemente usar o programa sam2p para efetuar tal conversão. No (K)Ubuntu, tal programa está disponível via Synaptic.

O sam2p gera arquivos postscript com tamanhos *muito* menores que os gerados via outros métodos, tais como usando o programa convert (que acessa a biblioteca ImageMagick) ou GIMP.

POSSÍVEIS PROBLEMAS COM ACENTUAÇÃO NOS ARQUIVOS *.TEX

Se você abrir os arquivos *.tex para edição e constatar que os acentos foram substituídos por caracteres estranhos, ou se o mesmo problema acontecer após você latequear a tese, leia as instruções abaixo.

Convém abordar outro problema comum encontrado durante a redação da tese. Dependendo do sistema operacional que você usa para editar os arquivos-textos latex, eles são salvos com um sistema de codificação de caracteres diferente. Por exemplo, no windows e no Suse Linux o sistema padrão é ISO-8859-1; no (K)Ubuntu/Debian linux o sistema é o UTF-8. Se você salvar o arquivo no sistema UTF-8 e abrí-lo no notepad do windows, vai perceber que os caracteres aparecem corrompidos.

É importante manter uma consistência no sistema de caracteres dos arquivos *.tex. Você também pode precisar configurar o seu editor de texto predileto para que ele reconheça o sistema de codificação caso ocorram problemas. Por exemplo, no caso do Kile, basta acessar o menu Tools -> Encoding. Convém notar que o editor TeXnicCenter do windows suporta somente o formato ISO-8859-1 (sistema padrão do windows), por este motivo eu prefiro o Texmaker quando uso windows.

Caso você use um S. O. que salve os arquivos no formato UTF-8, como eu fiz, é necessário carregar o pacote utf8x (ver arquivo tese-main.tex).

Para converter a codificação dos arquivos de um sistema para o outro, basta usar o comando iconv no linux/mac. Por exemplo, o comando

iconv --from-code=ISO-8859-1 --to-code=UTF-8 iso.txt > utf.txt

converte do sistema ISO-8859-1 para o UTF-8.

HOMOLOGAÇÃO DA TESE (25/6/2009)

Um aviso: para "homologar" a sua tese ou dissertação, não é mais necessário passar pelo crivo da Zuleika na biblioteca. Somente teses/dissertações da PPG Ensino de Física precisam passar pela checagem de referências da Zuleika agora.