Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ekspek/ist-thesis

Classe LaTeX para teses de mestrado do Instituto Superior Técnico
https://github.com/ekspek/ist-thesis

instituto-superior-tecnico ist latex-class latex-template thesis-latex-template thesis-template

Last synced: 6 months ago
JSON representation

Classe LaTeX para teses de mestrado do Instituto Superior Técnico

Awesome Lists containing this project

README 

          
# Modelo LaTeX de Tese Não Oficial do Instituto Superior Técnico



[Read this page in english.](README_EN.md)



Modelo de tese de mestrado em LaTeX não oficial para documentos escritos para o Instituto Superior Técnico. Este projeto tem como objetivo criar uma classe de LaTeX que define todas as restrições definidas pelo Instituto Superior Técnico por defeito quando incluída e implementa funções adicionais para definir pormenores do documento e permitir um certo nível de personalização dentro das restrições existentes.



## Utilização



Para compilar um documento em LaTeX com esta classe, só é necessário fazer download do ficheiro [`ist-thesis.cls`](https://github.com/ekspek/ist-thesis/releases/download/v1.1.0/ist-thesis.cls).

1. Colocar o ficheiro `ist-thesis.cls` na mesma pasta que o documento `.tex` a compilar;

2. Incluir a linha abaixo no início do ficheiro;

```tex

\documentclass{ist-thesis}

```

   - Opções podem ser incluídas entre parênteses retos entre `\documentclass` e `{ist-thesis}`, como no exemplo seguinte. As opções utilizáveis encontram-se na documentação.

```tex

\documentclass[english]{ist-thesis}

```

3. Compilar o documento.



### Compilação



Qualquer documento que utilize esta classe pode ser compilado da mesma maneira que a maior parte dos documentos LaTeX, sem configurações adicionais. Num serviço como o [Overleaf](https://www.overleaf.com/ "Overleaf"), basta fazer upload da classe e compilar. Para uma instalação local, basta correr o compilador através do editor de eleição ou através de `pdflatex main.tex` ou `xelatex main.tex` na linha de comandos, onde `main.tex` é o documento a ser compilado.



No entanto, é necessária caução quando o documento for compilado com bibliografia e glossário. Ajuda para estes tópicos específicos será incluída na documentação.



### Logótipos



Os logótipos oficiais do Instituto Superior Técnico estão incluídos neste repositório, mas também podem ser encontrados na [página oficial](https://tecnico.ulisboa.pt/pt/sobre-o-tecnico/institucional/logo-e-manual-de-identidade/). A utilização destes logótipos é obrigatória e a ausência dos ficheiros correspondentes retorna erro.



![Imagem da capa da tese de exemplo](./cover.png)



## Documentação



A documentação que é disponibilizada inclui detalhes sobre o conteúdo da classe e como melhor fazer uso das funções incluídas. Pode ser consultada neste [link](doc/doc.pdf) ou na pasta [doc](doc/) deste repositório, onde se encontra acompanhada do código fonte.



Foi também preparado um exemplo de uma tese com formato *lorem ipsum* para exemplificar algumas das funções da classe em si e também algumas (na minha opinião) boas práticas na escrita de documentos em LaTeX. Este encontra-se num [repositório separado](https://github.com/ekspek/ist-thesis-template) que acompanha este. Também irá aparecer na galeria do Overleaf quando a submissão for aprovada.



Poderá também vir a ser incluído um documento de ajuda com a criação da tese, separado da documentação oficial, para auxiliar em diversos aspetos de LaTeX.



## Erros, Problemas e Sugestões



Problemas com utilização da classe podem ser reportados aqui mesmo no GitHub ou contactando-me a mim ou a outros contribuidores diretamente. Contribuições em qualquer aspeto do projeto são bem-vindas!



Os erros, objetivos e outras discussões podem ser criadas e encontradas na página de [*Issues*](https://github.com/ekspek/ist-thesis/issues) do GitHub.



### Estado Atual do Projeto



O projeto neste momento encontra-se concluído e pronto a ser utilizado. Não implica, no entanto, que não possa ser atualizado ou alterado com o passar do tempo. Recomenda-se, portanto, que se atualize o ficheiro quando houver atualizações nesta página, ou pelo menos quando houver uma [*release*](https://github.com/ekspek/ist-thesis/releases) nova.



O progresso pode também ser observado na página de [*Issues*](https://github.com/ekspek/ist-thesis/issues) do GitHub.



#### Considerações sobre este projeto



Este projeto não é o primeiro nem será o último modelo de tese em LaTeX feito pela comunidade do IST. Em comparação a outros modelos, no entanto, este tem o objetivo de ser simples de utilizar, não distribuíndo um modelo pronto para ser subtituído com texto do autor mas sim fornecendo uma base para tal, definindo as regras e restrições da Direcção Académica e permitindo ao utilizador definir o resto como preferir, tentando não interferir com a experiência típica de LaTeX e da classe `report`. É, portanto, um projeto mais indicado a utilizadores com alguma experiência em LaTeX e que se sintam confortáveis a criar um documento de raíz (ou copiando trabalhos anteriores).



No entanto, para quem precisar, criei [um exemplo de tese](https://github.com/ekspek/ist-thesis-template) para auxiliar com os aspetos que a classe de tese aqui distribuída não cobre. Também estou disponível para contactar com quem precisar de ajuda com LaTeX, dentro dos meus conhecimentos. Os contactos estão incluídos acima.



## Referências



Os regulamentos de elaboração da tese foram retirados do [Guia de Preparação da Dissertação](https://academica.tecnico.ulisboa.pt/files/sites/54/guia-de-preparacao-da-dissertacao-1516.pdf "Guia de Preparação da Dissertação") da Direção Académica do Instituto Superior Técnico.



Inspiração e referência também foram retiradas do excelente [conjunto de documentos para elaboração da tese](https://fenix.tecnico.ulisboa.pt/homepage/ist31052/documentos-para-elaboracao-da-tese), criados e distribuídos pelo Professor André Marta do Instituto Superior Técnico.



## Licença



Este projeto está licenciado através da [LaTeX Project Public License](https://www.latex-project.org/lppl/), versão 1.3c.



Quaisquer dados pertinentes ao Instituto Superior Técnico em si (em especial os logótipos) são propriedade do Instituto Superior Técnico e da Universidade de Lisboa.