Construção de um relatório académico em LaTeX – Parte I

Iremos hoje aqui apresentar um guia para a construção de um relatório direccionado para o meio académico/escolar. Trata-se de um documento simples, mas completo, que contém os componentes essenciais que compõe um relatório. Será particularmente útil para aqueles que necessitam de aprender a trabalhar com esta tecnologia rapidamente, quer seja por obrigação ou por curiosidade. Este artigo será dividido em duas partes: construção inicial do relatório e inserção de imagens e tabelas.

No segundo ano do meu curso na universidade foi-me requerido que os relatórios apresentados, fossem redigidos em LaTeX. Tal facto motivou-me a pesquisar e a saber mais, pois vi que poderia apresentar trabalhos com melhor qualidade e em menos tempo. Eu e os meus colegas recorremos a livros e à Internet para aprender sobre LaTex o mais rápido possível, mas o que acontece é que a informação por vezes não é completa e encontra-se dispersa, o que fez com que gastássemos bastante tempo apenas para construir um simples documento. Com este artigo pretende-se facilitar um pouco a vida de quem se inicia no LaTex.

Passemos então à acção: Comecemos então por apresentar um código básico que iremos incrementar:

\documentclass[11pt,a4paper]{report}
 
\usepackage[portuguese]{babel}
%Em windows
 
\usepackage[latin1]{inputenc} 
 
\usepackage[T1]{fontenc}
%Em Linux
 
%\usepackage[utf8]{inputenc} 
 
\author{Autor do documento} 
 
\title{Titulo do documento}
 
\begin{document}
 
\maketitle
 
\end{document}

Trata-se do básico para a realização de um documento em língua portuguesa. Com estas marcações poderemos apenas escrever documentos que só contenham texto. Iremos então começar a adicionar outras funcionalidades.

Quem vem de sistemas WYSIWYG, está habituado a que as margens do texto sejam menores, isto é, que o texto ocupe mais espaço na página tanto a nível horizontal com a nível vertical. As classes article,report ou book utilizam uma configuração destes parâmetros, que por omissão, tornam os documentos um pouco estreitos, comparando com os documentos feitos em sistemas WYSIWYG, o que leva muita gente a procurar formas de mudar estes parâmetros.

Os parâmetros utilizados por omissão no LaTex são assim dessa forma, pois foram levados a cabo estudos que mostram que se torna mais fácil ler o documento nesse modelo, bem como cansa menos os olhos, entre outros... mas isso não quer dizer que estes não possam ou devam ser modificados. Por isso existem várias formas de o fazer. A forma mais fácil e prática é utilizando o pacote geometry. Para modificar as margens do documento, iremos então adicionar a seguinte linha antes do inicio do documento:

\usepackage[hmargin=2cm,vmargin=3.5cm,bmargin=2cm]{geometry}

Iremos então ter:

• Margem horizontal = 2cm
• Margem vertical = 3.5cm
• Margem de fundo = 2cm

Devido ao carácter lógico em que baseia se a linguagem LaTeX, a organização e distribuição de conteúdos presentes no documento são obtidas por meio de marcações que indicam, entre outros, os Capítulos, Secções, Resumo e Índices. As marcações que denominam estas partes são as seguintes:

Índices automáticos de conteúdo:

\tableofcontents %Índice de conteúdos
\listoftables %Lista de tabelas
\listoffigures %Lista de figuras

Resumo:

\begin{abstract}
Texto aqui
\end{abstract}

Capítulo:

\chapter{Nome_do_capítulo_aqui}

Secção:

\section{Nome_da_secção_aqui}

Neste momento torna-se já possível apresentar algo que se parece com um relatório. Adicionando algum texto ao acaso, apenas a título de exemplo, e fazendo uso das marcações acima descritas teremos o seguinte resultado:

Mas caso não se modifiquem as margens e se utilizem os valores por omissão, a zona correspondente à imagem acima irá ser mais estreita e terá o seguinte aspecto:

