Skip to content
Snippets Groups Projects
Commit aa9989ff authored by Jan Wille's avatar Jan Wille
Browse files

biber and clone command in quickstart guide

parent cc51f224
No related branches found
No related tags found
No related merge requests found
...@@ -20,16 +20,18 @@ Check out the [**Example-Branche**](https://lab.it.hs-hannover.de/qxx-tul-u1/lat ...@@ -20,16 +20,18 @@ Check out the [**Example-Branche**](https://lab.it.hs-hannover.de/qxx-tul-u1/lat
This project is distributed under the LaTeX project public license (LPPL), version 1.3c. This project is distributed under the LaTeX project public license (LPPL), version 1.3c.
# Requirements: # Quick start guide:
[MikTex is recommended](https://miktex.org/), TexLive doesn't find some packages, if somebody get's it working, let me know.
`biber`-Backend is standart! If you have Problems with that, check the [FAQ](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/wikis/faq).
The `Makefile` is only tested with mingw32-make.
## recomendet Software
As a Tex-Distribution, [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 very good.
# Quick start guide: 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.
## 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 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
...@@ -37,19 +39,12 @@ the `HsH-logo.pdf` from the src folder to your projectfolder. You can optionally ...@@ -37,19 +39,12 @@ the `HsH-logo.pdf` from the src folder to your projectfolder. You can optionally
preamble. preamble.
## using a proper subfolder structure ## 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 The projects also provides a recommendation for a subfolder structure, to keep things organized. You can [download the .zip-Archive](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/archive/master/latex-template-hsh-master.zip)
will allow you to use it easily. 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 classfiles and other needed files in the *.\src* folder, which means it needs to be added to the path searched when 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-src-folder-to-the-path). 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. The provided Makefile demonstrates how to run a successful build, you might want to check it out.
## 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) # 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 Sadly most Profs have widly different expectaions when it comes to styling of written works. So you might find yourself having to change some
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment