@@ -55,7 +55,7 @@ The provided Makefile demonstrates how to run a successful build, you might want
# Documentation:
# Documentation
## The different classes
...
...
@@ -64,6 +64,7 @@ This project provides a set of additional classes designed for use in the Hochsc
classes](https://ctan.org/pkg/koma-script) 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.
...
...
@@ -123,7 +124,7 @@ used in pretty much every project anyway.
-`pgffor` allows for the use of for-loops (internal)
-`graphicx` for importing images
-`hyperref` for references and links
-`caption` to customise captions and make references point to the begining of the floats
-`caption` to customize captions and make references point to the beginning of the floats
-`bookmark` for bookmarking
-`amsmath` for a lot of general purpose maths features
-`csquotes` makes quotations easier
...
...
@@ -162,7 +163,8 @@ You can use the following macros to define the different information presented o
comma-seperated list, if more than one author is present.
-`\titlehead` is for a small line left of the logo. This is usually the department or division. May be empty
-`\subject` is for a broad description of what your file is. "Laborbericht" for example. Can be empty.
-`\title` is quite obvious. The only one that must be present.
-`\title` is quite obvious. The only one that must be present. I additionally accept an optional parameter which will be treated as a short form of
the title and used in the header (this makes sense if your title is very long and fills your header too much)
-`\subtitle` is a smaller second line under the title. Can be empty
-`\date` is the date of your project. You can use a custom one, but if you don't set it, the current date at compile time will be used.
-`\professor` a new macro do define your professors name, if needed.
...
...
@@ -175,7 +177,8 @@ separated by a horizontal line.
The macro is defined in German and English and will automatically match your document language.
### `\abs`
A helpful macro for absolute values. It can be used in maths mode and will put vertical lines around its content, that match the height of the content.
A helpful macro for absolute values. It can be used in maths mode and will put vertical lines around its content, that match the height of the
content.
This macro is only provided, meaning if another package defines it, its definition will be used.
### HsH-Logo macros
...
...
@@ -192,11 +195,12 @@ Sadly most Profs have widely different expectations when it comes to styling of
settings. For some cases this has already 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!!
Also, if you create your own set of additions that are usefull for other, feel free to contact me and I will give you acces right so you can upload it there.
Also, if you create your own set of additions that are useful for other, feel free to contact me and I will give you access right, so you can upload
it there.
# Frequently Asked Questions:
# Frequently Asked Questions
## What is the `config.tex`?
...
...
@@ -229,7 +233,7 @@ For building from sub folders, just add a second `-include-directory=../src` to
### Using Texmaker and MiKTeX
As stated above, you just need to extend your Latex-call with the needed include path.
To do this, go to *Options → config Texmaker → Commands*
To do this, go to _Options → config Texmaker → Commands_
In VS Code you can configure your launch to set environment variables. Just edit your `settings.json`, so that your pdflatex tool contains a `env:` (add it, if it isn't there yet). If you use the template below, you will also get some additional nice configurations. See also [here](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/snippets/111) for some additional configs.
In VS Code you can configure your launch to set environment variables. Just edit your `settings.json`, so that your pdflatex tool contains a `env:`
(add it, if it isn't there yet). If you use the template below, you will also get some additional nice configurations. See also
[here](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/snippets/111) for some additional configs.
TexLive does not have this functionality built-in.
## LaTeX errors
> You have requested document class \`src/HsH-report', but the document class provides \`HsH-report'.
This happens when you tried to use something like `\documentclass{src/HsH-report}`, which was a good idea, but doesn't quite work. You need to properly
add the `src` directory to the path searched by LaTeX (as explained [here](#adding-src-to-path)). You can than simply use `\documentclass{HsH-report}`.
