Merge branch 'development'

CHANGELOG.md

@@ -2,23 +2,34 @@
 All notable changes to this project will be documented in this file.
 
 
+## [1.2] - 2021-10-24
+
+### Fixed
+- Issues that came with the Kernel update from 01.06.2021 are fixed (#2, #3, #4)
+- typos
+
+### Added
+- defined checklist environment via enumitem-package in `config.tex`
+- added required package for enum item
+
+
 ## [1.1] - 2021-04-22
 
 This version provides mostly minor fixed and upgrades.  
-**IMPORTANT:** the personal.tex has been removed
+**IMPORTANT:** the `personal.tex` has been removed
 
 ### Added
- - dtx installer file. All class files can be generated from this file. this removes code duplications and allows for more easy maintenance as well as
- 	deployment. This file will only be available on a separate branche and not be part of the master branch.
+ - dtx installer file. All class files can be generated from this file. This removes code duplications and allows for more easy maintenance as well as
+ 	deployment. This file will only be available on a separate branch and not be part of the master branch.
 
 ### Changed
- - Makefile has been reworked. should now be more stable and easier to understand
- - Titlepage as been improved. You can now align the standart titlepage as you prefer
- - the declaration of authorship now uses the proper babel interface for localisation
- - License is now LPPL
+ - Makefile has been reworked. Should now be more stable and easier to understand
+ - Title page as been improved. You can now align the standard title page as you prefer
+ - the declaration of authorship now uses the proper babel interface for localization
+ - Licence is now LPPL
 
 ### Removed
- - personal.tex has been removed. It pretty much not used anyway. All contents have been moved to the project files preamble.
+ - `personal.tex` has been removed. It pretty much not used anyway. All contents have been moved to the project files preamble.
 
 
 ## [1.0] - 2021-03-31
@@ -28,9 +39,9 @@ Initial Version. Official first release
  - HsH-article class
  - HsH-report class
  - HsH-standalone class
- - config.tex file
- - personal.tex file
+ - `config.tex` file
+ - `personal.tex` file
  - folder structure, with readme files for every folder
  - empty project file
  - makefile
- - example on the example branche
\ No newline at end of file
+ - example on the example branch

README.md

 # 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 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
-classes and customize them them with specific configurations, presets and provide commonly needed features.  
+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:**  
 
@@ -11,13 +11,13 @@ classes and customize them them with specific configurations, presets and provid
 	HsH-book (planed)
 	HsH-standalone
 
-**Version:** 1.1  
-**Date:** 21.04.2021  
+**Version:** 1.2  
+**Date:** 24.10.2021  
 Check out the [**Example-Branche**](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/tree/example)
 
+# Licence
 
-# License
-This project is distributed under the LaTeX project public license (LPPL), version 1.3c.  
+This project is distributed under the LaTeX project public licence (LPPL), version 1.3c.  
 
 
 # Quick start guide:

bib/README.md

-# Bibliograpy folder
+# Bibliography folder
 
-This folder is for bibliographic purpises. Here should be `.bib` files for useage with the `biblatex`package and source dokuments like pdfs,
+This folder is for bibliographic purposes. Here should be `.bib` files for usage with the `biblatex`package and source documents like PDFs,
 presentations or downloaded web-pages.

chap/README.md

 # Chapters folder
 
-For bigger projects it can be usefull to have separate files for chapters.
-These separate files should be stored here and can be included into the main document via `\include{chap/one}`. (the .tex extention is added internaly)
\ No newline at end of file
+For bigger projects it can be useful to have separate files for chapters.
+These separate files should be stored here and can be included into the main document via `\include{chap/one}`. (the .tex extension is added internally)

crc/README.md

 # Circuits folder
 
-This folder is for Circuit diagramms. It is recommended to use the `circuitikz` package. This extents the `tikz` package with commands for close to all
-your circuit diagramm needs. Have a look at the documentation.
\ No newline at end of file
+This folder is for Circuit diagrams. It is recommended to use the `circuitikz` package. This extends the `tikz` package with commands for close to all
+your circuit diagram needs. Have a look at the documentation.

csv/README.md

-# CSV folder (Comma Speeratet Values)
+# CSV folder (comma separate values)
 
 This folder is for measurement readings and other kinds of data collection.  
-It is named *csv*, but you could also use different filetypes, even though the `.csv` type is the easiest to include in LaTex.  
-Keep in mind, that the config selts the ';' as the seperator, which is the german standart
+It is named *CSV*, but you could also use different file types, even though the `.csv` type is the easiest to include in LaTeX.  
+Keep in mind, that the config sets the `;` as the separator, which is the German standard
 
 # Export Excel to CSV
 
-Excel ist a gerate tool for collecting and doing calculation on measured data, but is not so good for using that data in other tools. That's why there
+Excel is a great tool for collecting and doing calculation on measured data, but is not so good for using that data in other tools. That's why there
 is a VBA macro, that makes it super easy to export excel-sheets into separate CSV documents, which can be used in Latex and easily reexported on
-changes in the excel file.
\ No newline at end of file
+changes in the Excel file.

img/README.md

 # Images folder (pictures)
 
-This folder is for images, this can be pictures,created graphs, sketches or circuit diagramms. It is recommended to work with `.png` and `.pdf` filetypes for inclusion
-in the main document, but files needed by the respective editors may also be stored here.
+This folder is for images, this can be pictures, created graphs, sketches or circuit diagrams. It is recommended to work with `.png` and `.pdf` file 
+types for inclusion in the main document, but files needed by the respective editors may also be stored here.

plt/README.md

 # Plots-folder
 
 This folder is for plots and graphs. It exists mostly because it is recommended to use the `pgf-plots` package. This huge and powerful package also
-brings up the compilertime of a `.tex` file by a lot. That's why it is recommended to create separate files for every plot an just import the resulting
+brings up the compiler time of a `.tex` file by a lot. That's why it is recommended to create separate files for every plot a just import the resulting
 `.pdf` file into the final document, recompiling the graph itself only when needed.

src/HsH-article.cls

@@ -328,9 +328,9 @@
           % sneeky comma needed after \@matrikelnr to deal with single item lists
           \foreach \x [count=\i,evaluate=\i as \y using {{\@matrikelnr,}[\i-1]}] in \@author {\eaddtabtoks{\x & \y\protect\\}}
           \usekomafont{author}{\def\arraystretch{1.2}
-            \if\@param l\hspace{-6pt}\begin{tabular}{l l}\printtabtoks\end{tabular}\fi
+            \if\@param l\begin{tabular}{@{}l l}\printtabtoks\end{tabular}\fi
             \if\@param c\begin{tabular}{l l}\printtabtoks\end{tabular}\fi
-            \if\@param r\begin{tabular}{r r}\printtabtoks\end{tabular}\hspace{-6pt}\fi
+            \if\@param r\begin{tabular}{r r@{}}\printtabtoks\end{tabular}\fi
           }
         \fi
       \fi}

