Mudanças entre as edições de "Modelos para monografia"

De MediaWiki do Campus São José
Ir para navegação Ir para pesquisar
 
(4 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 2: Linha 2:
 
A monografia para o projeto final deverá ser regida de acordo com as normas da ABNT e do IFSC. Para facilitar a edição e formatação do texto, o professor Emerson Mello adaptou o modelo ABNTex2 para o padrão do IFSC. No curso de Engenharia de Telecomunicações, recomendamos que os alunos utilizem esse modelo assim como o [https://www.overleaf.com/ Overleaf] no desenvolvimento do TCC, pois além de possibilitar o compartilhamento do documento com o professor (co)orientador, ainda reduzir o tempo perdido na formação do documento, permitindo que o aluno utilize o seu tempo no conteúdo do TCC.  
 
A monografia para o projeto final deverá ser regida de acordo com as normas da ABNT e do IFSC. Para facilitar a edição e formatação do texto, o professor Emerson Mello adaptou o modelo ABNTex2 para o padrão do IFSC. No curso de Engenharia de Telecomunicações, recomendamos que os alunos utilizem esse modelo assim como o [https://www.overleaf.com/ Overleaf] no desenvolvimento do TCC, pois além de possibilitar o compartilhamento do documento com o professor (co)orientador, ainda reduzir o tempo perdido na formação do documento, permitindo que o aluno utilize o seu tempo no conteúdo do TCC.  
  
*Modelo sempre atualizado está disponível no [https://github.com/emersonmello/modelos-latex/tree/master/monografia github do professor Emerson Mello].
+
*Modelo sempre atualizado está disponível no [https://github.com/emersonmello/monografia-latex-ifsc github do professor Emerson Mello].
  
=Modelo para o projeto de TCC=
+
==Erros conhecidos no modelo==
Recomendamos que o aluno ao preparar o projeto de TCC (na disciplina de TCC1), já vá utilizando o modelo completo de TCC indicado acima.  No entanto, como nem todos os itens são necessários no projeto, seguem algumas recomendações adicionais:
+
;referências a URLs:  (resolvido em 10 abr 2023)
 +
A ABNT NBR6023:2020  Informação e documentação - Referências - Elaboração, mudou a forma de indicar a referências de URLs. Anteriormente se utilizava os símbolos < e >.
 +
ESPRESSIF. Datasheet: ESP32 Series. 2022. Disponível em: <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>. Acesso em: 26 nov. 2022. Citado na página 20.
 +
Na ABNT atual de 2020, não se usa mais os símbolos < e >
 +
ESPRESSIF. Datasheet: ESP32 Series. 2022. Disponível em: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf. Acesso em: 26 nov. 2022. Citado na página 20.
 +
No entanto, como essa alteração depende da modificação do pacote '''abnTeX''' que define o estilo bibliográfico, a geração dos documentos com o padrão antigo será aceita até a atualização deste pacote.
  
==Converter em PDF==
+
;Adaptação a nova NBR 10520: 
Ao converter o projeto de TCC para PDF, use o comando '''oneside''' para evitar as páginas em branco necessárias apenas para a impressão em papel. Também certifique-se que o tamanho da fonte é 12pt.
+
A ABNT NBR 10520:2023 - mudou a forma de fazer a citação das referências no texto, mudando de letras maiusculas para minusculas. Usando o modelo atual essa alteração ainda não está implementada.
  
<syntaxhighlight lang=latex>
+
=Modelo para o projeto de TCC=
\documentclass[
+
Recomendamos que o aluno ao preparar o projeto de TCC (na disciplina de TCC1)já utilize o modelo completo de TCC indicado acima.  No entanto, como nem todos os itens são necessários no projeto, seguem algumas recomendações adicionais que devem ser observadas:
% -- opções da classe memoir --
 
12pt,
 
%openright,
 
oneside,
 
a4paper,
 
chapter=TITLE, % títulos de capítulos convertidos em letras maiúsculas
 
%section=TITLE, % títulos de seções convertidos em letras maiúsculas
 
%subsection=TITLE, % títulos de subseções convertidos em letras maiúsculas
 
%subsubsection=TITLE,% títulos de subsubseções convertidos em letras maiúsculas
 
english, % idioma adicional para hifenização
 
%french, % idioma adicional para hifenização
 
%spanish, % idioma adicional para hifenização
 
brazil % o último idioma é o principal do documento
 
]{abntex2}
 
</syntaxhighlight>
 
  
 
==Ajustes no modelo==
 
==Ajustes no modelo==
Linha 39: Linha 29:
  
 
==Comente partes que não precisam estar no projeto de TCC==
 
==Comente partes que não precisam estar no projeto de TCC==
Comente (selecione todas as linhas e tecle '''[CTRL+/]''') os seguintes itens: ficha catalográfica, folha de aprovação, dedicatória, dedicatória, epígrafe, abstract.
+
Comente (selecione todas as linhas e tecle '''[CTRL+/]''') os seguintes itens: '''ficha catalográfica''', '''folha de aprovação''', '''dedicatória''', '''epígrafe'''.
  
 
Exemplo da ficha catalográfica comentada:
 
Exemplo da ficha catalográfica comentada:
Linha 76: Linha 66:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Comente ainda o Resumo em inglês (Abstract):
+
Comente ainda o resumo em inglês ('''Abstract'''), e as '''Keywords'''
 
<syntaxhighlight lang=latex>
 
<syntaxhighlight lang=latex>
 
% % resumo em inglês
 
% % resumo em inglês
Linha 91: Linha 81:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Comente as listas de tabelas, códigos e figuras que tiverem menos que 3 entradas.
+
Comente as listas de tabelas, códigos e figuras que tiverem menos que 3 entradas (pois são opcionais).
 
<syntaxhighlight lang=latex>
 
<syntaxhighlight lang=latex>
 
%---------------------------------------------------------------------%
 
%---------------------------------------------------------------------%
Linha 113: Linha 103:
 
% \cleardoublepage
 
% \cleardoublepage
 
% ---
 
% ---
 +
</syntaxhighlight>
  
 +
Comente as lista de abreviaturas e siglas.
 +
<syntaxhighlight lang=latex>
 
% inserir lista de abreviaturas e siglas
 
% inserir lista de abreviaturas e siglas
 
% \pdfbookmark[0]{Lista de abreviaturas e siglas}{loa}
 
% \pdfbookmark[0]{Lista de abreviaturas e siglas}{loa}

Edição atual tal como às 17h45min de 16 de agosto de 2023

Modelo para o Trabalho de Conclusão de Curso (TCC)

A monografia para o projeto final deverá ser regida de acordo com as normas da ABNT e do IFSC. Para facilitar a edição e formatação do texto, o professor Emerson Mello adaptou o modelo ABNTex2 para o padrão do IFSC. No curso de Engenharia de Telecomunicações, recomendamos que os alunos utilizem esse modelo assim como o Overleaf no desenvolvimento do TCC, pois além de possibilitar o compartilhamento do documento com o professor (co)orientador, ainda reduzir o tempo perdido na formação do documento, permitindo que o aluno utilize o seu tempo no conteúdo do TCC.

Erros conhecidos no modelo

referências a URLs
(resolvido em 10 abr 2023)

A ABNT NBR6023:2020 Informação e documentação - Referências - Elaboração, mudou a forma de indicar a referências de URLs. Anteriormente se utilizava os símbolos < e >.

ESPRESSIF. Datasheet: ESP32 Series. 2022. Disponível em: <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>. Acesso em: 26 nov. 2022. Citado na página 20.

Na ABNT atual de 2020, não se usa mais os símbolos < e >

ESPRESSIF. Datasheet: ESP32 Series. 2022. Disponível em: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf. Acesso em: 26 nov. 2022. Citado na página 20.

No entanto, como essa alteração depende da modificação do pacote abnTeX que define o estilo bibliográfico, a geração dos documentos com o padrão antigo será aceita até a atualização deste pacote.

Adaptação a nova NBR 10520

A ABNT NBR 10520:2023 - mudou a forma de fazer a citação das referências no texto, mudando de letras maiusculas para minusculas. Usando o modelo atual essa alteração ainda não está implementada.

Modelo para o projeto de TCC

Recomendamos que o aluno ao preparar o projeto de TCC (na disciplina de TCC1)já utilize o modelo completo de TCC indicado acima. No entanto, como nem todos os itens são necessários no projeto, seguem algumas recomendações adicionais que devem ser observadas:

Ajustes no modelo

Troque a texto da folha de rosto para:

\preambulo{Projeto de Trabalho de conclusão de curso apresentado à Coordenadoria do Curso de Engenharia de Telecomunicações do campus São José do Instituto Federal de Santa Catarina}

ou suprima a folha de rosto.

%\imprimirfolhaderosto*

Comente partes que não precisam estar no projeto de TCC

Comente (selecione todas as linhas e tecle [CTRL+/]) os seguintes itens: ficha catalográfica, folha de aprovação, dedicatória, epígrafe.

Exemplo da ficha catalográfica comentada:

% \begin{fichacatalografica}
% 	\sffamily
% 	\vspace*{\fill}					% Posição vertical
% 	\begin{center}					% Minipage Centralizado
% 	\fbox{\begin{minipage}[c][8cm]{13.5cm}		% Largura
% 	\small
% 	\imprimirautor
% 	%Sobrenome, Nome do autor
	
% 	\hspace{0.5cm} \imprimirtitulo  / \imprimirautor. --
% 	\imprimirlocal, \imprimirdata-
	
% 	\hspace{0.5cm} \pageref{LastPage} p. : il. (algumas color.) ; 30 cm.\\
	
% 	\hspace{0.5cm} \imprimirorientadorRotulo~\imprimirorientador\\
	
% 	\hspace{0.5cm}
% 	\parbox[t]{\textwidth}{\imprimirtipotrabalho~--~\imprimirinstituicao,
% 	\imprimirdata.}\\
	
% 	\hspace{0.5cm}
% 		1. Palavra-chave1.
% 		2. Palavra-chave2.
% 		2. Palavra-chave3.
% 		I. Orientador.
% 		II. Instituto Federal de Santa Catarina.
% 		III. Campus São José.
% 		IV. Título 
% 	\end{minipage}}
% 	\end{center}
% \end{fichacatalografica}

Comente ainda o resumo em inglês (Abstract), e as Keywords

% % resumo em inglês
% \begin{resumo}[Abstract]
%  \begin{otherlanguage*}{english}
%   This is the english abstract.

%   \vspace{\onelineskip}
 
%   \noindent 
%   \textbf{Keywords}: latex. abntex. text editoration.
%  \end{otherlanguage*}
% \end{resumo}

Comente as listas de tabelas, códigos e figuras que tiverem menos que 3 entradas (pois são opcionais).

%---------------------------------------------------------------------%
% inserir lista de ilustrações, tabelas, listagem de códigos, abreviaturas, símbolos
%---------------------------------------------------------------------%
% \pdfbookmark[0]{\listfigurename}{lof}
% \listoffigures*
% \cleardoublepage
% % inserir lista de tabelas
% \pdfbookmark[0]{\listtablename}{lot}
% \listoftables*
% \cleardoublepage

% ---
% inserir lista de listings
% ---
% \pdfbookmark[0]{\lstlistlistingname}{lol}
% \begin{KeepFromToc}
% \lstlistoflistings
% \end{KeepFromToc}
% \cleardoublepage
% ---

Comente as lista de abreviaturas e siglas.

% inserir lista de abreviaturas e siglas
% \pdfbookmark[0]{Lista de abreviaturas e siglas}{loa}
% \include{abreviaturas}
% \cleardoublepage

% % inserir lista de símbolos
% \begin{simbolos}
%   \item[$ \Gamma $] Letra grega Gama
%   \item[$ \Lambda $] Lambda
%   \item[$ \zeta $] Letra grega minúscula zeta
%   \item[$ \in $] Pertence
% \end{simbolos}
%---------------------------------------------------------------------%

Evite comentar linhas individuais, pois usando o comando [CTRL+/] para comentar trechos inteiros do código LaTeX, sempre é possível descomentar usando novamente [CTRL+/].

Dicas sobre o uso do Overleaf e LaTeX

Para usar de forma segura e eficiente o LaTeX, recomendamos consultar nas dúvidas as páginas Uso do Overleaf e Dicas de LaTeX.