Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/micheleberetta98/unibg-thesis-template

A LaTeX starter project with UniBG thesis guidelines and first page
https://github.com/micheleberetta98/unibg-thesis-template

bachelor-thesis latex master-thesis texlive thesis thesis-latex-template thesis-template unibg

Last synced: 22 days ago
JSON representation

A LaTeX starter project with UniBG thesis guidelines and first page

Host: GitHub
URL: https://github.com/micheleberetta98/unibg-thesis-template
Owner: micheleberetta98
License: other
Created: 2023-03-27T13:18:59.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-05-21T19:31:19.000Z (8 months ago)
Last Synced: 2024-05-21T20:41:28.660Z (8 months ago)
Topics: bachelor-thesis, latex, master-thesis, texlive, thesis, thesis-latex-template, thesis-template, unibg
Language: TeX
Homepage:
Size: 517 KB
Stars: 10
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff

Awesome Lists containing this project

latex-templates - micheleberetta98/<br>unibg-thesis-template - thesis-template?style=flat-square)<br/>![3](https://img.shields.io/github/forks/micheleberetta98/unibg-thesis-template?style=flat-square)<br/>![2024-11-12](https://img.shields.io/github/last-commit/micheleberetta98/unibg-thesis-template?style=flat-square) | A LaTeX starter project with UniBG thesis guidelines and first page | (Popular & New LaTeX Templates / Thesis/Dissertation)

README

        # UniBG LaTeX Thesis Template

A simple (unofficial) LaTeX template following the official

[UniBG formatting rules](https://www.unibg.it/studiare/frequentare/laurearsi/frontespizi).

*Also, checkout the Typst branch!*

## :warning: Important note

This template is completely free of use.

However, as highlighted in the MIT license, you have to give credit in your thesis

acknowledgements:

- To the *UniBG Seclab* if you're doing your thesis with them

- Or to me, *Michele Beretta*, in every other case

Remember to also include a link to this repository for reference.

An example sentence you can use is the following:

> I would like to thank *[INSERT NAME]* for providing the LaTeX template [1] used

> during the writing of this thesis.

>

> [1] *Link to this repo*

You can use the "Cite this repository" button on the right.

## Requirements

If you want to use this offline you need:

- *LaTeX* (required): this project is tested with TeX Live 2023/Arch Linux, the reference

  packages are [`texlive`](https://archlinux.org/groups/x86_64/texlive/) and

  [`biber`](https://archlinux.org/packages/community/any/biber/)

- [*latexmk*](https://mg.readthedocs.io/latexmk.html): not required, but recommended

`latexmk` could be installed alongside TeX Live if you go for the full version.

Other LaTeX flavours should work, but it's not guaranteed.

## Step-by-step setup

1. Make sure the requirements are installed

2. Setup your repository with the LaTeX code

   - Either use the "Use this template" button in GitHub

   - Or fork (or make your own copy) of the repo

3. Start writing in LaTeX, the structure is already setup for you

4. Use `make` to create the PDF

You can also copy the files to Overleaf or any other LaTeX editing software you

like. Note however that there could be some problems with some editors (see FAQs).

## Usage and options

Main usage is done through `\documentclass[language,degreetype]{unibg}`. You can set:

- *Lanuage*, either `italian` or `english`

- *Degree type*, either `master` or `bachelor`

### Quick example

```latex

\documentclass[english,master]{unibg}

\title{A Seclab Thesis}

\subtitle{A Seclab Subtitle}

\advisor{Prof.~John Smith}

\department{Department of Engineering}

\course{Computer Science}

\class{LM-32}

\author{John Doe}

\studentid{177013}

\academicyear{2021/2022}

\begin{document}

  \maketitle

\end{document}

```

See `main.tex` for the full setup.

### Title page options

| Option          | Required | Description                                                                              |

| --------------- | -------- | ---------------------------------------------------------------------------------------- |

| `\title`        | ✔️        | The title of the thesis                                                                  |

| `\subtitle`     |          | The subtitle of the thesis (or a "less important" part of the title)                     |

| `\advisor`      | ✔️        | Your advisor (professor who followed you)                                                |

| `\coadvisor`    |          | Your coadvisor (if you don't know about this, then you don't need it)                    |

| `\department`   | ✔️        | The [department](https://www.unibg.it/ateneo/organizzazione/dipartimenti) of your course |

| `\course`       | ✔️        | The official name of your course                                                         |

| `\class`        | ✔️        | The degree's class (check your course webpage)                                           |

| `\author`       | ✔️        | You (I hope)                                                                             |

| `\studentid`    | ✔️        | Your student number                                                                      |

| `\academicyear` | ✔️        | The academic year of your degree                                                         |

### Commands

| Command      | Description                | Options                                                                       |

| ------------ | -------------------------- | ----------------------------------------------------------------------------- |

| `\maketitle` | Creates the first page     | -                                                                             |

| `\emptypage` | Surprisingly, an empy page | -                                                                             |

| `\toc[opts]` | The table of contents      | Comma-separated list of zero or more among `figures`, `tables` and `listings` |

## FAQs

- *How to create a PDF?*

  Run `make` inside this folder.

- *How to have a live preview?*

  Run `make watch` inside this folder.

  Note that you have to configure `latexmk` in order to [support live updates](https://mg.readthedocs.io/latexmk.html#configuration-files).

  Also, this is known to not work with all viewers, especially not *Adobe Reader*.

- *I don't have make*

  Files can be compiled however you prefer (even when copied in Overleaf). Note

  that there can be some tricky cases, such as with TeXstudio (see further FAQ).

- *I use Windows*

  Don't. If you can't fire up a VM or dual boot a distro, use Overleaf.

  It'll save you some headaches.

- *I use macOS*

  As long as you have everything installed, should work out of the box.

  You should even have `make` already installed.

- *The bibliography doesn't show up in TeXstudio*

  If the bibliography doesn't show up, try changing `backend=biber` into

  `backend=bibtex` in `unibg.cls` (should be around line 26) and then look at

  [this StackExchange answer](https://tex.stackexchange.com/questions/135102/biblatex-doesnt-show-bibliography-when-compiling).

- *How to change language?*

  Write your desired language in the options of `\documentclass{unibg}`.

- *How does the table of contents work?*

  Just use `\toc`. Note that the table of contents kinda breaks the flow of opening chapters on a right page.

  So remember to check and add a `\emptypage` if necessary.

- *How can I show other tables of contents, like figures?*

  Use the optional argument to `\toc`. If you want to show all supported table of contents,

  do `\toc[figures,tables,listings]`. You can also mix and match how you prefer.

  The chapter/section/subsection table of contents will always be printed though.