Merge branch 'musabe24'

This commit is contained in:
2024-04-26 10:03:01 +02:00
22 changed files with 365 additions and 80 deletions

16
.gitignore vendored
View File

@@ -4,3 +4,19 @@
*.fls
*.log
*.synctex.gz
*.toc
*.out
*blx.bib
*.bbl
*.bcf
*.blg
*.run.xml
*.lof
*.lot
*.sub
*.suc
*.syc
*.sym
*.frm
*.nlo
*.equ

116
Readme.md
View File

@@ -2,83 +2,81 @@
## Vorgaben der DHBW Stuttgart Campus Horb an die Dokumentation
- [X] formaler Aufbau (S. 222)
- Seitennummerierung
- [] Deckblatt ohne Seitennummer
- [] Seitennummerierung ab Sperrvermerk mit römischen Zahlen, Beginn mit Seite II
- [] Seitennummerierung ab dem Textteil mit arabischen Zahlen, Beginn mit Seite 1
- [X] Deckblatt ohne Seitennummer
- [X] Seitennummerierung ab Sperrvermerk mit römischen Zahlen, Beginn mit Seite II
- [X] Seitennummerierung ab dem Textteil mit arabischen Zahlen, Beginn mit Seite 1
- Konformität mit der DIN 1421
- [] Eine mehr als dreistellige Untergliederung sollte vermieden werden
- [X] Eine mehr als dreistellige Untergliederung sollte vermieden werden
- Anhang
- [] fortlaufende Nummerierung wählen
- [] Kapitelnummerierung des Anhangs separat kennzeichnen
- [X] fortlaufende Nummerierung wählen
- [X] Kapitelnummerierung des Anhangs separat kennzeichnen
- z.B. Nummerierung einzelner Kapitel des Anhangs mit A, B, C und Unterkapitel mit A1, A2, ..., B1
- Abkürzungen
- [] Alle Abkürzungen bei der ersten Verwendung einmal ausschreiben und ggf. erläutern.
- [] Zuerst die Abkürzung schreiben und dann in Klammer dahinter die ausgeschriebene Variante
- [X] Alle Abkürzungen bei der ersten Verwendung einmal ausschreiben und ggf. erläutern.
- [X] Zuerst die Abkürzung schreiben und dann in Klammer dahinter die ausgeschriebene Variante
- Abbildungsverzeichnis
- [] Nummerierung der Abbildung erfolgt in der Reihenfolge des Auftretens im Text
- [] In gleicher Reihenfolge werden Abbildungen im Abbildungsverzeichnis aufgeführt
- [X] Nummerierung der Abbildung erfolgt in der Reihenfolge des Auftretens im Text
- [X] In gleicher Reihenfolge werden Abbildungen im Abbildungsverzeichnis aufgeführt
- weitere Verzeichnisse
- [] Wie beim Abbildungsverzeichnis auch
- [] Ideal: Seitenzahlen, auf denen der Verzeichnisinhalt auftritt, ins Verzeichnis aufnehmen
- [] Sachindex: Alphabetisch angeordnete Stichworte mit Seitenverweis auf das Auftreten im Text
- [X] Wie beim Abbildungsverzeichnis auch
- [X] Ideal: Seitenzahlen, auf denen der Verzeichnisinhalt auftritt, ins Verzeichnis aufnehmen
- Äußere Form
- [] Blätter nur einseitig beschreiben
- [X] Blätter nur einseitig beschreiben
- [x] Schriftgröße 12 Punkte
- [] Je Zeile ca. 70 Anschläge
- [X] Je Zeile ca. 70 Anschläge
- [x] Randabstand allseits mindestens 2,5 cm
- [x] Zeilenabstand 1,5
- [x] Schriftart: serifenbehaftet
- [] Einleitung beginnt auf Seite 1
- [] Verschiedene Ebenen (Überschriften) durch unterschiedliches Format kennzeichnen
- [] Keine halb leeren Seiten im Hauptteil
- [X] Einleitung beginnt auf Seite 1
- [X] Verschiedene Ebenen (Überschriften) durch unterschiedliches Format kennzeichnen
- [X] Keine halb leeren Seiten im Hauptteil
- Kopf- und Fußzeilen
- [] nur sinnvolle Daten aufnehmen
- [] nicht überfrachten
- [X] nur sinnvolle Daten aufnehmen
- [X] nicht überfrachten
- Fußnoten
- [] sparsam verwenden
- [X] sparsam verwenden
- Layout und Format
- [] schlichtes und übersichtliches Layout
- [] Layout durchgängig beibehalten
- [] Formatvorlagen für jede Formatierung
- [] Verzeichnisse automatisch erstellen lassen
- [] Für Titelblatt und Erklärung zur Eigenleistung die DHBW-Vorlage verwenden (Seite 255)
- [] von außen sichtbare Kennzeichnung von Arbeiten mit Sperrvermerk: roter Punkt mit Durchmesser von ca. 5 bis 15 mm auf das Deckblatt, Position rechts oben oder rechts unten
- [] Abbildungen, Tabellen, etc... linksbündig oder mittig platzieren
- [] Auf Abbildungen vorher im Text verweisen
- [] Nummerierung von Abbildungen entweder Kapitelweise oder durchgängig
- [] Objekte mit aussagekräftigen Bilduntertiteln versehen
- [] Bildquellen immer mit angeben
- [] Diagramme immer mit Achsenbeschriftung versehen (Zahlenwerte, Einheiten, Bedeutung der Achse)
- [X] schlichtes und übersichtliches Layout
- [X] Layout durchgängig beibehalten
- [X] Formatvorlagen für jede Formatierung
- [X] Verzeichnisse automatisch erstellen lassen
- [X] Für Titelblatt und Erklärung zur Eigenleistung die DHBW-Vorlage verwenden (Seite 255)
- [X] von außen sichtbare Kennzeichnung von Arbeiten mit Sperrvermerk: roter Punkt mit Durchmesser von ca. 5 bis 15 mm auf das Deckblatt, Position rechts oben oder rechts unten
- [X] Abbildungen, Tabellen, etc... linksbündig oder mittig platzieren
- [X] Auf Abbildungen vorher im Text verweisen
- [X] Nummerierung von Abbildungen entweder Kapitelweise oder durchgängig
- [X] Objekte mit aussagekräftigen Bilduntertiteln versehen
- [X] Bildquellen immer mit angeben
- [X] Diagramme immer mit Achsenbeschriftung versehen (Zahlenwerte, Einheiten, Bedeutung der Achse)
- Zahlen und Ziffern
- [] Alle natürlichen Zahlen kleiner als 13 werden als Zahlwörter (Numerale) geschrieben
- [] Zahlwörter schreibt man klein
- [] "Runde Zahlen" werden oft als Wörter geschrieben: z.B. fünfzig, hundert
- [] Werden in einem Satz Zahlen größer und kleiner als zwölf verwendet, werden alle in Ziffern geschrieben
- [] In Kombination mit Einheiten wird die Ziffernform verwendet
- [] Beim Aufzählen immer die Ziffernform verwenden
- [] Komma als Dezimaltrennzeichen (In Deutschen Texten)
- [] Wenn mehr als vier Stellen vor dem Komma, dann in Dreiergruppen zusammenfassen: z.B. 31 247,49 €.
- [] Konform mit den Normen DIN 1304, DIN 1338, DIN 461
- [X] Alle natürlichen Zahlen kleiner als 13 werden als Zahlwörter (Numerale) geschrieben
- [X] Zahlwörter schreibt man klein
- [X] "Runde Zahlen" werden oft als Wörter geschrieben: z.B. fünfzig, hundert
- [X] Werden in einem Satz Zahlen größer und kleiner als zwölf verwendet, werden alle in Ziffern geschrieben
- [X] In Kombination mit Einheiten wird die Ziffernform verwendet
- [X] Beim Aufzählen immer die Ziffernform verwenden
- [X] Komma als Dezimaltrennzeichen (In Deutschen Texten)
- [X] Wenn mehr als vier Stellen vor dem Komma, dann in Dreiergruppen zusammenfassen: z.B. 31 247,49 €.
- [X] Konform mit den Normen DIN 1304, DIN 1338, DIN 461
- Größen und Einheiten
- [] Folgendes wird kursiv geschrieben: Physikalische Größen, Variablen, Funktions- und Operatorzeichen deren Bedeutung frei gewählt werden kann
- [] Folgendes wird in steilschrift geschrieben: Einheiten und ihre Vorsätze, Zahlen, Funktions- und Operatorzeichen mit feststehender Bedeutung, Chemische Elemente und Verbindungen
- [] Maßzahl und Einheitenzeichen immer mit Leerzeichen trennen
- [X] Folgendes wird kursiv geschrieben: Physikalische Größen, Variablen, Funktions- und Operatorzeichen deren Bedeutung frei gewählt werden kann
- [X] Folgendes wird in steilschrift geschrieben: Einheiten und ihre Vorsätze, Zahlen, Funktions- und Operatorzeichen mit feststehender Bedeutung, Chemische Elemente und Verbindungen
- [X] Maßzahl und Einheitenzeichen immer mit Leerzeichen trennen
- Formeln
- [] Formeln müssen nummeriert werden
- [] Formeln zentriert setzen
- [] Formelverzeichnis für häufig im Text erwähnte Formel
- [X] Formeln müssen nummeriert werden
- [X] Formeln zentriert setzen
- [X] Formelverzeichnis für häufig im Text erwähnte Formel
- Literaturangaben
- [] Autor, Autoren bzw. Herausgeber
- [] Titel des Werkes, bzw. der Zeitschrift
- [] Auflage bei Büchern, wenn nicht 1. Auflage
- [] Band und Heftnummern bei Zeitschriften
- [] Ort der Publikation; oder der URL und Datum des Seitenabrufs
- [] Name des Verlags bzw. Verlegers
- [] Jahr der Publikation
- [] DOI von Beiträgen oder Zeitschriftenartikeln
- [X] Autor, Autoren bzw. Herausgeber
- [X] Titel des Werkes, bzw. der Zeitschrift
- [X] Auflage bei Büchern, wenn nicht 1. Auflage
- [X] Band und Heftnummern bei Zeitschriften
- [X] Ort der Publikation; oder der URL und Datum des Seitenabrufs
- [X] Name des Verlags bzw. Verlegers
- [X] Jahr der Publikation
- [X] DOI von Beiträgen oder Zeitschriftenartikeln
- Zusätzlich aus den DHBW Leitlinien
- [x] Titelseite nach Vorlage der DHBW anlegen
- [] Bei Abbildungen und Tabellen, die von anderen Autoren übernommen wurden, erfolgt der Quellennachweis
unmittelbar hinter der Legende.
- [] Wichtige Formeln werden jeweils bei ihrem ersten Auftreten durch eingeklammerte Zahlen am Ende oder
- [X] Bei Abbildungen und Tabellen, die von anderen Autoren übernommen wurden, erfolgt der Quellennachweis unmittelbar hinter der Legende.
- [X] Wichtige Formeln werden jeweils bei ihrem ersten Auftreten durch eingeklammerte Zahlen am Ende oder
Anfang der Zeile gekennzeichnet.

