wmeira / utfprct-tex

O UTFPRCT-TEX é um template LaTeX não oficial para trabalhos acadêmicos (teses, dissertações, trabalhos de conclusão...) da Universidade Tecnológica Federal do Paraná (UTFPR) - Curitiba

UTFPRCT-TEX

O UTFPRCT-TEX é um template LaTeX não oficial para trabalhos acadêmicos (teses, dissertações, trabalhos de conclusão, etc.) da Universidade Tecnológica Federal do Paraná (UTFPR) - Curitiba.

A versão mais recente do template encontra-se também disponível no Overleaf.

Este trabalho é baseado no projeto UTFPRPG-TEX mantido por Luiz. E. M. Lima. As alterações do template UTFPRPG-TEX foram necessárias para alinhar as diferentes interpretações da ABNT presentes mesmo entre diferentes campi da UTFPR e implementar os principais pontos da NBR 6023/2018 (referências).

A estrutura principal de ambos os trabalhos é baseada no template de trabalhos acadêmicos abnTeX2, que atende aos requisitos das normas da Associação Brasileira de Normas Técnicas (ABNT) para produção de documentos técnicos e científicos brasileiros.

---

Arquivos do Projeto

A pasta utfprct-tex contém os arquivos do template deste projeto e um exemplo de uso escrito pelo prof. Luiz. E. M. Lima, proveninente do projeto UTFPRPG-TEX.

Os arquivos do template são:

