diff --git a/bibliography.tex b/bibliography.tex deleted file mode 100644 index 9994303..0000000 --- a/bibliography.tex +++ /dev/null @@ -1,19 +0,0 @@ -% -% Quellenverzeichnis -% - -\begin{thebibliography}{defaultmarken} -% -% - \bibitem[Swe21]{bib:sicherheit-fuer-tcpip} { - \bibformat - {Wenzel, S., Wenzel, S.} % Author(s) - {IT-Sicherheit für TCP/IP- und IoT-Netzwerke} % Publication title - {Worms} % Publication city - {Springer Verlag} % Publisher - {2021} % Publication date - {} - } -% -% -\end{thebibliography} diff --git a/compile.sh b/compile.sh index 241fb74..5f9d33e 100755 --- a/compile.sh +++ b/compile.sh @@ -1,4 +1,5 @@ pdflatex -interaction errorstopmode -halt-on-error main.tex # Generate table of contents (ToC) +bibtex main.aux # Build bibliography 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 diff --git a/config.tex b/config.tex new file mode 100644 index 0000000..51b9c37 --- /dev/null +++ b/config.tex @@ -0,0 +1,56 @@ +% +% 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\_CHANE\_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} + +% Semester year +\newcommand{\cfgSemesterYear}{2021/22} + +% Semester name +\newcommand{\cfgSemesterName}{Wintersemester \cfgSemesterYear} + +% University course name +\newcommand{\cfgCourseName}{Wissenschaftliches Arbeiten} diff --git a/acrodex.tex b/dexes/acrodex.tex similarity index 100% rename from acrodex.tex rename to dexes/acrodex.tex diff --git a/dexes/bibdex.tex b/dexes/bibdex.tex new file mode 100644 index 0000000..eb3b97b --- /dev/null +++ b/dexes/bibdex.tex @@ -0,0 +1,8 @@ +% +% Literaturverzeichnis +% + +\nocite{*} % Show all references, even unused ones + +\bibliography{dexes/literature} +\bibliographystyle{apalike} diff --git a/dexes/glossarydex.tex b/dexes/glossarydex.tex new file mode 100644 index 0000000..9bba26a --- /dev/null +++ b/dexes/glossarydex.tex @@ -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} diff --git a/imagedex.tex b/dexes/imagedex.tex similarity index 100% rename from imagedex.tex rename to dexes/imagedex.tex diff --git a/dexes/literature.bib b/dexes/literature.bib new file mode 100644 index 0000000..4388625 --- /dev/null +++ b/dexes/literature.bib @@ -0,0 +1,24 @@ +# Example Paper +@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} +} diff --git a/tabledex.tex b/dexes/tabledex.tex similarity index 100% rename from tabledex.tex rename to dexes/tabledex.tex diff --git a/tocdex.tex b/dexes/tocdex.tex similarity index 100% rename from tocdex.tex rename to dexes/tocdex.tex diff --git a/environments.tex b/environments.tex index 9a341af..825fa60 100644 --- a/environments.tex +++ b/environments.tex @@ -20,3 +20,19 @@ { \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} +} diff --git a/flushcache.sh b/flushcache.sh index fc9e884..c809c43 100755 --- a/flushcache.sh +++ b/flushcache.sh @@ -1 +1 @@ -rm -f kapitel/*.aux *.aux *.lof *.log *.lot *.toc *.tps *.out *.fdb_latexmk *.fls *.synctex.gz +rm -f */*.aux *.aux *.lof *.log *.lot *.toc *.tps *.out *.fdb_latexmk *.fls *.bbl *.blg diff --git a/footer.tex b/footer.tex index 07bde81..39267ee 100644 --- a/footer.tex +++ b/footer.tex @@ -3,4 +3,4 @@ % % Bibliotheksverzeichnis -\input{bibliography} +\input{dexes/bibdex} diff --git a/header.tex b/header.tex index f4957a1..89a766c 100644 --- a/header.tex +++ b/header.tex @@ -17,6 +17,9 @@ 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} @@ -35,14 +38,13 @@ ngerman, % it's a german document % Verwende dieses Paket wenn du DML selbst kompilierst. \usepackage{lmodern} -% Tables +% Tabellen \usepackage{array} -\usepackage{tabularx} % Mathematische Formeln \usepackage{amsmath, amsthm, amssymb, mathtools} -% Deutsche Anf�hrungszeichen +% Deutsche Anführungszeichen \usepackage[babel, german=quotes]{csquotes} % Mehrere Bilder als eine Abbildung @@ -62,6 +64,12 @@ ngerman, % it's a german document \allsectionsfont{\rmfamily} \chaptertitlefont{\rmfamily\hspace*{0.5em}} +% Custom side marings +\usepackage{geometry} + +% Zeilenabstand 1.5 +\usepackage[onehalfspacing]{setspace} + % Tab-respecting code printing \usepackage{fancyvrb} @@ -70,9 +78,9 @@ ngerman, % it's a german document % Metadaten \usepackage[pdftex, - pdfauthor={Friedrich Gross, Leon Etienne}, - pdftitle={Exposé Smartes Dorf - Glasfaserverlegung}, - pdfsubject={Exposé Smartes Dorf - Glasfaserverlegung}, + pdfauthor={\cfgAuthorName}, + pdftitle={\cfgDocTitle}, + pdfsubject={\cfgDocSubTitle}, pdfproducer={Latex}, pdfcreator={pdflatex}]{hyperref} diff --git a/images/mult0.jpg b/images/mult0.jpg new file mode 100644 index 0000000..3e9195c Binary files /dev/null and b/images/mult0.jpg differ diff --git a/images/mult1.png b/images/mult1.png new file mode 100644 index 0000000..4f49c55 Binary files /dev/null and b/images/mult1.png differ diff --git a/images/mult2.jpg b/images/mult2.jpg new file mode 100644 index 0000000..b61167d Binary files /dev/null and b/images/mult2.jpg differ diff --git a/images/stars.jpg b/images/stars.jpg new file mode 100644 index 0000000..46be356 Binary files /dev/null and b/images/stars.jpg differ diff --git a/kapitel/foobar.tex b/kapitel/foobar.tex index cf7068a..ff9b1bc 100644 --- a/kapitel/foobar.tex +++ b/kapitel/foobar.tex @@ -3,4 +3,68 @@ % \chapter{Foobar} -Wer testet, der questet\cite{bib:sicherheit-fuer-tcpip}. \ No newline at end of file +Wer testet, der questet.\cite{bib:vodafone-legt-in-pirmasens} + + +% Figure +\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} + +% Multifigure +\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} + +% Table +\begin{table}[!htbp] % !htbp soll wohl das Objekt möglichst nah zum Text-punkt halten + \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{Renderzeiten mit TM-Prozessoren} + \label{tbl:renderzeiten_tm_processors} +\end{table} diff --git a/kapitel/titel.tex b/kapitel/titel.tex deleted file mode 100644 index f43ae58..0000000 --- a/kapitel/titel.tex +++ /dev/null @@ -1,24 +0,0 @@ -% -% Title page -% - -\begin{titlepage} - \begin{center} - \Huge - Exposé - Das smarte Dorf \\ - \vspace{5mm} - \normalsize - Verlegung von Glasfaserkabeln zur alten Schule\\ - \vspace{1cm} - \large - Version 0.5dev\\ - \vspace {2 cm } - Friedrich Gross \enpointy{idk@hs-worms.de}\\ - Leon Etienne \enpointy{leon@etiennes.de}\\ - \vspace{1em} - i.A. Prof. Dr. Michael Derek Werle Rutter \enpointy{rutter@hs-worms.de} - \end{center} - \normalsize - \vfill - Copyright ( c ) 2022 Friedrich Gross, Leon Etienne. -\end{titlepage} diff --git a/kapitel/title.tex b/kapitel/title.tex new file mode 100644 index 0000000..5ead843 --- /dev/null +++ b/kapitel/title.tex @@ -0,0 +1,33 @@ +% +% 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\\ + +\end{titlepage} diff --git a/macros.tex b/macros.tex index b3b1983..73c0872 100644 --- a/macros.tex +++ b/macros.tex @@ -10,13 +10,3 @@ % 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}} - -% Bibliography formatting -% #1 -> authors -% #2 -> title -% #3 -> publishing city -% #4 -> publisher -% #5 -> year of release -\newcommand{\bibformat}[5] { - #1: \textit{#2}. #3: #4, #5 -} diff --git a/main.pdf b/main.pdf index be67b98..1a37e76 100644 Binary files a/main.pdf and b/main.pdf differ diff --git a/main.tex b/main.tex index 4f133c5..a48267a 100644 --- a/main.tex +++ b/main.tex @@ -9,23 +9,36 @@ % Disable pagination, we'll re-enable it after the table of contents \pagenumbering{gobble} -\input{kapitel/titel} -\input{kapitel/selbstständigkeitserklärung} +\input{kapitel/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{tocdex} +\include{dexes/tocdex} \frontmatter % Begin document "header", paginated with roman numerals. \pagenumbering{Roman} % Capitalized roman numerals plssss % Abbildungsverzeichnis -\include{imagedex} +\include{dexes/imagedex} % Tabellenverzeichnis -\include{tabledex} +\include{dexes/tabledex} % Abkürzungsverzeichnis -\include{acrodex} +\include{dexes/acrodex} + +% Glossar +\include{dexes/glossarydex} \mainmatter % Begin main part of document, paginated with arabic numerals diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..a54940b --- /dev/null +++ b/readme.md @@ -0,0 +1,10 @@ +## To build the document: +1) `./compile.sh`, duh. Depends on pdflatex, bibtex, and miktex + +## Nomenclature +* All your text should go into `kapitel/`. +* All your indices, such as acronyms, references, glossary entrys, if not generated automatically, should go into `dexes/` + +# Other stuff worth noting +* All paths must be relative to project root! (where `compile.sh` lies). +* Configure your projects base informations such as title, author, year, etc in `config.tex`. \ No newline at end of file diff --git a/kapitel/selbstständigkeitserklärung.tex b/selbstständigkeitserklärung.tex similarity index 50% rename from kapitel/selbstständigkeitserklärung.tex rename to selbstständigkeitserklärung.tex index 8b9bb32..c920360 100644 --- a/kapitel/selbstständigkeitserklärung.tex +++ b/selbstständigkeitserklärung.tex @@ -4,7 +4,7 @@ \chapter*{Selbstständigkeitserklärung} -Hiermit erklären wir, dass wir die vorliegende Arbeit selbstständig und ohne Benutzung anderer als der angegebenen Hilfsmittel angefertigt haben. +Hiermit erkläre ich, dass ich die vorliegende Arbeit selbstständig und ohne Benutzung anderer als der angegebenen Hilfsmittel angefertigt haben. 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 @@ -12,14 +12,9 @@ vorgelegt worden. \\ \\ \\ -\hspace*{\fill}Ludwigshafen am Rhein, den 15. November 2021 +\hspace*{\fill}\cfgAuthorCity, \cfgDateLastModification \\ \\ \\ \\ -\hspace*{\fill}Friedrich Gross\ \ \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ -\\ -\\ -\\ -\\ -\hspace*{\fill}Leon Etienne\ \ \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ +\hspace*{\fill}\cfgAuthorName\ \ \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_