21
_clear.bat Normal file
View File

@@ -0,0 +1,21 @@
del *.aux
del *.fdb_latexmk
del *.fls
del *.log
del *.synctex.gz
del *.toc
del *.out
del *blx.bib
del *.bbl
del *.bcf
del *.blg
del *.run.xml
del *.lof
del *.lot
del *.sub
del *.suc
del *.syc
del *.sym
del *.frm
del *.nlo
del *.equ

BIN
anhang/hb_manual_de.pdf Normal file

Binary file not shown.

6
content/.gitignore vendored
View File

@@ -1,6 +0,0 @@
# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.aux
*.fdb_latexmk
*.fls
*.log
*.synctex.gz

View File

@@ -0,0 +1,18 @@
\chapter*{Sperrvermerk}
\begin{center}
\fbox{
\begin{minipage}{33em}
\textbf{Ein Sperrvermerk sollte nur bei berechtigtem Bedarf gesetzt werden!\\[10pt]
Beachten Sie, dass mit Sperrvermerk versehene Arbeiten nicht für weitere wissenschaftliche Zwecke
außerhalb des Firmenkontextes oder zur Publikation verwendet werden dürfen.\\[10pt]
Wir empfehlen, wenn m\"oglich, auf den Sperrvermerk zu verzichten.\\[10pt]
Besprechen Sie diese Problematik mit Ihrer Firma!}
\end{minipage}
}
\end{center}
(Mustertext) Der Inhalt dieser Arbeit darf weder als Ganzes noch in Auszügen Personen außerhalb des Prüfungsprozesses
und des Evaluationsverfahrens zugänglich gemacht werden, sofern keine anders lautende Genehmigung der Ausbildungsstätte vorliegt.
\cleardoublepage

