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 masters 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
...
...
@@ -16,8 +15,8 @@ classes and customize them them with specific configurations, presets and provid
**Date:** 21.04.2021
Check out the [**Example-Branche**](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/tree/example)
# License
# License
This project is distributed under the LaTeX project public license (LPPL), version 1.3c.
...
...
@@ -29,30 +28,37 @@ This project is distributed under the LaTeX project public license (LPPL), versi
The `Makefile` is only tested with mingw32-make.
# Quick start guide:
# Quick start guide:
## Quick and dirty
## quick and dirty
To get started, create a new folder for your project somewhere on your PC and create your `.tex` file. Copy the classfile (`.cls`) you want to use and
the `HsH-logo.pdf` from the src folder to your projectfolder. You can optionally copy the `config.tex` and the `personal.tex`, but you can also
configure everything in your preamble.
the `HsH-logo.pdf` from the src folder to your projectfolder. 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. Cloning the complete projekt into your projectfolder
will allow you to use it easily.
This has the downside of storing classfiles and other needed files in the *.\src* folder, which means it needs to be added to the path searched when
running your latex command. [How to do that is explained in the wiki](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/wikis/Adding%20the%20.%5Csrc%20folder%20to%20the%20path).
running your latex command. [How to do that is explained in the wiki](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/wikis/Adding-src-folder-to-the-path).
The provided Makefile demonstrates how to run a successful build, you might want to check it out.
# common addidtion and expantions (Snippets)
## recomendet Software
As a Tex-Distribution, I recomend [MikTex is recommended](https://miktex.org/). This is only avalible on windows though.
To edit the `.tex` files, you could use any texteditor, but I personally like [Visual Studio Code](https://code.visualstudio.com/) the moste, which
can also be used for pretty much all other programing languages. Use the [Latex Workshop extention](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)
and you can steal my config file from [here](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/snippets/111).
If you preffer a Tex-only editor, I used [Texmaker](https://www.xm1math.net/texmaker/) in the past and it's also verry good.
# Common additions and expantions (Snippets)
Sadly most Profs have widly different expectaions when it comes to styling of written works. So you might find yourself having to change some
settings. For some cases this has allready been done and, to help others, uploaded in
[the snippets section](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/snippets) of the project. Most of them are only visible when you
are logged in!!
# Use the Wiki:
# Use the Wiki:
Use the wiki [here](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/wikis/home):
-[Adding the src folder to the path](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/wikis/Adding-src-folder-to-the-path)
