Redao de Relatrios Tcnicos e Outros Documentos do A Instituto de Informtica da UFG Usando L TEX

C. L. de Carvalho
Technical Report

H. Longo

- RT-INF_000-05 - Relatrio Tcnico April - 2005 - Abril

The contents of this document are the sole responsibility of the authors. O contedo do presente documento de nica responsabilidade dos autores.

Instituto de Informtica Universidade Federal de Gois

www.inf.ufg.br

Redao de Relatrios Tcnicos e Outros Documentos do A Instituto de Informtica da UFG Usando LTEX
Cedric L. de Carvalho
cedric@inf.ufg.br

Humberto Longo
longo@inf.ufg.br

Abstract. This meta-paper describes how to use the class that denes the model for Technical Reports and other documents, according to the patterns adopted by the Instituto de Informtica of UFG. An abstract and "resumo"should be added. In both cases, abstract (and resumo) should not have more than 10 lines and must be in the rst page of the paper.
A Keywords: Technical Report, LTEX.

Resumo. Este meta-artigo descreve como usar a classe que dene o modelo para a confeco de Relatrios Tcnicos e outros documentos, segundo o padro adotado pelo Instituto de Informtica da UFG. solicitada a escrita de resumo e abstract. O autor deve tomar cuidado para que o resumo e o abstract no ultrapassem 10 linhas cada, sendo que ambos devem estar na primeira pgina do relatrio.
A Palavras-Chave: Relatrio Tcnico, LTEX.

1 Informaes Gerais
Relatrios Tcnicos do Instituto de Informtica so publicaes de natureza tcnica com o objetivo de divulgar em meio impresso e/ou eletrnico estudos e pesquisas realizadas no mbito do Instituto de Informatica (INF) da Universidade Federal de Gois (UFG). A Estes relatrios devero ser redigidos no LTEX, devendo ter entre 15 e 30 pginas, sem considerar eventuais anexos. A formatao do texto deve estar rigorosamente de acordo com o modelo aqui apresentado. Cada relatrio receber um identicador nico formado pelo prexo RT-INF_ e por um ndice de trs dgitos seguidos de - e o ano em que o relatrio foi publicado, representado com dois dgitos. Este identicador dever ser inserido na verso nal do relatrio, aps o mesmo ter sido aceito ocialmente para publicao. Aps esta aceitao, ele ser publicado eletronicamente no portal do INF. Verses impressas podero ser solicitadas secretaria do instituto.

Instituto de Informtica, UFG Responsvel pelo texto do relatrio. A Instituto de Informtica, UFG Responsvel pela classe LTEX tr-inf.cls.

A Relatrios Tcnicos Usando LTEX

Para ser aceito para publicao, um Relatrio Tcnico deve ser avalisado por, pelo menos um professor do INF. No caso de um professor ser autor ou co-autor do relatrio, poder solicitar que um outro professor faa a avaliao do mesmo. Neste caso, o nome deste professor avaliador dever constar na seo de agradecimentos (Seo 13). Para se utilizar este modelo, basta substituir o texto deste documento pelo texto a ser editado, como explicado nas sees a seguir. Devem ser mantidos no mesmo diretrio do arquivo A LTEX(neste caso, nomeado como RT-INF_000-05.tex) o arquivo de classe tr-inf.cls, o arquivo inf-ufg.bst e o arquivo INF.eps (logotipo do INF). O texto deve se iniciar com a especicao da classe a ser usada para a denio do estilo, neste caso, a classe tr-inf (especicada no arquivo tr-inf.cls). Assim, o comando \documentclass[capa]{tr-inf} deve preceder todos os outros comandos. Caso se deseje gerar a capa colorida para o relatrio, deve-se inserir o comando da forma como especicado. Entretanto, possvel suprimir a gerao da capa colorida simplesmente eliminando-se [capa] do referido comando. A bibliograa gerada segundo o estilo denido no arquivo inf-ufg.bst, o qual implementa as principais recomendaes do padro ABNT. Pode-se utilizar tambm o modelo plain inserindo-se [plain] neste comando: \documentclass[plain]{tr-inf}. O modelo que denido aqui tambm poder ser aproveitado para a edio de outros documentos como Relatrios de Disciplinas, Propostas de Projeto Final de Curso, etc. No caso de outros documentos, o nmero de pginas, cdigo identicador, e outras especicidades dos Relatrios Tcnicos no se aplicam. Para se utilizar o modelo para outros documentos necessria a denio do tipo do documento, utilizando-se os comandos \TRType{Document Type} e \TRTipo{Tipo do Documento}. Estes comandos especicam o tipo que ir ser mostrado na folha de rosto, a verso em ingls e portugus, respectivamente. O valor padro para Tipo do Documento Relatrio Tcnico. No restante deste documento esto denidas as formas de apresentao da capa (Seo 2), da folha de rosto (Seo 3), da primeira pgina (Seo 4), de sees e pargrafos (Seo 5), de guras (Seo 6), de tabelas (Seo 7), de algoritmos (Seo 8), de cdigos de programas (Seo 9), de textos pr-formatados (Seo 10), de referncias (Seo 12), e da seo de agradecimentos (Seo 13).

