├── acronyms └── acronyms.tex ├── bibliography └── dissertation.bib ├── images └── ist_logo.eps ├── preview └── preview.pdf ├── appendix ├── appendixa.tex ├── main.tex └── new_appendix_chapter_template.tex ├── chapters ├── conclusion.tex ├── evaluation.tex ├── new_chapter_template.tex ├── main.tex └── introduction.tex ├── glossary └── glossary.tex ├── toPDF.sh ├── acknowledgments └── acknowledgments.tex ├── extra_stuff.tex ├── abstract ├── abstract-pt.tex └── abstract-en.tex ├── .gitignore ├── clean.sh ├── Makefile ├── LICENSE ├── Gruntfile.js ├── package.json ├── variables.tex ├── cover.tex ├── dissertation.tex └── README.md /acronyms/acronyms.tex: -------------------------------------------------------------------------------- 1 | % Acronym Definition 2 | 3 | \newacronym{IST}{IST}{Instituto Superior T\'ecnico} 4 | -------------------------------------------------------------------------------- /bibliography/dissertation.bib: -------------------------------------------------------------------------------- 1 | @misc{nobody, 2 | author = {{No one}}, 3 | title = {{Nothing}}, 4 | } 5 | -------------------------------------------------------------------------------- /images/ist_logo.eps: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/samfcmc/ist-dissertation-latex-template/HEAD/images/ist_logo.eps -------------------------------------------------------------------------------- /preview/preview.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/samfcmc/ist-dissertation-latex-template/HEAD/preview/preview.pdf -------------------------------------------------------------------------------- /appendix/appendixa.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \chapter{Appendix chapter} 4 | \label{appendix:appendix_chapter} 5 | -------------------------------------------------------------------------------- /chapters/conclusion.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \chapter{Conclusion} 4 | \label{chapter:conclusion} 5 | Conclusion here... 6 | -------------------------------------------------------------------------------- /chapters/evaluation.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \chapter{Evaluation} 4 | \label{chapter:evaluation} 5 | Evaluation here... 6 | -------------------------------------------------------------------------------- /glossary/glossary.tex: -------------------------------------------------------------------------------- 1 | % Glossary Definition 2 | 3 | \newglossaryentry{MSc}{name={MSc}, description={Masters degree in the area of Science.}} 4 | -------------------------------------------------------------------------------- /appendix/main.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | % Appendix chapters entry point 4 | % Include the chapters below 5 | 6 | \include{appendix/appendixa} 7 | -------------------------------------------------------------------------------- /toPDF.sh: -------------------------------------------------------------------------------- 1 | BASENAME=dissertation 2 | NAME=dissertation.tex 3 | pdflatex $NAME 4 | bibtex $BASENAME 5 | makeglossaries $BASENAME 6 | pdflatex $NAME 7 | pdflatex $NAME 8 | -------------------------------------------------------------------------------- /chapters/new_chapter_template.tex: -------------------------------------------------------------------------------- 1 | %TEX root = ../dissertation.tex 2 | 3 | \chapter{Chapter's Name} 4 | \label{chapter:chaptername} 5 | Your chapter's content goes here. 6 | -------------------------------------------------------------------------------- /acknowledgments/acknowledgments.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | % Acknowledgments: This one is optional 4 | \chapter*{Acknowledgments} 5 | % Thanks to everyone and bla bla bla 6 | -------------------------------------------------------------------------------- /appendix/new_appendix_chapter_template.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \chapter{Appendix chapter} 4 | \label{appendix:appendix_chapter} 5 | Your new appendix chapter's content goes here 6 | -------------------------------------------------------------------------------- /extra_stuff.tex: -------------------------------------------------------------------------------- 1 | % Extra stuff file 2 | % This file is included before begin{document} environment 3 | % Use this to include extra packages and define your own commands 4 | % This way, you can easily grab a most recent version 5 | % of dissertation.tex file from the original repo 6 | -------------------------------------------------------------------------------- /chapters/main.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | % Entry point for chapters 4 | % In this file you define the order 5 | % in which the chapters are included 6 | 7 | % Chapters 8 | \include{chapters/introduction} 9 | \include{chapters/evaluation} 10 | \include{chapters/conclusion} 11 | -------------------------------------------------------------------------------- /abstract/abstract-pt.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \begin{otherlanguage}{portuguese} 4 | \begin{abstract} 5 | \abstractPortuguesePageNumber 6 | O teu resumo aqui... 7 | 8 | % Keywords 9 | \begin{flushleft} 10 | 11 | \palavrasChave{as tuas palavras chave} 12 | 13 | \end{flushleft} 14 | 15 | \end{abstract} 16 | \end{otherlanguage} 17 | -------------------------------------------------------------------------------- /chapters/introduction.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \chapter{Introduction} 4 | \label{chapter:introduction} 5 | Your introduction here...\\ 6 | 7 | A demonstration of how to use acronyms and glossary: 8 | 9 | A \gls{MSc} entry. 10 | 11 | Second use: \gls{IST}. 12 | 13 | Plurals: \glspl{MSc}. 14 | 15 | A citation example \cite{nobody} 16 | -------------------------------------------------------------------------------- /abstract/abstract-en.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ../dissertation.tex 2 | 3 | \begin{otherlanguage}{english} 4 | \begin{abstract} 5 | % Set the page style to show the page number 6 | \thispagestyle{plain} 7 | \abstractEnglishPageNumber 8 | Your abstract goes here. 9 | 10 | % Keywords 11 | \begin{flushleft} 12 | 13 | \keywords{my keywords} 14 | 15 | \end{flushleft} 16 | 17 | \end{abstract} 18 | \end{otherlanguage} 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.acn 2 | *.acr 3 | *.alg 4 | *.aux 5 | *.bbl 6 | *.blg 7 | *.dvi 8 | *.fdb_latexmk 9 | *.glg 10 | *.glo 11 | *.gls 12 | *.idx 13 | *.ilg 14 | *.ind 15 | *.ist 16 | *.lof 17 | *.log 18 | *.lot 19 | *.maf 20 | *.mtc 21 | *.mtc0 22 | *.nav 23 | *.nlo 24 | *.out 25 | *.pdfsync 26 | *.ps 27 | *.snm 28 | *.synctex.gz 29 | *.toc 30 | *.vrb 31 | *.xdy 32 | *.tdo 33 | .DS_Store 34 | dissertation.pdf 35 | *.fls 36 | images/ist_logo-eps-converted-to.pdf 37 | node_modules 38 | -------------------------------------------------------------------------------- /clean.sh: -------------------------------------------------------------------------------- 1 | FILES="*.aux .bb *.bl *.lo *.lo *.nl *.ou *.to *.bc *.run.xml *.bbl *.blg *.fdb_latexmk *.fls *.log *.toc *.synctex.gz *.acn *.glo *.ist *.lof *.lot *.out *.acr *.alg *.glg *.gls *.glsdefs" 2 | rm -f $FILES 3 | cd abstract 4 | rm -f $FILES 5 | cd .. 6 | cd acknowledgments 7 | rm -f $FILES 8 | cd .. 9 | cd acronyms 10 | rm -f $FILES 11 | cd .. 12 | cd bibliography 13 | rm -f $FILES 14 | cd .. 15 | cd chapters 16 | rm -f $FILES 17 | cd .. 18 | cd glossary 19 | rm -f $FILES 20 | cd .. 21 | cd appendix 22 | rm -f $FILES 23 | cd .. 24 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | BASENAME=dissertation 2 | NAME=$(BASENAME).tex 3 | PDF=$(BASENAME).pdf 4 | LATEX_COMPILER=pdflatex 5 | LATEX_FLAGS=-shell-escape 6 | GLOSSARIES_COMPILER=makeglossaries 7 | BIB_COMPILER=bibtex 8 | 9 | all: build 10 | 11 | pdf: 12 | $(LATEX_COMPILER) $(LATEX_FLAGS) $(NAME) 13 | 14 | bibliography: pdf 15 | $(BIB_COMPILER) $(BASENAME) 16 | 17 | bibliography_pdf: bibliography 18 | $(LATEX_COMPILER) $(LATEX_FLAGS) $(NAME) 19 | $(LATEX_COMPILER) $(LATEX_FLAGS) $(NAME) 20 | 21 | glossaries: pdf 22 | $(GLOSSARIES_COMPILER) $(BASENAME) 23 | 24 | glossaries_pdf: glossaries 25 | $(LATEX_COMPILER) $(LATEX_FLAGS) $(NAME) 26 | 27 | build: pdf glossaries bibliography_pdf 28 | 29 | clean: 30 | sh clean.sh 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 Samuel Coelho 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | /*global module:false*/ 2 | module.exports = function(grunt) { 3 | 4 | // Project configuration. 5 | grunt.initConfig({ 6 | acronymsPath: 'acronyms/acronyms.tex', 7 | glossaryPath: 'glossary/glossary.tex', 8 | shell: { 9 | build: { 10 | command: 'make' 11 | }, 12 | clean: { 13 | command: 'make clean' 14 | }, 15 | glossaries: { 16 | command: 'make glossaries_pdf' 17 | }, 18 | bibliography: { 19 | command: 'make bibliography_pdf' 20 | }, 21 | pdf: { 22 | command: 'make pdf' 23 | } 24 | }, 25 | watch: { 26 | latex: { 27 | files: ['./**/*.tex', '!<%= acronymsPath %>', '!<%= glossaryPath %>'], 28 | tasks: ['shell:pdf'] 29 | }, 30 | acronyms: { 31 | files: ['<%= acronymsPath %>', '<%= glossaryPath %>'], 32 | tasks: ['shell:glossaries'] 33 | }, 34 | bibliography: { 35 | files: ['./**/*.bib'], 36 | tasks: ['shell:bibliography'] 37 | } 38 | } 39 | }); 40 | 41 | require('load-grunt-tasks')(grunt); 42 | 43 | // Default task. 44 | grunt.registerTask('build', ['shell:build']); 45 | grunt.registerTask('work', ['build', 'watch']); 46 | grunt.registerTask('clean', ['shell:clean']); 47 | grunt.registerTask('default', ['work']); 48 | 49 | }; 50 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "meic-dissertation-template", 3 | "description": "Master dissertation Latex template for [Instituto Superior Técnico](http://tecnico.ulisboa.pt/) (Portugal). If you are a student in IST and you want to write your dissertation using Latex, this can be a good starting point. This template tries to follow this school's specification that you can get here: * [Dissertation guidelines](http://da.tecnico.ulisboa.pt/files/sites/33/guia-preparacao-dissertacao-13_14_2.pdf)", 4 | "version": "1.0.0", 5 | "main": "Gruntfile.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/samfcmc/ist-dissertation-latex-template.git" 12 | }, 13 | "keywords": [ 14 | "latex", 15 | "template", 16 | "dissertation" 17 | ], 18 | "author": "Samuel Coelho & Marcus Gomes", 19 | "license": "MIT", 20 | "bugs": { 21 | "url": "https://github.com/samfcmc/ist-dissertation-latex-template/issues" 22 | }, 23 | "homepage": "https://github.com/samfcmc/ist-dissertation-latex-template#readme", 24 | "engines": { 25 | "node": ">= 0.10.0" 26 | }, 27 | "devDependencies": { 28 | "grunt": "~0.4.5", 29 | "grunt-contrib-jshint": "~0.10.0", 30 | "grunt-contrib-nodeunit": "~0.4.1", 31 | "grunt-contrib-watch": "~0.6.1", 32 | "grunt-shell": "^1.1.2", 33 | "load-grunt-tasks": "^3.2.0" 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /variables.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ./dissertation.tex 2 | 3 | % Dissertation basic information 4 | \newcommand {\Title} {My Title} 5 | \newcommand {\Subtitle} {My Subtitle} 6 | \newcommand {\StudentName} {Student name} 7 | \newcommand {\DegreeName} {Degree name} 8 | \newcommand {\Supervisors} {{\large Prof./Dr. Lorem Ipsum}} 9 | 10 | % Include or not include acknowledgments 11 | \def \includeAcknowledgments{1} 12 | 13 | % Include or not include glossary 14 | \def \includeGlossary{0} 15 | 16 | % Examination Committee 17 | \newcommand {\Advisor} {{\large Prof./Dr. Lorem Ipsum}} 18 | \newcommand {\CoAdvisor} {{\large Prof./Dr. Co Advisor}} 19 | 20 | % After the thesis defense 21 | \newcommand {\CommitteeMembers} { 22 | {\large Prof./Dr. Lorem Ipsum}\\ 23 | {\large Prof./Dr. Lorem Ipsum} 24 | } 25 | \newcommand {\Chairperson} {{\large Prof./Dr. Lorem Ipsum}} 26 | 27 | % Is final version (will include Committee Members information) 28 | \def \IsFinalVersion{1} 29 | 30 | % Date 31 | \newcommand {\Month} {October} 32 | \newcommand {\Year} {2015} 33 | 34 | % Acknowledgments page number 35 | \def \acknowledgmentsPage{1} 36 | 37 | % Abstract-en page numbering 38 | \def \abstractEnglishPage{3} 39 | 40 | % Abstract-pt page number 41 | \def \abstractPortuguesePage{5} 42 | 43 | % You had a co-advisor: 44 | \def \HasCoAdvisor{0} 45 | 46 | % Logo Spacing Variables 47 | \def \finalLogoSpacing{2.0cm} 48 | \def \draftLogoSpacing{2.0cm} 49 | 50 | % Advisors Spacing Variables 51 | \def \finalAdvisorsSpacing{1.0cm} 52 | \def \draftAdvisorsSpacing{10.0cm} 53 | 54 | % Date Spacing Variable 55 | \def \dateSpacing{5.0cm} 56 | 57 | % You can define your own variables here 58 | -------------------------------------------------------------------------------- /cover.tex: -------------------------------------------------------------------------------- 1 | %!TEX root = ./dissertation.tex 2 | 3 | % --------------------------------------------------------- 4 | % MASTER THESIS DISSERTATION COVER 5 | % --------------------------------------------------------- 6 | \begin{titlepage} 7 | % --------------------------------------------------------- 8 | % INSTITUTION LOGO 9 | % --------------------------------------------------------- 10 | \includegraphics[width=5cm]{images/ist_logo}~\\ 11 | % 12 | \if\IsFinalVersion 1 13 | \vspace*{\finalLogoSpacing} 14 | \else 15 | \vspace*{\draftLogoSpacing} 16 | \fi 17 | 18 | \begin{center} 19 | % --------------------------------------------------------- 20 | % MASTER THESIS DISSERTATION TITLE 21 | % --------------------------------------------------------- 22 | {\LARGE \textbf{\Title}}\\[1.0cm] 23 | % --------------------------------------------------------- 24 | % MASTER THESIS DISSERTATION SUBTITLE 25 | % --------------------------------------------------------- 26 | {\Large \Subtitle}\\[1.0cm] 27 | % --------------------------------------------------------- 28 | % AUTHOR NAME (FULL) 29 | % --------------------------------------------------------- 30 | {\Large \textbf{\StudentName}}\\[1.0cm] 31 | % --------------------------------------------------------- 32 | % DISSERTATION DEGREE 33 | % ----------------------------------------------------------------- 34 | {\large Thesis to obtain the Master of Science Degree in}\\[1.0cm] 35 | % ----------------------------------------------------------------- 36 | % COURSE NAME 37 | % ----------------------------------------------------------------- 38 | {\LARGE \textbf{\DegreeName}}\\[1.0cm] 39 | 40 | % ----------------------------------------------------------------- 41 | % ADVISORS NAME 42 | % --------------------------------------------------------- 43 | \begin{minipage}[t]{.4\textwidth} 44 | \center 45 | \begin{flushright} 46 | {\large Supervisors:~~} 47 | \end{flushright} 48 | \end{minipage}% 49 | \begin{minipage}[t]{.6\textwidth} 50 | \center 51 | \begin{flushleft} 52 | {\Supervisors} 53 | \end{flushleft} 54 | \end{minipage}\\ 55 | % 56 | \if\IsFinalVersion 1 57 | \vspace*{\finalAdvisorsSpacing} 58 | \else 59 | \vspace*{\draftAdvisorsSpacing} 60 | \fi 61 | % --------------------------------------------------------- 62 | % JURI NAMES: 63 | % - PRESIDENT 64 | % - ADVISOR 65 | % - VOGALS 66 | % --------------------------------------------------------- 67 | % 68 | \if\IsFinalVersion 1 69 | % 70 | \begin{minipage}[t]{1\textwidth} 71 | \center 72 | {\Large \textbf{Examination Committee}}\\[.25cm] 73 | {\large Chairperson: \Chairperson}\\ 74 | {\large Supervisor: \Advisor}\\ 75 | {\large Member of the Committee: \CommitteeMembers} 76 | \end{minipage}\\[1.0cm] 77 | % 78 | \fi 79 | % 80 | 81 | \if\IsFinalVersion 1 82 | \vspace*{\dateSpacing} 83 | \fi 84 | 85 | % --------------------------------------------------------- 86 | % DATE (MONTH AND YEAR) 87 | % --------------------------------------------------------- 88 | {\Large \textbf{\Month\:\Year}}\\ 89 | \end{center} 90 | \end{titlepage} 91 | -------------------------------------------------------------------------------- /dissertation.tex: -------------------------------------------------------------------------------- 1 | % ------------------------------------------ 2 | % MASTER THESIS DISSERTATION 3 | % ------------------------------------------ 4 | % Author: 5 | % 6 | % Advisors: 7 | % 8 | % ------------------------------------------ 9 | \documentclass[10pt,twoside,openright,a4paper]{report} 10 | \usepackage[utf8]{inputenc} 11 | 12 | % Set document margins to 1in in all sides 13 | \usepackage[margin=2.5cm]{geometry} 14 | % Line spacing package 15 | \usepackage{graphicx, helvet, hyperref, setspace} 16 | \usepackage[portuguese,english]{babel} 17 | \usepackage[nomain, acronym, toc]{glossaries} 18 | \input{extra_stuff.tex} 19 | 20 | % Built the glossary when the main file is built. 21 | \makeglossaries 22 | % Set main font to Arial 23 | \renewcommand{\familydefault}{\sfdefault} 24 | % Define keywords macro 25 | \providecommand{\keywords}[1]{\textbf{Keywords:} #1} 26 | % Define "palavras-chave" macro 27 | \providecommand{\palavrasChave}[1]{\textbf{Palavras-Chave:} #1} 28 | % Define the NewPage macro 29 | \newcommand*\NewPage{\newpage\null\thispagestyle{empty}\cleardoublepage} 30 | % Abstract-en page numbering 31 | \newcommand {\abstractEnglishPageNumber} {\thispagestyle{plain}\setcounter{page}{\abstractEnglishPage}} 32 | % Abstract-pt page numbering 33 | \newcommand {\abstractPortuguesePageNumber} {\thispagestyle{plain}\setcounter{page}{\abstractPortuguesePage}} 34 | % Section numbering depth 35 | \setcounter{secnumdepth}{3} 36 | % Table of contents depth 37 | \setcounter{tocdepth}{3} 38 | % Set line spacing to 1.5cm 39 | \onehalfspacing 40 | % Page numbering 41 | \pagestyle{plain} 42 | 43 | % Glossary-File 44 | \input{glossary/glossary.tex} 45 | % Acronym-File 46 | \input{acronyms/acronyms.tex} 47 | 48 | % ------------------------------------------ 49 | % MASTER THESIS DISSERTATION 50 | % ------------------------------------------ 51 | 52 | \begin{document} 53 | \pagenumbering{gobble}% Remove page numbers (and reset to 1) 54 | \clearpage 55 | \thispagestyle{empty} 56 | \input{variables.tex} 57 | 58 | \include{cover} 59 | \NewPage 60 | 61 | \pagenumbering{roman} 62 | 63 | \if\includeAcknowledgments 1 64 | \input{acknowledgments/acknowledgments.tex} 65 | \NewPage 66 | \fi 67 | 68 | \include{abstract/abstract-en} 69 | \NewPage 70 | \include{abstract/abstract-pt} 71 | \NewPage 72 | 73 | % Table of contents 74 | \tableofcontents 75 | % A new page is necessary only if table of contents has an odd number of pages 76 | \NewPage 77 | 78 | % List of tables 79 | \addcontentsline{toc}{chapter}{\listtablename} 80 | \listoftables 81 | % A new page is necessary only if list of tables has an odd number of pages 82 | \NewPage 83 | 84 | % List of figures 85 | \addcontentsline{toc}{chapter}{\listfigurename} 86 | \listoffigures 87 | % A new page is necessary only if list of figures has an odd number of pages 88 | \NewPage 89 | 90 | % List of acronyms 91 | \printglossary[type=\acronymtype] 92 | 93 | \pagenumbering{arabic}% Arabic page numbers (and reset to 1) 94 | 95 | \input{chapters/main.tex} 96 | 97 | \bibliographystyle{ieeetr} 98 | \addcontentsline{toc}{chapter}{Bibliography} 99 | \bibliography{bibliography/dissertation} 100 | 101 | % Appendix 102 | \appendix 103 | \input{appendix/main.tex} 104 | 105 | % Glossary and Acronym List 106 | \if\includeGlossary 1 107 | \printglossary 108 | \fi 109 | 110 | % Back Cover 111 | \pagenumbering{gobble} 112 | \NewPage 113 | 114 | \end{document} 115 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ist-dissertation-latex-template 2 | Master dissertation Latex template for [Instituto Superior Técnico](http://tecnico.ulisboa.pt/) (Portugal). 3 | If you are a student in IST and you want to write your dissertation using Latex, this can be a good starting point. 4 | This template tries to follow this school's specification that you can get here: 5 | * [Dissertation guidelines](http://da.tecnico.ulisboa.pt/files/sites/33/guia-preparacao-dissertacao-13_14_2.pdf) 6 | 7 | The instructions to submit your dissertation at IST are available in the following link: 8 | * [Delivery instructions](https://fenix.tecnico.ulisboa.pt/downloadFile/845043405434871/MEIC-como%20submeter%20a%20dissertacao-v2.pptx.pdf) 9 | Sorry but it is only available in portuguese :( 10 | 11 | I cannot guarantee you that this template is 100% right. 12 | I recommend that you talk to your advisors to check it first. 13 | I am not responsible for something going wrong, if you choose to use this template. 14 | 15 | Focus on your thesis and not on the template. 16 | 17 | ## Requirements: 18 | * Latex: This will depend on your Operating System. You have to check how to install all Latex packages for your OS. 19 | **Note:** Make sure that the version of Latex that you are installing is the latest one. 20 | * Any text editor (I use [Atom](https://atom.io/)) 21 | * Latex plugins for your text editor (this is optional, but it will make your life easier). 22 | I use the following ones for Atom: 23 | * [language-latex](https://atom.io/packages/language-latex) 24 | * [latex](https://atom.io/packages/latex) 25 | * [latexer](https://atom.io/packages/latexer) 26 | 27 | ## Usage 28 | To use this template, you can simply fork this repo and start working on it. 29 | 30 | If you don't want to fork, you can download a zip of the repo. 31 | 32 | Once you have a copy of this repo, you can start creating sections, add a bibliography, etc. 33 | 34 | ### Variables 35 | Some values, for instance, the dissertation's title, are defined in a file called ```variables.tex```. 36 | For instance, if you want to change the title, open this file and look for title's definition: 37 | ```latex 38 | ... 39 | \newcommand {\Title} {My Title} 40 | ``` 41 | Replace "My Title" by your actual title. 42 | 43 | You can also add your own variables. 44 | To define a new variable all you need to do is just to add a new line like this: 45 | ```latex 46 | \newcommand {\VariableName} {Value} 47 | ``` 48 | Replace "VariableName" by its name and "Value" by the actual value. 49 | To use this variable in your document: 50 | ```latex 51 | \VariableName 52 | ``` 53 | 54 | If you know how to define macros in Latex you can define as many as you want and anyway you want in this file. 55 | 56 | ### Cover 57 | The cover file (```cover.tex```) has information such as title, supervisors, examination committee, etc. 58 | This file has the cover's layout. 59 | The values of title, subtitle, etc are defined in a file called ```variables.tex```. 60 | Edit that file according to what makes sense in your dissertation. 61 | 62 | ### Co-advisor name 63 | Some thesis have two advisors instead of just one. If this is your case, open the `variables.tex` file and look for a variable named `HasCoAdvisor` and change its value from `0` to `1` like this: 64 | ```latex 65 | % You had a co-advisor: 66 | % if you only had one advisor change \HasCoAdvisor{1} to \HasCoAdvisor{0} 67 | \def \HasCoAdvisor{1} 68 | ``` 69 | 70 | Then, edit his/her name in the same file `variables.tex`: 71 | ```latex 72 | \newcommand {\CoAdvisor} {{\large Prof./Dr. Co Advisor}} 73 | ``` 74 | 75 | ### Thesis Final Version 76 | There are committee members and a chairperson in the defense of your thesis. 77 | However, you don't know who they are before the presentation. 78 | The version that you deliver after the presentation is the final one and has this information that was missing before. 79 | To have this information in your thesis cover, 80 | open `variables.tex` file and edit the names of the `Committee Members` and `ChairPerson`: 81 | ```latex 82 | % After the thesis defense 83 | \newcommand {\CommitteeMembers} { 84 | {\large Prof./Dr. Lorem Ipsum}\\ 85 | {\large Prof./Dr. Lorem Ipsum} 86 | } 87 | \newcommand {\Chairperson} {{\large Prof./Dr. Lorem Ipsum}} 88 | ``` 89 | 90 | Then, in the same file, `variables.tex`change the value of `IsFinalVersion` from `0` to `1`: 91 | ```latex 92 | % Is final version (will include Committee Members information) 93 | \def \IsFinalVersion{1} 94 | ``` 95 | 96 | ### Abstract 97 | According to the specification you have to write the abstract in english and portuguese. 98 | The english is located at ```abstract/abstract-en.tex``` and the portuguese ```abstract/abstract-pt.tex```. 99 | Just edit those files. 100 | 101 | ### Acknowledgments 102 | Along the way, some people helped you. 103 | If you want to show them some love, this is the right place for it. 104 | Open the file ```acknowledgments/acknowledgments.tex```and say thanks to everyone. 105 | 106 | Anyway, this is optional. If you don't want to have this on your dissertation, just open ```variables.tex``` file and put 0 as the value of the ```includeAcknowledgments``` definition: 107 | ```latex 108 | ... 109 | % Include or not include acknowledgments 110 | \def \includeAcknowledgments{0} 111 | ``` 112 | 113 | Also, it would be nice if you buy, at least, a beer to whoever supported you :) 114 | (Including the one that provided you this awesome template) 115 | 116 | ### Chapters 117 | Chapters are located at ```chapters```folder. 118 | To create a new chapter, you first need to create a file in this folder. 119 | The easiest way to do this, is to create a copy of ```chapters/new_chapter_template.tex``` file: 120 | ``` 121 | $ cp chapters/new_chapter_template.tex chapters/mychapter.tex 122 | ``` 123 | 124 | In the new file, change the section's title and label. 125 | 126 | Now you just need to include this new chapter in the main file in ```chapters``` folder. 127 | Open ```chapters/main.tex``` file and add the include for the new chapter 128 | 129 | ```latex 130 | % Chapters 131 | ... 132 | \include{chapters/mychapter} 133 | ... 134 | ``` 135 | 136 | Now get some inspiration and write its content. 137 | 138 | ### Images 139 | Image files go to ```images``` directory. 140 | Place your files here and include them in wherever makes sense. 141 | 142 | ### Bibliography 143 | The bibliography is in a bib file located at ```bibliography/dissertation.bib```. 144 | Put your bibliography there and cite it anywhere. 145 | 146 | ### Appendix 147 | Appendix chapters are located at ```appendix```folder. 148 | To create an appendix chapter, create a file in this folder. The easiest way is to copy the ```new_appendix_chapter_template.tex``` file. 149 | ``` 150 | $ cp appendix/new_appendix_chapter_template.tex appendix/mynewchapter.tex 151 | ``` 152 | 153 | Edit this file to set the chapter's title and create its content. 154 | 155 | Now you have to include this new file in the main file (```appendix/main.tex```). Open it and include the new chapter's file below the appendix beginning 156 | ```latex 157 | ... 158 | % Appendix chapters entry point 159 | % Include the chapters below 160 | ... 161 | \include{appendix/mynewchapter} 162 | ... 163 | ``` 164 | ### Acronyms 165 | Acronyms definitions are located in the ```acronyms``` directory. 166 | To add a new acronym in your document you must define the new entry in the ```acronyms.tex``` file: 167 | ```latex 168 | \newacronym{