From 50d9f0e0fb83dc8fa30a1c5d7cf21ccc673762fd Mon Sep 17 00:00:00 2001
From: Michael Grinberg <michael.grinberg@iosb.fraunhofer.de>
Date: Sun, 24 Feb 2019 00:50:07 +0100
Subject: [PATCH] =?UTF-8?q?Erg=C3=A4nzungen=20an=20der=20Anleitung?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../0X-ExampleContents/AufbauDerVorlage.tex | 11 +++-
content/0X-ExampleContents/Bilder.tex | 58 ++++++++++++-------
content/0X-ExampleContents/GlossareEtc.tex | 34 +++++------
.../0X-ExampleContents/Sprachumschaltung.tex | 6 +-
preambel/Glossary.tex | 3 +-
5 files changed, 68 insertions(+), 44 deletions(-)
diff --git a/content/0X-ExampleContents/AufbauDerVorlage.tex b/content/0X-ExampleContents/AufbauDerVorlage.tex
index 6293cfa..2f2eabf 100644
--- a/content/0X-ExampleContents/AufbauDerVorlage.tex
+++ b/content/0X-ExampleContents/AufbauDerVorlage.tex
@@ -194,4 +194,13 @@ So wird beispielsweise bei Umstellung auf Englisch als Hauptsprache
\enquote{Danksagung} durch \enquote{Acknowledgments},
\enquote{Inhaltsverzeichnis} durch \enquote{Contents}
\usw ersetzt.
-Auch die Regeln der Silbentrennung werden entsprechend angepasst.
\ No newline at end of file
+Auch die Regeln der Silbentrennung werden entsprechend angepasst.
+
+Regeln zur Silbentrennung unbekannter Wörtern (\zB von Fachbegriffen)
+können in der Datei \printfilepath{./preambel/Hyphenation.tex} festgelegt werden.
+Zu beachten ist, dass zusammengesetzte Wörter mit einem Bindestrich
+ausschließlich am Bindestrich getrennt werden,
+wogegen auch ein Eintrag in die Datei \printfilepath{Hyphenation.tex} nicht hilft.
+Um Silbentrennung an anderen Stellen eines zusammengesetzten Wortes zu erlauben,
+muss man den Bindestrich durch „\verb+"=+“ ersetzen%
+\footnote{\url{https://de.wikibooks.org/wiki/LaTeX-W%C3%B6rterbuch:_Silbentrennung}}.
diff --git a/content/0X-ExampleContents/Bilder.tex b/content/0X-ExampleContents/Bilder.tex
index 809c9f2..921cbaa 100644
--- a/content/0X-ExampleContents/Bilder.tex
+++ b/content/0X-ExampleContents/Bilder.tex
@@ -11,8 +11,8 @@ Bei Einbindung von Grafiken sind zwei Fälle zu unterscheiden:
\end{itemize*}
Grundlegender Unterschied bei der Einbindung \enquote{regulärer} Bilder
-und \gls{gls:tikz}-Bilder ist, dass Binärformatgrafiken mit \lc{includegraphics}
-eingebunden werden, während \gls{gls:tikz}-Grafiken mit \lc{input} eingebunden
+und \gls{gls:tikz}-Bilder ist, dass Binärformatgrafiken mit \lc{includegraphics\{...\}}
+eingebunden werden, während \gls{gls:tikz}-Grafiken mit \lc{input\{...\}} eingebunden
und von \texttt{latex} mitkompiliert werden.
@@ -26,30 +26,44 @@ damit \LaTeX\ sie geschickt positionieren kann.
Bei Bildern heißt die entsprechende Float-Umgebung \printkeyword{figure}.
Die Positionierung kann durch Angabe von Buchstaben
\printkeyword{h}, \printkeyword{t}, \printkeyword{b} und \printkeyword{p}
-beeinflusst werden, die Auswirkung ist allerdings nicht immer intuitiv.
-Um diese zu verstehen, empfiehlt sich die Lektüre der Beschreibung
-von Frank Mittelbach
-\href{https://tex.stackexchange.com/questions/39017/how-to-influence-the-position-of-float-environments-like-figure-and-table-in-lat/39020#39020}{auf stackexchange.com}.%
-\footnote{\url{https://tex.stackexchange.com/questions/39017/how-to-influence-the-position-of-float-environments-like-figure-and-table-in-lat/39020#39020}}
+beeinflusst werden
+(\enquote{here}, \enquote{top}, \enquote{bottom}, \enquote{extra page}).
\myexcl{Wichtig!}
Seitens des \glsgen{ac:KSP} wird bezüglich Einbindung von Floats gefordert,
dass diese die einzelnen Sätze nicht zerreißen.
-Dies bedeutet, dass eine Platzierung am Anfang oder am Ende einer Seite
-unerwünscht ist, wenn dadurch ein Satz aufgeteilt wird.
-Somit bleibt eigentlich nur noch die Verwendung der \printkeyword{h}-Option,
-die das Bild allerdings nicht immer an der gewünschten Stelle einfügen kann.
-Manchmal wird das Bild dadurch ans Ende des Kapitels
-(genauer gesagt, an die Stelle, wo die nächste \lc{clearpage}-Anweisung kommt)
-verschoben.
-Und auch wenn die Platzierung mit der \printkeyword{h}-Option klappt,
-können unerwünschte Effekte auftreten.
+Dies bedeutet, dass eine Platzierung von Bildern und Tabellen lediglich
+zwischen zwei Absätzen in Frage kommt.
+Allerdings kann es passieren, dass der Platz auf der Seite nicht mehr ausreicht,
+und das Bild nicht an der gewünschten Stelle gesetzt werden kann.
+Damit wird das Bild auf die nächste Seite verschoben.
+Bei aktivierter \printkeyword{t}- oder \printkeyword{b}-Option würde \LaTeX{} versuchen,
+das Bild am oberen oder unteren Rand der Seite zu platzieren.
+Allerdings passiert das dann häufig mitten in einem Satz,
+was vom \gls{ac:KSP} ausdrücklich nicht erwünscht ist.
+Somit bleibt eigentlich nur noch die Verwendung der \printkeyword{h}-Option.
+
+Leider können dabei einige unerwünschte Effekte auftreten.
So können beispielsweise auf der vorherigen Seite riesige leere Flächen entstehen.
-Daher empfiehlt sich eine endgültige Platzierung der Bilder erst ganz am Schluss,
+Wenn der verbleibende Platz auf der Seite eine Platzierung nicht erlaubt,
+kann es schnell passieren, dass \LaTeX{} das betroffene Bild
+und alle Folgeilder ans Ende des Kapitels verschiebt
+(genauer gesagt, an die Stelle, wo die nächste \lc{clearpage}-Anweisung kommt).
+
+Eine genaue Auswirkung der Parameter
+\printkeyword{h}, \printkeyword{t}, \printkeyword{b} und \printkeyword{p}
+auf die Bildplatzierung ist nicht immer intuitiv.
+Um diese zu verstehen, empfiehlt sich die Lektüre der Beschreibung
+von Frank Mittelbach
+\href{https://tex.stackexchange.com/questions/39017/how-to-influence-the-position-of-float-environments-like-figure-and-table-in-lat/39020#39020}{auf stackexchange.com}.%
+\footnote{\url{https://tex.stackexchange.com/questions/39017/how-to-influence-the-position-of-float-environments-like-figure-and-table-in-lat/39020#39020}}
+
+Prinzipiell empfiehlt sich eine endgültige Platzierung der Bilder erst ganz am Schluss,
nachdem alle anderen Korrekturen durchgeführt sind.
Ggf. müssen die Bilderdefinitionen manuell im Quellcode herumgeschoben werden,
-bis sie von \LaTeX\ optimal gesetzt werden.
-Dafür empfiehlt es sich, die einzelnen Bilddefinitionen in Extra-Dateien auszulagern.
+bis die Abbildungen von \LaTeX\ optimal gesetzt werden.
+Dafür empfiehlt es sich, die einzelnen Bilddefinitionen in Extra-Dateien auszulagern,
+so dass nur noch eine einzige Zeile herumgeschoben werden muss.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection[Binärbilder]{\index{Bild!Binär-}Binärbilder}%
@@ -151,12 +165,12 @@ Man beachte die abschließenden Prozent-Zeichen am Ende jeder Zeile!
\label{sec:TikZ}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
-\pkg{\Gls{gls:tikz}} eignet sich hervorragend, um wissenschaftliche Zeichnungen,
+\Gls{gls:tikz} eignet sich hervorragend, um wissenschaftliche Zeichnungen,
Vektorgrafiken und \index{Diagramm}Diagramme direkt mithilfe von LaTeX
zu setzen, sodass die Schrift direkt zum restlichen Dokument passt.
-Zu \gls{gls:tikz} und dem darauf aufsetzenden \pkg{\gls{gls:pgfplots}} gibt
+Zu dem \pkg{tikz}-\gls{gls:pkg} und dem darauf aufsetzenden \pkg{PGFplots}-\gls{gls:pkg} gibt
es hervorragende Dokumentation \parencites{Tantau2013}{Feuersaenger2014}.
-Mit TikZ lassen sich viele gute Sachen machen.
+Mit \gls{gls:tikz} und \gls{gls:pgfplots} lassen sich viele gute Sachen machen.
Der Code für die Einbindung einer \gls{gls:tikz}-Grafik sieht folgendermaßen aus:
diff --git a/content/0X-ExampleContents/GlossareEtc.tex b/content/0X-ExampleContents/GlossareEtc.tex
index 764a695..f9b9e86 100644
--- a/content/0X-ExampleContents/GlossareEtc.tex
+++ b/content/0X-ExampleContents/GlossareEtc.tex
@@ -6,7 +6,7 @@
Die Vorlage unterstützt auch ein Abkürzungsverzeichnis, ein Stichwortverzeichnis,
ein Symbolverzeichnis sowie ein allgemeines \index{Glossar}\gls{gls:Glossar},
das Definitionen von \index{Fachbegriff!Definition}Fachtermini oder
-\index{Ãœbersetzung}Ãœbersetzungen von fremdsprachlichen Begriffen
+\index{Uebersetzung@Ãœbersetzung}Ãœbersetzungen von fremdsprachlichen Begriffen
(d.h. eine Art Lexikons) enthalten kann.
@@ -19,7 +19,7 @@ Zur Erzeugung des Abkürzungsverzeichnis und des Glossar wird intern das
Zudem wurden einige Makros definiert, welche die Erfassung der Begriffe erleichtern sollen.
Um ein Abkürzungsverzeichnis zu erzeugen, muss zuerst eine Liste der Abkürzungen angelegt werden.
-Dies geschieht in der Datei \texttt{./preambel/Acronyms.tex}.
+Dies geschieht in der Datei \printfilepath{./preambel/Acronyms.tex}.
Hierfür wird das Makro \lc{newacronym} verwendet.
Dieses Makro hat drei obligatorische Argumente, nämlich das
\begin{itemize*}
@@ -60,10 +60,10 @@ Beim zweiten Vorkommen wird nur noch die Abkürzung gedruckt.
Zusätzlich definiert die Vorlage die Befehle
\lc{acgen\{...\}}, \lc{acdat\{...\}} und \lc{acacc\{...\}}, sowie
\lc{acplgen\{...\}}, \lc{acpldat\{...\}} und \lc{acplacc\{...\}},
-die jeweils die Genitiv- Dativ- und Akkusativ-Form (singular und Plural) drucken.
+die jeweils die Genitiv-, Dativ- und Akkusativ-Form (singular und Plural) drucken.
Im \gls{gls:pkg} \pkg{glossaries} stellt der Befehl \lc{ac\{...\}} ein Shortcut für den Befehl \lc{gls\{...\}} dar.
-Mit diesem kann ein allgemeines Glossareintrag im Text referenziert werden.
+Mit diesem kann ein allgemeines Glossar-Eintrag im Text referenziert werden.
Mit den Befehlen
\lc{acrshort\{...\}}, \lc{acrlong\{...\}}, \lc{acrfull\{...\}}
@@ -106,30 +106,30 @@ gefolgt von der Kurzform. Bei der zweiten Nennung des
Neben einem Abkürzungsverzeichnis kann man auch ein
\index{Glossar}\gls{gls:Glossar} erstellen lassen.
In diesem können Definitionen von \index{Fachbegriff!Definition}Fachtermini oder
-\index{Ãœbersetzung}Ãœbersetzungen von fremdsprachlichen Begriffen stehen.
+\index{Uebersetzung@Ãœbersetzung}Ãœbersetzungen von fremdsprachlichen Begriffen stehen.
-Der wesentliche Unterschied zwischen einer Abkürzung und einem allgemeinen Glossareintrag ist,
+Der wesentliche Unterschied zwischen einer Abkürzung und einem allgemeinen Glossar-Eintrag ist,
dass bei Abkürzungen bei erstmaliger Verwendung die Abkürzung gedruckt und die Langform in Klammer dahinter gesetzt wird.
-Bei allgemeinen Glossareinträgen wird normalerweise nur der Name gesetzt.
+Bei allgemeinen Glossar-Einträgen wird normalerweise nur der Name gesetzt.
Durch eine Option des \pkg{glossaries}-\glsgen{gls:pkg} kann man sicher stellen,
-dass alle Glossareinträge auf das Glossar am Ende des Manuskripts verlinkt werden.
+dass alle Glossar-Einträge auf das Glossar am Ende des Manuskripts verlinkt werden.
Standardmäßig ist diese Option jedoch deaktiviert.
-Die Glossareinträge werden in der Datei \texttt{./preambel/Glossary.tex} definiert.
+Die Glossar-Einträge werden in der Datei \printfilepath{./preambel/Glossary.tex} definiert.
-Die Definition der Glossareinträge geschieht mit dem Makro \lc{myglossaryentry},
+Die Definition der Glossar-Einträge geschieht mit dem Makro \lc{myglossaryentry},
welches drei obligatorische Argumente hat, nämlich
\begin{itemize*}
\item die Marke,
\item den Begriff und
\item die Erklärung / Definition / Übersetzung.
\end{itemize*}
-Als Konvention wird der Marke eines Glossareintrages ein \enquote{gls:} als Präfix vorangestellt.
+Als Konvention wird der Marke eines Glossar-Eintrages ein \enquote{gls:} als Präfix vorangestellt.
Optional kann die Plural-, sowie Genitiv-, Dativ- und Akkusativ-Form des Begriffs angegeben werden,
sofern sie im Quelltext verwendet werden und sich von der Grundform unterscheiden.
-Ein Glossareintrag kann beispielsweise folgendermaßen definiert werden:
-\begin{latex}[caption={Definition eines Glossareintrages},label={lst:GlossEntry}]
+Ein Glossar-Eintrag kann beispielsweise folgendermaßen definiert werden:
+\begin{latex}[caption={Definition eines Glossar-Eintrages},label={lst:GlossEntry}]
\myglossaryentry[plural={Glossare},%
genitive={Glossars}]%
{gls:Glossare}{Glossar}{alphabetisch sortierte Liste von Begriffen mit Erklärung}
@@ -137,7 +137,7 @@ Ein Glossareintrag kann beispielsweise folgendermaßen definiert werden:
Normalerweise werden im Glossar nur diejenigen Begriffe angezeigt,
die im Text des Dokumentes erwähnt und entsprechend referenziert worden sind.
-Eine Referenzierung der Glossareinträge im Text geschieht normalerweise mit dem
+Eine Referenzierung der Glossar-Einträge im Text geschieht normalerweise mit dem
\lc{gls\{<Marke>\}}-Befehl,
welcher den Begriff im Text druckt und für seine Aufnahme ins Glossar sorgt.
Weitere mögliche Befehle sind \lc{Gls\{...\}} und \lc{GLS\{...\}},
@@ -150,10 +150,10 @@ die jeweils die Genitiv- Dativ- und Akkusativ-Form drucken.
Außerdem gibt es mit dem Befehl \lc{glsadd\{...\}} die Möglichkeit,
eine Stelle im Text mit einem Glossar-Begriff zu verlinken, ohne diesen explizit zu drucken.
-Mit \lc{glsaddall} kann man alle definierte Glossareinträge ins Glossar aufnehmen,
+Mit \lc{glsaddall} kann man alle definierte Glossar-Einträge ins Glossar aufnehmen,
ohne sie im Text des Dokumentes referenziert zu haben.
-Die Verwendung des oben definierten Glossareintrages im Text mit dem Befehl
+Die Verwendung des oben definierten Glossar-Eintrages im Text mit dem Befehl
\lc{glsgen\{gls:Glossar\}} mündet im Text in Erwähnung des \glsgen{gls:Glossar}.
@@ -191,7 +191,7 @@ Diese ist recht einfach und lässt sich bei Bedarf beliebig ergänzen.
Allerdings gibt es auch die Möglichkeit zur automatischen Erzeugung eines
Symbolverzeichnisses mit Hilfe des \pkg{glossaries}-\glsgen{gls:pkg}.
Um dieses, am Ende des Manuskriptes eingebundene Symbolverzeichnis zu erzeugen,
-müssen Symbole in Form von Glossareinträgen angelegt und im Text des Dokumentes
+müssen Symbole in Form von Glossar-Einträgen angelegt und im Text des Dokumentes
zumindest einmal entsprechend mit dem Befehl \lc{gls\{<Marke>\}} referenziert werden.
Dafür müsste ein Symboleintrag folgendermaßen angelegt werden:
\begin{latex}[caption={Definition eines Symboleintrages},label={lst:SymbEntry}]
diff --git a/content/0X-ExampleContents/Sprachumschaltung.tex b/content/0X-ExampleContents/Sprachumschaltung.tex
index 27e1f33..a97b43b 100644
--- a/content/0X-ExampleContents/Sprachumschaltung.tex
+++ b/content/0X-ExampleContents/Sprachumschaltung.tex
@@ -6,9 +6,9 @@
\label{sec:Sprache}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
-Die Hauptsprache der Arbeit wird in der Datei \texttt{./preambel/AlleAngaben.tex} festgelegt.
+Die Hauptsprache der Arbeit wird in der Datei \printfilepath{./preambel/AlleAngaben.tex} festgelegt.
Aktuell werden nur Deutsch und Englisch als Hauptsprachen unterstützt.
-Die Auswahl geschieht mit der Angabe des Wertes \texttt{true} oder \texttt{false}
+Die Auswahl geschieht mit der Angabe des Wertes \printkeyword{true} oder \printkeyword{false}
in der Zeile \lc{setboolean\{iesenglishs\}\{<Wert>\}}.
Bei Verwendung von fremdsprachlichen Begriffen oder Textabschnitten
@@ -24,5 +24,5 @@ Dann wird für den Text in den geschweiften Klammern die in den eckigen Klammern
Um die Sprache bis zum nächsten Aufruf des gleichen Kommandos dauerhaft umstellen,
gibt es den Befehl \verb+\selectlanguage{Sprache}+.
Es gilt eine Liste der Sprachen aus dem Paket \pkg{babel}.
-Für deustch sollte \texttt{ngerman} verwendet werden, was für die
+Für Deustch sollte \printkeyword{ngerman} verwendet werden, was für die
\index{Rechtschreibung!neue deutsche}neue deutsche Rechtschreibung steht.
\ No newline at end of file
diff --git a/preambel/Glossary.tex b/preambel/Glossary.tex
index 5930651..361542e 100644
--- a/preambel/Glossary.tex
+++ b/preambel/Glossary.tex
@@ -146,7 +146,8 @@
\myglossaryentry{gls:ProbabilityMassFunction}{probability mass function}{Zähldichte}
\myglossaryentry{gls:pgfplots}{PGFplots}{Eine Sammlung von TikZ-Paketen, die ein direktes Erzeugen
von Diagrammen aller Art (inkl. 3D-Diagramme) direkt aus LaTeX heraus ermöglicht.}
-\myglossaryentry[plural={Pakete}]%
+\myglossaryentry[plural={Pakete},%
+ genitive={Pakets}]%
{gls:pkg}{Paket}{Ein LaTeX-Paket besteht aus einer oder mehrerer Dateien,
die entweder vorhandene Kernfunktionen von LaTeX umdefinieren und so das Verhalten
derselbigen bzw. das Erscheinungsbild des fertigen Dokuments verändern
--
GitLab