2 Capa do Documento
O texto propriamente dito dever ser precedido, opcionalmente, de uma capa nas cores vermellho e azul contendo o logotipo do INF, conforme o padro denido neste modelo. Esta capa dever ter uma abertura retangular atravs da qual se possa ver as informaes contidas na folha de rosto, denida na Seo 3. A capa colorida pode tambm ser impressa, contendo as informaes da folha de rosto, como mencionado anteriormente.

3 Folha de Rosto
A folha de rosto dever conter o ttulo do relatrio, assim como os nomes de seus autores, o ms e ano da publicao, alm do identicador nico do relatrio. Esta pgina construda automaticamente a partir dos dados fornecidos da maneira descrita a seguir: Identicador do Reltrio: \TRNumber{XXX};

A Relatrios Tcnicos Usando LTEX

Ano da Publicao (representado por dois dgitos apenas): \TRYear{YY}; Ms da Publicao: \TRMonth{ZZ}; Autores: \TRAuthor{Autor1 \and H. Autor2 \and Autor3 ... } - os nome dos autores devem ser separados por \and; Tipo do documento: \TRType{Document Type} e \TRTipo{Tipo do Documento}, para o caso de no se tratar de um Relatrio Tcnico. Titulo: \TRTitle{Ttulo}.

4 Primeira Pgina
A primeira pgina deve mostrar o ttulo do trabalho, o nome e endereo eletrnico dos autores, um resumo e um abstract (traduo do resumo para o ingls), alm de uma lista de palavras-chave (em portugus e em ingls). A disposio destes elementos deve ser a mesma deste modelo. A denio do ttulo completo e dos autores, que devem aparecer na primeira pgina, deve ser feita com \title{Ttulo Completo} e com \author{AutorCompleto1 AutorCompleto2}, respectivamente. O nome do autor deve ser seguido pelo seu email e pelo comando \thanks{Comentrio}, usado aqui para fornecer alguma informao extra sobre o autor. Os nomes (abreviados) dos autores e o ttulo abreviado que devero aparecer no cabealho das pginas devem ser denidos com: \markboth{\small Autor1 e Autor2} {\small Ttulo Abreviado}

5 Sees e Pargrafos
Ttulos de sees devem estar em negrito, alinhados esquerda e ser numerados. Todas as primeiras linhas dos pargrafos de cada seo devem ser identadas. A primeira seo dever trazer uma introduo ao tema do relatrio, sendo nalizada com uma descrio geral da organizao do restante do texto. Desta forma, para se utilizar o modelo basta substituir o ttulo da seo pelo correspondente nome do texto em edio. Por exemplo, a seo Sees e Pargrafos deste texto se inicia como \begin{Sees e Pargrafos}. Desta forma, desejando-se substituir o ttulo da seo por outro, basta substituir a palavras Sees e Pargrafos pelo novo ttulo. O novo contedo da seo deve tomar o lugar do texto entre os comandos, begin da seo e o comando begin da seo seguinte.

5.1 Subsees
O que foi dito para as sees tambm se aplica para as subsees. Entretanto, neste caso, o camando a ser considerado , obviamente, \subsection e no \section.

6 Figuras
As guras devem estar no formato EPS. Em Linux, pode-se converter guras no formato JPG para EPS, por exemplo, usando-se o aplicativo jpg2eps.

A Relatrios Tcnicos Usando LTEX

Rtulos de guras e tabelas devem ser centralizados se tiverem at uma linha (Figura 1), caso contrrio devem estar justicados e identados em ambas as margens, como mostrado na Figura 2.

Figura 1: Uma gura tpica

Figura 2: Esta gura exemplica o uso de um rtulo de gura que ocupa mais de uma linha, devendo este ser identado e justicado.

7 Tabelas
Em tabelas, deve-se procurar usar fundo claro, preferencialmente o branco. Seus rtulos devem ser colocados antes das mesmas (veja a Tabela 1). Tabela 1: Contedo do diretrio [3] Comprimento Incio Tag Comprimento 0020 00000 100 0032 0004 00020 245 0087 0017 00024 246 0036 0041 00041 250 0012 0024 00082 260 0037 0025 00106 300 0029 0044 00131 500 0042 0018 00175 520 0220 0024 00193 650 0033 0018 00217 650 0012

Tag 001 003 005 008 010 020 020 040 050 082

Incio 00235 00267 00354 00390 00402 00439 00468 00510 00730 00763

