edit listings text for all operating systems
This commit is contained in:
parent
00535c97fb
commit
e5bb52e607
@ -5,12 +5,12 @@ Um nicht den Überblick im Quellcode zu verlieren und zu vermeiden, dass Quellda
|
||||
|
||||
\subsection{Hauptdatei} Typischerweise wird bei größeren Projekten mit einer Hauptdatei gearbeitet, die gerne \texttt{main.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:main-file}). 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 (vgl. \cref{subsec:input-vs-include}).
|
||||
|
||||
\example{lst:main-file}{projektstruktur/hauptdatei_crop}{Typische Struktur einer Hauptdatei in \LaTeX{}}
|
||||
\example{lst:main-file}{projektstruktur/hauptdatei}{Typische Struktur einer Hauptdatei in \LaTeX{}}
|
||||
\todo{Kommentar und pagenumbering im Beispiel rausnehmen?}
|
||||
|
||||
\subsection{Abschnittsdateien}
|
||||
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. Auch die Befehle \mintinline{latex}{\begin{document}} und \mintinline{latex}{\end{document}} tauchen nicht nochmal auf.
|
||||
Die Dateien, die durch die Hauptdatei eingebunden werden, enthalten keine Präambel, da diese ja schon in der Hauptdatei vorhanden ist. Auch die Befehle \mintinline{latex}{\begin{document}} und \mintinline{latex}{\end{document}} tauchen nicht noch mal auf.
|
||||
|
||||
\subsection{Input oder Include?}
|
||||
\label{subsec:input-vs-include}
|
||||
@ -18,4 +18,4 @@ Kommen wir nun zu den Unterschieden zwischen den beiden möglichen Befehlen zum
|
||||
|
||||
Benutzt man den Befehl \mintinline{latex}{\input}, kann die Dateiendung \texttt{.tex} angegeben werden, sie ist aber nicht zwingend notwendig. Außerdem kann man die Einbindung von Dateien schachteln: 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:main-file}).
|
||||
|
||||
Anders verhält sich der Befehl \mintinline{latex}{\include}: Hier wird die Dateiendung \texttt{.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. \todo{Ist die \mintinline{latex}{\includeonly}-Semantik korrekt?}
|
||||
Anders verhält sich der Befehl \mintinline{latex}{\include}: Hier wird die Dateiendung \texttt{.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.
|
||||
@ -5,11 +5,12 @@ Wir verwenden hierfür gern das Paket \mintinline{latex}{minted}, das zwar etwas
|
||||
|
||||
\subsection{Installation}
|
||||
\todo{Nochmal prüfen, wie der python-Befehl wirklich heißt. Anleitungen für verschiedene Betriebssysteme verlinken. Vor Änderungen in PATH warnen. In Windows: python -\-version, in Ubuntu: python3 -\-version}
|
||||
Zur Verwendung von \mintinline{latex}{minted} ist eine Installation der Programmiersprache Python 3 notwendig
|
||||
Die Installationsdateien sind auf der Projekt-Website\footnote{Verfügbar unter \url{https://www.python.org/downloads/}.} zu finden.
|
||||
Ein ausführlicherer Beitrag zur Installation unter Windows\footnote{Jason Fitzpatrick, How to Install Python on Windows. How-To Geek. July 11, 2017. Verfügbar unter \url{https://www.howtogeek.com/197947/how-to-install-python-on-windows/}.}\footnote{Für eine Anleitung unter Linux siehe \url{https://docs.python-guide.org/starting/install3/linux/}, für MacOS gibt es eine Anleitung unter \url{https://docs.python-guide.org/starting/install3/osx/}.} führt euch durch die verschiedenen Schritte, die speziell für dieses Betriebssystem notwendig sind.\footnote{Insbesondere das Anpassen des Systempfads sollte nicht vergessen werden.}
|
||||
Zur Verwendung von \mintinline{latex}{minted} ist eine Installation der Programmiersprache Python 3 notwendig. Je nachdem, welches Betriebsystem ihr nutzt, kann es sein, dass Python 3 bei euch schon installiert ist. Das könnt ihr durch die Engabe des Befehls \mintinline{bash}{python --version} oder \mintinline{bash}{python3 --version} in einem Terminal\footnote{Navigation unter Windows: \faWindows\ + R → \enquote{cmd} eingeben → Enter} herausfinden
|
||||
|
||||
Nach der erfolgreichen Installation solltet ihr in der Eingabeaufforderung\footnote{Navigation unter Windows: \faWindows\ + R → \enquote{cmd} eingeben → Enter} \mintinline{bash}{python --version} eingeben und mit Enter bestätigen können und in etwa folgendes Ergebnis erhalten:
|
||||
Sollte Python bei euch noch nicht installiert sein, sind die Installationsdateien auf der Projekt-Website\footnote{Verfügbar unter \url{https://www.python.org/downloads/}.} zu finden.
|
||||
Ein ausführlicherer Beitrag zur Installation unter Windows\footnote{Jason Fitzpatrick, How to Install Python on Windows. How-To Geek. July 11, 2017. Verfügbar unter \url{https://www.howtogeek.com/197947/how-to-install-python-on-windows/}.}, Linux\footnote{ \url{https://docs.python-guide.org/starting/install3/linux/}} oder MacOS\footnote{\url{https://docs.python-guide.org/starting/install3/osx/}} führt euch durch die verschiedenen Schritte, die speziell für euer Betriebssystem notwendig sind.\footnote{Insbesondere das Anpassen des Systempfads sollte unter Windows nicht vergessen werden.}
|
||||
|
||||
Nach der erfolgreichen Installation solltet ihr, je nach Betriebssystem, in der Eingabeaufforderung den oben genannten Befehl noch mal eingeben und mit Enter bestätigen können und in etwa folgendes Ergebnis erhalten:
|
||||
|
||||
\begin{minted}[]{bash}
|
||||
$ python --version
|
||||
@ -17,7 +18,7 @@ Python 3.8.5
|
||||
\end{minted}
|
||||
|
||||
\noindent Sollte die Versionsnummer höher sein, ist alles bestens.
|
||||
Im gleichen Fenster gebt ihr jetzt den Befehl \mintinline{bash}{pip install Pygments} ein, womit das Pygments-Paket für Python installiert wird.
|
||||
Im gleichen Fenster gebt ihr jetzt den Befehl \mintinline{bash}{pip install Pygments}\footnote{Achtung: In einigen Betriebssystem lautet der Befehl \mintinline{bash}{pip3 install Pygments}} ein, womit das Pygments-Paket für Python installiert wird.
|
||||
Nach Abschluss dieses Vorgangs könnt ihr das \LaTeX-Paket \mintinline{latex}{minted} über \mintinline{latex}{\usepackage{minted}} einbinden.
|
||||
|
||||
|
||||
|
||||
BIN
listings/projektstruktur/hauptdatei.pdf
Normal file
BIN
listings/projektstruktur/hauptdatei.pdf
Normal file
Binary file not shown.
Binary file not shown.
@ -1,12 +0,0 @@
|
||||
\documentclass{article}
|
||||
\usepackage[ngerman]{babel}
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage[T1]{fontenc}
|
||||
\title{Ein Titel}
|
||||
\begin{document}
|
||||
\pagenumbering{gobble}
|
||||
\maketitle
|
||||
\tableofcontents
|
||||
\input{abschnitt1.tex}
|
||||
\input{abschnitt2.tex}
|
||||
\end{document}
|
||||
Loading…
x
Reference in New Issue
Block a user