Compare commits
8 Commits
2d78b806e3
...
a2afe92f5e
| Author | SHA1 | Date | |
|---|---|---|---|
| a2afe92f5e | |||
| afc4c624ad | |||
| 13b143a92c | |||
| cff20f5dfb | |||
| fc105ba03e | |||
| 83e715b9b8 | |||
| 31325e289a | |||
| 21d3a9c57c |
BIN
06_template_demo.pdf
Normal file
BIN
06_template_demo.pdf
Normal file
Binary file not shown.
@ -14,67 +14,73 @@
|
||||
% ------------------------------------------------------------------------------
|
||||
% Generate the main table of contents with custom formatting
|
||||
% The blenderfont provides a consistent typographic style
|
||||
% Vertical spacing is adjusted for optimal layout
|
||||
% ------------------------------------------------------------------------------
|
||||
{
|
||||
|
||||
|
||||
\newcommand{\offsetA}{\vspace{-5.5em}}
|
||||
\newcommand{\offsetB}{\vspace{-1em}}
|
||||
|
||||
\newpage
|
||||
\pagestyle{fancy} % Ensure fancy page style is active after title page
|
||||
\blenderfont
|
||||
\vspace*{-5.5em}
|
||||
\tableofcontents
|
||||
\pagestyle{fancy}
|
||||
{
|
||||
% Remove title
|
||||
\let\oldcontentsname\contentsname
|
||||
\renewcommand{\contentsname}{}
|
||||
|
||||
% Formatting
|
||||
\blenderfont
|
||||
\chapter*{\oldcontentsname}
|
||||
\offsetA\offsetB
|
||||
\tableofcontents
|
||||
}
|
||||
|
||||
% Add vertical fill to push subsequent content down
|
||||
\vspace{\fill}
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
% List of Figures
|
||||
% Lists of Figures, Tables, Listings, and Equations
|
||||
% ------------------------------------------------------------------------------
|
||||
% Generate list of all figures in the document
|
||||
% Figures are automatically numbered and referenced
|
||||
% Generate all lists on a single page with compact spacing
|
||||
% The lists will only show entries if they exist
|
||||
% ------------------------------------------------------------------------------
|
||||
\newpage
|
||||
\pagestyle{fancy}
|
||||
{
|
||||
% Remove titles
|
||||
\let\oldlistfigurename\listfigurename
|
||||
\let\oldlisttablename\listtablename
|
||||
\let\oldlstlistlistingname\lstlistlistingname
|
||||
\let\oldlistequationsname\listequationsname
|
||||
\renewcommand{\listfigurename}{}
|
||||
\renewcommand{\listtablename}{}
|
||||
\renewcommand{\lstlistlistingname}{}
|
||||
\renewcommand{\listequationsname}{}
|
||||
|
||||
% Formatting
|
||||
\noindent
|
||||
\blenderfont
|
||||
\vspace*{-6em}
|
||||
|
||||
% List of Figures
|
||||
\chapter*{\oldlistfigurename}
|
||||
\offsetA\offsetB
|
||||
\listoffigures
|
||||
}
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
% List of Tables
|
||||
% ------------------------------------------------------------------------------
|
||||
% Generate list of all tables in the document
|
||||
% Tables are automatically numbered and referenced
|
||||
% ------------------------------------------------------------------------------
|
||||
{
|
||||
\noindent
|
||||
\blenderfont
|
||||
% List of Tables
|
||||
\vspace{1em}
|
||||
\chapter*{\oldlisttablename}
|
||||
\offsetA\offsetB
|
||||
\listoftables
|
||||
}
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
% List of Listings
|
||||
% ------------------------------------------------------------------------------
|
||||
% Generate list of all code listings in the document
|
||||
% Code listings are automatically numbered and referenced
|
||||
% This includes all lstlisting environments with captions
|
||||
% ------------------------------------------------------------------------------
|
||||
{
|
||||
\noindent
|
||||
\blenderfont
|
||||
% List of Listings
|
||||
\vspace{1em}
|
||||
\chapter*{\oldlstlistlistingname}
|
||||
\offsetB
|
||||
\lstlistoflistings
|
||||
}
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
% List of Equations
|
||||
% ------------------------------------------------------------------------------
|
||||
% Generate list of all equations in the document
|
||||
% Uses custom command \listofmyequations defined in the class
|
||||
% ------------------------------------------------------------------------------
|
||||
{
|
||||
\noindent
|
||||
\blenderfont
|
||||
% List of Equations
|
||||
\vspace{1em}
|
||||
\chapter*{\oldlistequationsname}
|
||||
\offsetA\offsetB
|
||||
\listofmyequations
|
||||
}
|
||||
|
||||
@ -95,6 +101,7 @@
|
||||
{
|
||||
\renewcommand*{\entryname}{Wort}
|
||||
\newpage
|
||||
\pagestyle{fancy}
|
||||
\vspace*{-2.25em}
|
||||
\printglossary
|
||||
}
|
||||
@ -104,11 +111,15 @@
|
||||
{
|
||||
\renewcommand*{\entryname}{Abkürzung}
|
||||
\newpage
|
||||
\pagestyle{fancy}
|
||||
\vspace*{-2.25em}
|
||||
\printglossary[type=\acronymtype]
|
||||
}
|
||||
}
|
||||
|
||||
% Break pages for following chapters
|
||||
\AddToHook{cmd/chapter/before}{\clearpage}
|
||||
|
||||
% ==============================================================================
|
||||
% End of Table of Contents and Lists
|
||||
% ==============================================================================
|
||||
|
||||
@ -53,6 +53,12 @@
|
||||
\clearpage
|
||||
|
||||
% --- CHAPTER LIST START --- (Do not remove this marker)
|
||||
\input{Content/Chapters/01_einleitung}
|
||||
\input{Content/Chapters/02_gliederung}
|
||||
\input{Content/Chapters/03_seitenformatierung}
|
||||
\input{Content/Chapters/04_formatierung_abschnitte}
|
||||
\input{Content/Chapters/05_zeichenformate}
|
||||
\input{Content/Chapters/06_template_demo}
|
||||
% --- CHAPTER LIST END --- (Do not remove this marker)
|
||||
|
||||
% ==============================================================================
|
||||
|
||||
21
Content/Chapters/01_einleitung.tex
Normal file
21
Content/Chapters/01_einleitung.tex
Normal file
@ -0,0 +1,21 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
% ==============================================================================
|
||||
% Kapitel 1: Einleitung
|
||||
% ==============================================================================
|
||||
% Description: Einleitung zur Formatierung der Seminararbeit
|
||||
% ==============================================================================
|
||||
|
||||
\chapter{Einleitung}
|
||||
\label{chap:einleitung}
|
||||
|
||||
Das hier vorliegende Dokument soll als Vorlage für die Gestaltung der im Seminarkurs \emph{Ausgewählte Themen der Medizinisch-Technischen Informatik} erstellten schriftlichen Ausarbeitungen dienen.
|
||||
|
||||
Es ist zu beachten, dass das Formatieren des Textes als einer der letzten Schritte der Ausarbeitung durchgeführt wird, da dieser Schritt erfahrungsgemäß viel Zeit in Anspruch nimmt und daher nur einmalig ausgeführt werden sollte.
|
||||
|
||||
Der vorliegende Entwurf wurde mit \LaTeX{} unter Verwendung der HSRTReport-Dokumentklasse erstellt, welche auf der KOMA-Script-Klasse \texttt{scrreprt} basiert. Diese Vorlage bietet eine professionelle und konsistente Formatierung für wissenschaftliche Arbeiten.
|
||||
|
||||
Alle in diesem Dokument enthaltenen Hinweise zur Gestaltung des Dokumentes dienen als Referenz für die korrekte Verwendung des Templates. Die Vorlage selbst übernimmt bereits die meisten Formatierungsanforderungen automatisch.
|
||||
|
||||
% ==============================================================================
|
||||
% End of Kapitel 1
|
||||
% ==============================================================================
|
||||
119
Content/Chapters/02_gliederung.tex
Normal file
119
Content/Chapters/02_gliederung.tex
Normal file
@ -0,0 +1,119 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
% ==============================================================================
|
||||
% Kapitel 2: Gliederung des Textes
|
||||
% ==============================================================================
|
||||
% Description: Anforderungen an die Gliederung der Seminararbeit
|
||||
% ==============================================================================
|
||||
|
||||
\chapter{Gliederung des Textes}
|
||||
\label{chap:gliederung}
|
||||
|
||||
Nach jedem der nachfolgend genannten Abschnitte muss mit einer neuen Seite begonnen werden. Die Ausarbeitung muss die nachfolgend gegebene Gliederung aufweisen (Hauptüberschriften).
|
||||
|
||||
Die als Liste angegeben Stichpunkte beschreiben, welche Inhalte in den Abschnitten behandelt werden sollten. Diese Stichpunkte sind, mit Ausnahme des Abschnitts „Verzeichnisse", nicht zwingend als Unterüberschriften vorgegeben, können aber in gleicher oder ähnlicher Form verwendet werden, sofern dies sinnvoll erscheint. Achten Sie hierbei insbesondere darauf, dass ein mit einer Überschrift versehener Textblock nicht nur aus einem oder wenigen Sätzen bestehen darf.
|
||||
|
||||
\section{Erforderliche Gliederung}
|
||||
\label{sec:erforderliche_gliederung}
|
||||
|
||||
Die Seminararbeit muss folgende Struktur aufweisen:
|
||||
|
||||
\subsection{Titelseite mit Abstract}
|
||||
\label{subsec:titelseite}
|
||||
|
||||
Die Titelseite enthält alle wesentlichen Informationen zur Arbeit sowie das Abstract und die Keywords.
|
||||
|
||||
\subsection{Verzeichnisse}
|
||||
\label{subsec:verzeichnisse}
|
||||
|
||||
Folgende Verzeichnisse sind zu erstellen:
|
||||
\begin{listenabsatz}
|
||||
\item Inhaltsverzeichnis
|
||||
\item Abbildungsverzeichnis
|
||||
\item Tabellenverzeichnis
|
||||
\item Formelverzeichnis
|
||||
\item Abkürzungsverzeichnis
|
||||
\item Glossar
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Einleitung}
|
||||
\label{subsec:einleitung_struktur}
|
||||
|
||||
Die Einleitung sollte folgende Punkte behandeln:
|
||||
\begin{listenabsatz}
|
||||
\item Beschreibung des Problems und der Forschungsaufgabe
|
||||
\item Verdeutlichung der Relevanz für Wissenschaft und Gesellschaft
|
||||
\item Hypothese
|
||||
\item Definition der Leitfragen
|
||||
\item Stand der Wissenschaft/Technik
|
||||
\item Vorgehensweise zur Verifikation der Hypothese
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Methoden}
|
||||
\label{subsec:methoden_struktur}
|
||||
|
||||
Der Methodenteil umfasst:
|
||||
\begin{listenabsatz}
|
||||
\item Beschreibung der Umsetzung der Vorgehensweise zur Erzielung der gesuchten Ergebnisse (z.\,B. Aufbau der Messtechnik und Ablauf der Experimente, Beschreibung der Arbeitsinstrumente und Werkzeuge, Beschreibung der Lösungsprozesse oder Vorgehensweise bei der Literaturrecherche/Selektionskriterien)
|
||||
\item Methoden müssen so beschrieben sein, dass andere Personen das Verfahren nachvollziehen/reproduzieren können
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Ergebnisse}
|
||||
\label{subsec:ergebnisse_struktur}
|
||||
|
||||
Im Ergebnisteil erfolgt:
|
||||
\begin{listenabsatz}
|
||||
\item Darstellung der über die Untersuchungsmethoden erzielten Ergebnisse (objektive Darstellung)
|
||||
\item Stellungnahme zur Verifikation der Hypothese durch Beantwortung der Leitfragen
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Diskussion}
|
||||
\label{subsec:diskussion_struktur}
|
||||
|
||||
Die Diskussion beinhaltet:
|
||||
\begin{listenabsatz}
|
||||
\item Interpretation der Ergebnisse (was lässt sich aus den Daten folgern -- subjektive Beurteilung/persönliche Meinung)
|
||||
\item Vergleich der Ergebnisse mit den bisher bekannten Daten (Bewertung der Ergebnisse aus der Literatur: gibt es Übereinstimmung oder Widersprüche; wie lassen sich mögliche Widersprüche erklären?)
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Zusammenfassung}
|
||||
\label{subsec:zusammenfassung_struktur}
|
||||
|
||||
Die Zusammenfassung enthält:
|
||||
\begin{listenabsatz}
|
||||
\item Kurze Beschreibung der Fragestellung und der Ergebnisse
|
||||
\item Ausblick und Empfehlungen
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Literaturverzeichnis}
|
||||
\label{subsec:literatur_struktur}
|
||||
|
||||
Das Literaturverzeichnis listet alle verwendeten Quellen auf.
|
||||
|
||||
\subsection{Danksagungen}
|
||||
\label{subsec:danksagungen_struktur}
|
||||
|
||||
Optional können Danksagungen eingefügt werden:
|
||||
\begin{listenabsatz}
|
||||
\item Benennung der Sponsoren
|
||||
\item Nennung der Hilfspersonen und deren Aufgabengebiet
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Eidesstattliche Erklärung}
|
||||
\label{subsec:erklaerung_struktur}
|
||||
|
||||
Die eidesstattliche Erklärung muss unterschrieben werden (z.\,B. durch die Verwendung der PDF-Unterschriftsfunktion im Acrobat Reader).
|
||||
|
||||
\subsection{Anhang}
|
||||
\label{subsec:anhang_struktur}
|
||||
|
||||
Der Anhang kann enthalten:
|
||||
\begin{listenabsatz}
|
||||
\item Arbeitshypothese
|
||||
\item Leitfragen mit Validierung
|
||||
\item Projektplan (Gantt-Diagramm)
|
||||
\item Verbesserungsvorschläge (nur in Version 2)
|
||||
\end{listenabsatz}
|
||||
|
||||
% ==============================================================================
|
||||
% End of Kapitel 2
|
||||
% ==============================================================================
|
||||
157
Content/Chapters/03_seitenformatierung.tex
Normal file
157
Content/Chapters/03_seitenformatierung.tex
Normal file
@ -0,0 +1,157 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
% ==============================================================================
|
||||
% Kapitel 3: Seitenformatierung
|
||||
% ==============================================================================
|
||||
% Description: Vorgaben zur Seitenformatierung der Seminararbeit
|
||||
% ==============================================================================
|
||||
|
||||
\chapter{Seitenformatierung}
|
||||
\label{chap:seitenformatierung}
|
||||
|
||||
\section{Seitenformat und Festlegung der richtigen Formatierung für zweizeilige Überschriften die eine Trennung von Hand erforderlich machen würden}
|
||||
\label{sec:seitenformat}
|
||||
|
||||
Das Dokument wird im DIN-A4-Format im Hochformat erstellt. Die automatische Silbentrennung sorgt dafür, dass auch längere Überschriften korrekt umgebrochen werden.
|
||||
|
||||
\subsection{Seitenformat}
|
||||
\label{subsec:seitenformat_detail}
|
||||
|
||||
Das Seitenformat ist auf DIN-A4 im Hochformat festgelegt. Diese Einstellung wird automatisch durch das Template vorgenommen.
|
||||
|
||||
\section{Seitenränder}
|
||||
\label{sec:seitenraender}
|
||||
|
||||
Die Seitenränder sind wie folgt definiert:
|
||||
\begin{listenabsatz}
|
||||
\item Linker Rand: 4\,cm
|
||||
\item Rechter Rand: 3\,cm
|
||||
\item Oberer Rand: 3\,cm
|
||||
\item Unterer Rand: 2\,cm
|
||||
\end{listenabsatz}
|
||||
|
||||
Jeder neue Absatz hat zum vorhergehenden Absatz einen Abstand von 6 Punkten. Für Listen gibt es die Formatvorlage \texttt{listenabsatz}, bei der kein Abstand zwischen den Absätzen enthalten ist.
|
||||
|
||||
Die Ausrichtung des Textes und aller Überschriften erfolgt im Blocksatz. Die Silbentrennung wird automatisch eingesetzt, um ein ausgewogenes Schriftbild zu erreichen.
|
||||
|
||||
\section{Titel und Überschriften}
|
||||
\label{sec:titel_ueberschriften}
|
||||
|
||||
Titel und Überschriften müssen kurz und aussagekräftig sein. Überschriften dürfen sich nicht wiederholen, sondern müssen eindeutig voneinander zu unterscheiden sein.
|
||||
|
||||
Die Gliederung des Textes sollte maximal über 2 Ebenen erfolgen. Es ist darauf zu achten, dass nicht jeder Absatz eine eigene Kapitelüberschrift erhält.
|
||||
|
||||
\section{Textabsätze}
|
||||
\label{sec:textabsaetze}
|
||||
|
||||
Ein Absatz darf nie mit einer einzelnen Zeile auf einer neuen Seite enden oder mit einer einzelnen Zeile am Seitenende beginnen. Dies gilt in gleicher Weise für Überschriften. Das Template verhindert dies automatisch durch entsprechende Penalties.
|
||||
|
||||
Die Länge eines Absatzes ist auf maximal 400 Zeichen zu beschränken.
|
||||
|
||||
Absätze werden nicht willkürlich gesetzt. Sie sollen dazu dienen, das Dokument nicht nur formal, sondern auch inhaltlich zu gliedern und somit das Lesen und Verstehen des Textes zu erleichtern.
|
||||
|
||||
Die Silbentrennung ist so einzusetzen, dass jede Zeile möglichst bis zum Zeilenrand beschrieben ist. Beim Einsatz von Blocksatz ist darauf zu achten, dass die Lücken zwischen den Worten nicht zu groß werden.
|
||||
|
||||
Zwischen den einzelnen Absätzen ist ein Abstand von 6 Punkten einzuhalten.
|
||||
|
||||
\section{Kopfzeile}
|
||||
\label{sec:kopfzeile}
|
||||
|
||||
Der Aufbau der Kopfzeile erfolgt, mit Ausnahme der Titelseite, automatisch und beinhaltet die Kapitelnummer und -überschrift der ersten Ebene auf der linken Seite sowie den Dokumenttitel auf der rechten Seite.
|
||||
|
||||
\section{Fußzeile}
|
||||
\label{sec:fusszeile}
|
||||
|
||||
Der Aufbau der Fußzeile erfolgt, mit Ausnahme der Titelseite, automatisch und zeigt: Autorname | Modulname | Seite X von Y.
|
||||
|
||||
\section{Seitennummerierung}
|
||||
\label{sec:seitennummerierung}
|
||||
|
||||
Die Seitennummerierung erfolgt automatisch. Die Zählung beginnt bei 0 für das Titelblatt, so dass die erste Verzeichnisseite die Nummer 1 aufweist.
|
||||
|
||||
\section{Fußnoten}
|
||||
\label{sec:fussnoten}
|
||||
|
||||
Fußnoten\footnote{Dies ist ein Beispiel für eine Fußnote.} werden im Text durch eine hochgestellte Ziffer grundsätzlich nach einem Satzzeichen (Komma, Strichpunkt, Punkt, Fragezeichen, Ausrufungszeichen, Gedankenstrich) referenziert. Die Fußnotennummerierung erfolgt fortlaufend über die gesamte Arbeit.
|
||||
|
||||
Erläuterungen zu den Fußnoten erfolgen oberhalb der Fußzeile und reduzieren die Zeilenzahl des Textkörpers. Der Beginn einer Fußnote wird durch einen linksbündigen horizontalen Strich, dessen Länge ca. 30\,\% der Breite des Textblockes beträgt, vom Textkörper abgetrennt.
|
||||
|
||||
Die Fußnotentexte sollten nicht länger als 4 Zeilen sein. Ebenso sollte vermieden werden, den Umbruch der Fußnoten auf die nächste Seite zu erzwingen.
|
||||
|
||||
\section{Formeln}
|
||||
\label{sec:formeln}
|
||||
|
||||
Formeln werden vom Rand einheitlich um 1\,cm eingerückt und vom vorhergehenden und nachfolgenden Absatz um zwei Zeilen abgesetzt. Jede Formel ist über eine fortlaufend aufsteigend zu vergebende Nummer zu kennzeichnen. Bei Formeln, die durch Umformung auseinander hervorgehen, können die Zwischenschritte durch eine einheitliche Nummer, ergänzt um einen Buchstaben, referenziert werden.
|
||||
|
||||
Beispiel für die Mitternachtsformel:
|
||||
|
||||
\begin{equation}
|
||||
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
|
||||
\label{eq:mitternachtsformel}
|
||||
\end{equation}
|
||||
\myequations{Mitternachtsformel zur Lösung quadratischer Gleichungen}
|
||||
|
||||
Die Formel~\ref{eq:mitternachtsformel} zeigt die bekannte Lösungsformel für quadratische Gleichungen.
|
||||
|
||||
\section{Abbildungen}
|
||||
\label{sec:abbildungen}
|
||||
|
||||
Abbildungen können an beliebiger Stelle im Text eingebaut werden. Jede Abbildung erhält eine Nummer, die sich aus der Abschnittsnummer der Ebene 1 und einer fortlaufenden, in jedem Abschnitt bei Eins beginnenden Nummer ergibt. Der Nummer folgt eine kurze Beschreibung zum Bild, die unterhalb des Bildes platziert wird.
|
||||
|
||||
\begin{figure}[h]
|
||||
\centering
|
||||
\fbox{\parbox{0.6\textwidth}{\centering\vspace{3cm}Beispielabbildung\vspace{3cm}}}
|
||||
\caption{Auswahlmenü auf der Website der HS Reutlingen}
|
||||
\label{fig:hs_website}
|
||||
\end{figure}
|
||||
|
||||
Die Nummer kann in Verbindung mit der Abkürzung Abb. oder dem Wort Abbildung zur Referenzierung einer Abbildung im Text eingesetzt werden. Hierzu werden im Text runde Klammern verwendet, z.\,B. (Abbildung~\ref{fig:hs_website}) oder (Abb.~\ref{fig:hs_website}).
|
||||
|
||||
Alle Abbildungsnummern und -überschriften werden automatisch im Abbildungsverzeichnis referenziert.
|
||||
|
||||
Werden Abbildungen aus fremden Quellen übernommen, so müssen die Copyright-Vorgaben berücksichtigt werden, d.\,h. die Quelle der Abbildung muss angegeben und im Literaturverzeichnis referenziert werden. Für alle Abbildungen ohne Referenz beansprucht der Autor/die Autorin die eigene Urheberschaft. Dementsprechend dürfen selbst erstellte Abbildungen nicht mit Angaben wie „eigene Abbildung" o.\,ä. versehen werden.
|
||||
|
||||
\section{Tabellen}
|
||||
\label{sec:tabellen}
|
||||
|
||||
Tabellen können an beliebiger Stelle im Text eingebaut werden. Die erste Zeile einer Tabelle enthält die Spaltenbeschriftung, die erste Spalte ggf. die Zeilenbeschriftung.
|
||||
|
||||
\begin{table}[h]
|
||||
\centering
|
||||
\caption{Beispiele für Formatvorlagen}
|
||||
\label{tab:formatvorlagen}
|
||||
\begin{tabular}{|l|l|c|c|}
|
||||
\hline
|
||||
\textbf{Formatbezeichner} & \textbf{Schrift} & \textbf{Größe} & \textbf{kursiv} \\
|
||||
\hline
|
||||
Überschrift 1 & Franklin Gothic Book & 16 & nein \\
|
||||
Eigennamen & Times New Roman & 12 & ja \\
|
||||
\hline
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
Es ist darauf zu achten, dass innerhalb einer Tabellenzeile kein Seitenumbruch erfolgt. Ist es erforderlich einen Seitenumbruch zwischen den Zeilen durchzuführen, so muss auf der nächsten Seite die Beschriftung der Spalten wiederholt werden.
|
||||
|
||||
Auch die Tabellen werden in gleicher Form wie die Abbildungen nummeriert und beschriftet (siehe Tabelle~\ref{tab:formatvorlagen}). Der Nummer wird hierbei das Präfix Tabelle oder Tab. vorangestellt. Aus den Referenznummern und der Beschreibung wird das am Anfang der Ausarbeitung stehende Tabellenverzeichnis automatisch erstellt.
|
||||
|
||||
\section{Abkürzungen}
|
||||
\label{sec:abkuerzungen}
|
||||
|
||||
Abkürzungen dürfen nur verwendet werden, wenn dies bei sehr häufiger Verwendung umfänglicher Begriffe zu einer erheblichen Ersparnis des Textumfanges führt und die Verständlichkeit des Textes nicht verschlechtert wird. Die Verwendung von allgemein gebräuchlichen Abkürzungen ist ebenfalls möglich. Ganz verzichten sollte man jedoch auf die Verwendung von selbst erfundenen Abkürzungen.
|
||||
|
||||
Abkürzungen sind innerhalb des Textes bei der ersten Verwendung in runden Klammern nach der vollständigen Angabe des nicht abgekürzten Textes zu benennen und im Abkürzungsverzeichnis aufzuführen. Wird zum Beispiel vom \gls{MPG} gesprochen, so kann dies später nur noch als \gls{MPG} bezeichnet werden.
|
||||
|
||||
\section{Zitate}
|
||||
\label{sec:zitate}
|
||||
|
||||
In der Seminararbeit werden die Hinweise auf die verwendete Literatur im Stil APA durchgeführt. Dieser Stil wird durch das Template automatisch unterstützt.
|
||||
|
||||
\section{Vorgabe für das Ausdrucken von Seiten}
|
||||
\label{sec:ausdruck}
|
||||
|
||||
Der Ausdruck erfolgt vorzugsweise beidseitig (Papier einsparen!). Bei der Formatierung wird nicht zwischen linker und rechter Seite unterschieden.
|
||||
|
||||
Die Ausarbeitung muss als PDF-Datei abgegeben werden.
|
||||
|
||||
% ==============================================================================
|
||||
% End of Kapitel 3
|
||||
% ==============================================================================
|
||||
123
Content/Chapters/04_formatierung_abschnitte.tex
Normal file
123
Content/Chapters/04_formatierung_abschnitte.tex
Normal file
@ -0,0 +1,123 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
% ==============================================================================
|
||||
% Kapitel 4: Formatierung der Abschnitte
|
||||
% ==============================================================================
|
||||
% Description: Spezifische Formatierungsanforderungen für verschiedene Abschnitte
|
||||
% ==============================================================================
|
||||
|
||||
\chapter{Formatierung der Abschnitte}
|
||||
\label{chap:formatierung_abschnitte}
|
||||
|
||||
\section{Gestaltung des Titelblattes}
|
||||
\label{sec:titelblatt}
|
||||
|
||||
Die Gestaltung des Titelblattes erfolgt automatisch durch das Template. Alle erforderlichen Informationen werden in der Datei \texttt{Settings/General.tex} konfiguriert.
|
||||
|
||||
\subsection{Titel der Arbeit}
|
||||
\label{subsec:titel_arbeit}
|
||||
|
||||
Der Titel der Arbeit wird mit folgenden Eigenschaften formatiert:
|
||||
\begin{listenabsatz}
|
||||
\item Abstand zum oberen Blattrand: 6\,cm
|
||||
\item Ausrichtung: zentriert
|
||||
\item Schriftgröße: 24 Punkte
|
||||
\item E-Mail-Anschrift: Als Hyperlink kenntlich gemacht
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Abstract}
|
||||
\label{subsec:abstract}
|
||||
|
||||
Das Abstract wird auf der Titelseite platziert und hat folgende Eigenschaften:
|
||||
\begin{listenabsatz}
|
||||
\item Schriftart: Times New Roman kursiv
|
||||
\item Schriftgröße: 10 Punkte
|
||||
\item Maximale Länge: 150--250 Wörter
|
||||
\item Inhalt: Zielsetzung, Methoden und Ergebnisse der Arbeit
|
||||
\end{listenabsatz}
|
||||
|
||||
Das Abstract soll es den Lesern und Leserinnen ermöglichen, innerhalb von wenigen Augenblicken zu erfassen, welcher Inhalt hinter der Überschrift steckt und ob das Thema zur weiteren Bearbeitung lohnt.
|
||||
|
||||
\section{Inhaltsverzeichnis}
|
||||
\label{sec:inhaltsverzeichnis_format}
|
||||
|
||||
Das Inhaltsverzeichnis wird automatisch generiert und umfasst:
|
||||
\begin{listenabsatz}
|
||||
\item Maximal 3 Gliederungsebenen
|
||||
\item Schriftgröße: 10 Punkte
|
||||
\item Automatische Seitenzahlen mit Punktführung
|
||||
\item Struktur so flach wie möglich halten
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Abbildungsverzeichnis}
|
||||
\label{sec:abbildungsverzeichnis}
|
||||
|
||||
Das Abbildungsverzeichnis wird automatisch aus allen mit \texttt{\textbackslash caption} versehenen Abbildungen erstellt. Die Formatierung erfolgt analog zum Inhaltsverzeichnis mit 10 Punkt Schriftgröße.
|
||||
|
||||
\section{Tabellenverzeichnis}
|
||||
\label{sec:tabellenverzeichnis}
|
||||
|
||||
Das Tabellenverzeichnis wird automatisch aus allen mit \texttt{\textbackslash caption} versehenen Tabellen erstellt. Die Formatierung entspricht dem Abbildungsverzeichnis.
|
||||
|
||||
\section{Abkürzungsverzeichnis}
|
||||
\label{sec:abkuerzungsverzeichnis}
|
||||
|
||||
Das Abkürzungsverzeichnis wird durch das \texttt{glossaries}-Paket verwaltet und hat folgende Eigenschaften:
|
||||
\begin{listenabsatz}
|
||||
\item Tabellarische Darstellung mit drei Spalten
|
||||
\item Alphabetische Sortierung
|
||||
\item Allgemein bekannte Abkürzungen werden nicht aufgenommen
|
||||
\item Schriftgröße: 10 Punkte
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Glossar}
|
||||
\label{sec:glossar}
|
||||
|
||||
Das Glossar dient dazu, dem Leser vermutlich nicht bekannte Fachbegriffe zu erläutern. Das Glossar ist nicht zu verwechseln mit dem Index, welcher im Rahmen dieser Seminararbeit nicht zur Anwendung kommt.
|
||||
|
||||
Das Glossar wird ebenfalls durch das \texttt{glossaries}-Paket verwaltet:
|
||||
\begin{listenabsatz}
|
||||
\item Tabellarische Darstellung mit zwei Spalten
|
||||
\item Alphabetische Sortierung
|
||||
\item Schriftgröße: 10 Punkte
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Textkörper}
|
||||
\label{sec:textkoerper}
|
||||
|
||||
Die Gestaltung und Unterteilung des Textkörpers in verschiedene Abschnitte muss entsprechend der Beschreibung der Inhalte erfolgen. Der Haupttext verwendet:
|
||||
\begin{listenabsatz}
|
||||
\item Schriftart: Franklin Gothic Book (oder Systemalternative)
|
||||
\item Schriftgröße: 12 Punkte
|
||||
\item Zeilenabstand: 1,5-fach
|
||||
\item Absatzabstand: 6 Punkte
|
||||
\item Ausrichtung: Blocksatz mit Silbentrennung
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Literaturverzeichnis}
|
||||
\label{sec:literaturverzeichnis_format}
|
||||
|
||||
Das Literaturverzeichnis wird automatisch durch BibLaTeX generiert und folgt diesen Regeln:
|
||||
|
||||
Die Quellen werden in alphabetischer Ordnung, sortiert nach dem Nachnamen des Hauptautors, aufgelistet.
|
||||
|
||||
Materialien, die aus dem Internet geladen werden, müssen neben der Angabe der URL und des Zugriffsdatums ebenfalls mit den Namen der Verfasser/innen, dem Titel des Dokumentes und allen weiteren Referenzbezeichnungen (Erscheinungsjahr, Ort, etc.) beschrieben werden, die für das entsprechende Dokument verfügbar sind.
|
||||
|
||||
Ist kein Verfasser genannt, so muss statt dem Namen des Autors die Abkürzung o.\,V. eingetragen werden. Ist eine Quelle neben der Zugriffsmöglichkeit über das Internet auch noch über ein offiziell referenziertes Druckmedium verfügbar, so muss grundsätzlich das Druckmedium benannt werden!
|
||||
|
||||
Für die Qualität des Literaturverzeichnisses ist entscheidend, dass der gewählte Stil (Format: APA) einheitlich angewendet wird.
|
||||
|
||||
\section{Eidesstattliche Erklärung}
|
||||
\label{sec:eidesstattliche_erklaerung}
|
||||
|
||||
Die eidesstattliche Erklärung muss:
|
||||
\begin{listenabsatz}
|
||||
\item Den vorgegebenen Text verwenden
|
||||
\item Unterschrieben werden (z.\,B. durch PDF-Unterschriftsfunktion)
|
||||
\item Als letzte Seite vor dem Anhang eingefügt werden
|
||||
\end{listenabsatz}
|
||||
|
||||
Der Wortlaut der Erklärung ist vorgegeben und darf nicht verändert werden.
|
||||
|
||||
% ==============================================================================
|
||||
% End of Kapitel 4
|
||||
% ==============================================================================
|
||||
115
Content/Chapters/05_zeichenformate.tex
Normal file
115
Content/Chapters/05_zeichenformate.tex
Normal file
@ -0,0 +1,115 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
% ==============================================================================
|
||||
% Kapitel 5: Zeichenformate
|
||||
% ==============================================================================
|
||||
% Description: Übersicht über die verwendeten Zeichenformate
|
||||
% ==============================================================================
|
||||
|
||||
\chapter{Zeichenformate}
|
||||
\label{chap:zeichenformate}
|
||||
|
||||
Die Zeichenformatierung ist ein wesentlicher Bestandteil der Dokumentgestaltung. Im Folgenden sind die Vorgaben für die verschiedenen Textelemente aufgeführt.
|
||||
|
||||
\section{Übersicht der Zeichenformate}
|
||||
\label{sec:zeichenformate_uebersicht}
|
||||
|
||||
Die folgende Tabelle gibt eine Übersicht über alle verwendeten Zeichenformate:
|
||||
|
||||
\begin{table}[h]
|
||||
\centering
|
||||
\caption{Zeichenformate im Dokument}
|
||||
\label{tab:zeichenformate}
|
||||
\begin{tabular}{|l|l|c|}
|
||||
\hline
|
||||
\textbf{Element} & \textbf{Schriftart} & \textbf{Größe (pt)} \\
|
||||
\hline
|
||||
Titel & Franklin Gothic Book & 24 \\
|
||||
Standardtext & Franklin Gothic Book & 12 \\
|
||||
Überschrift 1 & Franklin Gothic Book & 16 \\
|
||||
Überschrift 2 & Franklin Gothic Book & 14 \\
|
||||
Überschrift 3 & Franklin Gothic Book (fett) & 12 \\
|
||||
\hline
|
||||
Inhaltsverzeichnis & Franklin Gothic Book & 10 \\
|
||||
Abb.-verzeichnis & Franklin Gothic Book & 10 \\
|
||||
Tab.-verzeichnis & Franklin Gothic Book & 10 \\
|
||||
Abk.-verzeichnis & Franklin Gothic Book & 10 \\
|
||||
Glossar & Franklin Gothic Book & 10 \\
|
||||
\hline
|
||||
Zitate & Franklin Gothic Book & 12 \\
|
||||
Kopfzeilen & Franklin Gothic Book & 12 \\
|
||||
Fußzeilen & Franklin Gothic Book & 10 \\
|
||||
Fußnoten & Franklin Gothic Book & 10 \\
|
||||
Abstract & Times New Roman (kursiv) & 10 \\
|
||||
\hline
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
\section{Formatierungsrichtlinien}
|
||||
\label{sec:formatierungsrichtlinien}
|
||||
|
||||
\subsection{Standardtext}
|
||||
\label{subsec:standardtext}
|
||||
|
||||
Der Standardtext verwendet Franklin Gothic Book in 12 Punkt Größe. Diese Schriftart bietet eine gute Lesbarkeit sowohl auf Bildschirmen als auch im Druck. In \LaTeX{} wird eine passende Alternative automatisch ausgewählt, falls die exakte Schriftart nicht verfügbar ist.
|
||||
|
||||
\subsection{Überschriften}
|
||||
\label{subsec:ueberschriften_format}
|
||||
|
||||
Die Hierarchie der Überschriften wird durch unterschiedliche Schriftgrößen deutlich gemacht:
|
||||
\begin{listenabsatz}
|
||||
\item Überschrift 1. Ebene: 16 Punkte
|
||||
\item Überschrift 2. Ebene: 14 Punkte
|
||||
\item Überschrift 3. Ebene: 12 Punkte (fett)
|
||||
\end{listenabsatz}
|
||||
|
||||
Alle Überschriften verwenden die gleiche Schriftart wie der Standardtext, um ein einheitliches Erscheinungsbild zu gewährleisten.
|
||||
|
||||
\subsection{Verzeichnisse}
|
||||
\label{subsec:verzeichnisse_format}
|
||||
|
||||
Alle Verzeichnisse (Inhalts-, Abbildungs-, Tabellen-, Abkürzungsverzeichnis und Glossar) werden einheitlich in 10 Punkt Schriftgröße formatiert. Dies sorgt für eine kompakte Darstellung bei gleichzeitig guter Übersichtlichkeit.
|
||||
|
||||
\subsection{Spezielle Formatierungen}
|
||||
\label{subsec:spezielle_formatierungen}
|
||||
|
||||
\subsubsection{Eigennamen}
|
||||
Bei der Nennung von Eigennamen kann eine Kursivschrift mit Serifen verwendet werden, beispielsweise \emph{Times New Roman} in kursiv. Dies hebt Eigennamen vom restlichen Text ab.
|
||||
|
||||
\subsubsection{Hervorhebungen}
|
||||
Auf Hervorhebungen von Text mittels Fettdruck, Unterstreichungen etc. soll generell verzichtet werden. Ausnahmen bilden:
|
||||
\begin{listenabsatz}
|
||||
\item Überschriften der dritten Ebene (fett)
|
||||
\item Tabellenköpfe (fett)
|
||||
\item Eigennamen (kursiv mit Serifen)
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsubsection{Abstract}
|
||||
Das Abstract auf der Titelseite verwendet als einziges Element \emph{Times New Roman} in kursiv mit 10 Punkt Schriftgröße. Diese Formatierung hebt das Abstract visuell vom restlichen Dokument ab.
|
||||
|
||||
\section{Tabulatoren und Abstände}
|
||||
\label{sec:tabulatoren}
|
||||
|
||||
Der Abstand für Tabulatoren beträgt einheitlich 2\,cm. Dies gewährleistet eine konsistente Einrückung bei:
|
||||
\begin{listenabsatz}
|
||||
\item Listen und Aufzählungen
|
||||
\item Eingerückten Zitaten
|
||||
\item Formeln (1\,cm Einrückung)
|
||||
\item Strukturierten Daten
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Technische Umsetzung in \LaTeX}
|
||||
\label{sec:technische_umsetzung}
|
||||
|
||||
In \LaTeX{} werden die Zeichenformate automatisch durch die Dokumentklasse und die gewählten Pakete umgesetzt. Die HSRTReport-Klasse definiert:
|
||||
\begin{listenabsatz}
|
||||
\item Standardschriftart und -größe
|
||||
\item Überschriftformatierung durch KOMA-Script
|
||||
\item Verzeichnisformatierung durch \texttt{tocloft}
|
||||
\item Spezialformatierungen durch entsprechende Befehle
|
||||
\end{listenabsatz}
|
||||
|
||||
Die konsistente Anwendung der Zeichenformate trägt wesentlich zur Professionalität und Lesbarkeit des Dokuments bei.
|
||||
|
||||
% ==============================================================================
|
||||
% End of Kapitel 5
|
||||
% ==============================================================================
|
||||
347
Content/Chapters/06_template_demo.tex
Normal file
347
Content/Chapters/06_template_demo.tex
Normal file
@ -0,0 +1,347 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
% ==============================================================================
|
||||
% Kapitel 6: Template-Features Demonstration
|
||||
% ==============================================================================
|
||||
% Description: Demonstration aller Features des HSRTReport Templates
|
||||
% ==============================================================================
|
||||
|
||||
\chapter{Template-Features Demonstration}
|
||||
\label{chap:template_demo}
|
||||
|
||||
Dieses Kapitel demonstriert die verschiedenen Funktionen und Möglichkeiten des HSRTReport-Templates für wissenschaftliche Arbeiten.
|
||||
|
||||
\section{Textformatierung}
|
||||
\label{sec:textformatierung_demo}
|
||||
|
||||
\subsection{Grundlegende Textauszeichnungen}
|
||||
\label{subsec:textauszeichnungen}
|
||||
|
||||
Das Template unterstützt verschiedene Textauszeichnungen:
|
||||
\begin{listenabsatz}
|
||||
\item \textbf{Fetter Text} für wichtige Begriffe
|
||||
\item \emph{Kursiver Text} für Betonungen und Eigennamen
|
||||
\item \texttt{Maschinenschrift} für Code und Befehle
|
||||
\item \textsf{Serifenlose Schrift} für spezielle Hervorhebungen
|
||||
\item \textsc{Kapitälchen} für besondere Formatierungen
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Spezielle Zeichen und Symbole}
|
||||
\label{subsec:spezielle_zeichen}
|
||||
|
||||
Das Template unterstützt korrekte Typografie:
|
||||
\begin{listenabsatz}
|
||||
\item Gedankenstriche -- so wie hier -- für Einschübe
|
||||
\item Anführungszeichen: "`deutsche Anführungszeichen"' und ``englische Quotes''
|
||||
\item Auslassungspunkte \ldots{} mit korrektem Spacing
|
||||
\item Geschützte Leerzeichen: z.\,B. oder 10\,cm oder S.\,42
|
||||
\item Mathematische Symbole: $\alpha$, $\beta$, $\gamma$, $\sum$, $\int$
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Listen und Aufzählungen}
|
||||
\label{sec:listen_demo}
|
||||
|
||||
\subsection{Verschiedene Listentypen}
|
||||
\label{subsec:listentypen}
|
||||
|
||||
Standard-Aufzählung:
|
||||
\begin{itemize}
|
||||
\item Erster Punkt
|
||||
\item Zweiter Punkt
|
||||
\item Dritter Punkt mit Unterpunkten:
|
||||
\begin{itemize}
|
||||
\item Unterpunkt A
|
||||
\item Unterpunkt B
|
||||
\end{itemize}
|
||||
\end{itemize}
|
||||
|
||||
Nummerierte Liste:
|
||||
\begin{enumerate}
|
||||
\item Erster Schritt
|
||||
\item Zweiter Schritt
|
||||
\item Dritter Schritt
|
||||
\end{enumerate}
|
||||
|
||||
Kompakte Liste ohne Abstände (listenabsatz):
|
||||
\begin{listenabsatz}
|
||||
\item Element ohne Abstand darüber
|
||||
\item Element ohne Abstand dazwischen
|
||||
\item Element ohne Abstand darunter
|
||||
\end{listenabsatz}
|
||||
|
||||
Beschreibungsliste:
|
||||
\begin{description}
|
||||
\item[Begriff 1] Erklärung des ersten Begriffs
|
||||
\item[Begriff 2] Erklärung des zweiten Begriffs
|
||||
\item[Begriff 3] Erklärung des dritten Begriffs
|
||||
\end{description}
|
||||
|
||||
\section{Mathematische Formeln}
|
||||
\label{sec:formeln_demo}
|
||||
|
||||
\subsection{Inline-Formeln}
|
||||
\label{subsec:inline_formeln}
|
||||
|
||||
Formeln können direkt im Text verwendet werden, wie z.\,B. $E = mc^2$ oder $a^2 + b^2 = c^2$. Auch komplexere Ausdrücke wie $\int_{0}^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2}$ sind möglich.
|
||||
|
||||
\subsection{Abgesetzte Formeln}
|
||||
\label{subsec:abgesetzte_formeln}
|
||||
|
||||
Einfache nummerierte Gleichung:
|
||||
|
||||
\begin{equation}
|
||||
\nabla \times \vec{E} = -\frac{\partial \vec{B}}{\partial t}
|
||||
\label{eq:maxwell1}
|
||||
\end{equation}
|
||||
\myequations{Erste Maxwell-Gleichung (Faradaysches Induktionsgesetz)}
|
||||
|
||||
Mehrzeilige Gleichung mit Alignment:
|
||||
|
||||
\begin{align*}
|
||||
f(x) & = x^2 + 2x + 1 \\
|
||||
& = (x + 1)^2 \numbereq
|
||||
\label{eq:binomial}
|
||||
\end{align*}
|
||||
\myequations{Binomische Formel}
|
||||
|
||||
Matrix-Darstellung:
|
||||
|
||||
\begin{equation}
|
||||
\mathbf{A} = \begin{pmatrix}
|
||||
a_{11} & a_{12} & a_{13} \\
|
||||
a_{21} & a_{22} & a_{23} \\
|
||||
a_{31} & a_{32} & a_{33}
|
||||
\end{pmatrix}
|
||||
\label{eq:matrix}
|
||||
\end{equation}
|
||||
\myequations{3x3-Matrix}
|
||||
|
||||
\section{Abbildungen und Grafiken}
|
||||
\label{sec:abbildungen_demo}
|
||||
|
||||
\subsection{Einfache Abbildung}
|
||||
\label{subsec:einfache_abbildung}
|
||||
|
||||
\begin{figure}[h]
|
||||
\centering
|
||||
\fbox{\parbox{0.7\textwidth}{
|
||||
\centering
|
||||
\vspace{4cm}
|
||||
\Large Platzhalter für Abbildung\\
|
||||
\normalsize (Hier könnte eine Grafik, ein Diagramm oder ein Foto stehen)
|
||||
\vspace{4cm}
|
||||
}}
|
||||
\caption{Demonstrationsabbildung mit Platzhalter}
|
||||
\label{fig:demo_abbildung}
|
||||
\end{figure}
|
||||
|
||||
Die Abbildung~\ref{fig:demo_abbildung} zeigt einen Platzhalter für eine echte Grafik. Abbildungen werden automatisch nummeriert und im Abbildungsverzeichnis aufgeführt.
|
||||
|
||||
\subsection{Subfigures}
|
||||
\label{subsec:subfigures}
|
||||
|
||||
Mit dem \texttt{subcaption}-Paket können mehrere Abbildungen nebeneinander platziert werden:
|
||||
|
||||
\begin{figure}[h]
|
||||
\centering
|
||||
\begin{subfigure}[b]{0.45\textwidth}
|
||||
\centering
|
||||
\fbox{\parbox{0.9\textwidth}{\centering\vspace{2cm}Bild A\vspace{2cm}}}
|
||||
\caption{Erste Teilabbildung}
|
||||
\label{fig:sub1}
|
||||
\end{subfigure}
|
||||
\hfill
|
||||
\begin{subfigure}[b]{0.45\textwidth}
|
||||
\centering
|
||||
\fbox{\parbox{0.9\textwidth}{\centering\vspace{2cm}Bild B\vspace{2cm}}}
|
||||
\caption{Zweite Teilabbildung}
|
||||
\label{fig:sub2}
|
||||
\end{subfigure}
|
||||
\caption{Zwei Abbildungen nebeneinander}
|
||||
\label{fig:subfigures_demo}
|
||||
\end{figure}
|
||||
|
||||
\section{Tabellen}
|
||||
\label{sec:tabellen_demo}
|
||||
|
||||
\subsection{Einfache Tabelle}
|
||||
\label{subsec:einfache_tabelle}
|
||||
|
||||
\begin{table}[h]
|
||||
\centering
|
||||
\caption{Messwerte-Demonstration}
|
||||
\label{tab:messwerte}
|
||||
\begin{tabular}{|l|c|c|c|c|}
|
||||
\hline
|
||||
\textbf{Messung} & \textbf{Zeit [s]} & \textbf{Spannung [V]} & \textbf{Strom [A]} & \textbf{Leistung [W]} \\
|
||||
\hline
|
||||
1 & 0 & 12.0 & 0.5 & 6.0 \\
|
||||
2 & 10 & 11.8 & 0.6 & 7.1 \\
|
||||
3 & 20 & 11.5 & 0.7 & 8.1 \\
|
||||
4 & 30 & 11.2 & 0.8 & 9.0 \\
|
||||
\hline
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
\subsection{Komplexe Tabelle mit multirow und multicolumn}
|
||||
\label{subsec:komplexe_tabelle}
|
||||
|
||||
\begin{table}[h]
|
||||
\centering
|
||||
\caption{Komplexe Tabellenstruktur}
|
||||
\label{tab:komplex}
|
||||
\begin{tabular}{|l|c|c|c|}
|
||||
\hline
|
||||
\multirow{2}{*}{\textbf{Kategorie}} & \multicolumn{3}{c|}{\textbf{Messwerte}} \\
|
||||
\cline{2-4}
|
||||
& \textbf{Min} & \textbf{Max} & \textbf{Mittel} \\
|
||||
\hline
|
||||
Temperatur [°C] & 18.5 & 24.3 & 21.2 \\
|
||||
Luftfeuchtigkeit [\%] & 45 & 62 & 53 \\
|
||||
Druck [hPa] & 1013 & 1021 & 1017 \\
|
||||
\hline
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
\section{Code-Listings}
|
||||
\label{sec:code_listings}
|
||||
|
||||
\subsection{Python-Code}
|
||||
\label{subsec:python_code}
|
||||
|
||||
\begin{lstlisting}[caption={Python-Beispiel: Fakultätsfunktion},label={lst:python_factorial},language=Python]
|
||||
def factorial(n):
|
||||
"""Berechnet die Fakultät einer Zahl rekursiv."""
|
||||
if n <= 1:
|
||||
return 1
|
||||
else:
|
||||
return n * factorial(n - 1)
|
||||
|
||||
# Verwendungsbeispiel
|
||||
for i in range(10):
|
||||
print(f"{i}! = {factorial(i)}")
|
||||
\end{lstlisting}
|
||||
|
||||
\subsection{LaTeX-Code}
|
||||
\label{subsec:latex_code}
|
||||
|
||||
\begin{lstlisting}[caption={LaTeX-Beispiel: Dokumentstruktur},label={lst:latex_example},language=TeX]
|
||||
\documentclass{article}
|
||||
\usepackage[ngerman]{babel}
|
||||
\usepackage{amsmath}
|
||||
|
||||
\begin{document}
|
||||
\section{Überschrift}
|
||||
Dies ist ein Beispieltext mit einer Formel: $x^2 + y^2 = r^2$
|
||||
|
||||
\begin{equation}
|
||||
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
|
||||
\end{equation}
|
||||
\end{document}
|
||||
\end{lstlisting}
|
||||
|
||||
\section{Querverweise und Zitationen}
|
||||
\label{sec:querverweise}
|
||||
|
||||
\subsection{Interne Querverweise}
|
||||
\label{subsec:querverweise_intern}
|
||||
|
||||
Das Template unterstützt intelligente Querverweise mit dem \texttt{cleveref}-Paket:
|
||||
\begin{listenabsatz}
|
||||
\item Verweis auf Kapitel: siehe \cref{chap:template_demo}
|
||||
\item Verweis auf Abschnitt: siehe \cref{sec:formeln_demo}
|
||||
\item Verweis auf Gleichung: siehe \cref{eq:maxwell1}
|
||||
\item Verweis auf Abbildung: siehe \cref{fig:demo_abbildung}
|
||||
\item Verweis auf Tabelle: siehe \cref{tab:messwerte}
|
||||
\item Verweis auf Listing: siehe \cref{lst:python_factorial}
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Fußnoten}
|
||||
\label{subsec:fussnoten_demo}
|
||||
|
||||
Fußnoten\footnote{Dies ist eine Beispiel-Fußnote mit zusätzlichen Informationen.} können für ergänzende Informationen verwendet werden. Sie sollten jedoch sparsam eingesetzt werden\footnote{Eine zweite Fußnote zur Demonstration der automatischen Nummerierung.} und nicht länger als vier Zeilen sein.
|
||||
|
||||
\section{Glossar und Abkürzungen}
|
||||
\label{sec:glossar_demo}
|
||||
|
||||
\subsection{Verwendung von Glossareinträgen}
|
||||
\label{subsec:glossar_verwendung}
|
||||
|
||||
Das Template nutzt das \texttt{glossaries}-Paket für die Verwaltung von Fachbegriffen und Abkürzungen:
|
||||
\begin{listenabsatz}
|
||||
\item Erster Aufruf eines Glossarbegriffs: \gls{Textkörper}
|
||||
\item Zweiter Aufruf desselben Begriffs: \gls{Textkörper}
|
||||
\item Verwendung einer Abkürzung: \gls{MPG}
|
||||
\item Nochmalige Verwendung: \gls{MPG}
|
||||
\end{listenabsatz}
|
||||
|
||||
Die Begriffe werden automatisch in das entsprechende Verzeichnis aufgenommen.
|
||||
|
||||
\section{Spezielle Umgebungen}
|
||||
\label{sec:spezielle_umgebungen}
|
||||
|
||||
\subsection{Theorem-ähnliche Umgebungen}
|
||||
\label{subsec:theoreme}
|
||||
|
||||
Obwohl nicht standardmäßig aktiviert, können bei Bedarf Theorem-Umgebungen definiert werden für:
|
||||
\begin{listenabsatz}
|
||||
\item Definitionen
|
||||
\item Sätze (Theoreme)
|
||||
\item Lemmata
|
||||
\item Korollare
|
||||
\item Beweise
|
||||
\item Beispiele
|
||||
\end{listenabsatz}
|
||||
|
||||
\subsection{Infoboxen und Warnungen}
|
||||
\label{subsec:infoboxen}
|
||||
|
||||
Das Template kann erweitert werden um spezielle Boxen für:
|
||||
\begin{listenabsatz}
|
||||
\item Wichtige Hinweise
|
||||
\item Warnungen
|
||||
\item Tipps und Tricks
|
||||
\item Zusammenfassungen
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Erweiterte Features}
|
||||
\label{sec:erweiterte_features}
|
||||
|
||||
\subsection{TikZ-Grafiken}
|
||||
\label{subsec:tikz}
|
||||
|
||||
Mit TikZ können komplexe Diagramme direkt in \LaTeX{} erstellt werden. Das Template lädt die notwendigen Pakete automatisch.
|
||||
|
||||
\subsection{SVG-Integration}
|
||||
\label{subsec:svg}
|
||||
|
||||
SVG-Dateien können direkt eingebunden werden mit dem \texttt{\textbackslash includesvg}-Befehl, was besonders für Vektorgrafiken aus Inkscape nützlich ist.
|
||||
|
||||
\subsection{Hyperlinks}
|
||||
\label{subsec:hyperlinks}
|
||||
|
||||
Das Template unterstützt:
|
||||
\begin{listenabsatz}
|
||||
\item Automatische Verlinkung von Querverweisen
|
||||
\item Klickbare URLs: \url{https://www.example.com}
|
||||
\item E-Mail-Links: \href{mailto:example@domain.com}{example@domain.com}
|
||||
\item Verlinktes Inhaltsverzeichnis im PDF
|
||||
\end{listenabsatz}
|
||||
|
||||
\section{Zusammenfassung der Template-Features}
|
||||
\label{sec:template_zusammenfassung}
|
||||
|
||||
Das HSRTReport-Template bietet eine umfassende Lösung für wissenschaftliche Arbeiten mit:
|
||||
\begin{listenabsatz}
|
||||
\item Automatischer Formatierung gemäß den Vorgaben
|
||||
\item Konsistenter Typografie und Layout
|
||||
\item Intelligenter Verwaltung von Verzeichnissen
|
||||
\item Flexiblen Möglichkeiten für Formeln, Abbildungen und Tabellen
|
||||
\item Professioneller PDF-Ausgabe mit Hyperlinks
|
||||
\item Einfacher Anpassbarkeit über Konfigurationsdateien
|
||||
\end{listenabsatz}
|
||||
|
||||
Alle diese Features tragen dazu bei, dass sich der Autor auf den Inhalt konzentrieren kann, während das Template die korrekte Formatierung übernimmt.
|
||||
|
||||
% ==============================================================================
|
||||
% End of Kapitel 6
|
||||
% ==============================================================================
|
||||
@ -180,6 +180,7 @@ For important equations, use the equation environment:
|
||||
= \mu_0 \vec{J}
|
||||
\label{eq:maxwell}
|
||||
\end{equation}
|
||||
\myequations{Maxwell's Equations}
|
||||
|
||||
Equation \eqref{eq:maxwell} represents one of Maxwell's equations.
|
||||
|
||||
@ -201,6 +202,7 @@ Matrix example:
|
||||
\end{bmatrix}
|
||||
\label{eq:matrix}
|
||||
\end{equation}
|
||||
\myequations{Matrix}
|
||||
|
||||
% ==============================================================================
|
||||
% Section: Figures and Graphics
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
% ------------------------------------------------------------------------------
|
||||
|
||||
% Example: Technical term
|
||||
\newglossaryentry{Textkoerper}
|
||||
\newglossaryentry{Textkörper}
|
||||
{
|
||||
name=Textkörper,
|
||||
description={
|
||||
@ -59,7 +59,7 @@
|
||||
\newacronym{a:Tab}{Tab.}{Tabelle}
|
||||
|
||||
% Legal and regulatory acronyms
|
||||
\newacronym{a:MPG}{MPG}{Medizinproduktegesetz}
|
||||
\newacronym{MPG}{MPG}{Medizinproduktegesetz}
|
||||
|
||||
% Company and organization acronyms
|
||||
\newacronym{a:MS}{MS}{Microsoft®}
|
||||
|
||||
@ -21,8 +21,16 @@
|
||||
% Equation List Commands
|
||||
% ==============================================================================
|
||||
% Command to add equations to the list
|
||||
\newcommand{\myequations}[1]{%
|
||||
\addcontentsline{equ}{myequations}{\protect\equationname~\numberline{\theequation:} #1}\par}
|
||||
\newfloat{Formel}{htbp}{}
|
||||
\newcommand\numbereq{\addtocounter{equation}{1}\tag{\theequation}}
|
||||
|
||||
\newcommand{\myequations}[1]{
|
||||
% Add Floating (N) #1 below (This function is called after the equation environment)
|
||||
\captionof{Formel}{#1}\vspace{1em}
|
||||
|
||||
% Add to list of equations
|
||||
\cftaddtitleline{equ}{myequations}{\quad\blenderfont(\theequation)\quad #1}{\blenderfont\thepage}\par
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Equation Counter Configuration
|
||||
|
||||
240
HSRTReport/Config/PageBreakControl.tex
Normal file
240
HSRTReport/Config/PageBreakControl.tex
Normal file
@ -0,0 +1,240 @@
|
||||
% !TEX root = ../HSRTReport.cls
|
||||
% ==============================================================================
|
||||
% Page Break Control Configuration Module
|
||||
% ==============================================================================
|
||||
% Description: Advanced page break control for sections, paragraphs, listings,
|
||||
% and itemize environments to ensure proper page layout
|
||||
% Author: Frederik Beimgraben
|
||||
% License: Creative Commons CC BY 4.0
|
||||
% ==============================================================================
|
||||
|
||||
% ==============================================================================
|
||||
% Required Packages
|
||||
% ==============================================================================
|
||||
\RequirePackage{needspace} % For conditional page breaks based on available space
|
||||
\RequirePackage{afterpage} % For deferred page break commands
|
||||
\RequirePackage{placeins} % For section barriers to control float placement
|
||||
|
||||
% ==============================================================================
|
||||
% Global Page Break Penalties
|
||||
% ==============================================================================
|
||||
% Fine-tune the global penalties for page breaking
|
||||
\binoppenalty=10000 % Penalty for breaking at binary operators
|
||||
\relpenalty=10000 % Penalty for breaking at relational operators
|
||||
\brokenpenalty=10000 % Additional penalty for hyphenated line breaks
|
||||
|
||||
% ==============================================================================
|
||||
% Section-Level Page Break Control
|
||||
% ==============================================================================
|
||||
% Define minimum content requirements after sections
|
||||
\newlength{\sectionminspace}
|
||||
\newlength{\subsectionminspace}
|
||||
\newlength{\subsubsectionminspace}
|
||||
|
||||
% Set minimum space requirements (approximately 2 paragraphs)
|
||||
\setlength{\sectionminspace}{12\baselineskip}
|
||||
\setlength{\subsectionminspace}{10\baselineskip}
|
||||
\setlength{\subsubsectionminspace}{8\baselineskip}
|
||||
|
||||
% Hook into section commands to check space
|
||||
\pretocmd{\section}{%
|
||||
\needspace{\sectionminspace}%
|
||||
\FloatBarrier% % Ensure all floats are placed before new section
|
||||
}{}{}
|
||||
|
||||
\pretocmd{\subsection}{%
|
||||
\needspace{\subsectionminspace}%
|
||||
}{}{}
|
||||
|
||||
\pretocmd{\subsubsection}{%
|
||||
\needspace{\subsubsectionminspace}%
|
||||
}{}{}
|
||||
|
||||
% ==============================================================================
|
||||
% Paragraph Cohesion Control
|
||||
% ==============================================================================
|
||||
% Keep paragraphs together when possible
|
||||
\newcommand{\keeptogether}[1]{%
|
||||
\begin{minipage}{\linewidth}%
|
||||
#1%
|
||||
\end{minipage}%
|
||||
}
|
||||
|
||||
% Automatic paragraph protection for short paragraphs
|
||||
\newcommand{\protectparagraph}{%
|
||||
\nopagebreak[4]%
|
||||
\interlinepenalty=10000%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Listing Environment Protection
|
||||
% ==============================================================================
|
||||
% Redefine lstlisting to prevent page breaks
|
||||
\let\originallstlisting\lstlisting
|
||||
\let\endoriginallstlisting\endlstlisting
|
||||
|
||||
\renewenvironment{lstlisting}[1][]{%
|
||||
\needspace{5\baselineskip}% Ensure minimum space
|
||||
\nopagebreak[4]%
|
||||
\originallstlisting[#1]%
|
||||
}{%
|
||||
\endoriginallstlisting%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% For inline listings that must stay together
|
||||
\newenvironment{nobreaklistings}{%
|
||||
\begin{minipage}{\linewidth}%
|
||||
\vspace{0.5em}%
|
||||
}{%
|
||||
\vspace{0.5em}%
|
||||
\end{minipage}%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Itemize and Enumerate Protection
|
||||
% ==============================================================================
|
||||
% Protected itemize that stays with preceding paragraph
|
||||
\newenvironment{nobreakitemize}{%
|
||||
\nopagebreak[4]%
|
||||
\begin{minipage}{\linewidth}%
|
||||
\begin{itemize}%
|
||||
\interlinepenalty=10000%
|
||||
}{%
|
||||
\end{itemize}%
|
||||
\end{minipage}%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% Protected enumerate that stays with preceding paragraph
|
||||
\newenvironment{nobreakenumerate}{%
|
||||
\nopagebreak[4]%
|
||||
\begin{minipage}{\linewidth}%
|
||||
\begin{enumerate}%
|
||||
\interlinepenalty=10000%
|
||||
}{%
|
||||
\end{enumerate}%
|
||||
\end{minipage}%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% Itemize and enumerate hooks are defined in Typography.tex
|
||||
% to avoid conflicts with the listenabsatz environment
|
||||
|
||||
% ==============================================================================
|
||||
% Description List Protection
|
||||
% ==============================================================================
|
||||
\AtBeginEnvironment{description}{%
|
||||
\nopagebreak[4]%
|
||||
\interlinepenalty=5000%
|
||||
}
|
||||
\AtEndEnvironment{description}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Smart Section Breaking
|
||||
% ==============================================================================
|
||||
% Command to check if section should be moved to next page
|
||||
\newcommand{\smartsection}[2][]{%
|
||||
\vfil\penalty-9999\vfilneg% Allow break here if needed
|
||||
\needspace{\sectionminspace}%
|
||||
\section[#1]{#2}%
|
||||
}
|
||||
|
||||
\newcommand{\smartsubsection}[2][]{%
|
||||
\vfil\penalty-9999\vfilneg%
|
||||
\needspace{\subsectionminspace}%
|
||||
\subsection[#1]{#2}%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Figure and Table Protection
|
||||
% ==============================================================================
|
||||
% Keep figures with their captions
|
||||
% Note: Using samepage in figure/table can cause issues with color groups
|
||||
% Instead, use penalties to discourage breaks
|
||||
\AtBeginEnvironment{figure}{%
|
||||
\nopagebreak[4]%
|
||||
}
|
||||
\AtEndEnvironment{figure}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% Keep tables with their captions
|
||||
\AtBeginEnvironment{table}{%
|
||||
\nopagebreak[4]%
|
||||
}
|
||||
\AtEndEnvironment{table}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Code Block Protection
|
||||
% ==============================================================================
|
||||
% For verbatim environments
|
||||
\AtBeginEnvironment{verbatim}{%
|
||||
\nopagebreak[4]%
|
||||
\interlinepenalty=10000%
|
||||
}
|
||||
\AtEndEnvironment{verbatim}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Math Environment Protection
|
||||
% ==============================================================================
|
||||
% Keep equations together
|
||||
\AtBeginEnvironment{equation}{%
|
||||
\nopagebreak[4]%
|
||||
}
|
||||
\AtEndEnvironment{equation}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
\AtBeginEnvironment{align}{%
|
||||
\nopagebreak[4]%
|
||||
\interlinepenalty=10000%
|
||||
}
|
||||
\AtEndEnvironment{align}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Custom Commands for Manual Control
|
||||
% ==============================================================================
|
||||
% Force content to stay together
|
||||
\newcommand{\keeptogetherflex}[1]{%
|
||||
\vbox{#1}%
|
||||
}
|
||||
|
||||
% Conditional page break based on remaining space
|
||||
\newcommand{\conditionalpagebreak}[1][10\baselineskip]{%
|
||||
\needspace{#1}%
|
||||
}
|
||||
|
||||
% Mark critical content that should not be split
|
||||
\newenvironment{critical}{%
|
||||
\begin{samepage}%
|
||||
\interlinepenalty=10000%
|
||||
\widowpenalty=10000%
|
||||
\clubpenalty=10000%
|
||||
}{%
|
||||
\end{samepage}%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Debugging Commands (can be commented out in production)
|
||||
% ==============================================================================
|
||||
% Show page break penalties in log
|
||||
\newcommand{\showpenalties}{%
|
||||
\typeout{Current penalties:}%
|
||||
\typeout{ Widow: \the\widowpenalty}%
|
||||
\typeout{ Club: \the\clubpenalty}%
|
||||
\typeout{ Interline: \the\interlinepenalty}%
|
||||
\typeout{ Broken: \the\brokenpenalty}%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% End of Page Break Control Module
|
||||
% ==============================================================================
|
||||
@ -22,6 +22,9 @@
|
||||
% Remove default header rule
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
|
||||
% Override KOMA-Script chapter page style to use fancy instead of plain
|
||||
\renewcommand{\chapterpagestyle}{fancy}
|
||||
|
||||
% ==============================================================================
|
||||
% Page Number Configuration
|
||||
% ==============================================================================
|
||||
@ -74,9 +77,14 @@
|
||||
% Define the plain page style (used on chapter start pages)
|
||||
\fancypagestyle{plain}{
|
||||
\fancyhf{}
|
||||
% No header on chapter start pages
|
||||
\fancyhead[R]{}
|
||||
\fancyhead[L]{}
|
||||
% Show headers also on chapter start pages
|
||||
\fancyhead[R]{%
|
||||
\color{gray}\blenderfont%
|
||||
\ifnum\value{chapter}>0%
|
||||
\thechapter\quad\leftmark%
|
||||
\fi%
|
||||
}
|
||||
\fancyhead[L]{\color{gray}\blenderfont\@title}
|
||||
% Same footer as regular pages
|
||||
\fancyfoot[L]{%
|
||||
\color{gray}\blenderfont%
|
||||
@ -113,13 +121,12 @@
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Chapter Start Configuration
|
||||
% Override Default Page Styles
|
||||
% ==============================================================================
|
||||
% Ensure chapters start on a new page
|
||||
\let\originalchapter\chapter
|
||||
\renewcommand{\chapter}[1]{%
|
||||
\clearpage%
|
||||
\originalchapter{#1}%
|
||||
% Ensure all special pages use fancy style
|
||||
\AtBeginDocument{%
|
||||
\pagestyle{fancy}%
|
||||
\renewcommand{\chapterpagestyle}{fancy}%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
\setkomafont{disposition}{\blenderfont\bfseries}
|
||||
|
||||
% Configure individual section level fonts
|
||||
\setkomafont{chapter}{\Large\blenderfont\bfseries}
|
||||
\setkomafont{chapter}{\LARGE\blenderfont\bfseries}
|
||||
\setkomafont{section}{\Large\blenderfont\bfseries}
|
||||
\setkomafont{subsection}{\large\blenderfont\bfseries}
|
||||
\setkomafont{subsubsection}{\large\blenderfont\bfseries}
|
||||
|
||||
@ -38,18 +38,29 @@
|
||||
% Figure and Table TOC Formatting
|
||||
% ==============================================================================
|
||||
% Configure font for figure entries in list of figures
|
||||
\renewcommand\cftfigfont{\blenderfont\color{gray}}
|
||||
\renewcommand\cftfigpagefont{\blenderfont\color{gray}}
|
||||
\renewcommand\cftfigfont{\blenderfont}
|
||||
\renewcommand\cftfigpagefont{\blenderfont}
|
||||
|
||||
% Configure font for table entries in list of tables
|
||||
\renewcommand\cfttabfont{\blenderfont\color{gray}}
|
||||
\renewcommand\cfttabpagefont{\blenderfont\color{gray}}
|
||||
\renewcommand\cfttabfont{\blenderfont}
|
||||
\renewcommand\cfttabpagefont{\blenderfont}
|
||||
|
||||
% Configure font for equation entries in list of equations
|
||||
% Define robust font commands
|
||||
|
||||
|
||||
% Configure font for listing entries in lstlistings list
|
||||
\renewcommand*{\l@lstlisting}[2]{
|
||||
\@dottedtocline{1}{1em}{2.3em}
|
||||
{\blenderfont#1}
|
||||
{\blenderfont#2}
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Dot Separation Configuration
|
||||
% ==============================================================================
|
||||
% Set spacing between dots in TOC
|
||||
\renewcommand{\cftdotsep}{1.5}
|
||||
% \renewcommand{\cftdotsep}{1.5}
|
||||
|
||||
% ==============================================================================
|
||||
% End of Table of Contents Configuration Module
|
||||
|
||||
@ -48,20 +48,107 @@
|
||||
\@beginparpenalty=10000
|
||||
\@endparpenalty=10000
|
||||
|
||||
% ==============================================================================
|
||||
% Enhanced Page Break Control
|
||||
% ==============================================================================
|
||||
% Section page break penalties are handled in PageBreakControl.tex
|
||||
|
||||
% Minimum lines on a new page after section break
|
||||
% Require at least 2 paragraphs (approximately 8-10 lines) after a section
|
||||
\raggedbottom % Allow variable page heights to avoid bad breaks
|
||||
\flushbottom % But try to align bottoms when possible
|
||||
|
||||
% Configure penalties for better paragraph cohesion
|
||||
\interlinepenalty=150 % Discourage breaks within paragraphs
|
||||
\predisplaypenalty=10000 % Prevent breaks before equations
|
||||
\postdisplaypenalty=10000 % Prevent breaks after equations
|
||||
\floatingpenalty=20000 % Strongly discourage breaks around floats
|
||||
|
||||
% Keep at least two paragraphs together at page boundaries
|
||||
\setlength{\parskip}{0.5em plus 0.2em minus 0.1em}
|
||||
\parfillskip=0pt plus 1fil
|
||||
|
||||
% ==============================================================================
|
||||
% Listing and Itemize Environment Protection
|
||||
% ==============================================================================
|
||||
% Prevent page breaks in listings
|
||||
\lstset{
|
||||
float=H, % Force listings to stay in place
|
||||
belowskip=-0.5em plus 0.2em, % Adjust spacing
|
||||
aboveskip=0.5em plus 0.2em,
|
||||
keepspaces=true,
|
||||
breaklines=true
|
||||
}
|
||||
|
||||
% Create protected itemize environment that resists page breaks
|
||||
\newenvironment{protecteditemize}{%
|
||||
\begin{minipage}{\linewidth}%
|
||||
\begin{itemize}%
|
||||
}{%
|
||||
\end{itemize}%
|
||||
\end{minipage}%
|
||||
}
|
||||
|
||||
% Create protected enumerate environment
|
||||
\newenvironment{protectedenumerate}{%
|
||||
\begin{minipage}{\linewidth}%
|
||||
\begin{enumerate}%
|
||||
}{%
|
||||
\end{enumerate}%
|
||||
\end{minipage}%
|
||||
}
|
||||
|
||||
% Hook into itemize/enumerate to discourage breaks without redefining
|
||||
% This avoids conflicts with enumitem package options
|
||||
\AtBeginEnvironment{itemize}{%
|
||||
\nopagebreak[4]% Strong discouragement of page break
|
||||
\interlinepenalty=5000% Discourage breaks within items
|
||||
}
|
||||
\AtEndEnvironment{itemize}{%
|
||||
\nopagebreak[3]% Discourage break after list
|
||||
}
|
||||
|
||||
\AtBeginEnvironment{enumerate}{%
|
||||
\nopagebreak[4]%
|
||||
\interlinepenalty=5000%
|
||||
}
|
||||
\AtEndEnvironment{enumerate}{%
|
||||
\nopagebreak[3]%
|
||||
}
|
||||
|
||||
% ==============================================================================
|
||||
% Needspace Package for Conditional Page Breaks
|
||||
% ==============================================================================
|
||||
\usepackage{needspace}
|
||||
|
||||
% Section spacing is handled in PageBreakControl.tex
|
||||
|
||||
% ==============================================================================
|
||||
% Float Placement Control
|
||||
% ==============================================================================
|
||||
% Adjust float placement to keep figures and tables near their reference
|
||||
\renewcommand{\floatpagefraction}{0.8} % Float page must be 80% full
|
||||
\renewcommand{\topfraction}{0.9} % Max 90% of page for top floats
|
||||
\renewcommand{\bottomfraction}{0.9} % Max 90% of page for bottom floats
|
||||
\renewcommand{\textfraction}{0.1} % Min 10% of page must be text
|
||||
\setcounter{topnumber}{2} % Max 2 floats at top of page
|
||||
\setcounter{bottomnumber}{2} % Max 2 floats at bottom of page
|
||||
\setcounter{totalnumber}{4} % Max 4 floats per page
|
||||
|
||||
% ==============================================================================
|
||||
% List Formatting
|
||||
% ==============================================================================
|
||||
% Define a list paragraph style with no spacing between items
|
||||
% This will be used for compact lists as required
|
||||
\newenvironment{listenabsatz}{%
|
||||
\begin{itemize}[nosep,left=0pt,labelwidth=*,itemsep=0pt,parsep=0pt,topsep=0pt]%
|
||||
\begin{itemize}[nosep,leftmargin=*]%
|
||||
}{%
|
||||
\end{itemize}%
|
||||
}
|
||||
|
||||
% Also provide enumerated version
|
||||
\newenvironment{listenabsatz*}{%
|
||||
\begin{enumerate}[nosep,left=0pt,labelwidth=*,itemsep=0pt,parsep=0pt,topsep=0pt]%
|
||||
\begin{enumerate}[nosep,leftmargin=*]%
|
||||
}{%
|
||||
\end{enumerate}%
|
||||
}
|
||||
|
||||
@ -81,6 +81,7 @@
|
||||
\input{\classPath/Config/Equations}
|
||||
\input{\classPath/Config/Floats}
|
||||
\input{\classPath/Config/Typography}
|
||||
\input{\classPath/Config/PageBreakControl}
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
% Content Modules
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
% !TEX root = ../../Main.tex
|
||||
|
||||
\lstset{basicstyle=\footnotesize\ttfamily,breaklines=true,numbers=left,frame=single}
|
||||
\lstset{basicstyle=\footnotesize\ttfamily,breaklines=true,numbers=left,frame=single,float=H}
|
||||
|
||||
\lstdefinestyle{htmlCode} {
|
||||
language=html,
|
||||
@ -63,23 +63,24 @@
|
||||
\ExplSyntaxOn
|
||||
\tl_new:N \l_listings_boxed_options_tl
|
||||
\keys_define:nn { listings/boxed }
|
||||
{
|
||||
{
|
||||
caption .tl_set:N = \l_listings_boxed_caption_tl,
|
||||
shortcaption .tl_set:N = \l_listings_boxed_shortcaption_tl,
|
||||
label .tl_set:N = \l_listings_boxed_label_tl,
|
||||
unknown .code:n =
|
||||
\tl_put_right:NV \l_listings_boxed_options_tl \l_keys_key_tl
|
||||
\tl_put_right:Nn \l_listings_boxed_options_tl { = #1 , },
|
||||
}
|
||||
}
|
||||
\box_new:N \l_listings_boxed_box
|
||||
|
||||
\lstnewenvironment{blstlisting}[1][]
|
||||
{
|
||||
{
|
||||
\nopagebreak[4]
|
||||
\keys_set:nn { listings/boxed } { #1 }
|
||||
\exp_args:NV \lstset \l_listings_boxed_options_tl
|
||||
\hbox_set:Nw \l_listings_boxed_box
|
||||
}
|
||||
{
|
||||
}
|
||||
{
|
||||
\hbox_set_end:
|
||||
\cs_set_eq:cc {c@figure} {c@lstlisting}
|
||||
\tl_set_eq:NN \figurename \lstlistingname
|
||||
@ -95,5 +96,6 @@
|
||||
\tl_if_empty:NF \l_listings_boxed_label_tl { \label{\l_listings_boxed_label_tl} }
|
||||
}
|
||||
\leavevmode\box_use:N \l_listings_boxed_box
|
||||
}
|
||||
\nopagebreak[3]
|
||||
}
|
||||
\ExplSyntaxOff
|
||||
@ -84,4 +84,5 @@
|
||||
|
||||
\GetTitlePageDataTable
|
||||
\end{titlepage}
|
||||
\pagestyle{fancy} % Activate fancy page style after title page
|
||||
}
|
||||
|
||||
151
PageBreak_Implementation_Summary.md
Normal file
151
PageBreak_Implementation_Summary.md
Normal file
@ -0,0 +1,151 @@
|
||||
# Page Break Control Implementation Summary
|
||||
|
||||
## Changes Implemented
|
||||
|
||||
### 1. Core Configuration Files Modified
|
||||
|
||||
#### `/HSRTReport/Config/Typography.tex`
|
||||
- Added enhanced page break control penalties
|
||||
- Implemented listing and itemize environment protection
|
||||
- Added needspace package for conditional page breaks
|
||||
- Configured float placement control
|
||||
- Set up protected itemize/enumerate environments
|
||||
- Defined `listenabsatz` environment for compact lists
|
||||
|
||||
#### `/HSRTReport/Config/PageBreakControl.tex` (New File)
|
||||
- Created comprehensive page break control module
|
||||
- Implemented section-level space requirements (12/10/8 baseline skips)
|
||||
- Added protected environments for lists and listings
|
||||
- Created smart section commands
|
||||
- Implemented conditional page break commands
|
||||
- Added figure/table protection
|
||||
|
||||
#### `/HSRTReport/HSRTReport.cls`
|
||||
- Added inclusion of PageBreakControl.tex module
|
||||
|
||||
#### `/HSRTReport/Modules/Content/Listings.tex`
|
||||
- Updated listings configuration to prevent page breaks
|
||||
- Added float=H option to keep listings in place
|
||||
- Modified blstlisting environment for better page break control
|
||||
|
||||
### 2. Key Features Implemented
|
||||
|
||||
#### Section and Paragraph Control
|
||||
- **Minimum content after sections**: Sections require ~2 paragraphs (12 baseline skips) or move to next page
|
||||
- **Smart section breaking**: Sections check available space before placement
|
||||
- **Paragraph cohesion**: Enhanced penalties to keep paragraphs together
|
||||
|
||||
#### Listing Protection
|
||||
- Listings automatically stay on the same page when they fit
|
||||
- `float=H` option prevents floating
|
||||
- Protected listing environment available for guaranteed no-break
|
||||
|
||||
#### List Environment Protection
|
||||
- Itemize and enumerate lists stay with preceding paragraphs
|
||||
- Automatic penalties added to standard environments
|
||||
- Protected versions available: `nobreakitemize` and `nobreakenumerate`
|
||||
|
||||
### 3. Technical Implementation Details
|
||||
|
||||
#### Penalties Applied
|
||||
- `\widowpenalty=10000` - Prevents orphaned lines
|
||||
- `\clubpenalty=10000` - Prevents widowed lines
|
||||
- `\interlinepenalty=150-5000` - Variable penalty for list items
|
||||
- `\floatingpenalty=20000` - Strongly discourages float breaks
|
||||
- `\predisplaypenalty=10000` - Prevents breaks before equations
|
||||
- `\postdisplaypenalty=10000` - Prevents breaks after equations
|
||||
|
||||
#### Package Dependencies
|
||||
- `needspace` - For conditional page breaks based on available space
|
||||
- `afterpage` - For deferred page break commands
|
||||
- `placeins` - For float barriers at section boundaries
|
||||
- `enumitem` - For customized list environments (already included)
|
||||
- `etoolbox` - For environment hooks (already included)
|
||||
|
||||
### 4. Usage Examples
|
||||
|
||||
#### Automatic Protection (Works Without Changes)
|
||||
```latex
|
||||
\section{Title}
|
||||
This content automatically requires sufficient space or moves to next page.
|
||||
|
||||
\begin{itemize}
|
||||
\item Lists are automatically protected
|
||||
\item From breaking with their introduction
|
||||
\end{itemize}
|
||||
|
||||
\begin{lstlisting}
|
||||
Code listings stay together automatically
|
||||
\end{lstlisting}
|
||||
```
|
||||
|
||||
#### Manual Control When Needed
|
||||
```latex
|
||||
% Force content to stay together
|
||||
\begin{critical}
|
||||
Important content that must not split
|
||||
\end{critical}
|
||||
|
||||
% Protected list
|
||||
\begin{nobreakitemize}
|
||||
\item Guaranteed to stay together
|
||||
\item No page breaks within
|
||||
\end{nobreakitemize}
|
||||
|
||||
% Smart section with space check
|
||||
\smartsection{Intelligent Section}
|
||||
|
||||
% Conditional page break
|
||||
\conditionalpagebreak[15\baselineskip]
|
||||
```
|
||||
|
||||
### 5. Configuration Values
|
||||
|
||||
| Element | Minimum Space Required | Description |
|
||||
|---------|----------------------|-------------|
|
||||
| Section | 12 baseline skips | ~2 paragraphs |
|
||||
| Subsection | 10 baseline skips | ~1.5 paragraphs |
|
||||
| Subsubsection | 8 baseline skips | ~1 paragraph |
|
||||
| Listing | 5 baseline skips | ~5 lines minimum |
|
||||
| Float pages | 80% full | Minimum fill for float-only pages |
|
||||
| Text on float pages | 10% minimum | Ensures some text with floats |
|
||||
|
||||
### 6. Benefits
|
||||
|
||||
1. **Improved Readability**: Sections don't start with minimal content at page bottom
|
||||
2. **Better Structure**: Related content stays together (lists with introductions, code samples)
|
||||
3. **Professional Appearance**: Eliminates awkward page breaks
|
||||
4. **Flexibility**: Automatic behavior with manual override options
|
||||
5. **Compatibility**: Works with existing HSRT Report template structure
|
||||
|
||||
### 7. Testing Results
|
||||
|
||||
- Document compiles successfully with `make compile`
|
||||
- PDF output generated without errors
|
||||
- Page break penalties active and functioning
|
||||
- No conflicts with existing template features
|
||||
|
||||
### 8. Files Created/Modified
|
||||
|
||||
**New Files:**
|
||||
- `/HSRTReport/Config/PageBreakControl.tex`
|
||||
- `/PageBreakControl_Usage.md`
|
||||
- `/PageBreak_Implementation_Summary.md`
|
||||
|
||||
**Modified Files:**
|
||||
- `/HSRTReport/Config/Typography.tex`
|
||||
- `/HSRTReport/HSRTReport.cls`
|
||||
- `/HSRTReport/Modules/Content/Listings.tex`
|
||||
|
||||
### 9. Maintenance Notes
|
||||
|
||||
- All changes are modular and contained within configuration files
|
||||
- Can be disabled by removing PageBreakControl.tex inclusion
|
||||
- Individual features can be adjusted through penalty values
|
||||
- Compatible with future template updates
|
||||
|
||||
### 10. Known Limitations
|
||||
|
||||
- Very long sections may still need manual intervention
|
||||
- Float placement may occasionally override page break preferences
|
||||
- Performance impact minimal but present for very large documents
|
||||
@ -157,9 +157,7 @@
|
||||
% ------------------------------------------------------------------------------
|
||||
|
||||
% Name for the list of equations (appears as chapter/section title)
|
||||
\renewcommand{\listequationsname}{Formeln und Gleichungen}
|
||||
|
||||
% Name for individual equation references
|
||||
\renewcommand{\listequationsname}{Formeln}
|
||||
\renewcommand{\equationname}{Formel}
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user