A Relatrios Tcnicos Usando LTEX

8 Algoritmos
Algoritmos devem ser representados no formato do Algoritmo 1, segundo o estilo algorithm2e. Algoritmo 1: M SR(A, i, j) Entrada: vetor A[i . . j], inteiros no negativos i e j. Sada: vetor A[i . . j] ordenado.
1 2 3 4 5 6 7 8

nji se n < 4 ento Ordene com 3 comparaes. seno Divida A em n subvetores de comprimento mximo n . Aplique M SR a cada um dos subvetores. Intercale os subvetores. m

9 Cdigos de Programa
Cdigos de programa podem ser importados, mantendo-se a formatao original, conforme se pode ver no exemplo do Cdigo 1. C 1 igo 1 Funo insertionsort() 2
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

void insertionSort( int* v, int n ) { int i = 0; int j = 1; int aux = 0; while (j < n) { aux = v[j]; i = j - 1; while ((i >= 0) && (v[i] > aux)) { v[i + 1] = v[i]; i = i - 1; } v[i + 1] = aux; j = j + 1; } }

O rtulo Cdigo que aparece no exemplo anterior pode ser substituido por um outro com o acrscimo do comando \oatname{codigo}{Exemplo}, onde codigo uma constante e Exemplo o nome valor desejado para o rtulo. O resultado deste procedimento pode ser visto no Exemplo 2.

A Relatrios Tcnicos Usando LTEX

Exemplo 2 Funo insertionsort()

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

void insertionSort( int* v, int n ) { int i = 0; int j = 1; int aux = 0; while (j < n) { aux = v[j]; i = j - 1; while ((i >= 0) && (v[i] > aux)) { v[i + 1] = v[i]; i = i - 1; } v[i + 1] = aux; j = j + 1; } }

10 Textos pr-formatados
Podem ser inseridos textos pr-formatados. Neste caso, a formatao original ser mantida, conforme se pode ver na Figura 3.
GV943 .25 .B74 1990 Brenner, Richard J., 1941Make the team. Soccer : a heads up guide to super soccer! / Richard J. Brenner. -- 1st ed. -- Boston : Little, Brown, c1990. 127 p. : ill. ; 19 cm. "A Sports illustrated for kids book." Summary: Instructions for improving soccer skills. Discusses dribbling, heading, playmaking, defense, conditioning, mental attitude, how to handle problems with coaches, parents, and other players, and the history of soccer. ISBN 0316107514 : \$12.95 1. Soccer -- Juvenile literature. 2. Soccer. II. Title: Heads up guide to super soccer. II. Title. Dewey Class no.: 796.334/2 -- dc 20 89-48230 MARC

Figura 3: Arquivo de cha catalogrca.[3]

A Relatrios Tcnicos Usando LTEX

11 Hifenao
Para conseguir uma correta separao de slabas em textos em portugus, preciso conA gurar o LTEX. No Linux, isto pode ser feito, logando-se como root e executando-se o comando texcong. Deve-se escolher ento a opo HYPHEN e depois latex. O arquivo de congurao ser aberto no editor de texto padro. Devem ser acrescentadas seguintes linhas nesse arquivo (exatamente nesta forma):
portuges pt8hyph.tex =brazilian

Quem usar o MikTeX, no ambiente Windows, deve chamar o aplicativo de congurao (MenuIniciar Meus Programas MikTeX MikTeX Options). Na aba Languages, deve-se marcar a opo portugus e, a seguir, pressionar o boto Edit. Na janela de dilogo que aberta, o campo Hyphenation Files deve ser preenchido com pthyph.tex.

12 Referncias
Referncias bibliogrcas devem ser no ambgas e uniformes. Recomenda-se usar nmeros entre colchetes, como por exemplo [2], [4] e [1].

13 Agradecimento
Esta uma seo opcional que deve aparecer apenas no caso do artigo ter passado pela avaliao de um professor que no seja autor ou co-autor do relatrio. O contedo desta seo pode ser algo do tipo: "Ao Prof. Dr. Fulano de Tal pela avaliao do presente texto e pelas sugestes feitas, as quais muito contribuiram para a melhoria do texto original."

Referncias
[1] BERNERS-LEE, R; SWICK, T. Semantic Web Development. http://www.w3.org/ 2002, ltimo acesso em Agosto de 2003, 2002. [2] KNUTH, D. E. The TeX Book. Addison-Wesley, 15th edition, 1989. [3] OF CONGRESS, L. MARC 21 Reference Materials. http://www.loc.gov/marc/ umb/um11to12.html, acessado em outubro de 2004, 2004. [4] SMITH, A; JONES, B. On the Complexity of Computing. In: Smith-Jones, A. B, editor, ADVANCES IN COMPUTER SCIENCE, p. 555566. Publishing Press, 1999.