From 52223da7205eff71c2f2092856eee8d34a20d629 Mon Sep 17 00:00:00 2001
From: Jan Wille <jan.wille@stud.hs-hannover.de>
Date: Mon, 19 Oct 2020 11:24:43 +0200
Subject: [PATCH] translated to englisch
---
.gitignore | 1 +
.vscode/settings.json | 4 +++
Makefile | 6 ++--
README.md | 67 +++++++++++++++++++++++++++--------------
chap/README.md | 4 +++
csv/README.md | 13 +++++---
img/README.md | 12 +++++---
plt/README.md | 6 ++--
test.tex => project.tex | 5 +--
src/README.md | 3 +-
10 files changed, 80 insertions(+), 41 deletions(-)
create mode 100644 chap/README.md
rename test.tex => project.tex (56%)
diff --git a/.gitignore b/.gitignore
index 3b742fd..9a1bf98 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,5 @@
*.log
*.toc
build/
+.vscode/
img/logos-fakultäten.svg
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 5f9c3f4..8112916 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -15,5 +15,9 @@
"TEXINPUTS": "%DIR%/src"
}
}
+ ],
+ "cSpell.enabled": true,
+ "cSpell.enableFiletypes": [
+ "markdown"
]
}
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 4b47d26..6832e1b 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
# Makefile for Latex project
-NAME = test
-PDF = pdflatex
+NAME = project
+LATEX = pdflatex
BIB = biber
OUTDIR = .\build
@@ -10,7 +10,7 @@ export TEXINPUTS:=.\src
pdf: $(NAME).tex
- $(PDF) -synctex=1 -interaction=nonstopmode -file-line-error --output-directory=$(OUTDIR) $(NAME).tex
+ $(LATEX) -synctex=1 -interaction=nonstopmode -file-line-error -include-directory=.\src -output-directory=$(OUTDIR) $(NAME).tex
clean: tidy
diff --git a/README.md b/README.md
index 3ef3a70..18780f2 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
# What this is
-This is a template designed to ease the workflow when wrighting documents for the Hochschule Hannover. It is intendet to be used in all sufisticated
-works, from lab-reporst to masters thesisies.
-The project provieds custom document-classes cariing the `HsH-` prefix as well as support files. These classes extend the well known KOMA-script classes and customise them
-them with specifig configurations and presets as well as providing comonly needed features.
+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 specifig configurations and presets as well as providing commonly needed features.
**Provides classes are:**
@@ -15,36 +15,57 @@ them with specifig configurations and presets as well as providing comonly neede
## 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 optionaly copy the `config.tex` and the `personal.tex`, but you can also
-configre everything in your preamble.
+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.
## using a proper subfolder structure
-The projects also provieds a recomondation for a subfolder structure, to keep things organised. Cloning the complete projekt into your projectfolder
-will allow you to use it easiely.
+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 later on.
+The provided Makefile demonstrates how to run a successful build, you might want to check it out.
## writing your document
Write your Latexdocument as usual, starting with: `\documentclass{HsH-report}`
-You may provide all usuall classoptions as well as specifying your fakultie (f1 to f5), so the correct logo can be picked. Here is a recomendation:
+You may provide all usual classoptions as well as specifying your fakultae (f1 to f5), so the correct logo can be picked. Here is a recommendation:
\documentclass[11pt,a4paper,twoside,f1]{HsH-report}
+# Adding the .\src folder to the path
-# What are the presonal.tex and config.tex?
+The makefile shows how to do this via export of the `TEXINPUTS` variable or with the miktex option.
-These files are a easy way to configre your project in a single central location, so it can be used over multiple documents in the same project as
+
+## using MIKTEX
+Miktex makes this very easy by adding a option for that. Just add `-include-directory=.\src` to your call to `pdflatex`.
+
+
+## using VScode with LaTex Workshop
+in VS Code you can configure your launch to set environment variables. Just edit your settings, so that your pdflatex tool contains a `env:`
+
+ "name": "pdflatex",
+ "command": "pdflatex",
+ "args": [...],
+ "env": {
+ "TEXINPUTS": "%DIR%/src"
+ }
+
+# What are the personal.tex and config.tex?
+
+These files are a easy way to configure your project in a single central location, so it can be used over multiple documents in the same project as
well as allowing easy reuse of configs for other projects.
-The provied classes automaticly check for thes files and use them, if they are present. But they are completly optional, so you can just ditch them if
-you want to. Keep in mind that the `config.tex` will be includet rigth befor the `\begin{document}`, so it overides all settings you may have put in
+The provide classes automatically check for these files and use them, if they are present. But they are completely optional, so you can just ditch them if
+you want to. Keep in mind that the `config.tex` will be included right before the `\begin{document}`, so it overrides all settings you may have put in
your preamble.
-The `personal.tex` is intednet for presonal information displayed on the titlepage and elsewhere. For example the definitions of `\autor{}` and
+The `personal.tex` is internet for personal information displayed on the titlepage and elsewhere. For example the definitions of `\autor{}` and
`\title{}` are here.
-The `config.tex` is intendet for configurations. For example new- or redefinitions of commands should be put here. Also pakages specifig configs are
-loadet here. The `\@ifpackageloaded{pakagename}{true}{false}` Makro allows to check for the existans of a pakage, so that you can reuse config files,
-even if you dont use all the same pakeges.
+The `config.tex` is intendet for configurations. For example new- or redefinitions of commands should be put here. Also packages-specific configs are
+loaded here. The `\@ifpackageloaded{pakagename}{true}{false}` Makro allows to check for the existenz of a package, so that you can reuse config files,
+even if you don't use all the same packages.
# Creating a titlepage
@@ -58,14 +79,14 @@ Standart KOMA commands (read also [KOMA-documentation](https://golatex.de//wiki/
`\date{}`
Custom Commands:
-`\author{A,B,C}` needs to be a comma seperated list, to make the declaration of autorship work properly, `\thanks{}` may still be used
+`\author{A,B,C}` needs to be a comma separated list, to make the declaration of autorship work properly, `\thanks{}` may still be used
`\publishers{}` has no effect
-It is very importand, that the HsH-logo file can be found when using this command. The standart config looks on the enviroment path, but if you whant to
-customise it, you can use `\HsHlogoPath{path/to/logo}` to provide the path yourself. Note that the `\HsHlogoPage{num}` must also be set to point to the
-correct page inside the providet file (standart is 1).
+It is very important, that the HsH-logo file can be found when using this command. The standart config looks on the environment path, but if you want to
+customize it, you can use `\HsHlogoPath{path/to/logo}` to provide the path yourself. Note that the `\HsHlogoPage{num}` must also be set to point to the
+correct page inside the provided file (standart is 1).
-# Declation of autorship
+# Declaration of autorship
TODO
@@ -74,7 +95,7 @@ TODO
# other providet commands
-`\abs{}` sets vertical lines left and right of the contained expression to mark an absolout value. Only works in mathmode
+`\abs{}` sets vertical lines left and right of the contained expression to mark an absolut value. Only works in mathmode
# Für Beamer gibt es das schon:
diff --git a/chap/README.md b/chap/README.md
new file mode 100644
index 0000000..1cf1ae9
--- /dev/null
+++ b/chap/README.md
@@ -0,0 +1,4 @@
+# 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 `\input{chap/one.tex}`.
\ No newline at end of file
diff --git a/csv/README.md b/csv/README.md
index e42037b..a1e3464 100644
--- a/csv/README.md
+++ b/csv/README.md
@@ -1,5 +1,10 @@
-# Der CSV-Ordner (Comma Seperatet Values)
+# CSV folder (Comma Seperatet Values)
-Dieser Ordner ist für für Messwerte und andere arten der Datenerfassung gedacht.
-Der Name lautet zwar *csv*, ist aber nicht auf diese beschränkt. Eine gute Möglichkeit ist z.B. die erstellung einer Excel Tabelle, deren einzelne
-Sheets bei bedarf als CSV exporttiert werden. Dazu existiert auch ein VBA Makro.
+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.
+
+# 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. Thats 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
diff --git a/img/README.md b/img/README.md
index d2e73d4..7e12ea1 100644
--- a/img/README.md
+++ b/img/README.md
@@ -1,8 +1,10 @@
-# Der Images-Ordner (Bilder)
+# Images folder (pictures)
-Dieser Ordner ist für Bilder, sowohl Fotos als auch selbst erstellte Schaubilder und Skizzen. Grundsätzlich sollte mit .png oder .pdf gearbeitet
-werden, jedoch können hier auch die Dateine der jeweiligen Editoren abgelegt werden.
+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.
-# Schaubilder erstellen mit Inkscape
+# Image creation with Inkscape
-soll hier ein Beispiel dafür rein oder ist das zu Komplex??
\ No newline at end of file
+Inkscape is a amazing vectorgraphics 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
diff --git a/plt/README.md b/plt/README.md
index b20c692..342b890 100644
--- a/plt/README.md
+++ b/plt/README.md
@@ -1,5 +1,5 @@
# Der Plots-Ordner
-Ein Ordner für alle Plots und Graphen. Dieser Existiert vor allem, da die Erstellung mit PGF-Plots empfohlen wird. Dies erfordert eine eigene .tex
-Datei für jeden Plot, spart aber Compilezeit, da nicht jedes mal alle Plots neu erstellt werden. Dadurch ist es aber möglich, direkt auch .csv Daten
-zuzugreifen.
\ No newline at end of file
+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 compiletime of a `.tex` file by a lot. Thats why it is recommended to create separate files for every plot an just import the resulting
+`.pdf` file into the final document, recompiling the graph itself only when needed.
\ No newline at end of file
diff --git a/test.tex b/project.tex
similarity index 56%
rename from test.tex
rename to project.tex
index 1c62d5f..725d3df 100644
--- a/test.tex
+++ b/project.tex
@@ -1,5 +1,6 @@
\documentclass[11pt,a4paper]{HsH-report}
+% preamble
\begin{document}
-
-\end{document}
+ % content goes here
+\end{document}
\ No newline at end of file
diff --git a/src/README.md b/src/README.md
index 75df13b..86a20f0 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,3 +1,4 @@
# Der Sources Ordner
-Hier kommen alle Verwendeten Quelldateien hinein. Angefangen bei den eigenen Klassen über Bibliogrphien bis hin zu Versuchsanleitungen.
\ No newline at end of file
+This folder is for additional source files. It provides the custom classes and support files as well as being good for storing your assignments or
+documents you need for information.
\ No newline at end of file
--
GitLab