From e6dac15b660cbd514f2216416a1d6133f89a448b Mon Sep 17 00:00:00 2001
From: Jan Wille <jan.wille@stud.hs-hannover.de>
Date: Mon, 9 Nov 2020 13:53:49 +0100
Subject: [PATCH] merge from master
---
.gitignore | 14 +-------------
Makefile | 14 ++++++++------
crc/README.md | 6 +++---
csv/README.md | 4 ++--
img/README.md | 6 ------
plt/README.md | 2 +-
src/HsH-report.cls | 26 ++++++++++++++------------
src/config.tex | 17 +++++++----------
svg/README.md | 10 ++++++++--
9 files changed, 44 insertions(+), 55 deletions(-)
diff --git a/.gitignore b/.gitignore
index de05d64..aaecd3e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,15 +1,3 @@
-*.synctex.*
-*.aux
-*.bbl
-*.bcf
-*.blg
-*.idx
-*.ind
-*.lof
-*.lot
-*.log
-*.xml
-*.toc
-.vscode/
+
build/
.vscode/
diff --git a/Makefile b/Makefile
index e92d069..c2ff8ce 100644
--- a/Makefile
+++ b/Makefile
@@ -3,8 +3,7 @@ NAME = test
LATEX = pdflatex
BIBTEX = biber
-SUBDIRS = img plt
-# use . for no OUTDIR
+SUBDIRS = svg plt crc
OUTDIR = build
TEX_FLAGS = -file-line-error -interaction=nonstopmode
COM_FLAGS = -output-directory=$(OUTDIR) -quiet
@@ -24,12 +23,15 @@ all: bib
$(LATEX) -synctex=1 $(TEX_FLAGS) $(COM_FLAGS) $(NAME).tex
copy /Y $(OUTDIR)\$(NAME).pdf .\
-std: all tidy
-
-bib: pdf $(OUTDIR)\$(NAME).bcf
+bib: $(NAME).pdf $(OUTDIR)\$(NAME).bcf
$(BIBTEX) $(COM_FLAGS) $(NAME)
-pdf: $(SUB_PDF_FILES) $(SUB_PDF_TEX_FILES)
+$(OUTDIR)\$(NAME).bcf:
+ $(LATEX) -synctex=1 $(TEX_FLAGS) $(COM_FLAGS) $(NAME).tex
+
+pdf: $(NAME).pdf
+
+$(NAME).pdf: $(NAME).tex $(SUB_PDF_FILES) $(SUB_PDF_TEX_FILES)
$(LATEX) -synctex=1 $(TEX_FLAGS) $(COM_FLAGS) $(NAME).tex
$(SUB_PDF_FILES): $(SUB_TEX_FILES)
diff --git a/crc/README.md b/crc/README.md
index 901c0ba..73c39db 100644
--- a/crc/README.md
+++ b/crc/README.md
@@ -1,4 +1,4 @@
-# Circuit-diagramms folder
+# Circuits-folder
-This folder is for circuit diagramms.
-The `circuitkz` pakage is recomendet for creating these.
+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
diff --git a/csv/README.md b/csv/README.md
index a1e3464..919f618 100644
--- a/csv/README.md
+++ b/csv/README.md
@@ -1,10 +1,10 @@
-# CSV folder (Comma Seperatet Values)
+# CSV folder (Comma Speeratet 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.
# 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
+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
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 7e12ea1..d7ac214 100644
--- a/img/README.md
+++ b/img/README.md
@@ -2,9 +2,3 @@
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.
-
-# 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
-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 d740a03..a703d46 100644
--- a/plt/README.md
+++ b/plt/README.md
@@ -1,5 +1,5 @@
# 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 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
+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
`.pdf` file into the final document, recompiling the graph itself only when needed.
\ No newline at end of file
diff --git a/src/HsH-report.cls b/src/HsH-report.cls
index 22173fc..bc8d5a5 100644
--- a/src/HsH-report.cls
+++ b/src/HsH-report.cls
@@ -61,9 +61,11 @@
\PassOptionsToPackage{headsepline}{scrlayer-scrpage}
\PassOptionsToPackage{backend=biber,style=alphabetic,sorting=nyt}{biblatex}
-\PassOptionsToPackage{free-standing-units}{siunitx}
+\PassOptionsToPackage{free-standing-units,abbreviations}{siunitx}
\PassOptionsToPackage{babel, german=quotes}{csquotes}
\PassOptionsToPackage{european,EFvoltages,straightvoltages}{circuitikz}
+\PassOptionsToPackage{hidelinks}{hyperref}
+
%used packages:
\RequirePackage{inputenc} % inputencoding, utf8 recomendet
@@ -72,8 +74,11 @@
\RequirePackage{geometry} % required for changing layout
\RequirePackage{graphicx} % required for importing images
\RequirePackage{babel} % required for german names
+\RequirePackage{hyperref} % references and lists are clikable
+\RequirePackage{bookmark} % generat bookmarkes
\RequirePackage{scrlayer-scrpage} % required for header and footer
\RequirePackage{scrhack} % compatability with listings
+\RequirePackage{csquotes} % quotations
\RequirePackage{pgffor} % foreach loops
\if@german\RequirePackage{ziffer}\fi % german dezimal numbers
@@ -82,9 +87,6 @@
\RequirePackage{amssymb}
\RequirePackage{subfigure}
\RequirePackage{pdfpages}
-\RequirePackage{hyperref}
-\RequirePackage{bookmark}
-\RequirePackage{csquotes}
\RequirePackage{soul}
% config for header and footer
@@ -117,6 +119,7 @@
\renewcommand{\fps@figure}{h!t} % positioning of figures
\renewcommand{\fps@table}{h!t} % Positonierung of tables
\renewcommand{\layercontentsmeasure}{\empty} % rulers when using draft disabled
+ \MakeOuterQuote{"} % easy quotationmarks
\newcommand\declarationAuthorship{
\thispagestyle{plain}
@@ -141,9 +144,9 @@
\end{center}
\vspace{1cm}\normalsize
Hiermit bestätige\plutalendung\space\pronomen, dass die folgende Arbeit eigenständig von \genitiv\space allein erstellt und unter
- Berücksichtigung der zur Verfügung gestellten Aufgabenstellung sowie dem Arbeitsmaterial unter Angabe aller verwendeten Quellen selbstständig
- erarbeitet wurde. Die Regelungen und Konsequenzen eines Plagiats, inklusieve disziplinarischer Maßnahmen, sind \genitiv\space bewusst.
- Insbesondere wurden alle Zitate und gedanklichen Übernahmen als solche kenntlich gemacht.
+ Berücksichtigung der zur Verfügung gestellten Aufgabenstellung sowie dem Arbeitsmaterial unter Angabe aller verwendeten Quellen erarbeitet
+ wurde. Die Regelungen und Konsequenzen eines Plagiats, inklusive disziplinarischer Maßnahmen, sind \genitiv\space bewusst. Insbesondere wurden
+ alle Zitate und gedanklichen Übernahmen als solche kenntlich gemacht.
}\else{
\newcommand{\pronomen}{I}
\newcommand{\pronomenf}{I}
@@ -158,13 +161,12 @@
\else\fi
}
\begin{center}
- \huge \textbf{Declatiation of Authorship}\\
+ \huge \textbf{Declaration of Authorship}\\
\end{center}
\vspace{1cm}\normalsize
- \pronomenf\space hereby certify that this work \pronomen\space\proniomeverb\space submitting is entirely \genitiv\space own original work except
- where otherwise indicated. \pronomen\space\proniomeverb\space aware of regulations concerning plagiarism, including those regulations
- concerning disciplinary actions that may result from plagiarism. Any use of the works of any other author, in any form, is properly
- acknowledged at their point of use.
+ \pronomenf\space hereby certify that the work \pronomen\space\proniomeverb\space submitting is entirely of \genitiv\space own making except
+ where otherwise indicated. \pronomenf\space\proniomeverb\space aware of regulations concerning plagiarism, including disciplinary actions that
+ may result from it. Any use of the works of any other author, in any form, is properly acknowledged at their point of use.
}\fi
\begin{flushright}
\foreach \x [count=\i] in \@author{
diff --git a/src/config.tex b/src/config.tex
index e9dcc66..74ab6f5 100644
--- a/src/config.tex
+++ b/src/config.tex
@@ -1,4 +1,4 @@
-\renewcommand{\abstractname}{Abstract} %Abstract
+\renewcommand{\abstractname}{Abstract} % Abstract
\ifx\KOMAScriptVersion\undefined\else % check if KOMA is used
\g@addto@macro\@floatboxreset\centering % center all floats
@@ -8,24 +8,21 @@
\@ifpackageloaded{biblatex}{
\ExecuteBibliographyOptions{
bibwarn=true,
+ url=true,
isbn=false,
- url=false
}
}{}%
-\@ifpackageloaded{csquotes}{
- \MakeOuterQuote{"}
-}{}%
\@ifpackageloaded{siunitx}{
- \if@german
- \sisetup{output-decimal-marker={,}}
+ \if@german % if german
+ \sisetup{output-decimal-marker={,}} % use comma as dezimal
\fi
\sisetup{
- free-standing-units,
tight-spacing=true,
per-mode=symbol,
scientific-notation=engineering,
- round-mode = places,
- round-precision = 3,
+ % exponent-to-prefix, % use this instead of sci-notatio
+ round-mode = places, % round numbers
+ round-precision = 3, % to 3 places
}
}{}%
\@ifpackageloaded{listings}{
diff --git a/svg/README.md b/svg/README.md
index c2f6bb4..c583c2c 100644
--- a/svg/README.md
+++ b/svg/README.md
@@ -1,3 +1,9 @@
-# SVG-images folder
+# SVG-Folder
-using Inkscape you can create pretty much every image you need and export it for use inside a Latex document
\ No newline at end of file
+The svg format is widely used for webgraphics and vectorgraphics. This makes it usefull 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
+experimental setup.
+Check oute their website: [Inkscape.org](https://inkscape.org/)
\ No newline at end of file
--
GitLab