Getting Started hinzugefügt

document/appendix/appendix.tex

 \chapter{Abbildungen}
-\label{abbildungen_tabellen}
+\label{abbildungen}
 \input{abbildungen}
 
+\chapter{Tabellen}
+\label{tabellen}
+\input{tabellen}
+
 \chapter{Zusätzliche Dokumente}
 \label{dokumente}
 \input{dokumente}
 
 \chapter{Digitaler Anhang}
-\label{digitaler_datenträger}
+\label{digitaler_datentraeger}
 \input{digitaler_anhang}

document/appendix/tabellen.tex

+Hier können Sie Tabellen anfügen, die für das Verständnis der Arbeit nicht zwingend notwendig sind und/oder einen gewissen Umfang überschreiten.
+
+\newpage

document/body_text/Beispielinhalte/beispielinhalte.tex

+Dieses Kapitel zeigt beispielhaft den Aufbau des Hauptteils einer wissenschaftlichen Arbeit und mögliche Inhalte der einzelnen Abschnitte. Zudem demonstriert das Kapitel die Einbindung von Zitaten, Abbildungen, Tabellen und Abkürzungen.
+
+\section{Einleitung}
+\label{einleitung}
+\input{einleitung}
+
+\section{Stand der Wissenschaft}
+
+\section{Problemstellung und Lösungsansatz}
+
+\section{Implementierung des Lösungsansatzes}
+
+\section{Validierung}
+\label{validierung}
+\input{validierung}
+
+\section{Untersuchungen und Ergebnisse}
+\label{ergebnisse}
+\input{ergebnisse}
+
+\section{Diskussion und Ausblick}
+\label{diskussion}
+\input{diskussion}
\ No newline at end of file

document/body_text/body_text.tex

@@ -8,27 +8,6 @@
 
 
 \chapter{Beispielinhalte}
+\label{beispielinhalte}
+\subimport{/beispielinhalte}{beispielinhalte}
 
-Dieses Kapitel zeigt beispielhaft den Aufbau des Hauptteils einer wissenschaftlichen Arbeit und mögliche Inhalte der einzelnen Abschnitte. Zudem demonstriert das Kapitel die Einbindung von Zitaten, Abbildungen, Tabellen und Abkürzungen.
-
-\section{Einleitung}
-\label{einleitung}
-\input{Beispielinhalte/einleitung}
-
-\section{Stand der Wissenschaft}
-
-\section{Problemstellung und Lösungsansatz}
-
-\section{Implementierung des Lösungsansatzes}
-
-\section{Validierung}
-\label{validierung}
-\input{Beispielinhalte/validierung}
-
-\section{Untersuchungen und Ergebnisse}
-\label{ergebnisse}
-\input{Beispielinhalte/ergebnisse}
-
-\section{Diskussion und Ausblick}
-\label{diskussion}
-\input{Beispielinhalte/diskussion}
\ No newline at end of file

document/body_text/nutzung.tex

 Dieses Kapitel beschreibt den Aufbau und die Nutzung dieser LaTeX-Vorlage. Die Vorlage basiert auf dem TUD-Script-Bundle \emph{tudscr} zur Erstellung von Dokumenten im Corporate Design der TU Dresden. Weiterführende Nutzungshinweise sind daher im Handbuch dieses Bundles zu finden \parencite{hanisch2022}.
 
