Initial commit

This commit is contained in:
Leon Etienne 2022-05-19 09:11:50 +02:00
commit d3d69b4d1f
30 changed files with 642 additions and 0 deletions

7
.gitignore vendored Normal file
View File

@ -0,0 +1,7 @@
.vs\
*.aux
*.lof
*.log
*.lot
*.toc
*.tps

25
LICENSE.md Normal file
View File

@ -0,0 +1,25 @@
BSD 2-Clause License
Copyright (c) 2022, Leon Etienne
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

6
Makefile Normal file
View File

@ -0,0 +1,6 @@
all:
pdflatex -interaction errorstopmode -halt-on-error main.tex # Generate table of contents (ToC)
pdflatex -interaction errorstopmode -halt-on-error main.tex # Generate ToC page indices taking account the new ToC file
pdflatex -interaction errorstopmode -halt-on-error main.tex # Generate PDF with new ToC
rm -f kapitel/*.aux *.aux *.lof *.log *.lot *.toc *.tps *.out *.fdb_latexmk *.fls # Remove cache files

Binary file not shown.

7
appendix.tex Normal file
View File

@ -0,0 +1,7 @@
%
% Appendix entries
%
\begin{appendices}
\input{appendix/example}
\end{appendices}

8
appendix/example.tex Normal file
View File

@ -0,0 +1,8 @@
%
% Anhang-Beispielsdokument:
%
\chapter{Beispiel}
\label{chap:anhang/beispiel} % Mit dieser Marke kann im Dokument auf diesen Anhang verwiesen werden
Hallo, Welt!

6
chapters.tex Normal file
View File

@ -0,0 +1,6 @@
%
% Include all your chapters here
%
\input{chapters/foobar}
\input{chapters/fazit}

6
chapters/fazit.tex Normal file
View File

@ -0,0 +1,6 @@
%
% Chapter: Fazit
%
\chapter{Fazit}
Abschließend ist zu sagen, dass es ganz schön schwurbelt.

139
chapters/foobar.tex Normal file
View File

@ -0,0 +1,139 @@
%
% Chapter: Foobar
%
\chapter{Example Markup}
Example citation:\\
Wer testet, der questet.\cite{bib:vodafone-legt-in-pirmasens}\\
Example thicc text:\\
Wer testet, der \textbf{questet}.\\
Example italic text:\\
Wer testet, der \textit{questet}.\\
Example monospace text:\\
Wer testet, der \texttt{questet}.\\
Example emphasized text:\\
Wer testet, der \emph{questet}.\\
Example quotation marks:\\
Wer testet, der \enquote{questet}.\\
Example acronym:\\
Wer dual studiert, braucht eine \ac{PRA}. Wer eine \ac{PRA} dokumentiert, kann diese Vorlage verwenden.\\
Example plural acronym:\\
Damit kann man ganz einfach viele \acp{PRA} dokumentieren.\\
Example linking (to an image, for example):\\
Wie im Bild \fullref{fig:stars} zu sehen ist, gibt es tolle Sterne.\\
Example ordinary list:\\
\begin{enumerate}
\item Apple
\item Beans
\item More Beans
\end{enumerate}
Example itemized list:\\
\begin{itemize}
\item Apple
\item Beans
\item More Beans
\end{itemize}
Example descriptive list:\\
\begin{description}
\item[Apple] A fruit.
\item[Beans] Not a fruit.
\item[More Beans] That's a lot of beans!
\end{description}
Example nested lists (works with any type of list):\\
\begin{enumerate}
\item Apple
\item Beans
\item More Beans
\begin{itemize}
\item Soy Beans
\item Kidney Beans
\end{itemize}
\end{enumerate}
% Example Figure/Image:
\begin{nicepic}
\includegraphics[width=0.9\textwidth]{images/stars.jpg}
\captionof{figure}{Sterne}
\caption*{Quelle: \cite{bib:vodafone-legt-in-pirmasens}}
\label{fig:stars}
\end{nicepic}
% Example Multifigure/multiple images
\begin{figure}[!htbp]
\begin{subfigure}[t]{0.3\textwidth}
\includegraphics[width=\textwidth]{images/mult0.jpg}
\captionof{figure}{Lichtpunkte auf dunklem Hintergrund}
\caption*{Quelle: \cite{bib:vodafone-legt-in-pirmasens}}
\label{fig:light-points-on-dark-bg}
\end{subfigure}
\hfill
\begin{subfigure}[t]{0.3\textwidth}
\includegraphics[width=\textwidth]{images/mult1.png}
\captionof{figure}{Ein Tannenbaum}
\caption*{Quelle: \cite{bib:vodafone-legt-in-pirmasens}}
\label{fig:tannenbaum}
\end{subfigure}
\hfill
\begin{subfigure}[t]{0.3\textwidth}
\includegraphics[width=\textwidth]{images/mult2.jpg}
\captionof{figure}{Eine Winterstadt}
\caption*{Quelle: \cite{bib:vodafone-legt-in-pirmasens}}
\label{fig:winter-city}
\end{subfigure}
\caption{Ein Beispiel für mehrere Bilder nebeneinander}
\end{figure}
% Example Table:
\begin{table}[!htbp] % !htbp
\centering
\begin{tabular}{|l|l|r|}
\hline
\textbf{TM Configuration} & \textbf{Detail-Level} & \textbf{Frametime}\\
\hline
\hline
Tensor-800 & 0 & 28\\
Tensor-800 & 1 & 52\\
Tensor-800 & 2 & 69\\
Tensor-800 & 3 & 89\\
\hdashline
V-Core Zenyx 33 & 0 & 2\\
V-Core Zenyx 33 & 1 & 4\\
V-Core Zenyx 33 & 2 & 5\\
V-Core Zenyx 33 & 3 & 7\\
\hdashline
Intel iZ237-8 & 0 & 298\\
Intel iZ237-8 & 1 & 448\\
Intel iZ237-8 & 2 & 556\\
Intel iZ237-8 & 3 & 767\\
\hline
\end{tabular}
\caption{Eine Beispieltabelle}
\label{tbl:renderzeiten_tm_processors}
\end{table}
% Example code:
\begin{code}
// Example code
#include <iostream>
int main(int argc, char** argv)
{
std::cout << "Hello, World!" << std::endl;
return 0;
}
\end{code}

34
chapters/title.tex Normal file
View File

@ -0,0 +1,34 @@
%
% Title page
%
\begin{titlepage}
\cfgUniversityName\\
\cfgUniversityDepartment\\
Studiengang \cfgUniversityDegreeCourse\\
\\
\cfgDocClassification\\
\cfgCourseName\\
\begin{center}
\Huge
\cfgDocTitle\\
\vspace{10mm}
\Large
\cfgDocSubTitle\\
\vspace{15mm}
\normalsize
Version \cfgDocVersion
\end{center}
\vfill
Vorgelegt von\\
\vspace{3mm} \ \\
\cfgAuthorName, \cfgAuthorMatriculationNum\\
\cfgAuthorContact\\
Im \cfgSemesterName\\
\vspace{3mm} \ \\
bei \cfgUniversitySupervisorName\\
\cfgUniversitySupervisorContact\\
\end{titlepage}

59
config.tex Normal file
View File

@ -0,0 +1,59 @@
%
% Project configuration
%
% Document title
\newcommand{\cfgDocTitle}{Eine wissenschaftliche Arbeit}
\newcommand{\cfgDocSubTitle}{Mit LaTeX}
% Document classification
\newcommand{\cfgDocClassification}{Hausarbeit}
% Document version
\newcommand{\cfgDocVersion}{1.0}
% Last modification date
\newcommand{\cfgDateLastModification}{15. November 2021}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Author name
\newcommand{\cfgAuthorName}{Mux Mastermann}
% Author matriculation number
\newcommand{\cfgAuthorMatriculationNum}{696969\_CHANGE\_THAT!!}
% Author contact
\newcommand{\cfgAuthorContact}{mux@hotmail.com}
% Author city
\newcommand{\cfgAuthorCity}{Worms}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% University city
\newcommand{\cfgUniversityCity}{Worms}
% University name
\newcommand{\cfgUniversityName}{Hochschule \cfgUniversityCity}
% University department
\newcommand{\cfgUniversityDepartment}{Fachbereich Informatik}
% University degree course
\newcommand{\cfgUniversityDegreeCourse}{Angewandte Informatik - dual (B.Sc)}
% University supervisor name
\newcommand{\cfgUniversitySupervisorName}{Michael D.Werle-Rutter}
% University supervisor contact
\newcommand{\cfgUniversitySupervisorContact}{rutter@hs-worms.de}
% Semester year
\newcommand{\cfgSemesterYear}{2021/22}
% Semester name
\newcommand{\cfgSemesterName}{Wintersemester \cfgSemesterYear}
% University course name
\newcommand{\cfgCourseName}{Wissenschaftliches Arbeiten}

15
dexes/acrodex.tex Normal file
View File

@ -0,0 +1,15 @@
%
% Abkürzungsverzeichnis
%
% This generates a headline that is linked in the TOC, but without a number
\addcontentsline{toc}{chapter}{Abkürzungsverzeichnis}
\chapter*{Abkürzungsverzeichnis}
\begin{acronym}
%
%
\acro{MDWR}[MDWR]{Michael Derek Werle Rutter}
\acroplural{MDWR}[MDWRs]{Michael Derek Werle Rutters}
%
%
\end{acronym}

8
dexes/bibdex.tex Normal file
View File

@ -0,0 +1,8 @@
%
% Literaturverzeichnis
%
\nocite{*} % Show all references, even unused ones
\bibliography{dexes/literature}
\bibliographystyle{apalike}

11
dexes/glossarydex.tex Normal file
View File

@ -0,0 +1,11 @@
%
% Glossar:
%
\chapter{Glossar}
\begin{description}
\item [Abschlusspunkt-Linientechnik] \hfill \\
\enquote{Am Abschlusspunkt-Linientechnik endet das vom Kabelverzweiger kommende Verzweigungskabel.} \cite{bib:vodafone-legt-in-pirmasens}
\end{description}

6
dexes/imagedex.tex Normal file
View File

@ -0,0 +1,6 @@
%
% Abbildungsverzeichnis
%
\addcontentsline{toc}{chapter}{\listfigurename}
\listoffigures

35
dexes/literature.bib Normal file
View File

@ -0,0 +1,35 @@
# Example Paper
# Note that authors are "and"-seperated. The comma is part of the name. Like in "Etienne, Leon".
# So if you have multiple authors, use "Peter and Werner and Mario and Johann"...
@article{bib:leossfc,
author = {Maral, Gérard and de Ridder, Jean-Jacques and Evans, Barry G. and Richharia, Madhavendra},
title = {Low earth orbit satellite systems for communications},
journal = {International Journal of Satellite Communications},
volume = {9},
number = {4},
pages = {209-225},
publisher = {Wiley Online Library},
doi = {https://doi.org/10.1002/sat.4600090403},
url = {https://onlinelibrary.wiley.com/doi/abs/10.1002/sat.4600090403},
eprint = {https://onlinelibrary.wiley.com/doi/pdf/10.1002/sat.4600090403},
abstract = {Abstract It may be that we are now entering the era of LEO constellation satellite communications after thirty years of domination by the GEO systems. This paper heralds the coming of the new era with a tutorial approach to the system design and trade-offs of LEO constellation system design. It discusses orbital configurations, network topologies and routeing considerations, multiple access schemes and link performance design. In so doing it brings out the major design parameters and how they interact with each other. Also considered are the service applications for the LEO constellation systems, and the important difference between real-time and delayed communication systems is highlighted. Examples of single and multi-beam (cellular) coverage system link designs are presented for L-Ka frequency bands. Future papers will consider aspects of the LEO spacecraft and launchers.},
year = {1991}
}
# Example Website
@misc{bib:vodafone-legt-in-pirmasens,
author = {Vodafone},
howpublished = "\url{https://www.vodafone.de/business/festnetz-internet/glasfaser-pirmasens.html}",
title = {{Wir haben Glasfaser in Pirmasens ausgebaut}},
year = {2021},
note = {Zugriff: November 2021}
}
# Example Lecture
@book{bib:schwarzer-vorlesung-swa,
author = {Volker Schwarzer},
title = {Vorlesung: Software Architektur},
year = {2021},
publisher = {Hochschule Worms},
}

6
dexes/tabledex.tex Normal file
View File

@ -0,0 +1,6 @@
%
% Inhaltsverzeichnis
%
\addcontentsline{toc}{chapter}{\listtablename}
\listoftables

5
dexes/tocdex.tex Normal file
View File

@ -0,0 +1,5 @@
%
% Inhaltsverzeichnis
%
\tableofcontents

38
environments.tex Normal file
View File

@ -0,0 +1,38 @@
%
% Custom environments
%
% Code frame
\DefineVerbatimEnvironment{code}{Verbatim}
{
tabsize=4,
samepage=true,
frame=lines,
numbers=left,
}
% Nonpagebreaking chapters
\newenvironment{npbrChap}
{
\begingroup
\let\clearpage\relax
}
{
\endgroup
}
% Nicely placed image environment
% Features:
% Margin-top
% placed exactly where it's put in the source code
% image and caption always stays on same page
\newenvironment{nicepic}
{
\begin{minipage}{\textwidth}
\vspace{7.5mm}
\begin{center}
}
{
\end{center}
\end{minipage}
}

14
footer.tex Normal file
View File

@ -0,0 +1,14 @@
%
% Ende des Dokumentes
%
% Bibliotheksverzeichnis
\input{dexes/bibdex}
% Clear special page geometry
\newgeometry{
a4paper
}
% Anhang
\input{appendix}

97
header.tex Normal file
View File

@ -0,0 +1,97 @@
%
% Project header
%
\documentclass[
12pt, % 12pt font size
pdftex, % we are just using pdf
a4paper, % a4 paper format
titlepage,% title has its own page
oneside, % single-page view
%twocolumn,% use two text columns
headsepline, % hr after headline
footsepline, % hr before footer,
bibliography=totoc, % Include literaturverzeichnis in inhaltsverzeichnis
listoftables=totoc,
ngerman, % it's a german document
%draft % create debug build. remove for release build
]{scrbook}
% Load project configuration
\input{config}
\parindent=0pt % disable paragraph indent
\usepackage{ngerman}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
% Paket um Grafiken im Dokument einbetten zu k<>nnen.
% Im PDF sind GIF, PNG, und PDF Grafiken m<>glich.
\usepackage{graphicx}
% caption setzt per default hypcap=true, sodass Sprungmarken im PDF-File nicht nur
% zu den Captions von Bildern springen, sondern an den oberen Rand der Bilder.
\usepackage{caption}
% Font 'Latin Modern Family' verwenden.
% Verwende dieses Paket wenn du DML selbst kompilierst.
\usepackage{lmodern}
% Tabellen
\usepackage{array}
% Mathematische Formeln
\usepackage{amsmath, amsthm, amssymb, mathtools}
% Deutsche Anführungszeichen
\usepackage[babel, german=quotes]{csquotes}
% Mehrere Bilder als eine Abbildung
\usepackage{subcaption}
% Seiten-bottom-padding
\usepackage[bottom=2.5cm]{geometry}
% Dashed lines
\usepackage{arydshln}
% Colored text
\usepackage{color}
% Custom title format
\usepackage{sectsty}
\allsectionsfont{\rmfamily}
\chaptertitlefont{\rmfamily\hspace*{0.5em}}
% Custom side marings
\usepackage{geometry}
% Zeilenabstand 1.5
\usepackage[onehalfspacing]{setspace}
% Tab-respecting code printing
\usepackage{fancyvrb}
% Abkürzungsverzeichnis
\usepackage{acronym}
% Appendix
\usepackage[toc,page]{appendix}
\renewcommand{\appendixname}{Anhang}
\renewcommand{\appendixtocname}{Anhang}
\renewcommand{\appendixpagename}{Anhang}
% Metadaten
\usepackage[pdftex,
pdfauthor={\cfgAuthorName},
pdftitle={\cfgDocTitle},
pdfsubject={\cfgDocSubTitle},
pdfproducer={Latex},
pdfcreator={pdflatex}]{hyperref}
% Load custom macros
\input{macros}
% Load custom environments
\input{environments}

BIN
images/mult0.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

BIN
images/mult1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

BIN
images/mult2.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
images/stars.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

12
macros.tex Normal file
View File

@ -0,0 +1,12 @@
%
% Custom macros
%
% Will encapsule a text in italic << >>
\newcommand{\enpointy}[1]{\emph{\textlangle\textlangle{#1}\textrangle\textrangle}}
% Will add a vertical line to tables
\newcommand{\tblVline}{\vline\hspace{2mm}}
% Will do a full reference, with both a number AND a caption. Like '1.2.3 Coding the code'
\newcommand{\fullref}[1]{\ref{#1} \nameref{#1}}

BIN
main.pdf Normal file

Binary file not shown.

50
main.tex Normal file
View File

@ -0,0 +1,50 @@
%
% Hauptdatei
%
\input{header}
\begin{document}
% Disable pagination, we'll re-enable it after the table of contents
\pagenumbering{gobble}
\input{chapters/title}
% Only apply this geometry after the title page.
% We don't want to have a right/bottom indent on the title page aswell.
\newgeometry{
a4paper,
right=50mm,
bottom=50mm
}
% Selbstständigkeitserklärung
\include{selbstständigkeitserklärung}
% Inhaltsverzeichnis
\include{dexes/tocdex}
\frontmatter % Begin document "header", paginated with roman numerals.
\pagenumbering{Roman} % Capitalized roman numerals plssss
% Abbildungsverzeichnis
\include{dexes/imagedex}
% Tabellenverzeichnis
\include{dexes/tabledex}
% Abkürzungsverzeichnis
\include{dexes/acrodex}
% Glossar
\include{dexes/glossarydex}
\mainmatter % Begin main part of document, paginated with arabic numerals
% Include all the chapters
\include{chapters}
% Include the footer
\input{footer}
\end{document}

28
readme.md Normal file
View File

@ -0,0 +1,28 @@
# LaTeX-Paper-template
> Note: When a path in this readme begins with `/`, it is relative to the project root.
This is a small framework/template/starting point for scientific LaTeX papers in german.
## To build the document:
1) `make`
## Nomenclature
* All your text should go into `/chapters/`.
* All your indices, such as acronyms, references, glossary entrys, if not generated automatically, should go into `/dexes/`
* All your appendix pages should go into `/appendix/`
See example files in these directories...
## Literature
Literature goes in `/dexes/literature.bib`. See examples in this file.
## LaTeX syntax
You'll find a basic LaTeX cheat sheet in`/chapters/foobar.tex`.
A way more extensive (but also deviating from this workflow) paper is `/abschlussarbeit_mit_latex.pdf`, which is targetted towards writing german scientific papers with LaTeX, with some weird IDE on windblows OS. So take that with a grain of salt.
# Other stuff worth noting
* All paths (like when referencing an image, or including a `.tex`) must always be relative to project root! (where the Makefile lies).
* Configure your projects base informations such as title, author, year, etc in `/config.tex`.
* When creating new chapters (files in `/chapters/`), you have to include them in `/chapters.tex`.
* When creating new appendix entries (files in `/appendix/`), you have to include them in `/appendix.tex`.

View File

@ -0,0 +1,20 @@
%
% Selbstständigkeitserklärung
%
\chapter*{Selbstständigkeitserklärung}
Hiermit erkläre ich, dass ich die vorliegende Arbeit selbstständig und ohne Benutzung anderer als der angegebenen Hilfsmittel angefertigt habe.
Alle Stellen, die wörtlich oder sinngemäß aus veröffentlichten und nicht veröffentlichten Schriften
entnommen wurden, sind als solche kenntlich gemacht. Die Arbeit ist noch nicht in
gleicher oder ähnlicher Form oder auszugsweise im Rahmen einer anderen Prüfung
vorgelegt worden.
\\
\\
\\
\hspace*{\fill}\cfgAuthorCity, \cfgDateLastModification
\\
\\
\\
\\
\hspace*{\fill}\cfgAuthorName\ \ \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_