View File

@@ -1,7 +1,8 @@
\section*{Ehrenwörtliche Erklärung}
\chapter*{Ehrenwörtliche Erklärung}
Ich versichere hiermit, dass ich meine \art_der_arbeit mit dem Thema: \textit{\thema} selbstständig verfasst und keine anderen als die angegebenen Quellen und Hilfsmittel benutzt habe. Ich versichere zudem, dass die eingereichte elektronische Fassung
mit der gedruckten Fassung übereinstimmt.
Ich versichere hiermit, dass ich meine \art_der_arbeit mit dem Thema: \textit{\thema} selbstständig verfasst und
keine anderen als die angegebenen Quellen und Hilfsmittel benutzt habe. Ich versichere zudem, dass die eingereichte
elektronische Fassung mit der gedruckten Fassung übereinstimmt.
\vspace{20mm}
\begin{tabbing}

View File

@@ -0,0 +1,2 @@
\chapter*{Kurzzusammenfassung}
\lipsum[1-2]

View File

@@ -0,0 +1,2 @@
\chapter*{Abstract}
\lipsum[2-3]

View File

@@ -0,0 +1,2 @@
\chapter*{Vorwort}
\lipsum[3-4]

View File

@@ -0,0 +1,37 @@
%Inhaltsverzeichnis
\pagebreak
\tableofcontents
\pagebreak
\begingroup
\let\clearpage\relax
%Abbildungsverzeichnis
\listoffigures
\addcontentsline{toc}{chapter}{Abbildungsverzeichnis}
\printindex
\nopagebreak
%Tabellenverzeichnis
\listoftables
\addcontentsline{toc}{chapter}{Tabellenverzeichnis}
\printindex
\nopagebreak
%Abkürzungsverzeichnis
\printacronyms[name=Abkürzungsverzeichnis, include=acronym]
\addcontentsline{toc}{chapter}{Abkürzungsverzeichnis}
\printindex
\nopagebreak
%Symbolverzeichnis
\listofsymbols
\addcontentsline{toc}{chapter}{Symbolverzeichnis}
\printindex
\nopagebreak
%Formelverzeichnis
\listofequations
\addcontentsline{toc}{chapter}{Formelverzeichnis}
\endgroup
\pagebreak