+\section{Getting Started}
+
+\subsection{Online Schreiben mit Overleaf}
+Das ZIH bietet Ihnen die Möglichkeit, Ihr LaTeX-Projekt online zu schreiben und zu kompilieren. Dafür wird Ihnen eine \href{https://tex.zih.tu-dresden.de/}{Overleaf-Instanz} bereitgestellt. Ihr Projekt können Sie direkt aus dieser Vorlage erstellen, indem Sie \href{https://gitlab.hrz.tu-chemnitz.de/vibe460a--tu-dresden.de/latex-vorlage-fuer-wissenschaftliche-arbeiten-an-der-professur-fuer-technische-logistik/-/archive/main/latex-vorlage-fuer-wissenschaftliche-arbeiten-an-der-professur-fuer-technische-logistik-main.zip}{das Verzeichnis der Vorlage als .zip}  herunterladen und dieses in Overleaf über \emph{New Project} > \emph{Upload Project} hochladen.
+
+\subsection{Lokal Schreiben}
+Um auf Ihrem lokalen Rechner schreiben zu können, benötigen Sie TeX und einen Texteditor Ihrer Wahl. \href{https://www.tug.org/texlive/}{TeX Live} bietet eine einfache Möglichkeit, TeX zu installieren. Bei der Wahl des Texteditors sollten Sie darauf achten, dass dieser LaTeX-Quelltext \emph{versteht} und idealerweise direkt einen Kompiliervorgang anstoßen kann.
+
+\subsubsection{Versionierung mittels git}
+Zur Sicherung Ihres Fortschritts empfiehlt sich die Nutzung eines Versionierungssystems.
+Zur Versionierung und Verwaltung von Code hat sich \emph{git} bewährt.
+LaTeX ist hervorragend für die Nutzung von git geeignet, da ihre Arbeit in LaTeX hauptsächlich aus Textfiles besteht (mit Ausnahme von eingebundenen Abbildungen oder Dokumenten).
+Zu beachten ist lediglich, dass git rein zeilenbasiert arbeitet - ändern Sie einen Teil eines Absatzes, markiert git die ganze Zeile als geändert.
+Dies können Sie umgehen, indem Sie in Ihrem LaTeX-Quellcode häufiger neue Zeilen beginnen, bspw. nach jedem Satz.
+LaTeX wird erst einen neuen Absatz beginnen, wenn Sie eine \emph{Leerzeile} einfügen, während einfache Zeilenumbrüche ignoriert werden.
+
 \section{Ordnerstruktur der Vorlage}
+Der Quelltext der Vorlage ist modular organisiert, um auch bei Arbeiten mit großem Umfang die Übersichtlichkeit zu wahren. Alle Quellfiles laufen in der obersten Ebene der Ordnerstruktur in der LaTeX-Datei \verb+main.tex+ zusammen. Diese Datei brauchen Sie in der Regel nicht zu verändern, es ist jedoch die Datei, die Sie kompilieren. Bei Overleaf ist dies voreingestellt. Das kompilierte Dokument wird als PDF-Datei ebenfalls in die oberste Hierarchieebene abgelegt (\verb+main.pdf+). Als letzte Datei in dieser Ebene finden Sie die \verb+literatur.bib+. Darin speichern Sie die Daten zu Ihren Quellen. Die Datei können Sie bei kleineren Arbeiten händisch ergänzen, bei umfangreicheren Literaturverzeichnissen empfiehlt sich die Verwendung einer Literaturverwaltung. Einen Überblick über gängige Software dazu sowie deren Vor- und Nachteile \href{https://slub.qucosa.de/api/qucosa%3A23381/attachment/ATT-0/}{liefert die SLUB} \parencite{slub}.
 
-\section{Anpassung der Vorlage für Ihre Arbeit}
+Im Ordner \verb+graphics+ legen Sie Ihre Abbildungen ab, die Sie in die Arbeit einbinden möchten. Der Ordner \verb+enclosed_documents+ enthält Dokumente, die sie in die Arbeit einfügen. Dies betrifft zumindest die Aufgabenstellung - ersetzen Sie die dort vorhandene Datei mit Ihrer Aufgabenstellung.
 
-\subsection{Verfassen der Arbeit in Englisch}
-Wenn Sie die Arbeit in englischer Sprache schreiben möchten, ändern Sie die erste Zeile der Dateien \verb+main.tex+ sowie \verb+latex_preamble/packages.tex+ entsprechend der dort hinterlegten Anweisungen. Außerdem entfällt die Übersetzung des Abstract.
+Der Kern Ihrer Arbeit befindet sich im Ordner \verb+document+. Der Ordner gliedert sich wie auch Ihre Arbeit in den Frontteil (\verb+front_matter+), den Hauptteil (\verb+body_text+) sowie den Anhang (\verb+appendix+). Im Frontteil legen Sie den Titel Ihrer Arbeit bzw. die Inhalte der Titelseite fest (\verb+title.tex+), definieren Ihre Abkürzungen (\verb+acronyms.tex+) und schreiben Ihr Abstract (\verb+abstract.tex+) sowie ggf. eine Vorbemerkung (\verb+vorbemerkung.tex+). Sollten Sie Ihre Arbeit in einem Unternehmen schreiben und dieses einen Sperrvermerk wünschen, so legen Sie dessen Parameter in \verb+declarations.tex+ fest. Benötigen Sie keinen Sperrvermerk, entfernen Sie diesen dort.
 
-\subsection{Daten zur Arbeit}
+Dem Hauptteil der Arbeit fügen Sie neue Kapitel hinzu, indem Sie für diese eine neue \verb+.tex+-Datei anlegen und diese in \verb+body_text.tex+ referenzieren. Gleiches gilt für den Anhang mit \verb+appendix.tex+.
 
-\subsection{Kapitelstruktur}
+\section{Verfassen der Arbeit in Englisch}
+Wenn Sie die Arbeit in englischer Sprache schreiben möchten, ändern Sie die erste Zeile der Dateien \verb+main.tex+ sowie \verb+latex_preamble/packages.tex+ entsprechend der dort hinterlegten Anweisungen. Außerdem entfällt die Übersetzung des Abstract.
 
-\subsection{Quellenangaben}
+\section{Quellenangaben}
 Sie sollen gemäß ISO 690 zitieren. Diese erlaubt mehrere Referenzstile. In der Datei latex\_preamble/packages.tex in Zeile 12 lassen sich der Harvard-Stil (Author Year) über style=iso-authoryear oder der numerische Verweis [1] auswählen. Die Befehle zur Einbindung von Zitaten unterscheiden sich hierbei:
 \begin{itemize}
    \item Bei Verwendung von Verweisen im Harvard-Stil nutzen Sie
@@ -21,9 +38,4 @@ Sie sollen gemäß ISO 690 zitieren. Diese erlaubt mehrere Referenzstile. In der
       \item den Befehl  \verb|\parencite|, wenn Sie den Namensteil der Referenz nicht im Textfluss einbauen können: \\ \textit{...gehören zu den Stetigförderern (Schmidt et~al., 2021).}
    \end{itemize}
    \item Bei Verwendung von numerischen Verweisen nutzen Sie ausschließlich den Befehl \verb|\cite|
-\end{itemize}
-\section{Einfügen von Dokumenten}
-\label{sec:docs}
-
-\section{Einfügen von Grafiken}
-\label{sec:graphics}
\ No newline at end of file
+\end{itemize}
\ No newline at end of file

document/body_text/prozess.tex

@@ -27,13 +27,13 @@
 \item Zeichnungsoriginale, deren Formate größer als A4 sind, müssen, soweit nicht entsprechend faltbar, gesondert als Rolle eingereicht werden. Die Zeichnungen sind dabei eindeutig als Anlage der Arbeit zu beschriften.
 \item Von Unikaten sind allen Ausfertigungen der Arbeit Kopien (Ausdrucke, Fotos u.ä.) beizufügen.
 \item Gegenständliche Ergebnisse der Arbeit (Materialproben, Muster, Modelle) sind so zu übergeben, dass eine eindeutige Zuordnung der Objekte zu den Beschreibungen in der Arbeit auch nachträglich möglich ist.
-\item Softwareprodukte, die Ergebnis der Beleg- oder Diplomarbeit sind, werden als digitaler Anhang mit folgendenden :
+\item Softwareprodukte, die Ergebnis der Beleg- oder Diplomarbeit sind, werden als digitaler Anhang mit folgenden Bestandteilen abgegeben:
    \begin{itemize}
-\item das lauffähige Programm
-\item die Quelltextfiles, 
+\item die Quelltextfiles 
 \item ein Ein- und Ausgabenbeispiel
-\item die Benutzerdokumentation
-\item ein Angaben zum verwendeten Betriebssystem, der Programmiersprache und Compilerversion sowie die Versionen der verwendeten Bibliotheken
+\item die Ddokumentation
+\item Angaben zum verwendeten Betriebssystem, der Programmiersprache und Compilerversion sowie die Versionen der verwendeten Bibliotheken (zB für Python-Projekte das \emph{requirements.txt})
+\item ggf. das lauffähige Programm
    \end{itemize}
 \item Bei Verweis auf Webseiten bzw. downloadfähige Dokumente sollte der verwendete Stand der Daten mit auf dem Datenträger zur Arbeit abgegeben werden.
 \end{enumerate}

document/front_matter/sperrvermerk.tex → document/front_matter/declarations.tex

+% Eidesstattliche Erklärung 
+\confirmation
+
+% Sperrvermerk (optional, wenn nicht benötigt löschen)
+\company{Elbe-Spedition Else Spahn GmbH} % Firma, deren Daten geschützt werden sollen
+\newcommand{\ablaufdatumsperrvermerk}{31. Juni 2027} % Ablauf des Sperrvermerks, max. 5 Jahre nach Abgabedatum
+
+
+\nextdeclaration{Sperrvermerk}{
 Diese Arbeit basiert auf vertraulichen, internen Daten der Firma \textit{\getfield{company}} und darf aus diesem Grund ohne Zustimmung des Verfassers und der Firma \textit{\getfield{company}} nicht von Dritten – mit Ausnahme der wissenschaftlichen Betreuer bzw. der damit beauftragten wissenschaftlichen Mitarbeiter im Prüfungsverfahren, den Prüfern, den Mitgliedern des Prüfungsausschusses sowie den mit der Abwicklung des Prüfungsverfahrens befassten Hochschulbediensteten und im Falle einer rechtlichen Auseinandersetzung dem Justitiariat der TU Dresden, damit befassten Rechtsanwälten, Gutachtern und Gerichten – eingesehen werden.
 \vspace{0.5em} \\
-Dieser Sperrvermerk endet am \ablaufdatumsperrvermerk.
\ No newline at end of file
+Dieser Sperrvermerk endet am \ablaufdatumsperrvermerk.
+}
\ No newline at end of file

document/front_matter/front_matter.tex

@@ -13,13 +13,7 @@
 \end{abstract}
 
 \begin{declarations}
-    % Eidesstattliche Erklärung 
-    \confirmation
-    
-    % Sperrvermerk (optional, wenn nicht benötigt auskommentieren/löschen)
-    \company{Elbe-Spedition Else Spahn GmbH} % Firma, deren Daten geschützt werden sollen
-    \newcommand{\ablaufdatumsperrvermerk}{31. Juni 2027} % Ablauf des Sperrvermerks, max. 5 Jahre nach Abgabedatum
-    \nextdeclaration{Sperrvermerk}{\input{sperrvermerk}}
+    \input{declarations}
 \end{declarations}
 
 \tableofcontents

latex_preamble/config.tex

-\renewcommand{\newunitpunct}{, }
-\renewcaptionname{ngerman}{\chairmanname}{Studienrichtungsleiter}
-\renewcaptionname{ngerman}{\objectivesname}{Zielsetzung der Arbeit}
-\renewcaptionname{ngerman}{\abstractname}{Zusammenfassung}
-\renewcaptionname{ngerman}{\confirmationname}{Eidesstattliche Erklärung}
-\TUDoptions{cdhead=nocolor}
\ No newline at end of file

latex_preamble/packages.tex

-\usepackage[english, main=ngerman]{babel} % for English use [english]{babel}
-\usepackage[math]{blindtext}
-\usepackage[utf8]{inputenc}
-\usepackage{tudscrsupervisor}
-\usepackage{appendix}
-\usepackage{amsmath}
-\usepackage{acro}
-\input{document/front_matter/acronyms}
-\usepackage{booktabs}
-\usepackage{glossaries}
-\usepackage{blindtext}
-\usepackage[backend=biber, style=iso-authoryear, maxbibnames=4, maxcitenames=1, uniquelist=false]{biblatex}
-% die ISO 690 erlaubt mehrere Referenzstile. Hier lassen sich der Harvard-Stil (Author Year) über style=iso-authoryear oder der numerische Verweis (1) über style=iso-numeric nutzen
-\addbibresource{literatur.bib}
-   \apptocmd{\UrlBreaks}{\do\f\do\m}{}{} % Zur Trennung von URLs
-   \setcounter{biburllcpenalty}{9000}% Kleinbuchstaben
-   \setcounter{biburlucpenalty}{9000}% Großbuchstaben
-\usepackage{csquotes}
-\usepackage{enumitem}
-\usepackage{setspace}
-%\usepackage[colorlinks=true,linkcolor=cyan]{hyperref}
-\usepackage{hyperref}
-\usepackage{pdfpages}
-\usepackage{microtype} % optimierte Typografie (Silbentrennung, Satzspiegel etc.)
-\usepackage{multirow}
-\usepackage{tabularx}
-\usepackage{svg}
-\usepackage{fancyvrb}
-\usepackage{import}
-\usepackage{xcolor}
\ No newline at end of file

literatur.bib

@@ -24,6 +24,13 @@
   TITLE = {Bundesanzeiger},
 }
 
+@MISC{slub,
+  AUTHOR = {{SLUB Dresden}},
+  URL = {https://nbn-resolving.org/urn:nbn:de:bsz:14-qucosa2-77350},
+  DATE = {2018},
+  TITLE = {Literaturverwaltungsprogramme im Überblick},
+}
+
 @BOOK{Chatfield2019,
   AUTHOR = {Chatfield, Chris and Xing, Haipeng},
   PUBLISHER = {Chapman and Hall/{CRC}},

main.tex

 \documentclass[ngerman, fontsize=12pt, numbers=noenddot, headheight=19pt, footheight=19pt]{tudscrreprt} % for English use 'english' instead of 'ngerman'
 
-
 \iftutex
     \usepackage{fontspec}
 \else
@@ -8,8 +7,43 @@
     \usepackage{hyphsubst}
 \fi
 
-\input{latex_preamble/packages}
-\input{latex_preamble/config}
+\usepackage[english, main=ngerman]{babel} % for English use [english]{babel}
+\usepackage[math]{blindtext}
+\usepackage[utf8]{inputenc}
+\usepackage{tudscrsupervisor}
+\usepackage{appendix}
+\usepackage{amsmath}
+\usepackage{acro}
+\input{document/front_matter/acronyms}
+\usepackage{booktabs}
+\usepackage{glossaries}
+\usepackage{blindtext}
+\usepackage[backend=biber, style=iso-authoryear, maxbibnames=4, maxcitenames=1, uniquelist=false]{biblatex}
+% die ISO 690 erlaubt mehrere Referenzstile. Hier lassen sich der Harvard-Stil (Author Year) über style=iso-authoryear oder der numerische Verweis (1) über style=iso-numeric nutzen
+\addbibresource{literatur.bib}
+   \apptocmd{\UrlBreaks}{\do\f\do\m}{}{} % Zur Trennung von URLs
+   \setcounter{biburllcpenalty}{9000}% Kleinbuchstaben
+   \setcounter{biburlucpenalty}{9000}% Großbuchstaben
+\usepackage{csquotes}
+\usepackage{enumitem}
+\usepackage{setspace}
+%\usepackage[colorlinks=true,linkcolor=cyan]{hyperref}
+\usepackage{hyperref}
+\usepackage{pdfpages}
+\usepackage{microtype} % optimierte Typografie (Silbentrennung, Satzspiegel etc.)
+\usepackage{multirow}
+\usepackage{tabularx}
+\usepackage{svg}
+\usepackage{fancyvrb}
+\usepackage{import}
+\usepackage{xcolor}
+
+\renewcommand{\newunitpunct}{, }
+\renewcaptionname{ngerman}{\chairmanname}{Studienrichtungsleiter}
+\renewcaptionname{ngerman}{\objectivesname}{Zielsetzung der Arbeit}
+\renewcaptionname{ngerman}{\abstractname}{Zusammenfassung}
+\renewcaptionname{ngerman}{\confirmationname}{Eidesstattliche Erklärung}
+\TUDoptions{cdhead=nocolor}
 
 \begin{document}