Code Monkey home page Code Monkey logo

ua-thesis-template's Introduction

University of Aveiro Thesis Template

A thesis LaTeX template that complies with the University of Aveiro's guidelines and provides a simple CLI workflow around make that was developed and tested for cross-compatibility on Linux (Slackware, ArchLinux, Debian, Ubuntu) and macOS.

This template was developed by professors and students. We will try to keep up to date with thesis requirements but some discrepancies may exist. Feel free to open issues and pull requests with new options, packages and fixes.

Usage

Optional: In debian and ubuntu you can install all dependencies automatically:

make setup

Build a development version of the document:

make [build]

Continuously build the development version of the document:

make preview

This option is great when paired with a document viewer (such as Okular) which automatically reloads the document on file change. This means you can keep writing and on save the updated document is compiled and displayed!

Build versions of the document for publishing:

make print
make ebook

Run linters (for now only proselint) against a TeX file (e.g. chapter 1):

make lint [texfile=chapter1.tex]

If you do not specify the texfile to lint, then all TeX files in chapters/ will be linted.

Clean the build directory:

make clean[all]

clean will leave the output products (the PDFs) in place, while cleanall will remove these too. If your document is not compiling for some reason and you think you've already solved the problem in the LaTeX sources, maybe try a cleanall before insisting. Sometimes the underlying build programs (namely latexmk) get stuck in inconsistent temporary files.

How to use the template

This is all great, but how can this repository be used as a starting point for writing your own thesis?

In our opinion you have mostly three options:

  • Download/clone the repository and copy all files to a directory of your desire, for instance to inside some special folder within you own thesis repository.
    Notice that this will not allow you to easily keep up with this template should it change.
  • Fork the repository to your own and work there. If you want to include it within your own thesis repository, you can use git submodules for this.
  • Use git subtree to pull this repository to your main thesis repository and work directly there. Changes in your copy will be versioned by your main thesis repo, while you will still be able to pull new updates from here should they appear.

The last of these options mas be the most adquate, as it seems to be the most flexible and easy-to-use alternative. Here follow the main commands you will need should you choose to go along with this too.

$ mkdir mythesis
$ git init .
$ git commit --allow-empty -n -m "Initial commit."
$ git subtree add  --prefix document https://github.com/detiuaveiro/ua-thesis-template.git master --squash;
$ git subtree pull --prefix document https://github.com/detiuaveiro/ua-thesis-template.git master --squash;
  • The first line will init a new repository for your thesis
  • It will create an initial commit
  • It will pull this repository for the first time to document
  • The second is used for subsequent pulls.

The result should be a git repository for your thesis work. In the $DESTDIR (e.g. document) you will have the document to edit. If you wish you can add a reference to another git repository to track your own changes.

Use as a template in github

Please check the github instructions to create your own repository using this as a template.

Use it in Overleaf

It is possible to use this template in overleaf.

To enable it:

  • in matter.tex change \def\useoverleaf{0}to 1
  • add fc-portuges.def to the project the file be can found in here
  • change the main document to matter.tex

Dependencies

  • A TeX distribution: TeX Live or MacTeX
  • gs (for make print, make ebook and simplify-colors.sh)
  • pandoc (for make lint)
  • imagemagick and poppler (for simplify-colors.sh)
  • pygments (for minted)

As for pygments and proselint, those can by installed with pip by issuing pip install -r requirements.txt at the root of this repository.

On Ubuntu relatives the following dependencies, installable with apt may also be required

  • biber
  • texlive-bibtex-extra
  • texlive-latex-extra
  • texlive-science

These endorsed dependencies which may or may not come with the TeX Live package distributed with your Linux distribution.

Usually TeX Live is split into a minimal package and a texlive-extra which is filled with the remainder of TeX Live, be it fonts, styles, language support, and so on. So, if a LaTeX dependency is missing on your installation, do verify that you are not missing one of these packages.

Authors

Tom谩s Oliveira e Silva created the original template which was later picked up by Jo茫o Paulo Barraca who improved and maintained it for years.

This is a fork by F谩bio Maia and Ricardo Jesus who wanted to further improve the template and setup a clean environment and workflow for writing their MSc thesis.

ua-thesis-template's People

Contributors

aanm avatar avzuquete avatar caiosantanaj avatar danielvcorreia avatar dvcorreia avatar eduardosantoshf avatar fmanco avatar joaobranquinho avatar jpbarraca avatar jpfonseca avatar ludeed avatar mluis avatar oescal avatar pbmartins avatar pkill37 avatar rj-jesus avatar ruilvo avatar vitorcunha avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

ua-thesis-template's Issues

make setup doesn't work for non apt distros && small makefile contribution

setup:
@sudo apt install texlive-latex-base texlive-lang-portuguese texlive-lang-english biber texlive-latex-extra texlive-science python3-pygments python3-proselint pandoc imagemagick latexmk ghostscript

This could be fixed by adding a argument to the makefile with lsb_release -ds.

In arch for instance, I must install the dependencies one by one and it's annoying.


Non related to the first topic but sometimes the compilation fails and I loose citations because of something to do with the auxiliary files, I'm not sure what it is but clearing them solves it.

