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

so many typos

parent 13f48a3e
Branches
Tags
No related merge requests found
...@@ -2,35 +2,46 @@ ...@@ -2,35 +2,46 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [V 1.1] - 2021-04-22 ## [Current]
### 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. This version provides mostly minor fixed and upgrades.
**IMPORTANT:** the personal.tex has been removed **IMPORTANT:** the `personal.tex` has been removed
### Added ### 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 - 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. deployment. This file will only be available on a separate branch and not be part of the master branch.
### Changed ### Changed
- Makefile has been reworked. should now be more stable and easier to understand - 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 - 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 localisation - the declaration of authorship now uses the proper babel interface for localization
- License is now LPPL - Licence is now LPPL
### Removed ### 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.
## [V 1.0] - 2021-03-31 ## [1.0] - 2021-03-31
Initial Version. Official first release Initial Version. Official first release
### Added ### Added
- HsH-article class - HsH-article class
- HsH-report class - HsH-report class
- HsH-standalone class - HsH-standalone class
- config.tex file - `config.tex` file
- personal.tex file - `personal.tex` file
- folder structure, with readme files for every folder - folder structure, with readme files for every folder
- empty project file - empty project file
- makefile - makefile
- example on the example branche - example on the example branch
\ No newline at end of file
# What this is # 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 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. 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 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. classes and customize them with specific configurations, presets and provide commonly needed features.
**Provided classes are:** **Provided classes are:**
...@@ -15,9 +15,9 @@ classes and customize them them with specific configurations, presets and provid ...@@ -15,9 +15,9 @@ classes and customize them them with specific configurations, presets and provid
**Version:** 1.1 **Version:** 1.1
**Date:** 21.04.2021 **Date:** 21.04.2021
# License # Licence
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.
# TODO: # TODO:
......
# 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. presentations or downloaded web-pages.
# Chapters folder # Chapters folder
For bigger projects it can be usefull to have separate files for chapters. 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 `\input{chap/one.tex}`. These separate files should be stored here and can be included into the main document via `\input{chap/one.tex}`.
# Circuits folder # 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 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 diagramm needs. Have a look at the documentation. your circuit diagram needs. Have a look at the documentation.
\ No newline at end of file
# CSV folder (Comma Speeratet Values) # CSV folder (comma separate values)
This folder is for measurement readings and other kinds of data collection. 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. 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 selts the ';' as the seperator, which is the german standart Keep in mind, that the config sets the `;` as the separator, which is the German standard
# Export Excel to CSV # 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 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. changes in the Excel file.
\ No newline at end of file
# Images folder (pictures) # 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 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
in the main document, but files needed by the respective editors may also be stored here. types for inclusion in the main document, but files needed by the respective editors may also be stored here.
# Plots-folder # 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 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. `.pdf` file into the final document, recompiling the graph itself only when needed.
# SVG-Folder # 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 # 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. experimental setup.
Check oute their website: [Inkscape.org](https://inkscape.org/) Check out their website: [Inkscape.org](https://inkscape.org/)
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment