latex/latex-skript
5
0
Fork 0
Code Issues 2 Pull Requests Releases 2 Wiki Activity

Kapitel zur Projektstruktur fertiggestellt

Browse Source
This commit is contained in:
Fradtschuk 2021-01-03 21:43:48 +01:00
parent ac4619f36a
commit ea1ab88f49
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
content/projektstruktur.tex
View File

@ -1,16 +1,19 @@
\section{Projektstruktur}
\label{sec:projektstruktur}
In den bisherigen Beispielen haben wir nur sehr kurze \LaTeX{}-Beispiele gesehen. Natürlich kann \LaTeX{} aber auch verwendet werden, um größere Dokumente und Projekte zu erstellen, wie etwa eine Abschlussarbeit.
Um nicht den Überblick im Quellcode zu verlieren, ist es empfehlenswert, ein Projekt sinnvoll zu strukturieren. So die Länge der \LaTeX{}-Dokumente auf eine übersichtliche Größe heruntergebrochen werden.
In den bisherigen Kapiteln haben wir nur sehr kurze \LaTeX{}-Beispiele gesehen. Natürlich kann \LaTeX{} aber auch verwendet werden, um größere Dokumente und Projekte zu erstellen, wie etwa eine Abschlussarbeit.
Um nicht den Überblick im Quellcode zu verlieren und zu vermeiden, dass Quelldateien zu lang werden, ist eine sinnvolle Strukturierung eines größeren \LaTeX{}-Projektes ratsam. Hierfür wird der Quellcode in verschiedene Dateien aufgeteilt, welche in den folgenden Abschnitten näher beleuchtet werden.
\subsection{Hauptdatei} Eine sinnvolle Herangehensweise an die Strukturierung größerer \LaTeX{}-Dokumente ist das Arbeiten mit einer Hauptdatei, die gerne \enquote{maint.tex} genannt wird. Sie ist sozusagen das Skelett des Projektes und enthält damit dessen Grundgerüst. In dieser Hauptdatei werden Titel, Inhaltsverzeichnis sowie die einzelnen Kapitel einer Arbeit eingebunden. Die Einbindung einzelner Kapitel kann entweder mittels \mintinline{latex}{\input{...}} oder \mintinline{latex}{\include{...}} erfolgen. Beide verlangen als Argument den Pfad zur Datei, die eingebunden werden soll. Auf die Unterschiede gehen wir später noch ein.
\subsection{Hauptdatei} Typischerweise wird bei größeren Projekten mit einer Hauptdatei gearbeitet, die gerne \enquote{maint.tex} genannt wird. Sie ist sozusagen das Skelett des Projektes und enthält damit dessen Grundgerüst inklusive der Präambel. In dieser Hauptdatei werden Titel, Inhaltsverzeichnis sowie die einzelnen Kapitel einer Arbeit eingebunden (vgl. \cref{lst:hauptdatei}). Die Einbindung der einzelnen Abschnitte kann entweder mittels \mintinline{latex}{\input{...}} oder \mintinline{latex}{\include{...}} erfolgen. Beide verlangen als Argument den Pfad zur Datei, die eingebunden werden soll. Auf die Unterschiede zwischen den beiden Befehlen gehen wir später noch ein.
\example{lst:hauptdatei}{projektstruktur/hauptdatei}{Typische Struktur einer Hauptdatei in \LaTeX{}}
\subsection{Abschnittsdateien}
Die Dateien, die durch die Hauptdatei eingebunden werden, enthalten typischerweise keine Präambel, da diese ja schon in der Hauptdatei vorhanden ist. Außerdem können auch die Befehle \mintinline{latex}{\begin{document}} und \mintinline{latex}{\end{document}} in den Abschnittsdateien getrost weggelassen werden.
Abschnittsdateien sind Dateien, die innerhalb der Hauptdatei eingebunden werden. Diese können in einer Abschlussarbeit beispielsweise einzelne Kapitel sein. Grundsätzlich ist man aber ganz frei in der Entscheidung, wie granular die Aufteilung des Inhaltes in einzelne Dateien gestaltet werden soll.
Die Dateien, die durch die Hauptdatei eingebunden werden, enthalten keine Präambel, da diese ja schon in der Hauptdatei vorhanden ist. Außerdem sind in den Abschnittsdateien auch die Befehle \mintinline{latex}{\begin{document}} und \mintinline{latex}{\end{document}} nicht notwendig.
\subsection{Input oder Include?}
Kommen wir nun zu den Unterschieden zwischen den beiden möglichen Befehlen zum Einbinden von \LaTeX-Dateien. Kurz zusammengefasst weisen \mintinline{latex}{\include} und \mintinline{latex}{\input} Unterschiede in den folgenden drei Aspekten auf: Die Art und Weise, wie der Pfad zur einzubindenden Datei angegeben wird, die Möglichkeit der Schachtelung von Einbindungen und ob für jedes Kapitel eine neue Seite angefangen wird.
Kommen wir nun zu den Unterschieden zwischen den beiden möglichen Befehlen zum Einbinden von \LaTeX-Dateien. Kurz zusammengefasst weisen \mintinline{latex}{\include} und \mintinline{latex}{\input} Unterschiede in den folgenden drei Aspekten auf: Die Art und Weise, wie der Pfad zur einzubindenden Datei angegeben wird, die Möglichkeit der Schachtelung von Einbindungen und ob für jeden Abschnitt eine neue Seite angefangen wird.
Benutzt man den Befehl \mintinline{latex}{\input}, kann die Dateiendung \enquote{.tex} angegeben werden, sie ist aber nicht zwingend notwendig. Außerdem kann man die Einbindung von Dateien schachteln, das heißt, eine Datei, die mit \mintinline{latex}{\input} eingebunden wurde, kann wiederum mit dem gleichen Befehl eine andere Datei einbinden. Die Dateien, die eingebunden wurden, werden im fertigen Dokument eingefügt, ohne dass dabei eine neue Seite für den eingebundenen Abschnitt angefangen wird (vgl. \cref{lst:hauptdatei}). Anders verhält sich der Befehl \mintinline{latex}{\include}: Hier wird die Dateiendung \enquote{.tex} für die eingebundenen Kapitel nicht mit angegeben. Die Schachtelung von Einbindungen nicht möglich. Für jede eingebundene Datei wird außerdem eine neue Seite erzeugt. Der \mintinline{latex}{\include} Befehl bietet aber einen Vorteil für größere Projekte: Man kann mit dem Befehl \mintinline{latex}{\includeonly{file1,file2,...}} direkt mehrere Dateien in der Präambel einbinden, allerdings muss hier vorher das gesamte Projekt mindestens einmal kompiliert worden sein.
Benutzt man den Befehl \mintinline{latex}{\input}, kann die Dateiendung \enquote{.tex} angegeben werden, sie ist aber nicht zwingend notwendig. Außerdem kann man die Einbindung von Dateien schachteln, das heißt, eine Datei, die mit \mintinline{latex}{\input} eingebunden wurde, kann wiederum mit dem gleichen Befehl eine andere Datei einbinden. Die Dateien, die eingebunden wurden, werden im fertigen Dokument eingefügt, ohne dass dabei eine neue Seite für den eingebundenen Abschnitt angefangen wird (vgl. \cref{lst:hauptdatei}).
Anders verhält sich der Befehl \mintinline{latex}{\include}: Hier wird die Dateiendung \enquote{.tex} für die eingebundenen Kapitel \emph{nicht} mit angegeben. Die Schachtelung von Einbindungen ist nicht möglich. Für jede eingebundene Datei wird außerdem eine neue Seite erzeugt. Der \mintinline{latex}{\include}-Befehl bietet aber einen Vorteil für größere Projekte: Man kann mit dem Befehl \mintinline{latex}{\includeonly{file1,file2,...}} direkt mehrere Dateien in der Präambel einbinden, allerdings muss hier vorher das gesamte Projekt mindestens einmal kompiliert worden sein.