I also added another command to the Makefile, might be an interesting addition.

clean_aux:
	ls | grep -e 'matter.*' | grep -v matter.tex | xargs rm

EDIT : If this is to be implemented I think it should first change to the template's root directory.

It's a small thing so I figured it wasn't deserving of a dedicated issue.

License

Decide on license and be sure to properly credit the previous efforts by the professors

Print page number in correct place + subsubsection formatting

Hi guys,

I'm quite new to LaTeX, so it is quite possible these are dumb questions.

Number
I noticed that the page numbers appear in the bottom right side of the page, while for even pages the number appears in the middle. Is there a way to solve this?

Subsubsection
Is there a way to change the formatting of the subsubsection? They appear in italics. I would like to have them in bold and a bit larger.

Btw, I'm using this template in Overleaf in case this are problems specific to Overleaf.

Dissertation vs Thesis

Clear up whether we're doing a dissertation or a thesis and further document the following option in cover.tex to clear things up for others:

%\DocumentTypeThesis
\DocumentTypeDissertation

How to change the language of "code block"?

I changed the standard language from portuguese to english in matter.tex and as expected the figure names changed from "Figura" to "Figure", and the chapter names from "Capitulo" to "Chapter". But when I create a code block like this:

\begin{listing}
\begin{verbatim}
(code ...)
\end{verbatim}
\caption{Code description}
\label{code_lbl}
\end{listing}

The label still is displayed in portuguese. Instead of "Code 1: Code description" it is still "C贸digo 1: Code description". I tried to see if I could change it in custom_theme.tex and in uaThesisTemplate.sty, but haven't found anything.

How can I make that label change from portuguese to english?

\Quote on Chapters

Maybe big noob on latex but the macro \Quote appears to not be usable in the Chapters

Error building with make

It seems that make build is presenting an error.

./matter.tex:81: LaTeX Error: Missing \begin{document}.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...                                              
                                                  
l.81 \usepackage{b
                  ookmark} % New Bookmarks
? 

It might be related to #20. I've tried to build #21 and it was ok.
@Jpfonseca were you able to build it?

`make print` incorrect

make print causes the pages in thesis-print-final.pdf to be out of order. This may be due to some glob happening (wrongly) in simplify-colors.sh.

Removal of lines in both covers

Greetings!

I have submitted my Master Thesis and, according to my department's secretary, both the outside and inside cover should no longer have a line underneath "Universidade de Aveiro". From what I've done, simply commenting or completely removing \hrule in the \long\def\HEADER#1#2 definition suffices.

The output of removing this would be of the sorts:
Captura de ecra虄 2021-11-05, a虁s 10 34 11

Best regards,
Eduardo Santiago.

Get bibliography for each chapter

Hi all,

Is there a way to obtain the bibliography for each chapter, and print it at the end of the chapter instead of printing it at the end of the document?

I tried adding \printbibliography at the end of each chapter and this creates a new chapter with the bibliography instead of writing it as a section in the chapter

How do i remove "documento provis贸rio"

hey, so my professor wants me to use the UA latex template, the problem is that i'm a noob on latex and cant figure out how to remove the "documento provis贸rio".

been studying latex for the past week, working great so far, but i just cant find where to delete that.

Thesis rejected because of the Quote page

I had my thesis rejected because of the Quote page.
In this template, the quote is put as the second cover page. This includes all the title information, as it just a variation of the cover, with a cover instead of a figure.
This got my document rejected.
Turns out the quote is supposed to be on an empty page, last thing in the cover pages (after the abstracts).

Supevisor Department information in the cover pages (adding a comment)

Regarding the cover.tex file,I have a suggestion. I couldn't change the department information of my supervisor, but then I solved the problem after 10 or 15 minutes.

I noticed that the supervisor's department was by by default "Departamento de Eletr贸nica e Comunica莽玫es", as I quote here, from the page 4 of the cover.pdf:
Disserta莽茫o apresentada 脿 Universidade de Aveiro para cumprimento dos requisi-
tos necess谩rios 脿 obten莽茫o do grau de Mestre em Engenharia de Computadores e
Telem谩tica, realizada sob a orienta莽茫o cient铆fica do Doutor Tiago C. A. Oliveira,
Professor auxiliar do Departamento de Eletr贸nica, Telecomunica莽玫es e Inform谩-
tica da Universidade de Aveiro, e do (...)

And when I changed the supervisor line of cover.tex to this:
\Supervisor{Tiago C. A. Oliveira}{auxiliar}{do Departamento de F铆sica}{da Universidade de Aveiro}
I got an error when I compiled the cover file. Then I solved the problem because I realised that I had to change the department information to fis on the line \usepackage[engineering,fis]{uaThesisTemplate}

So, my suggestion is for you to put a comment on that line on the fact that we have to select the department first (the emphasis of the department information is at the moment less relevant, at first sight, due to the fact that the department is, by the new rule of Univ. of Aveiro, not printed in the first page of the cover.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    馃枛 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 馃搳馃搱馃帀

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google 鉂わ笍 Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.