Giter Club home page Giter Club logo

unibg-thesis-template's Introduction

UniBG LaTeX Thesis Template

A simple (unofficial) LaTeX template following the official UniBG formatting rules.

⚠️ 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 and biber
  • latexmk: 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

\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 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. 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.

  • 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.

unibg-thesis-template's People

Contributors

micheleberetta98 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

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.