• utfprct.cls: arquivo de classe do template UTFPRCT-TEX
• utfprct.tex: arquivo LaTeX de trabalho acadêmico utilizando o template UTFPRCT-TEX
• utfprct-dados.tex: arquivo de dados do trabalho acadêmico. Deve conter todas as informações da capa, contra-capa e metadados do documento
• abntex2-alf.bst: arquivo com pequenas alterações do estilo alfanumérico bibtex do pacote abnTeX2 para se adaptar a NBR6023/2018 (estilo bibtex padrão)
• abntex2-num.bst: arquivo com pequenas alterações do estilo numérico bibtex do pacote abnTeX2 para se adaptar a NBR6023/2018
• abntex2-alf-en.bst: arquivo abntex2-alf.bst com conectores e termos traduzidos para o inglês
• abntex2-num-en.bst: arquivo abntex2-num.bst com conectores e termos traduzidos para o inglês
• make.bat (makefile): possui comandos para converter o arquivo utfprct.tex (default) para PDF e um comando para limpar os arquivos intermediários (clean) (vide comando help)
• Licencas/*.png: contém as imagens referentes as licenças Creative Commons

Outros arquivos:

• capituloexemplo.tex: capítulo exemplo que serve como documentação de como utilizar os recursos disponívels no template

Normas vigentes do Sistema de Bibliotecas da UTFPR (2020)

A orientação para entrega de trabalhos acadêmicos pode ser encontrada no portal da UTFPR (publicada em 18/09/2017). No qual, estabele-se que os trabalhos devem estar de acordo com as normas da Associação Brasileira de Normas Técnicas (ABNT):

• NBR 6023/2018: Informação e documentação - Referências
• NBR 6024/2012: Informação e documentação - Numeração progressiva das seções de um documento - Apresentação
• NBR 6027/2012: Informação e documentação - Sumário - Apresentação
• NBR 6028/2003: Informação e documentação - Resumo - Apresentação
• NBR 6034/2004: Informação e documentação - Índice - Apresentação
• NBR 10520/2002: Informação e documentação - Citações em Documentos - Apresentação
• NBR 14724/2011: Informação e documentação - Trabalhos Acadêmicos - Apresentação
• NBR 15287/2011: Informação e documentação - Projeto de Pesquisa - Apresentação

É possível consultar as normas ABNT no site da biblioteca da UTFPR através dos seguintes passos:

1. Acesse o site da biblioteca da UTFPR: http://biblioteca.utfpr.edu.br/
2. Faça o login no sistema da biblioteca
3. Na barra de "Pesquisa Geral", insera a norma (e.g., NBR 6023/2018) e clique no botão "Pesquisar"
4. Ao terminar a busca, clique em "Pesquisa Target GEDWeb" (conforme figura)
5. Verifique se é a versão correta da norma procurada no atributo Data
6. Clique na imagem do documento para consultar

Compatibilidade do projeto UTFPRCT-TEX com as normas vigentes

O projeto UTFPRCT-TEX envolve o projeto abnTeX2 (v. 1.9.7). Sendo o pacote abnTeX2 compatível com quase todas as normas vigentes na UTFPR, exceto a NBR 6023/2018 (referências).

Por este motivo, modificações no pacote abnTeX2 e no código do UTFPRPG-TEX foram necessárias para tornar o UTFPRCT-TEX compatível com as principais características de formatação e os principais tipos de entrada bibtex da NBR 6023/2018. No entanto, a norma NBR 6023/2018 é extensa e possui muitos novos recursos que podem ser referenciados, inexistentes na norma anterior NBR 6023/2002 e, por isso, possíveis melhorias podem ainda ser necessárias neste aspecto para cobrir a norma no seu total.

---

Formato de Entrega

A Instrução Normativa Conjunta nº 01/2018 – PROPPG/PROGRAD dispõe sobre o formato das versões finais enviadas às bancas de avaliação e depósito no Sistema de Bibliotecas da UTFPR (disponível no link).

Art. 1) As versões de Trabalhos de Conclusão de Cursos de Graduação, de Trabalhos de Conclusão de Cursos de Especialização, de Dissertações de Mestrado e de Teses de Doutorado enviadas aos integrantes das respectivas bancas examinadoras de qualificação e defesa final devem, obrigatoriamente, estar em formato digital.

• Faculta-se o envio em formato impresso apenas aos integrantes das bancas examinadoras externos ao quadro de servidores da UTFPR, desde que requerido pelos mesmos.

Art. 2) O depósito das versões finais de Trabalhos de Conclusão de Cursos de Graduação, de Trabalhos de Conclusão de Cursos de Especialização, de Dissertações de Mestrado e de Teses de Doutorado no Portal de Informação em Acesso Aberto da UTFPR e nas Bibliotecas dos Câmpus será feito apenas no formato digital.

Para que o template UTFPRCT-TEX produza documentos no formato digital ou impresso de entrega, as seguintes opções devem ser definidas na declaração da classe (\documentclass) do arquivo utfprct.tex:

Formato Digital

Implica na remoção de todas as páginas em branco, a fim de não parecer que existe falta de informação durante a leitura do documento.

• pretextualoneside: impressão dos elementos pré-textuais começa em qualquer lado da folha (anverso ou verso)
• oneside: impressão dos elementos textuais e pós-textuais no anverso da folha (sem folhas em branco para o verso)

Formato Impresso

• pretextualtwoside: impressão dos elementos pré-textuais começa sempre no anverso
• oneside ou twoside: impressão dos elementos textuais e pós-textuais oneside (anverso) ou twoside (anverso e verso, se mais de 100 páginas)

---

Formato PDF-A

Além do formato digital, a entrega de TCC, dissertação ou tese deve ser feita no formato de arquivo PDF/A.

O PDF/A é um formato de arquivo definido pela norma ISO 19005 para arquivamento de longo prazo de documentos eletrônicos, a fim de garantir que poderão ser reproduzidos com precisão no futuro. Um elemento fundamental para alcançar este objetivo é a exigência de que documentos PDF/A devam ser 100% autocontidos, ou seja, todas as informações necessárias para visualizar o documento de forma consistente devem estar presentes no arquivo. Isso inclui, entre outras coisas, o conteúdo propriamente dito (texto, imagens e gráficos vetoriais), as fontes utilizadas e as informações de cor. Não é permitido que um documento PDF/A dependa de fontes externas (por exemplo, programas de tipografia e hiperlinks) (ref. portal do aluno).

Existem diversas categorias de PDF/A (e.g., PDF/A-1A, PDF/A-2, PDF/A-3), sendo que cada um deles possui diferentes requisitos para serem aceitos. A biblioteca da UTFPR não especifica nenhuma categoria, desde que esteja em algum formato PDF/A.

Uma das categorias mais básicas dentro do PDF/A-2 é o PDF/A-2B (Basic) e que já torna o arquivo adequado para o longo prazo de armazenamento, enquanto mantém seu aspecto visual. Para converter um PDF para PDF/A-2B, sugiro a ferramenta online da PDFEN: https://www.pdfen.com/

Outra categoria é o PDF/A-1B, cujo formato pode ser gerado ao tentar imprimir o documento PDF para outro PDF com o Foxit Reader PDF Printer (impressora de PDF do Foxit) e nas propriedades escolher na "Qualidade de Impressão" a categoria padrão PDF/A-1b` (cuidado para não imprimir em escala de cinza). A mesma funcionalidade pode estar presente em outras impressoras de PDF (e.g., o Adobe Acrobat Reader).

Para validar se o PDF/A foi gerado corretamente, o programa VeraPDF pode detectar e validar a categoria do PDF/A do documento de entrada. Outra opção é abrir o arquivo no Abobe Acrobat Reader, no qual aparecerá um aviso informando que o documento PDF aberto é um PDF/A.

A conversão para PDF/A poderia ser feita através de algum procedimento de compilação do LaTeX, porém tive algumas dificuldades e não consegui validar o arquivo gerado como PDF/A. A falta da ferramenta não é tão negativa, pois o procedimento só é necessário no momento de gerar a versão final e as alternativas citadas já satisfazem bem o requisito (fico aberto à sugestões).

Licenciamento

A Resolução Conjunta nº 01/2020 COGEP-COPPG dispõe sobre a Política de licenciamento das versões finais dos TCCs e dos Programas de Pós-Graduação Stricto Sensu (dissertações e teses) produzidas na UTFPR. Sendo obrigatória a adoção de uma das seguintes licenças Creative Commons: CC-BY, CC-BY-SA, CC-BY-ND, CC-BY-NC, CC-BY-NC-SA ou CC-BY-NC-ND. A licença deve ser inserida na folha de rosto de acordo com os modelos disponilizados pela biblioteca. Para escolha da forma de licenciamento, verificar junto ao curso ou programa de pós-graduação do discente qual deverá ser utilizada. Por exemplo, o CPGEI aderiu a opção CC-BY segundo a Resolução Normativa 02/2020.

Todas as opções de licenciamento estão disponíveis no template UTFPRCT-TEX através da configuração da folha de rosto.

Opções de Trabalho Acadêmico

Trabalho Acadêmico em Inglês

Na declaração da classe utfprct no arquivo utfprct.tex, as últimas opções adicionam idiomas para hifenização, no qual, o último idioma definido será o idioma principal do documento (define o \languagename). Portanto, caso o trabalho seja desenvolvido em inglês apenas coloque english na última posição (evite idiomas duplicados).

Qualquer redefinição de nome em inglês pode ser feito dentro da classe utfprct.cls dentro da seção "Variáveis dependentes do idioma".

Trabalho Acadêmico em Cotutela (Duplo Grau)

Para trabalhos acadêmicos em cotutela com outro instituto (duplo grau), pode-se adicionar as informações do instituto de cotutela no arquivo de dados do trabalho (utfprct-dados.tex), de forma que essas informações sejam mencionadas nos elementos pré-textuais.

No arquivo de dados, definir \AtribuiCotutela{true} para inserir as informações de cotutela na capa, folha de rosto e forma de referenciar o trabalho (adicionado na errata, resumo e abstract). Na folha de rosto, pode-se também atribuir uma segunda descrição do documento mais específica para o instituto de cotutela definindo \AtribuiDescricaoCotutela{true} com a descrição em \DescricaoDoDocumentoCotutela.

utfprct-tex's Issues

Nome do curso

Uma sugestão.

Em diversos pontos do arquivo utfprct-dados.tex identifiquei que há uma instrução: \imprimircurso, porém neste mesmo arquivo, não encontrei onde definir o nome do curso. Aí reparei que no arquivo utfprct.cls tem as linhas:
%% Nome do curso \providecommand{\imprimircurso}{Nome do Curso} \newcommand{\Curso}[1]{\renewcommand{\imprimircurso}{#1}}

então deduzi que eu deveria usar o comando \Curso no arquivo utfprct-dados.tex. Mas isso foi uma dedução.
Sugiro, colocar nesse arquivo um exemplo de como definir o nome do curso, e seguir o padrão que você seguiu.

Arquivo bibtex

Como usar com arquivo o bibtex ?

Alteração de documento para inglês

Boa noite,

Estou tendo problemas em adaptar o documento para inglês, por mais que mude no cls para Table no lugar de Tabela, no List of tables o nome ainda aparece como Tabela 1... O mesmo acontece para as figuras que persistem com o nome Figura 1. Peço que se possível, me auxilie com relação a esse aspecto.

Agradeço desde já,

[BUG] Primeiro Anexo no Sumário

Dado que existe ao menos um apêndice e um anexo e não estamos utilizando a página de abertura da parte de anexos (comando \partanexos).

Então o primeiro anexo, o "Anexo A", é referido como "Apêndice A" no sumário (TOC). Os próximos anexos ficam corretos.

O problema deriva de uma issue conhecida do pacote abntex2 com o pacote memoir: abntex/abntex2#224 (abntex2)

A classe abntex2 e memoir estão tendo problemas em lidar com a condição dada no arquivo que monta o toc (table of contents). Quando adicionamos uma nova página entre o último apêndice e o primeiro anexo, então os pacotes conseguem resolver o TOC corretamente. Por enquanto, recomendo manter a página de abertura do Anexo e do Apêncide (apenas para manter o padrão) para evitar o problema.

Já tentei solucionar o problema, porém não obtive sucesso até o momento. Deixo a issue em aberto para quem conseguir contribuir com uma solução!

Título em inglês na folha de rosto

Estou com problemas para exibir o título do trabalho em inglês na folha de rosto. No documento em PDF está sendo exibido apenas o título em português. No arquivo utfprct-dados.txt defini as variáveis da seguinte forma:

\TituloDoDocumento{%%
Detecção de fogo ativo por aprendizado profundo em imagens provenientes do satélite Landsat-8 
}%

%% Título do trabalho em INGLÊS (abstract)
\DocumentTitle{%%
Active fire detection with Deep-Learning in Landsat-8 imagery
}%

% [...]

\TituloEmMultiplasLinhas{%%
Detecção de fogo ativo por aprendizado \par
profundo em imagens provenientes do satélite Landsat-8 
}%

\TituloEmMultiplasLinhasIngles{%%
Active fire detection with Deep-Learning \par
in Landsat-8 imagery
}%

E no documento utfprct.txt os idiomas estão na seguinte ordem:

english,%% Idioma adicional para hifenização  (colocar em último para doc. em inglês)  
brazil%% Idioma principal do documento (último da lista)   

e o início do documento está da seguinte forma:

\begin{document}%% Não comente esta linha

\pretextual%% Não comente esta linha

\incluircapa%% Comente para remover este item

\Licenca{CC-BY}
%\incluirfolhaderosto*%% Com ficha catalográfica no verso 
\incluirfolhaderosto%% Sem ficha catalográfica no verso

Alguma ideia do que pode estar acontecendo?

Geração de referências

William, clonei o repositório, instalei o texstudio, e todos os pacotes necessário, mas ao tentar gerar uma referência, ele fica com ?? marcado.
Pode me ajudar nessa questão?

Log:
_Processo iniciado: pdflatex -synctex=1 -interaction=nonstopmode "utfprct".tex

This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support). Scanning input file utfprct.idx....

done (79 entries accepted, 0 rejected). Sorting entries....done (522 comparisons). Generating output file utfprct.ind....done (64 lines written, 0 warnings). Output written in utfprct.ind. Transcript written in utfprct.ilg.

This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support). Scanning style file ./utfprct.ist...................

..........done (29 attributes redefined, 0 ignored). Scanning input file utfprct.glo....done (73 entries accepted, 0 rejected). Sorting entries....done (471 comparisons). Generating output file utfprct.gls....done (50 lines written, 0 warnings). Output written in utfprct.gls. Transcript written in utfprct.glg.

This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support). Scanning style file ./utfprct.ist........................

.....done (29 attributes redefined, 0 ignored). Scanning input file utfprct.acn....done (1 entries accepted, 0 rejected). Sorting entries...done (0 comparisons). Generating output file utfprct.acr....done (6 lines written, 0 warnings). Output written in utfprct.acr. Transcript written in utfprct.alg.

This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support). Scanning style file ./utfprct.ist.............................done (29 attributes redefined, 0 ignored). Scanning input file utfprct.acn2....

done (16 entries accepted, 0 rejected). Sorting entries....done (71 comparisons). Generating output file utfprct.acr2....done (20 lines written, 0 warnings). Output written in utfprct.acr2. Transcript written in utfprct.alg2.

This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support). Scanning style file ./utfprct.ist...................

..........done (29 attributes redefined, 0 ignored). Scanning input file utfprct.acn3....done (3 entries accepted, 0 rejected). Sorting entries....done (4 comparisons). Generating output file utfprct.acr3....done (12 lines written, 0 warnings). Output written in utfprct.acr3. Transcript written in utfprct.alg3.

This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support). Scanning style file /usr/share/texlive/texmf-dist/makeindex/nomencl/nomencl.ist............

done (12 attributes redefined, 3 ignored). Scanning input file utfprct.nlo....done (25 entries accepted, 0 rejected). Sorting entries....done (101 comparisons). Generating output file utfprct.nls....done (39 lines written, 0 warnings). Output written in utfprct.nls. Transcript written in utfprct.ilg.

O processo saiu normalmente
_