Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/severinlandolt/latex-thesis-template

A LaTeX template for humans.
https://github.com/severinlandolt/latex-thesis-template

latex latex-template thesis

Last synced: about 2 months ago
JSON representation

A LaTeX template for humans.

Awesome Lists containing this project

README

        

# A LaTeX Template

A LaTeX template for humans writing their thesis.

There are two ways of getting started:
1. Online Latex editor: [overleaf.com](https://www.overleaf.com) For this download the thesis template, create zip file and import it to overleaf.

2. On your local machine. Please, follow a guide below:

## Getting Started

These instructions will get you a copy of the project up and running on your local machine to start writing your thesis.

### Prerequisites
The first part of a working LaTeX environment is a TeX distribution. This depends on your operating system.

**macOS:**
[http://www.tug.org/mactex/](http://www.tug.org/mactex/)

```bash
brew install --cask mactex
```

**windows:**
[https://miktex.org](https://miktex.org)

### Installing an editor

There are many capable editors designed for LaTeX.

**macOS**\
texpad: https://www.texpad.com/osx (worth every penny!)

![texpad](https://raw.githubusercontent.com/severinlandolt/latex-thesis-template/master/images/Screenshot_texpad.png)

**windows**\
TeXniCe: http://www.texniccenter.org

You can also use every other text editor you prefer (Atom, Notepad++, etc.). Be aware that you might lose enhanced syntax highlighting, debugging options and pdf preview without additional plugins installed.

### Get template

[Download](https://github.com/severinlandolt/latex-thesis-template/archive/master.zip) or Clone this Git Repository

```bash
git clone https://github.com/severinlandolt/latex-thesis-template.git
```

In Atom, you first have to set a "root" file. A LaTeX root file is essential for Atom-LaTeX. Building, preview, autocompletion, and more features rely on its proper configuration. You can manually select the root file by clicking the `home` icon at the bottom of the editor. Select the *your_thesis.tex* file. This is the correct root file with the sequence `\begin{document}` in it.

If you have any problems with "rendering" your PDF, just delete the .aux file.

## Citation

We are using the _natbib_ package to cite in the prose text and also to generate the bibliography. Here we will explain the workflow of citing. The template is set up to APA-Style referencing.

A great way to cleanup or beauitfy you bibfile is [FlamingTempura's](https://github.com/FlamingTempura) bibtex-tidy
→ https://flamingtempura.github.io/bibtex-tidy/

**Prepare your bibliographic database**\
Copy/Paste the source you want to cite in a BibTeX formatting (see screenshot below) into your references.bib file. Bear in mind that LaTeX by default only puts those sources into the final references section which are actually cited in the document.
![references01](https://raw.githubusercontent.com/severinlandolt/latex-thesis-template/master/images/references_01.png)

**Ways to cite**\
There are plenty ways to cite. The following information is mostly derived from [natbib's documentation](https://ctan.org/pkg/natbib?lang=de). Basically there are two basic citation commands, \citet and \citep for textual and parenthetical citations. There exist also starred versions \citet* and \citep* that print the full author list, and not just the abbreviated one.

![finalref](https://raw.githubusercontent.com/severinlandolt/latex-thesis-template/master/images/finalref3.png)

**Bibliography Management**\
I personally recommend using [Zotero](https://www.zotero.org/) for bibliography management. It is a is a free, easy-to-use tool to help you
collect, organise, cite, and share research. Zotero is available for Mac, Windows, and Linux.

## Miscellaneous

If you want to use an other paragraph styling, you can do this within the _settings.tex_ file. You can tune both the indentation (\parindent, default 0px) and the space between the paragraphs (\parskip, default 1em)

![paragraph](https://raw.githubusercontent.com/severinlandolt/latex-thesis-template/master/images/paragraph.png)

To create entries for a glossary or a list of abbreviations use the `\newglossaryentry{label}{name={key}, description={value}}` command in the little-_/01_head/abbreviations.tex_ file. In text use: `\gls{label}`.

## Further information

* [A great LaTeX Cheatsheet](https://wch.github.io/latexsheet/)

* [Tobi Oetiker's *The not so Short Introduction to LaTeX2e*](https://tobi.oetiker.ch/lshort/lshort.pdf)

* [Latex Report Writing Tutorials by Alexander Baran-Harper](https://www.youtube.com/watch?v=FXujG7c9p8g&list=PLNnwglGGYoTtW7o4PHFOSWGevcdFa3v3D)

* [‘Deadly sins’— The most severe mistakes in using LaTeX2e](https://ctan.math.utah.edu/ctan/tex-archive/info/l2tabu/english/l2tabuen.pdf)

## License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/severinlandolt/latex-thesis-template/blob/master/LICENSE) file for details