View File

@@ -0,0 +1,6 @@
\chapter{Einleitung}
\section{Unterkapitel 1}
\subsection{Unterunterkapitel 1}
\lipsum[]
\subsubsection{Unterunterunterkapitel 1}
Dies sollte vermieden werden!

41
content/08_chapter2.tex Normal file
View File

@@ -0,0 +1,41 @@
\chapter{Weitere Beispiele}
\section{Literatur Zitate}
\subsection{Beispiel}
Das hier ist ein beliebiger Text. \autocite{ameling2013grundlagen}
\section{Abbildungen und Abbildungsverzeichnis}
\subsection{Beispiel}
\begin{figure}[h]
\center
\includegraphics{images/logo1.png}
\bilduntertitel{DHBW Logo}{Standard Logo der DHBW}{DHBW Website}
\end{figure}
\section{Tabllen}
\subsection{Beispiel}
\begin{table}[h]
\centering
\begin{tabular}{|l|r|c|}
A & B & C \\
\hline
1 & 2 & 3 \\
\end{tabular}
\caption{Beispiel für eine Tabelle}
%\tabellenuntertitel{CAPTION}{QUELLE}
\end{table}
\section{Abkürzungen}
\subsection{Beispiel}
Eine \ac{GUI} ist eine Bedienoberfläche für Benutzer. Mit einer \ac{GUI} kann der benutzer bequem Sachen einstellen.
\section{Symbole}
\subsection{Beispiel}
Nichts ist schneller, als Licht. Die Lichtgeschwindigkeit \symc beträgt ungefähr 300.000 km / s.
\section{Formeln}
\subsection{Beispiele}
Dies ist ein Beispiel für eine Formel:
\begin{equation}
E = mc^2
\end{equation}
\equationentry{Einstein Formel}{Einsteins Formel der Relativitätstheorie}