Depois de atingir este estado evolutivo, torna-se pertinente também a inclusão de cabeçalho e rodapé no documento. Desta forma o documento possuirá mais organização e será mais fácil saber em que região nos encontramos. Em LaTeX isto é feito recorrendo ao pacote fancyhdr.

Teremos então de adicionar este pacote usando a marcação \usepackage{fancyhdr}. Depois necessitamos de dizer qual o estilo, e o que queremos em cada posição do cabeçalho e rodapé. Adicionamos então as seguintes linhas (imediatamente antes da marcação \maketitle):

\pagestyle{fancy} %estilo fancy
 
\lhead{\rightmark} % esquerda do cabeçalho
 
\chead{} %centro do cabeçalho
 
\rhead{\leftmark} % direita do cabeçalho
 
\lfoot{} %esquerda do rodapé
 
\cfoot{\thepage} %centro do rodapé
\rfoot{} %direita do rodapé

Em que \rightmark indica a secção e \leftmark indica o capítulo. Estas alterações produzirão o seguinte resultado:

E pronto, com algumas linhas mais o cabeçalho e rodapé é criado de forma muito simples. Este ainda se poderá tornar mais avançado utilizando o pacote fancyvbr e outras marcações. Nesta fase, a nível de componentes, já não estamos mal, mas não há relatório que se preze que não contenha uma bibliografia. Para adicionar uma bibliografia existem duas formas:

• Recorrendo ao BibTeX: modo em que se utiliza um ficheiro .bib que contém todas as obras por nós utilizadas, e outras mais. De modo a podermos ter sempre acesso às obras que costumamos utilizar, e citar apenas aquelas que foram consultadas no âmbito de um dado projecto.
• Modo manual: modo indicado quando existem poucas referências a serem citadas. Não há necessidade de complicar quando a bibliografia irá conter apenas dez itens, porém utilizando BibTeX a qualidade da bibliografia irá de encontro a uma informação tendencialmente mais completa.

Neste momento irei apenas aplicar o método manual pois é mais básico, e produz o mesmo resultado visual. Para uma bibliografia manual são usadas as seguintes marcas:

\begin{thebibliography}{2}
 
\bibitem{ref1} Alberto Simões ,{\em Uma não tão pequena introdução ao \LaTeX},2007.
 
\bibitem{ref2} Autor do livro ,{\em Título do Livro}, Ano de edição,Editora,etc.
 
\end{thebibliography}

Tendo como resultado o seguinte:

Como se pode ver tem uma apresentação bastante simples. É certo que a informação também não está muito completa e isso faz com que o aspecto perca um pouco. Para citar um elemento da bibliografia utilização a marcação \cite{ref1} contendo como parâmetro a referência atribuída ao respectivo livro. Algo bastante útil, também para se ter num modelo de relatório, são os apêndices, úteis para adicionar ao relatório código fonte, ficheiros de configuração, demonstrações,etc..

Para isso adicionamos no fim documento a marca \appendix e adicionam-se os apêndices da seguinte forma:

\chapter{Exemplo de Apêndice }
\section{Exemplo de Sub Apêndice }

Isto produz o seguinte:

E concluímos assim este modelo focado na estrutura e na organização do relatório. Existem, com certeza, outras capacidades que o modelo deve conter, como por exemplo a inclusão de tabelas e figuras.

Informação sobre o autor: O meu nome é Ricardo Fernandes e sou estudante na Universidade do Minho no curso de Engenharia de Comunicações. Sou um entusiasta da plataforma LaTeX e tecnologia em geral. Recentemente decidi empregar um pouco do meu tempo na redacção de artigos e manutenção de um blog sobre LaTeX. É meu objectivo facilitar um pouco mais a integração nesta tecnologia. O blog pode ser acedido no seguinte endereço: http:\\easylatek.blogs.sapo.pt

Artigos relacionados

• O que é o LaTeX? Primeiros passos