Skip to content

Latest commit

 

History

History
208 lines (146 loc) · 7.61 KB

README.md

File metadata and controls

208 lines (146 loc) · 7.61 KB
Raw

Template para ufscthesisx

Modelo Canônico de TCC, Monografia, Dissertação, Tese ou Relatório de Pós--Doutorado da UFSC com abnTeX2. Originado de endereço https://github.com/AdrianoRuseler/abntex2-ufsc com o nome abntex2-ufsc, este projeto foi renomeado para ufscthesisx.

Esse projeto não está vinculado a nenhum órgão da UFSC.

Qualquer problema com a utilização ou com o modelo em si, basta criar um issue aqui no GitHub no nosso issue tracker: issues

Modelo em PDF

Se você quer ter uma ideia de como é o modelo, a compilação deve resultar no seguinte PDF.

Instalar LaTeX e abnTeX2

Para poder utilizar a classe é necessário ter uma distribuição atual do LaTeX, incluindo o pacote abnTeX2. Sugerimos formtemente a utilização da distribiução TeX Live para Windows e Linux e MacTeX para macOS.

As configurações específicas para cada sistema podem ser encontradas nos link abaixo para o pacote abnTeX2:

  1. abntex2 CTAN
  2. abnTeX2 Instalação

Instalação Ubuntu/Linux Mint and others

sudo apt-get install texlive-full
sudo apt-get install xzdec

Instalação Windows

  1. Baixe o arquivo do instalador em: https://miktex.org/download
  2. Enquando seguindo dos passas do instalador, assegure-se de marcar para instalar todos os pacotes latex (full install).

Baixando diretamente modelo UFSC

Caso queria, pode baixar diretamente o arquivo zip em releases e descompacte o arquivo.

Utilizando git para baixar o modelo USFC

No diretório do seu projeto faça um clone (recursivo) dos arquivos do repositório:

git clone --recursive https://github.com/ufsc/ufscthesisx

Este repositório já contém um exemplo de tese com uso avançado de conceitos e LaTeX. Se você tiver interesse em utilizar esse template, você precisa preencher os seus dados como nome do orientador, coorientador, seu nome, nome da sua instituição, do seu curso, departamento, etc.

Para isso altere os dados fictícios para os corretos no arquivo main.tex, que é o arquivo principal do template utilizado, e carrega todos os pacotes necessários e incluir os arquivos LaTeX que contém as partes da sua monografia.

Utilizando Overleaf para digitar sua tese com modelo UFSC

Se você quiser, pode utilizar o Overleaf, um sistema de editoração online de textos em LaTeX.

Se você já tiver uma conta no Overleaf pode fazer o upload do arquivo .zip baixado em releases.

Você também pode fazer o upload automaticamente para Overleaf com a última versão disponível clicando aqui.

Uso

A ideia é fazer com que você utilize a classe abnTeX2, mas com customizações voltadas para as normas de trabalhos acadêmicos da UFSC, fazendo com que o seu uso seja idêntico ao uso direto da classe abnTeX2.

A documentação dessa classe pode ser encontrada nos link a seguir e também é possível encontrar modelos de documentos que utilizam a classe para tomar como base:

  1. Documentação e Modelos abnTeX2

Para compilar este modelo, você pode utilizar seu editor git favorito, e pedir para ele compilar o documento a partir do arquivo main.tex no diretório principal.

Por conveniência, você também pode executar o arquivo build.bat caso você esteja no Windows, ou executar o comando make caso você esteja no Linux.

Compilação

O jeito mais legal de compilar é executando um dos seguintes comandos:

  1. make clean
  2. make clean halt=1 debug=1
  3. make latex biber latex1
  4. make latex biber latex1 halt=1 debug=1
  5. make latex biber latex1 biber1 latex2
  6. make latex biber latex1 biber1 latex2 halt=1 debug=1
  7. ...

Se você quiser saber quais são todos os comandos de compilação disponíveis, basta chamar utilizar o comando make help. Exemplo:

$ make help

 Usage:
   make <target> [debug=1]

 Use debug=1 to run make in debug mode. Use this if something does not work!
 Examples:
   make help
   make debug=1
   make latex debug=1
   make thesis debug=1

...

Caso você tenha problemas, error ou algo não funcione, execute o make file em modo debug. Para isso, basta chamar ele como você normalmente faz, mas passando o parâmetro debug=true. Por exemplo, make latex debug=true.

Por conveniência, você também pode chamar make latex debug=a qualquer outra coisa desde que não seja vazio. Por exemplo, make latex debug=1 Você também pode diretamente editar o arquivo setup/makefile.mk e descomentar a linha # ENABLE_DEBUG_MODE := true para ativar o modo debug permanentemente.

Normas da UFSC para trabalhos acadêmicos

Na UFSC, a Biblioteca Central disponibiliza um site específico para as normas e foi com base nessas informações que este projeto foi feito.

  1. Geral
  2. Normas de Citação
  3. Normas em docx
  4. Capa
  5. Dados da ficha
  6. Ficha de identificação da obra

Site da abnTeX2

  1. abnTeX2
  2. https://github.com/abntex/abntex2
  3. https://github.com/abntex/biblatex-abnt

Mudanças

Para ver as mudanças, acesse o histórico do git no endereço commits/master.

Ou clone este repositório e execute seguinte comando do cliente git:

# https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History
git log

Licença

Copyright (c) 2012-2014 by abnTeX2 group at http://abntex2.googlecode.com/
Copyright (c) 2014-2015 Mateus Dubiela Oliveira
Copyright (c) 2015-2016 Adriano Ruseler
Copyright (c) 2017-2018 Evandro Coan, Luiz Rafael dos Santos
Copyright (c) 2019-2019 Alisson Lopes Furlani

É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia deste modelo e
software e arquivos de documentação associados (o "Software"), para ter estes arquivos com os
direitos de uso, cópia, modificação, mesclagem, publicar, distribuir, e permitir que as pessoas a
quem o Software seja fornecido tenham estes mesmos direitos, ambos sujeitos às seguintes condições:

O aviso de direitos autorais acima e este aviso de permissão devem ser incluídos em todas as cópias
ou partes substanciais do Software.

Os arquivos `chapters/intro.tex`, `chapters/chapter_1.tex` e `setup/ufscthesisx.sty` estão
licenciados sobre a licença LPPL (The Latex Project License). Portanto você deve respeitar essa
licença para esses arquivos ao invés dessa. Entretanto a condição a seguir continuará valendo sobre
esses arquivos licenciados pela licença LPPL:

OS ARQUIVOS NESTE REPOSITÓRIO SÃO FORNECIDOS "NO ESTADO EM QUE SE ENCONTRAM", SEM GARANTIA DE
QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE
COMERCIALIZAÇÃO, APTIDÃO PARA UM PROPÓSITO ESPECÍFICO E NÃO INFRACÇÃO. EM NENHUMA CIRCUNSTÂNCIA, OS
AUTORES OU TITULARES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTRA
RESPONSABILIDADE, SEJA EM AÇÃO DE CONTRATO, DELITO OU DE OUTRA FORMA, DECORRENTE, DESTE OU
RELACIONADO COM DOS ARQUIVOS DESTE REPOSITÓRIO OU O USO OU OUTRAS NEGOCIAÇÕES NO MODELO E SOFTWARE.