View File

@@ -0,0 +1,4 @@
\printbibliography[title=Literaturverzeichnis]
\addcontentsline{toc}{chapter}{Literaturverzeichnis}
\printindex
\pagebreak

View File

@@ -0,0 +1,9 @@
\appendix
\chapter*{Anhang}
\addcontentsline{toc}{chapter}{Anhang}
\renewcommand{\thechapter}{A} % Setzt die Kapitelnummerierung auf "A"
\renewcommand{\thesection}{\thechapter\arabic{section}} % Setzt die Sektionsnummerierung auf "A1, A2, ..."
\section{Erster PDF-Anhang}
\includepdf[pages=-, scale=0.8, frame]{anhang/hb_manual_de.pdf}

View File

@@ -1,23 +1,34 @@
% Schriftgröße 12 Punkte
\documentclass[12pt,a4paper]{article}
\documentclass[12pt,a4paper,oneside]{scrreprt}
\input{settings/preamble.tex}
\input{settings/acronyms.tex}
\input{settings/symbols.tex}
\begin{document}
\input{settings/definitions.tex}
\input{settings/titlepage.tex}
\pagenumbering{Roman}
\ifthenelse{\boolean{sperrvermerk}}{%
\input{content/01_sperrvermerk.tex}
}{}
\input{content/02_eidesstattliche_erklaerung.tex}
\input{content/03_kurzzusammenfassung.tex}
\input{content/04_abstract.tex}
\input{content/05_vorwort.tex}
\input{content/06_verzeichnisse.tex}
\pagenumbering{arabic}
\automark{chapter}
\input{content/07_chapter1.tex}
\input{content/08_chapter2.tex}
\pagebreak
\manualmark
\markboth{}{}
\input{content/98_literaturverzeichnis.tex}
\input{content/99_anhang.tex}

6
settings/.gitignore vendored
View File

@@ -1,6 +0,0 @@
# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.aux
*.fdb_latexmk
*.fls
*.log
*.synctex.gz

13
settings/acronyms.tex Normal file
View File

@@ -0,0 +1,13 @@
\DeclareAcronym{GUI}{
short = GUI,
long = Graphical User Interface,
tag = acronym,
first-style = short-long
}
\DeclareAcronym{HB}{
short = HB,
long = Hysteresebremse,
tag = acronym,
first-style = short-long
}

6
settings/literatur.bib Normal file
View File

@@ -0,0 +1,6 @@
@book{ameling2013grundlagen,
title = {Grundlagen der Elektrotechnik I},
author = {Ameling, Walter},
year = {2013},
publisher = {Springer-Verlag}
}

View File

