Utilizando o LaTeX com o estilo NuapaTeX

Prévia do material em texto

Dr
aft
Utilizando o LATEX com o estilo NuapaTEX
Sistemas de Informac¸a˜o – Univa´s
Roberto Ribeiro Rocha
1 Objetivos
Este documento destina-se a orientar os alunos do curso de Sistemas de In-
formac¸a˜o da Univa´s, na confecc¸a˜o do documento escrito do Trabalho de Conclusa˜o
de Curso (TCC), em como utilizar o LATEX com o estilo NuapaTEX para formatar
seus documentos.
Apesar deste conteu´do estar intimamente relacionado com a disciplina de Me-
todologia, o foco aqui e´ somente mostrar aos alunos como utilizar esta ferramenta
robusta, o LATEX.
2 Motivac¸a˜o
A formatac¸a˜o de documentos e´ uma importante atividade do desenvolvimento
de um trabalho acadeˆmico, e consome uma parcela importante do tempo das pessoas
que o fazem.
As ferramentas populares de edic¸a˜o de texto (M$ Word, OpenOffice, etc.)
levam as pessoas a ficarem preocupando com a apareˆncia do documento desde o
primeiro para´grafo escrito. Com isso perde-se muita energia com o visual, deixando
o conteu´do, que e´ muito importante, de lado. Outros problemas presentes sa˜o as
divergeˆncias encontradas nas regras de formatac¸a˜o de documentos impostas pela
ABNT.
A principal motivac¸a˜o de usar o LATEX na elaborac¸a˜o de documentos acadeˆmi-
cos e´ preocupar-se menos com a formatac¸a˜o e mais com o conteu´do, dei-
xando para o LATEX o trabalho pesado de formatac¸a˜o. Assim os autores dispo˜em de
mais tempo para dedicar ao conteu´do do trabalho.
3 O que e´ o LATEX ?
O LATEX e´ um compilador que transforma um ou va´rios arquivos texto fontes
em um arquivo, normalmente um PDF, contento o documento final formatado de
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 2
acordo com as regras contidas nos arquivos fontes.
4 Ferramentas
Para usufruir do LATEX sa˜o necessa´rias basicamente treˆs ferramentas:
1. O compilador LATEX: utilizado para gerar o arquivo final a partir dos fontes;
2. Um editor de texto simples: utilizado para criar os arquivos fontes;
3. Um leitor de PDF’s: utilizado para visualizar o PDF final.
Para facilitar a criac¸a˜o dos arquivos fontes, existem ferramentas que auxiliam
na visualizac¸a˜o, compilac¸a˜o e outros recursos para acelerar a criac¸a˜o de documentos.
4.1 O compilador
O compilador e´ a principal ferramenta, que corresponde ao LATEX em si. Ele e´
responsa´vel por converter o texto, bem como os comandos contidos no arquivo fonte,
para o formato final, utilizando um conjunto de bibliotecas, tanto ja´ existentes no
LATEX em si, quanto criados por qualquer outra pessoa.
No ambiente Window$, o compilador utilizado deve ser a distribuic¸a˜o do
LATEX chamado MikTeX1. A versa˜o utilizada no tempo da edic¸a˜o deste documento
e´ basic-miktex-2.9.4813.
Apo´s o download, deve-se fazer a sua instalac¸a˜o. Para mais detalhes veja
http://docs.miktex.org/2.9/manual/installing.html. Caso o computador
esteja conectado na internet, o MikTeX ja´ faz atualizac¸a˜o automa´tica de seus itens,
se necessa´rio. Para Window$ XP, pode-se utilizar a versa˜o portable2.
Em ambiente Ubuntu, a instalac¸a˜o pode ser feita atrave´s do seguinte comando:
sudo apt-get install texlive-latex-base texlive-science.
4.2 O editor de textos
Devido ao fato dos arquivos fontes utilizados pelo LATEX serem de texto plano,
eles podem ser criados com um editor de texto comum. Pore´m, existem outras ferra-
mentas que auxiliam e aceleram a criac¸a˜o de texto, provendo recursos de colorac¸a˜o,
auto-completar, criac¸a˜o de tabelas, pre´-visualizac¸a˜o, entre outras.
1Dispon´ıvel em http://miktex.org/download
2Dispon´ıvel em http://miktex.org/portable
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 3
Dentre estes editores, os mais comuns sa˜o: TeXStudio, Kile, Eclipse plugin
TeXlipse, Gedit LaTeX Plugin, Notepad++, Texmaker e muitos outros. Uma com-
parac¸a˜o destas ferramentas e´ demonstrada em http://en.wikipedia.org/wiki/
Comparison_of_TeX_editors.
Neste documento foi adotado a ferramenta TeXStudio3, que possui a versa˜o
para Window$, Mac e Linux. Ele possui um interessante manual4 do usua´rio em
ingleˆs. Outro link interessante que pode ser consultado e´: https://code.google.
com/p/abntex2/wiki/Ferramentas.
Um passo importante depois de sua instalac¸a˜o e´ a configurac¸a˜o para a uti-
lizac¸a˜o do MikTex (lembrando que o editor TeXStudio faz chamadas ao compilador
MikTex, para compilar o texto).
Esta configurac¸a˜o deve ser feita de acordo com o item 1.2 (Configuring the
latex related commands) de seu manual5, acessada atrave´s do menu Options >
Configure TeXStudio. Nesta tela deve-se acessar o item Commands do lado es-
querdo, e configurar o campo PdfLaTeX para apontar para o executa´vel pdflatex.exe
que, na versa˜o portable, esta´ localizado na pasta $MIKTEX HOME/miktex/bin. Esta
configurac¸a˜o indica ao TeXStudio a ferramenta de compilac¸a˜o (MikTex).
A configurac¸a˜o da ferramenta de visualizac¸a˜o do PDF final e´ feita atrave´s do
campo External PDF Viewer.
A interface gra´fica do TeXStudio possui va´rias a´reas de visualizac¸a˜o. As mais
importantes sa˜o:
• uma composta por va´rios recursos como estrutura dos arquivos e conteu´dos,
bookmarks, operadores, s´ımbolos, comandos, etc.;
• outra com a visualizac¸a˜o do texto em si;
• outra com mensagens, resultados de busca;
• e outra com a visualizac¸a˜o do PDF final.
Atrave´s do menu File e´ poss´ıvel criar um arquivo novo, abrir um arquivo
existe, inclusive um arquivo mestre, que aponta para um conjuntos de arquivos
que formam um projeto. Tambe´m e´ poss´ıvel compilar e visualizar o PDF final
atrave´s do menu Tools>Build & View (F1).
3Dispon´ıvel em http://texstudio.sourceforge.net/
4Dispon´ıvel em http://texstudio.sourceforge.net/manual/current/usermanual_en.
html
5Dispon´ıvel em http://texstudio.sourceforge.net/manual/current/usermanual_en.
html#SECTION02
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 4
O aluno e´ livre para escolher a ferramenta de edic¸a˜o de sua prefereˆncia, sendo as
outras ferramentas similares ao TeXStudio, podendo conter mais ou menos recursos.
5 NuapaTEX
A Univa´s possui um servic¸o de apoio metodolo´gico, chamado NUAPA, um
acroˆnimo para Nu´cleo de Apoio a` Produc¸a˜o Acadeˆmica6, que possui um conjunto
de regras de formatac¸a˜o7 de documentos acadeˆmicos.
Este tutorial abrange, com algumas excec¸o˜es, os seguintes servic¸os do NUAPA,
dispon´ıveis em dezembro de 2013:
• Manual de Normas Metodolo´gicas do NUAPA;
• Normas da ABNT do NUAPA: Modelo Elementos Pre´-textuais, Modelo Ele-
mentos Textuais e Modelo Elementos Po´s-textuais.
A Univa´s disponibiliza os exemplos em M$ Word e PDF com alguns exemplos
do documento final do TCC.
Para seguir as regras de formatac¸a˜o de documentos definidas pelo NUAPA, foi
criado um estilo LATEX que fornece a maioria dos detalhes de formatac¸a˜o exigidos
a fim de facilitar a criac¸a˜o de documentos acadeˆmicos pelos alunos do curso de
Sistemas de Informac¸a˜o, chamado NuapaTEX.
5.1 A estrutura NuapaTEX
O projeto NuapaTEX Univas possui va´rios direto´rios e arquivos, que quando
compilados pelo LATEX geram um arquivo final com as configurac¸o˜es exigidas (com
excec¸o˜es) pelo NUAPA. Este projeto conte´m a seguinte estrutura de direto´rios:
• Principal.tex: e´ o arquivo principal (arquivo mestre) de construc¸a˜o do
documento. Ele possui a configurac¸a˜o do documento, imports de pacotes,
includes de configurac¸a˜o e dos arquivos que compo˜em o documento, tanto
fixos quanto edita´veis.
• fixos: conte´m os arquivos com as configurac¸o˜es pre´-definidas dos seguintes
itens no documento: capa, folha de rosto, folha de aprovac¸a˜o, ficha cata-
logra´fica, listas automa´ticas e suma´rio. Os arquivos desta pasta na˜o necessitam
edic¸a˜o por parte do aluno, exceto algumas condic¸o˜es especiais.
6Dispon´ıvel em http://www.univas.edu.br/Graduacao/conteudo/nuapa_graduacao_1.asp
7Dispon´ıvel emhttp://www.univas.edu.br/Graduacao/conteudo/downloads_graduacao_
1.asp
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 5
• editaveis: conte´m os arquivos que devem ser preenchidos e editados pelos
alunos. Estes arquivos compo˜em o conteu´do textual do documento final. Um
arquivo especial deste direto´rio e´ o arquivo 00 Dados.tex, que conte´m as
informac¸o˜es utilizadas nos itens iniciais do trabalho, como autores, t´ıtulo, ori-
entador, pre´-aˆmbulo, avaliadores, etc. O aluno deve edita´-lo de acordo com
as informac¸o˜es de seu trabalho. O restante dos arquivos desta pasta conte´m o
restante do texto do trabalho, de acordo com cada nome de arquivo.
• fluxos: exemplo de um direto´rio que pode conter va´rios arquivos espec´ıficos
do texto. Neste exemplo, o arquivo fluxo-evento-cadastro-filme.tex
conte´m comandos para criar uma tabela de fluxo de eventos que e´ utilizado
no Quadro Metodolo´gico do TCC. O aluno e´ livre para criar outras pastas,
subpastas e arquivos para compor seu trabalho.
• imagens: direto´rio que conte´m as imagens utilizadas no documento principal.
Aqui tambe´m podem existir subpastas para organizar as imagens.
• styles: conte´m os arquivos que definem a formatac¸a˜o exigida pelo NUAPA, a
formatac¸a˜o dos co´digos fonte utilizados no ambiente lstlisting e definic¸a˜o
dos comandos do fluxo de eventos.
• out: sugesta˜o de direto´rio(quando se usa o Eclipse) para ser usado como sa´ıda
do processo de compilac¸a˜o. Isto evita que os arquivos de sa´ıda se misturem
com os arquivos fonte.
• tmp: sugesta˜o de direto´rio(quando se usa o Eclipse) para ser usado para os
arquivos tempora´rios utilizados no processo de compilac¸a˜o. Isto evita que os
arquivos tempora´rios se misturem com os arquivos fonte.
• biblio.bib: neste arquivo conte´m um cata´logo de todas as refereˆncias bibli-
ogra´ficas utilizadas no documento. Ele sera´ detalhado melhor na Sec¸a˜o 6.1.
Importante: todos os arquivos texto criados pelos alunos devem ter a codi-
ficac¸a˜o UTF8 para evitar problemas com acentuac¸a˜o e cedilha.
O estilo NuapaTEX e´ baseado no AbnTEX2.
5.2 AbnTEX2
O AbnTEX2 “trata-se de um conjunto de customizac¸o˜es da classe memoir para
elaborac¸a˜o de documentos te´cnicos e cient´ıficos condizentes com as normas da As-
sociac¸a˜o Brasileira de Normas Te´cnicas”, tambe´m e´ “responsa´vel pelo layout dos
elementos de estruturac¸a˜o de documentos te´cnicos e cient´ıficos – como trabalhos
acadeˆmicos, artigos e relato´rios te´cnicos”8, possuindo uma documentac¸a˜o razoa´vel.
Verificar seu site oficial para mais detalhes.
8Dispon´ıvel em http://abntex2.googlecode.com/
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 6
O projeto NuapaTEX utiliza va´rios pacotes para uma boa formatac¸a˜o dos
documentos. O AbnTEX2 e´ um deles e e´ obrigato´rio sua instalac¸a˜o, atrave´s do
Package Manager do MikTex, para que ocorra a compilac¸a˜o. Para instalar o
AbnTEX2, e´ necessa´rio seguir os passos da documentac¸a˜o oficial, dispon´ıvel em
https://code.google.com/p/abntex2/wiki/Instalacao.
5.3 Importac¸a˜o do NuapaTEX no TeXStudio
Para importar o projeto NuapaTEX no TeXStudio, basta abrir o arquivo fonte
Principal.tex atrave´s do menu File>Open. A partir deste momento, a a´rea de
visualizac¸a˜o de Structure ira´ mostrar a hierarquia de todos os arquivos inclu´ıdos
no arquivo Principal.tex. E´ necessa´rio clicar com o bota˜o direito sobre o item
Principal.tex e selecionar a opc¸a˜o Set this document as master document.
Ao dar dois cliques em algum item, seu conteu´do sera´ mostrado na visualizac¸a˜o do
texto em si, e ao apertar F1, todo o conteu´do sera´ compilado e exibido na pre´-
visualizac¸a˜o.
5.4 Dependeˆncia de Pacotes
Conforme citado na Sec¸a˜o 4.1, o compilador, ao processar os arquivos fonte,
necessita incluir bibliotecas, chamadas de pacotes para gerar o documento final.
Ale´m do AbnTEX2, o projeto NuapaTEX utiliza va´rios pacotes para a for-
matac¸a˜o correta dos documentos. Caso na˜o exista os pacotes necessa´rios para com-
pilac¸a˜o, o TeXStudio exibe a mensagem e fornece a opc¸a˜o de instalac¸a˜o. Estes
pacotes tambe´m podem ser instalados atrave´s da interface Package Manager do
MikTex.
5.5 Visualizando o PDF Final
Apo´s a compilac¸a˜o e´ gerado um PDF contendo o documento final, que pode ser
visualizado pela pre´-visualizac¸a˜o do TeXStudio ou qualquer outro leitor de PDF’s.
5.6 Erros de compilac¸a˜o
O processo de compilac¸a˜o gera mensagens nas abas de Messages e Logs, que
indicam sucesso ou na˜o na compilac¸a˜o. Estas mensagens ajudam a localizar e corrigir
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 7
erros nos documentos fontes.
6 Principais comandos
Para a edic¸a˜o do texto no decorrer do documento sa˜o utilizados va´rios coman-
dos, nos quais, os principais sera˜o listados aqui.
Comandos comuns de formatac¸a˜o:
% caractere de comenta´rio.
% O texto da linha apo´s ele na˜o e´ compilado.
\chapter{Nome do capı´tulo}
\section{Nome da sec¸a˜o}
\subsection{Nome da subsec¸a˜o}
\subsubsection{Nome da sub-subsec¸a˜o}
\textit{Texto em ita´lico}
\textbf{Texto em negrito}
\texttt{Texto em typewriter}
\par %Inicia um para´grafo novo
\footnote{Texto de rodape´}
\url{url_desejada}
\input{caminho_do_arquivo} %inclui o conteu´do do arquivo
\include{caminho_do_arquivo} %inclui o conteu´do do arquivo com nova pa´gina
Ambientes de listagem e enumerac¸a˜o :
\begin{itemize}
\item um item;
\item outro item;
\item outro item ainda;
\item u´ltimo item.
\end{itemize}
\begin{enumerate}
\item primeiro item;
\item segundo item;
\item terceiro item;
\item quarto item.
\end{enumerate}
Comandos de label e refereˆncia cruzada:
\label{id_do_label} %define um ro´tulo para qualquer item no texto.
\ref{id_do_label} %define uma refereˆncia cruzada para um label.
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 8
Ambiente de figura:
\begin{figure}[h!]
\centerline{\includegraphics[scale=.5]{./imagens/nomeDoArquivo.png}}
\caption[Legenda da figura.]
{Legenda da figura. \textbf{Fonte:} \cite{id_da_citac¸a˜o}}
\label{id_do_label_da_figura}
\end{figure}
Neste exemplo de figura, o comando \caption define a legenda da figura, o
comando \label define o ro´tulo que pode ser utilizado por uma refereˆncia cruzada e
a propriedade scale define a escala do tamanho da figura em relac¸a˜o a seu tamanho
original.
Citac¸a˜o longa:
\begin{citacao}
Grafo e´ um par ordenado de conjuntos disjuntos $(V, A)$, onde $V$
e´ um conjunto arbitra´rio que se designa por conjunto dos ve´rtices
e $A$ e´ um subconjunto de pares na˜o ordenados de elementos
(distintos) de $V$ que se designa por conjunto de arestas.
\end{citacao}
Ambiente de listagem XML:
\begin{lstlisting}[style=custom_XML]
...
conteu´do do xml
...
\ end{lstlisting}
Ambiente de listagem Java:
\begin{lstlisting}[style=custom_Java,
caption={[Classe \texttt{Connection}]
Classe \texttt{Connection}.
\textbf{Fonte:} Elaborado pelos autores},
label=fig:connection_class]
...
co´digo java
...
\ end{lstlisting}
Neste exemplo de listagem, a propriedade caption define a legenda da listagem
e a propriedade label define o ro´tulo que pode ser utilizado por uma refereˆncia
cruzada.
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 9
Tabelas: para tabelas simples, utilizar o wizard de tabelas do TeXStudio.
Tabelas complexas na˜o sera˜o abordadas neste documento.
As fo´rmulas podem ser escritas em dois ambientes: entre dois s´ımbolos de $
(ex: o co´digo $\displaystyle\sum {x=0} ˆ {i} {x i}$ resulta em:
i∑
x=0
xi) ou da
seguinte forma:
\begin{equation}
\Delta Q =
\left[
\frac{\sum_{in} + k_{i,in}}{2m} -
\left(\frac{\sum_{tot} + k_i}{2m} \ right)ˆ2
\right] -
\left[
\frac{\sum_{in}}{2m} -
\left(\frac{\sum_{tot}}{2m} \ right)ˆ2 -
\left(\frac{k_i}{2m} \ right)ˆ2
\right]
\end{equation}
cujoresultado e´:
∆Q =
∑in +ki,in
2m −
(∑
tot +ki
2m
)2−
∑in
2m −
(∑
tot
2m
)2
−
(
ki
2m
)2 (1)
Para criar fluxos de eventos, usados para descric¸a˜o de casos de uso, verifique
o arquivo fluxos/fluxo-evento-cadastro-filme.tex do NuapaTEX.
Para colocar um fluxo de eventos dentro de um ambiente quadro, utilizar:
\begin{quadro}[h!]
\input{./fluxos/fluxo-evento-cadastro-filme}
\caption[Fluxo de eventos para cadastro de filme]
{Fluxo de eventos para cadastro de filme.
\textbf{Fonte:} Elaborado pelos autores}
\label{fig:fluxo_evento_cadastro_filme}
\end{quadro}
Neste exemplo de quadro, o comando \caption define a legenda do quadro e o
comando \label define o ro´tulo que pode ser utilizado por uma refereˆncia cruzada.
Caso seja necessa´rio forc¸ar uma quebra de linha, utilizar: \\ .
Caso seja necessa´rio forc¸ar a hifenizac¸a˜o, utilizar \−.
Caso seja necessa´rio forc¸ar uma quebra de pa´gina, utilizar: \newpage.
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 10
Obserbac¸a˜o: estes treˆs ultimos comandos e alguns outros para forc¸ar alguma
ac¸a˜o sa˜o poucos utilizados, pois o LATEX tenta, na maioria das vezes, resolver estes
problemas da melhor forma poss´ıvel, pore´m pode ocorrer excec¸o˜es.
Estes e muitos outros sa˜o encontrados no menu LaTeX do TeXStudio, na do-
cumentac¸a˜o oficial do LATEX e em muitos tutoriais e documentos dispon´ıveis na
internet, inclusive com muitos materiais em portugueˆs.
6.1 Trabalhando com refereˆncias bibliogra´ficas
As refereˆncias bibliogra´ficas sa˜o itens indispensa´veis em um documento acadeˆ-
mico, e o LATEX possui um excelente suporte para elas.
Primeiramente, deve ser definido um arquivo contendo o cata´logo com todas as
informac¸o˜es de refereˆncias bibliogra´ficas. No NuapaTEX, este arquivo esta´ nomeado
como biblio.bib.
Cada entrada bibliogra´fica pode conter uma das seguintes estruturas ba´sicas:
• Livro:
@book{id_da_obra,
title = {tı´tulo_da_obra},
author = {autor1 and autor2_da_obra and autor3_da_obra},
url = {url_da_obra},
year = {ano_da_obra},
publisher = {editora_da_obra}
}
A palavra chave and e´ o separador de autores quando a obra possui mais de
um autor.
• Artigo:
@article{id_da_obra,
title = {tı´tulo_da_obra},
author = {autor1_da_obra and autor2_da_obra},
journal = {onde_foi_publicada_a_obra},
year = {ano_da_obra},
number = {2011},
url = {url_da_obra}
}
• Site:
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 11
@site{id_do_site,
author = {autor_do_site},
publisher = {publicador_do_site},
year = {ano_do_site},
url = {url_do_site}
}
• Anais em congressos:
@InProceedings{id_da_obra,
author = {autor1_da_obra and autor2_da_obra},
title = {tı´tulo_da_obra},
year = {ano_da_obra},
number = {nu´mero_da_obra},
coverage = {local_de_publicac¸a˜o_da_obra},
booktitle = {tı´tulo_da_revista_da_obra},
ISSN = {issn_da_obra},
pages = {pa´ginas_da_obra}
}
• Dissertac¸a˜o:
@mastersthesis{id_da_obra,
address={cidade_da_obra},
author={autor_da_obra },
school={escola_universidade_da_obra},
title={tı´tulo_da_obra},
type={tipo ex: Mestrado em Cieˆncia e Tecnologia da Computac¸a˜o},
year={ano_da_obra}
}
Existem outras estruturas que na˜o sera˜o descritas neste documento.
Com as entradas bibliogra´ficas cadastradas no arquivo biblio.bib, a inclusa˜o
da refereˆncia bibliogra´fica no texto e´ facilmente feita atrave´s dos comandos:
\cite{id_da_obra} %insere uma citac¸a˜o
\citeonline{id_da_obra} %insere uma citac¸a˜o online
\citeonline[p. 16]{id_da_obra} %citac¸a˜o com o nu´mero de pa´gina
O valor id da obra deve corresponder ao valor definido na respectiva entrada
bibliogra´fica definida no arquivo biblio.bib. Com isto, o LATEX ja´ insere automa-
Utilizando o LATEX com o estilo NuapaTEX - Univa´s 12
ticamente a refereˆncia no texto e tambe´m insere as informac¸o˜es bibliogra´ficas nas
refereˆncias no final do documento.
7 Refereˆncias
MikTex: http://miktex.org/download
TeXStudio: http://texstudio.sourceforge.net
AbnTEX2: http://abntex2.googlecode.com
Nuapa: http://www.univas.edu.br/Graduacao/conteudo/nuapa_graduacao_1.
asp
Guia para LATEX: http://en.wikibooks.org/wiki/LaTeX
Perguntas e respostas sobre LATEX: http://tex.stackexchange.com
Direto´rio Comprehensive TeX Archive Network: http://ctan.math.washington.
edu/tex-archive
Observac¸a˜o: este documento na˜o segue as regras Nuapa nem ABNT. :)
	Objetivos
	Motivação
	O que é o LaTeX ?
	Ferramentas
	O compilador
	O editor de textos
	NuapaTeX
	A estrutura NuapaTeX
	AbnTeX2
	Importação do NuapaTeX no TeXStudio
	Dependência de Pacotes
	Visualizando o PDF Final
	Erros de compilação
	Principais comandos
	Trabalhando com referências bibliográficas
	Referências