What this is
This is a template designed to ease the workflow when writing documents for the Hochschule Hannover. It is intended to be used in all sophisticated
works, from lab-reports to master’s thesis's.
The project provides custom document-classes caring the HsH- prefix as well as support files. These classes extend the well known KOMA-Script
classes and customize them with specific configurations, presets and provide commonly needed features.
Provided classes are:
HsH-article
HsH-report
HsH-book (planed)
HsH-standalone
Quick start guide:
Recommended software
As a Tex-Distribution, MiKTeX is recommended, TexLive should also work, but I don't use it much.
To edit the .tex files, you could use any text editor, but I personally like Visual Studio Code the most, which
can also be used for pretty much all other programming languages. Use the Latex Workshop extension,
and you can steal my config file from here.
If you prefer a Tex-only editor, I used Texmaker in the past, and it's also very good.
If you want to use citations in your work, you should get familiar with the biblatex package and include it in your project. The classes set it up
to use biber as the backend, which is more modern and has more features than the usual bibtex, but you will need to set you editor up to also use
this.
I have now Idea how to start, show me!
To get you started, there is a working example Project on the example branch that has loads of tips. Check it out
Online or locally using git checkout example
Quick and dirty
To get started, create a new folder for your project somewhere on your PC and create your .tex file. Copy the class file (.cls) you want to use
and the HsH-logo.pdf from the src folder to your project folder. You can optionally copy the config.tex, but you can also configure everything in
your preamble.
Using a proper subfolder structure
The projects also provides a recommendation for a subfolder structure, to keep things organized. You can
download the .zip-Archive
and unpack it or clone the repository via git clone https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh.git.
This has the downside of storing class files and other needed files in the ./src folder, which means it needs to be added to the path searched when
running your latex command (see below).
The provided Makefile demonstrates how to run a successful build, you might want to check it out.
Documentation:
The different classes
This project provides a set of additional classes designed for use in the Hochschule Hannover, Germany. They extend the well-known KOMA-Script classes by adding styling and providing some additional commands. The provided classes are:
HsH-article
Based on the scrartcl this class is designed for quick and compact documents. It does not have chapters and therefore never breaks to a new page on
its own. This class is useful for writing lab-protocols and alike.