@@ -1,8 +1,90 @@
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[german]{babel}
\usepackage{pdfpages}
\usepackage[titletoc]{appendix}
\RedeclareSectionCommand[
beforeskip=-1\baselineskip,
%afterskip=0.5\baselineskip
]{chapter}
%\usepackage{scrlayer-scrpage}
%\pagestyle{scrheadings}
%\cofoot*{}
%rofoot*{\pagemark}
%Mathematische Schreibweise und Konformität mit DIN 1304, DIN 1338, DIN 461
\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{siunitx}
\usepackage{tikz}
\usepackage{ifthen}
% Boolean-Wert definieren, der steuert, ob der Sperrvermerk & der rote Punkt gezeigt wird
\newboolean{sperrvermerk}
\setboolean{sperrvermerk}{true} % Setzen Sie dies auf false, um den Sperrvermerk & Punkt zu verstecken
% Befehl zum Zeichnen eines roten Punktes
%\newcommand{\redDot}[1]{%
% \ifthenelse{\boolean{showRedDot}}{%
% \draw (0,0) -- (2, 2);
% }{}
%}
% Roter Punkt aktivieren, #1 kann 'east' oder 'west' sein, um die Position zu bestimmen
%\redDot{east} Dies setzt den Punkt rechts oben. Für rechts unten verwenden Sie "west".
\usepackage{tocbasic}
\DeclareNewTOC[
type=equation,
name={Gl.},
types=equations,
listname={Formelverzeichnis},
tocentrynumwidth=2.2em
]{equ}
\newcommand{\equationentry}[2][\theequation]{%
\addxcontentsline{equ}{equation}[{#1}]{#2}%
}
\BeforeStartingTOC[equ]{\def\autodot{}}
\usepackage[ngerman]{babel}
\usepackage{graphicx}
\usepackage{geometry}
\usepackage{lipsum}
\usepackage{csquotes}
\usepackage[backend=biber, autocite=inline, style=numeric]{biblatex}
\addbibresource{settings/literatur.bib}
\newcommand{\bilduntertitel}[3]{\caption[#1]{#2 \\(Quelle:~#3)}}
%Syntax: \bilduntertitel{Text für Verzeichnis}{Bilduntertitel}{Quellenangabe}
\newcommand{\tabellenuntertitel}[2]{\caption[#1]{#1 \\(Quelle:~#2)}}
\usepackage{scrhack}
\usepackage{listings}
\usepackage[german]{varioref}
\usepackage{caption}
\usepackage{booktabs}
\usepackage{fnpct}
\usepackage{makeidx}
\usepackage{acro}
\usepackage[draft]{listofsymbols}
%\usepackage[final]{listofsymbols}
\renewcommand{\symheadingname}{Symbolverzeichnis}
\renewcommand{\symheading}{\chapter*{\symheadingname}}
\DeclareOldFontCommand{\bf}{\normalfont\bfseries}{\mathbf}
% Schriftart: serifenbehaftet
\usepackage{times}
@@ -18,3 +100,23 @@
left=25mm,
right=25mm
}
\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
\usepackage{scrlayer-scrpage}
\pagestyle{scrheadings}
% Kopf- und Fußzeilen löschen
\clearpairofpagestyles
% Kopfzeile
\ihead*{\headmark} % Innenseite der Kopfzeile
\chead*{} % Zentrierter Text in der Kopfzeile
\ohead*{} % Außenseite der Kopfzeile
% Fußzeile
\ifoot*{Autor: \vorname \ \nachname} % Innenseite der Fußzeile
\cfoot*{} % Zentrierter Text in der Fußzeile; auch auf plain Seiten
\ofoot*{\pagemark} % Außenseite der Fußzeile
% Linien unter Kopfzeile und über Fußzeile aktivieren
%\addtokomafont{headsepline}{\rule[\baselineskip]{\textwidth}{.5pt}}
%\addtokomafont{footsepline}{\rule[-\baselineskip]{\textwidth}{.5pt}}
\usepackage[hidelinks]{hyperref}

4
settings/symbols.tex Normal file
View File

@@ -0,0 +1,4 @@
\opensymdef
\newsym[Lichtgeschwindigkeit]{symc}{c}
\closesymdef

View File

@@ -46,5 +46,9 @@
%Betreuer*in des Dualen Partners\\
%Gutachter*in des Dualen Partners
\end{minipage}
\ifthenelse{\boolean{sperrvermerk}}{%
\begin{tikzpicture}[remember picture,overlay]
\fill[red] ([xshift=-1cm,yshift=-1cm]current page.north east) circle (7.5mm);
\end{tikzpicture}
}{}
\end{center}