src/HsH-report.cls

@@ -345,9 +345,9 @@
           % sneeky comma needed after \@matrikelnr to deal with single item lists
           \foreach \x [count=\i,evaluate=\i as \y using {{\@matrikelnr,}[\i-1]}] in \@author {\eaddtabtoks{\x & \y\protect\\}}
           \usekomafont{author}{\def\arraystretch{1.2}
-            \if\@param l\hspace{-6pt}\begin{tabular}{l l}\printtabtoks\end{tabular}\fi
+            \if\@param l\begin{tabular}{@{}l l}\printtabtoks\end{tabular}\fi
             \if\@param c\begin{tabular}{l l}\printtabtoks\end{tabular}\fi
-            \if\@param r\begin{tabular}{r r}\printtabtoks\end{tabular}\hspace{-6pt}\fi
+            \if\@param r\begin{tabular}{r r@{}}\printtabtoks\end{tabular}\fi
           }
         \fi
       \fi}

src/config.tex

@@ -43,6 +43,7 @@
   }
 }{}
 \@ifpackageloaded{enumitem}{
+  \RequirePackage{amssymb}
   \newlist{checklist}{itemize}{2}
   \setlist[checklist]{label=$\square$}
 }{}

svg/README.md

 # SVG-Folder
 
-The svg format is widely used for webgraphics and vectorgraphics. This makes it usefull for creating complex graphics and illustrations.
+The svg format is widely used for web graphics and vector graphics. This makes it useful for creating complex graphics and illustrations.
 
 # Image creation with Inkscape
 
-Inkscape is a amazing vectorgraphics tool with an export to LaTex feature. I highly recommend it for creating complex images like sketches of
+Inkscape is an amazing vector graphics tool with an export to LaTeX feature. I highly recommend it for creating complex images like sketches of
 experimental setup.  
-Check oute their website: [Inkscape.org](https://inkscape.org/)
\ No newline at end of file
+Check out their website: [Inkscape.org](https://inkscape.org/)