Manual de utilização e elaboração de trabalhos acadêmicos utilizando a classe uftex.cls

Manual de utilização e elaboração de trabalhos acadêmicos utilizando a classe uftex.cls

Escrever documentos acadêmicos pode ser uma tarefa trabalhosa quando os autores precisam preparar seus manuscritos respeitando as regras de formatação imposta pela instituição de ensino ou mesmo por agentes externos, como por exemplo, a ABNT (Associação Brasileira de Normas Técnicas). O objetivo da classe uftex.cls é automatizar a preparação de manuscritos, deixando que o estudante dedique mais ao desenvolvimento do trabalho, ao invés de despender muito tempo com a formatação do documento. Atualmente, os Trabalhos de Conclusão de Curso do curso de Ciência da Computação da Universidade Federal do Tocantins (CComp/UFT (Universidade Federal do Tocantins) é elaborado em LaTeX, e essa demanda motivou o criação do projeto UFTeX, que tenta facilitar e incentivar o uso do LaTeX no âmbito da UFT.

Opções da Classe

Esta classe contém uma série de configurações que visam facilitar o trabalho do aluno no momento da produção do texto em LaTeX. A classe uftex vem pré-configurada para cinco tipos de documentos distintos, são eles:

Você pode especificar a opção de documento escolhida através do

\documentclass[opções]{uftex}

É importante destacar que as opções: tcc, tcc1 e tcc2 são conflitantes e não devem ser utilizadas em conjunto.

Estrutura Visual

Os documentos produzidos a partir da classe uftex devem conter três partes: pré-textuais, textuais e pós-textuais. Cada uma dessas partes são iniciadas chamando seu macro correspondente \frontmatter, \mainmatter ou \backmatter. Os pré-textuais de um documento consistem em capa, folha de rosto, dedicatória, agradecimentos, resumos seguidos de palavras chaves, resumo em língua estrangeira, lista de abreviaturas, lista de símbolos, lista de algoritmos, listas de figuras, listas de tabelas e sumário. A parte principal ou textuais é composta apenas por capítulos, com suas seções e subseções, enquanto a parte pós-textual consiste de referências bibliográficas, apêndices e anexos.

Você deve chamar o macro \frontmatter imediatamente após o \maketitle. O comando \mainmatter vem logo antes do primeiro capítulo, e \backmatter deve ser digitado antes das referências bibliográficas.

Capa

Este elemento é automaticamente construído pelo comando \maketitle. A opção de documento project inibe a construção do elemento capa.

Obrigatoriamente, para a construção do elemento capa, devem ser inseridos os seguintes comandos:

\advisor{Prof.}{Nome do Primeiro Orientador}{Sobrenome}{Dr.}
\advisor{Prof.}{Nome do Segundo Orientador}{Sobrenome}{Me.}

Mais de um orientador pode ser adicionado, para o caso de trabalhos co-orientados.

Folha de Rosto

É construída juntamente com a capa.

A Folha de Rosto é composta pelos seguintes itens na mesma ordem com que são apresentados:

Ficha Catalográfica (Para TCC2)

A Ficha Catalográfica é inserida após a defesa de TCC2. Ela deve vir imediatamente após a folha de rosto e antes da folha de aprovação.

A Ficha Catalográfica localiza-se na parte inferior da página no verso da folha de rosto, constando os dados que identificam o trabalho de acordo com o padrão internacional em vigor Código Anglo Americano (FEDERAÇÃO BRASILEIRA DE ASSOCIAÇÕES DE BIBLIOTECÁRIOS, 2002) e obedecendo a uma dimensão de 7,5 X 12,5 cm. Elaboração pelo Sistema Eletrônico de Geração de Fichas Catalográfica da UFT, conforme tutorial.

Disponível em: https://sistemas.uft.edu.br/ficha/

A Ficha Catalográfica não é gerada por esse template, deve ser inserida posteriormente.

Folha de Aprovação

Este elemento também é construída a partir do \maketitle, se as opções escolhidas no documento forem: tcc, tcc1 ou tcc2.

Os orientadores não são necessariamente membros da banca examinadora do TCC. Assim, é necessário digitar os nomes de todos os avaliadores usando o comando examiner{}{}{}. Os nomes dos examinadores são inseridos da seguinte forma:

\examiner{Prof.}{Nome do Primeiro Examinador Sobrenome}{Dr.}
\examiner{Prof.}{Nome do Segundo Examinador Sobrenome}{Me.}
\examiner{Prof.}{Nome do Terceiro Examinador Sobrenome}{Ma.}

Antecedendo Resumo e Abstract

As palavras-chave devem descrever as áreas de concentração de seu trabalho. Essas informações serão utilizadas na criação do resumo. Você deve fornecê-las como se segue:

\keyword{Primeira palavra-chave}
\keyword{Segunda palavra-chave}
\keyword{Terceira palavra-chave}

As palavras chaves em língua estrangeira também devem ser descritas para criação do Abstract, utilizando os comandos:

\foreignkeyword{First keyword}
\foreignkeyword{Second keyword}
\foreignkeyword{Third keyword}

Lembre-se que todos os nomes devem ser dados antes do comando maketitle.

Dedicatória (Opcional)

Este comando foi adicionado por conveniência. O texto de entrada é colocado no lado inferior direito de uma página em branco. Deve ser enfatizado e em tamanho normal. A forma correta de utilizar esta macro é:

\dedication{A alguém cujo valor é digno desta dedicatória.}

e a mesma deverá vir logo abaixo do comando \frontmatter.

Resumo e Abstract

O resumo e abstract devem estar em uma página cada, com em torno de 250 palavras. É recomendável que eles tenham apenas um parágrafo longo. Eles devem ser definidos dentro dos ambientes abstracts e foreignabstract. Por exemplo:

\begin{abstract}
Algum texto...    
\end{abstract}

E

\begin{foreignabstract}
Algum texto...    
\end{foreignabstract}

Lista de Símbolos e Abreviaturas (Opcional)

As listas de símbolos e abreviaturas são opcionais, embora altamente recomendadas. É uma boa prática definir um símbolo/abreviatura em sua primeira ocorrência no texto. Para definir um símbolo de uso \symbl{Símbolo}{Definição do Símbolo}, e para abreviaturas \abbrev{Abreviatura}{Abreviatura Definição}. É interessante destacar que estes comandos não provocam alteração no lugar onde são escritos, ou seja, só aparecem na lista de símbolos e abreviaturas.

Estas listas são lexicograficamente classificadas usando o programa \emph{MakeIndex}, que é parte de qualquer implementação LaTeX. MakeIndex precisa de dois comandos para criar uma lista final ordenada: um que gera uma lista de entradas e outro que indica a posição onde a lista será impressa. Para gerar as listas de símbolos e abreviaturas, a classe uftex fornece os comandos \makeloabreviations e \makelosymbols, respectivamente. Eles devem ser chamados no preâmbulo do documento. Os comandos \printlosymbols e printloabbreviations tem que ser invocados no ponto onde você quer que estas listas apareçam, por exemplo, seguindo a lista de tabelas como por exemplo:

\documentclass[tcc]{uftex}
% --------------------------------------------------------------------- %
\usepackage[alf,abnt-emphasize=bf]{abntex2cite}
\renewcommand{\backrefpagesname}{}
\renewcommand{\backref}{}
\renewcommand*{\backrefalt}[4]{}
% ----  Esse comandos são necessário no pré-ambulo para a impressão da
% lista de lista abreviatuas e de símbolos
\makelosymbols
\makeloabbreviations
% ---- Início do documento
\begin{document}
  \title{Estudo da vida marinha}
  \foreigntitle{Thesis Title}
  \author{Tiago da Silva}{Almeida}
  
  \advisor{Prof.}{José}{Mendonça}{Dr.}
  \advisor{Prof.}{Marcos}{da Oliveira}{Me.}

  \department{EC}
  \date{03}{2016}

  \keyword{Primeira palavra-chave}
  \keyword{Segunda palavra-chave}
  \keyword{Terceira palavra-chave}
  \keyword{Quarta palavra-chave}

  \foreignkeyword{First keyword}
  \foreignkeyword{Second keyword}
  \foreignkeyword{Third keyword}
  \foreignkeyword{Fourth keyword}
  % ---- Comando responsável por criar a capa do trabalho e/ou folha de
  %resto conforme a configuração exigida
  \maketitle
  % ---- Esse comando marca o inicio dos elementos pré-textuais, e
  %adiciona a numeração de páginas em algarismos romanos em caixa baixa
  \frontmatter
  
  % ----------------------------------------------------------------------------------------------------- %
  %  Este trecho deve ser inserido somente no caso do TCC2 já na versão FINAL
  % ----------------------------------------------------------------------------------------------------- %
  %\includepdf{ficha_catalografica}
  %\includepdf{ata_de_aprovacao}
  % ----------------------------------------------------------------------------------------------------- %
  
  % ---- Cria uma dedicatória ao trabalho. OPCIONAL
  \dedication{A algu\'em cujo valor \'e digno desta dedicat\'oria.}
  % ---- Cria os agradecimentos do trabalho. OPCIONAL
  \begin{acknowledgement}
  Gostaria de agradecer a todos.
  \end{acknowledgement}
  % ---- Cria o resumo em idioma escolhido pelo usuário, no caso em
  %português. OBRIGATÓRIO
  \begin{abstract}
  Algum texto ...
  \end{abstract}
  % ---- Cria o resumo em idioma estrangeiro, no caso em inglês.
  %OBRIGATÓRIO
  \begin{foreignabstract}
  In this work, we present ...
  \end{foreignabstract}
  \printlosymbols  
  \printloabbreviations
  % ---- Cria a lista de figuras. OPCIONAL
  \listoffigures
  % ---- Cria a lista de tabelas. OPCIONAL
  \listoftables 
  % ---- Cria o sumário. OBRIGATÓRIO
  \tableofcontents % sumário
% --- Marca o inicio dos elementos textuais. Capítulos.
\mainmatter
% ---- Defino o espaçamento de um e meio centímetros
\onehalfspacing
% --------------------------------------------------------------------- %
% Capítulos do trabalho
% --------------------------------------------------------------------- %
\ChapterStart{first}{First chapter}
\chapter{Introdução}
.
.
.
\backmatter 
\singlespacing   % espaçamento simples
% --------------------------------------------------------------------- %
% Bibliografia
% --------------------------------------------------------------------- %
\bibliography{tcc_exemplo}

% --------------------------------------------------------------------- %
% Anexos
% --------------------------------------------------------------------- %
\appendix

\end{document}

Uma vez que você compila o latex, ele criará dois arquivos com extensões abx e syx, que contêm dados de entrada \emph{MakeIndex}. Eles devem ser processados com makeindex a fim de obter as listas produzidas corretamente, redirecionando a saída para arquivos com extensão lab e los respectivamente:

makeindex -s uftex.ist -o tcc_exemplo.lab tcc_exemplo.abx
makeindex -s uftex.ist -o tcc_exemplo.los tcc_exemplo.syx

Observe a opção -s para especificar o estilo uftex.ist. Agora, compile o latex duas vezes para obter as referências e está feito. % explicar melhor isso aqui. Especificar com mais clareza a ordem em que os comandos devem ser feitos, ou seja, explicar melhor o processo.

Elaboração do documento

\begin{quote}
``Minha citação''
\end{quote}

Porém, esse recurso deve ser utilizado com muito cuidado para evitar situação de plágio.

Caso contrário utilizar \verb+\cite{}+ para citação indireta e \verb+\citeonline{}+ para citação direta.

\begin{figure}
  \caption{Legenda.}\label{chave_para_refencia_cruzada}
  \includegraphics[dimensões]{nome-do-arquivo}
\end{figure}

e o pdflatex irá procurar em primeiro lugar um arquivo chamado nome-do-arquivo.pdf e depois para nome-do-arquivo.png.

Referências Bibliográficas

Sabe-se que os dados bibliográficos podem ser facilmente mantidos com o auxílio do BibTeX. A forma correta de utilizar este recurso é incluindo suas referências BibTeX sem a extensão bib, como no exemplo a seguir:

\documentclass[tcc2]{uftex}
% --------------------------------------------------------------------- %
\usepackage[alf,abnt-emphasize=bf]{abntex2cite}
\renewcommand{\backrefpagesname}{}
\renewcommand{\backref}{}
\renewcommand*{\backrefalt}[4]{}
% ----  Esse comandos são necessário no pré-ambulo para a impressão da
% lista de lista abreviatuas e de símbolos
\makelosymbols
\makeloabbreviations
% ---- Início do documento
\begin{document}
.
.
.
\backmatter 
\singlespacing   
% --------------------------------------------------------------------- %
% Bibliografia
% --------------------------------------------------------------------- %
\bibliography{tcc_exemplo}
.
.
.

É necessária a inclusão na mesma pasta do projeto os pacotes do abntex2 para geração das referências bibliográficas de acordo com o padrão ABNT.

Algumas Referências

É muito recomendável a utilização de arquivos bibtex para o gerenciamento de referências a trabalhos. Exemplos de referências com a tag:

@book{JW82,
 author   = {Richard A. Johnson and Dean W. Wichern},
 title    = {Applied Multivariate Statistical Analysis},
 publisher= {Prentice-Hall},
 year     = {1983}
}

@article{MenaChalco08,
 author   = {Jesús P. Mena-Chalco and Helaine Carrer and Yossi Zana and 
            Roberto M. Cesar-Jr.},
 title    = {Identification of protein coding regions using the modified 
            {G}abor-wavelet transform},
 journal  = {IEEE/ACM Transactions on Computational Biology and Bioinformatics},
 volume   = {5},
 pages    = {198-207},
 year     = {2008},
}

@inproceedings{alves03:simi,
 author   = {Carlos E. R. Alves and Edson N. Cáceres and Frank Dehne and 
            Siang W. Song},
 title    = {A Parallel Wavefront Algorithm for Efficient Biological 
            Sequence Comparison},
 booktitle= {ICCSA '03: The 2003 International Conference on Computational 
            Science and its Applications},
 year     = {2003},
 pages    = {249-258},
 month    = May,
 publisher= {Springer-Verlag}
}

@InCollection{bobaoglu93:concepts,
 author   = {Ozalp Babaoglu and Keith Marzullo},
 title    = {Consistent Global States of Distributed Systems: Fundamental 
             Concepts and Mechanisms},
 editor   = {Sape Mullender},
 booktitle= {Distributed Systems},
 edition  = {segunda},
 year     = {1993},
 pages    = {55-96}
}

@Conference{bronevetsky02,
 author   = {Greg Bronevetsky and Daniel Marques and Keshav Pingali and 
            Paul Stodghill},
 title    = {Automated application-level checkpointing of {MPI} programs},
 booktitle= {PPoPP '03: Proceedings of the 9th ACM SIGPLAN Symposium on Principles
            and Practice of Parallel Programming},
 year     = {2003},
 pages    = {84-89}
}

@PhdThesis{garcia01:PhD,
 author   = {Islene C. Garcia},
 title    = {Visões Progressivas de Computações Distribuídas},
 school   = {Instituto de Computação, Universidade de Campinas, Brasil},
 year     = {2001},
 month    = {Dezembro}
}

@MastersThesis{schmidt03:MSc,
 author   = {Rodrigo M. Schmidt},
 title    = {Coleta de Lixo para Protocolos de \emph{Checkpointing}},
 school   = {Instituto de Computação, Universidade de Campinas, Brasil},
 year     = {2003},
 month    = Oct
}

@Techreport{alvisi99:analysisCIC,
 author   = {Lorenzo Alvisi and Elmootazbellah Elnozahy and Sriram S. Rao and
            Syed A. Husain and Asanka Del Mel},
 title    = {An Analysis of Comunication-Induced Checkpointing},
 institution= {Department of Computer Science, University of Texas at Austin},
 year     = {1999},
 number   = {TR-99-01},
 address  = {Austin, {USA}}
}

@Manual{CORBA:spec,
 title    = ,
 author   = ,
 month    = Jul,
 year     = {2002},
 note     = 
}

@Misc{gridftp,
 author   = {William Allcock},
 title    = {GridFTP protocol specification. Global Grid Forum Recommendation (GFD.20)},
 year     = {2003}
}

@Misc{fowler04:designDead,
 author   = {Martin Fowler},
 title    = {Is Design Dead?},
 year     = {2004},
 month    = May,
 note     = {Último acesso em 30/1/2010},
 howpublished= {\url{http://martinfowler.com/articles/designDead.html}},
}

@Misc{FSF:GNU-GPL,
 author   = {Free Software Foundation},
 title    = {GNU general public license},
 note     = {Último acesso em 30/1/2010},
 howpublished= {\url{http://www.gnu.org/copyleft/gpl.html}},
}