diff --git a/doc/iodhbwm.pdf b/doc/iodhbwm.pdf index 57516cf..aceee68 100644 Binary files a/doc/iodhbwm.pdf and b/doc/iodhbwm.pdf differ diff --git a/doc/iodhbwm.tex b/doc/iodhbwm.tex index 55adf6d..b4cd5e5 100644 --- a/doc/iodhbwm.tex +++ b/doc/iodhbwm.tex @@ -4,8 +4,8 @@ \usepackage{lmodern} \usepackage{enumitem} -\package[ctan=iodhbwm, vcs=https://github.com/faltfe/iodhbwm]{iodhbwm} -\version{0.3-alpha} +\package[vcs=https://github.com/faltfe/iodhbwm]{iodhbwm} +\version{0.4-alpha} \title{iodhbwm bundle} \author{Felix Faltin} @@ -40,7 +40,7 @@ \section{Die Klasse iodhbwm}\label{cls:iodhbwm} Die Angabe der Optionen erfolgt über das optionale Argument von \cs{documentclass}. Dabei wird auf das \meta{key}=\meta{value} System von \pkg{pgfopts} zurückgegriffen. - + \subsection{Optionen} \subsubsection{Allgemeine} \Option{load-preamble}\WithValues{true, false}\AndDefault{true} @@ -60,17 +60,17 @@ \item [\pkg{multirow}] Paket zur vertikalen Verbinden von einzelnen Zellen in einer Tabelle \item [\pkg{listings}] Darstellung von Quellcode unterschiedlicher Sprachen. Bei Aktivierung von \opt{load-dhbw-templates} wird ein Design vorgeladen. \end{description} - + \Option{load-dhbw-templates}\WithValues{true, false}\AndDefault{false} Bei Angabe der Option wird das Paket \pkg{iodhbwm-templates} geladen. Die dadurch bereitgestellten zusätzlichen Funktionen werden im Abschnitt~\ref{pkg:iodhbwm-templates} beschrieben.\medskip - + \Option{add-tocs-to-toc}\WithValues{true, false}\AndDefault{false} bei Aktivierung der Option werden alle Verzeichnisse (Tabellen-, Abbildungs- und Literaturverzeichnis) in das Inhaltsverzeichnis übernommen. Es ist ein zusätzlicher Lauf von pdf\LaTeX notwendig, damit das Literaturverzeichnis im Inhaltsverzeichnis erscheint. \medskip - + \Option{language}\WithValues{babel language}\AndDefault{empty} Sprachen, welche im Dokument verwendet werden soll, sind über diese Option anzugeben. Als Hauptsprache wird die letzte angegebene Sprache verwendet. Alternativ kann die Option \opt{mainlanguage} genutzt werden. - + \begin{verbatim} \documentclass[% language = english, @@ -78,12 +78,12 @@ ]{iodhbwm} \end{verbatim} Im Beispiel werden die Sprachen Englisch und Deutsch (neue Deutsche Rechtschreibung) geladen, wobei Deutsch automatisch als Hauptsprache verwendet wird. - + Die Sprachen werden als Option an alle notwendigen Pakete (\pkg{babel}, \pkg{cleveref}) weiter gereicht.\medskip - + \Option{mainlanguage}\WithValues{babel language}\AndDefault{}\medskip Im Gegensatz zu \opt{language} wird mit der Option ausschließlich die Hauptsprache gesetzt. - + \begin{verbatim} \documentclass[% language = english, @@ -91,16 +91,16 @@ ]{iodhbwm} \end{verbatim} Die Angaben der Sprache ist äquivalent zum vorherigen Beispiel.\medskip - + \subsubsection{Bibliographie} \Option{add-bibliography}\WithValues{true, false}\AndDefault{false} Bei Aktivierung der Option wird versucht, ein Literaturverzeichnis zu erstellen, welches automatisch am Ende des Dokuments ausgegeben werden soll. Wenn die Option \opt{bib-file} nicht gesetzt ist, wird automatisch nach der Datei \file{dhbw-source.bib} gesucht. - + Das Literaturverzeichnis wird mittel \pkg{biblatex} und biber erstellt. Es ist darauf zu achten, dass die Einstellungen in der IDE gegebenenfalls anzupassen sind!\medskip - + \Option{add-bibliography-}\WithValues{true, false}\AndDefault{false} Die Option verhält sich ähnlich wie \opt{add-bibliography} mit dem Unterschied, dass am Ende des Dokuments kein Literaturverzeichnis abgebildet wird. Diese Option ist gut geeignet, wenn Fußnoten für Zitate verwendet werden sollen.\medskip - + \Option{bib-file}\WithValues{\meta{filename}} Der Option kann als \meta{key} eine Datei mitgegeben werden, welche die Einträge für das Inhaltsverzeichnis beinhalten. Es ist darauf zu achten, dass die Datei einschließlich Dateiendung übergeben wird. \begin{verbatim} @@ -110,40 +110,40 @@ ]{iodhbwm} \end{verbatim} Diese Option ist nur in Verbindung mit \opt{add-bibliography} oder \opt{add-bibliography-} wirksam.\medskip - + \Option{biblatex/style}\WithValues{\meta{citation style}}\AndDefault{numeric-comp} Biblatex bietet unterschiedliche Zitierweisen an. Diese Option erlaubt die Angabe der gewünschten Zitierweise. Wenn der Option ein Stil übergeben wird, überschreibt dieser die Optionen \opt{biblatex/bibstyle} und \opt{biblatex/citestyle}, wenn diese zuvor definiert wurden.\medskip - + \Option{biblatex/bibstyle}\WithValues{\meta{citation style}} Wenn sich die Zitierweise im Literaturverzeichnis von jener im Text unterscheiden soll, kann ein abweichender Stil mit dieser Option definiert werden. Es ist darauf zu achten, dass die Option zwingend nach \opt{biblatex/style} zu setzen ist, falls diese verwendet wird.\medskip - + \Option{biblatex/citestyle}\WithValues{\meta{citation style}} Wenn sich die Zitierweise im Dokument von jener im Literaturverzeichnis unterscheiden soll, kann ein abweichender Stil mit dieser Option definiert werden. Es ist darauf zu achten, dass die Option zwingend nach \opt{biblatex/style} zu setzen ist, falls diese verwendet wird.\medskip - + \subsubsection{Entwickler und Debug} \Option{debug}\WithValues{true, false}\AndDefault{false} Bei Angabe der Option werden die Pakete \pkg{blindtext} und \pkg{lipsum} geladen. \subsection{Allgemeine Makros} Derzeit stellt die Klasse keine Makros zur Verfügung. - + \subsection{Hintergrund Informationen} Die Klasse basiert auf der KOMA-Script Klasse \pkg{scrreprt}. Eine Änderung der Klasse ist in der derzeitigen Version \theversion{} nicht vorgesehen. \section{Das Paket iodhbwm-templates}\label{pkg:iodhbwm-templates} \subsection{Optionen}\label{pkg:options} Das Paket stellt das Makro \Macro\dhbwsetup{\meta{key}=\meta{value}} bereit, über welches alle Einstellungen (Optionen) angepasst werden können. Hierfür sind eine Reihe von \meta{key} Variablen vordefiniert.\medskip - + \Option{titlepage}\WithValues{\meta{filename}}\AndDefault{dhbw-titlepage.def} Mit der Option kann eine eigene Titelseite übergeben werden. Falls die angegeben Datei nicht gefunden wird, wird auf die Standardtitelseite zurückgegriffen. - + Es gilt zu beachten, dass die Option \opt{thesis type} eine höhere Priorität besitzt. Das bedeutet, dass bei der Angabe eines \opt{thesis type} die Option \opt{titlepage} überschrieben wird und stattdessen die gewählte Vorlage geladen wird. - + Bei gleichzeitiger Verwendung von \cs{dhbwdeclaration} ist es notwendig, dass die Option \opt{location} gesetzt wird. Alle anderen Optionen sind in Abhängigkeit der verwendeten Macros (s.~Abschnitt~\ref{subsec:macro}) zu setzen.\medskip - + \Option{declaration}\WithValues{\meta{filename}}\AndDefault{dhbw-declaration.def} Mit der Option kann eine eigene Eigenständigkeitserklärung übergeben werden. In der derzeitigen Version wird nur eine deutsche Variante bereitgestellt.\medskip - + \Option{thesis type}\WithValues{SA, BA, PA} Die Option gibt die Art der Arbeit an. Die Abkürzungen sind wie folgt zu verstehen: \begin{description}[noitemsep,style=multiline,leftmargin=1cm] @@ -152,40 +152,54 @@ \item[PA] Praxisarbeit \end{description} Die Angabe des Typ der Arbeit bestimmt die Gestaltung der Titelseite.\medskip - + + \Option{bachelor degree}\WithValues{BoE, BaA, BoS}\AndDefault{BoE} + Die Option gibt die Art des Bachelorabschlusses an und muss daher nur bei \opt{thesis type} = \meta{BA} angegeben werden, wenn der es sich \textbf{nicht} um einen \textit{Bachelor of Engineering} handelt. + \begin{description}[noitemsep,style=multiline,leftmargin=1cm] + \item[BoE] Bachelor of Engineering + \item[BoA] Bachelor of Sciencs + \item[BoS] Bachelor of Arts + \end{description}\medskip + + \Option{bachelor degree type}\WithValues{\meta{value}}\AndDefault{Bachelor of Engineering} + Für den Fall, dass eine andere Angabe des Abschlusses gewünscht ist, kann dieser durch diese Option angegeben werden.\medskip + \Option{thesis title}\WithValues{\meta{value}} Die Option ermöglicht die Angabe des Titel (Thema) der Arbeit.\medskip - + \Option{thesis second title}\WithValues{\meta{value}} Im Fall einer Praxisarbeit \opt{thesis type} = \meta{PA} kann es vorkommen, dass zwei unterschiedliche Themen in einer Arbeit vorkommen. Das zweite Thema kann über diese Option definiert werden.\medskip - + \Option{author}\WithValues{\meta{value}} Mit der Option wird der Autor der Arbeit angegeben. Der Autor wird auf der Titelseite und im der Eigenständigkeitserklärung verwendet.\medskip - + \Option{date}\WithValues{\meta{value}}\AndDefault{\cs{today}} Mit der Option wird das Datum angegeben.\medskip - + \Option{location}\WithValues{\meta{value}} Mit Setzen der Option wird der Ort angegeben, an welchem die Arbeit erstellt wurde.\medskip - + \Option{institute}\WithValues{\meta{value}} Mit Angabe der Option wird der Firmenname angeben.\medskip - + \Option{institute section}\WithValues{\meta{value}} Eine weitere Spezialisierung des Firmennamen kann durch Angabe des Abteilung beschrieben werden. Die Abteilung kann mithilfe dieser Option angegeben werden.\medskip - + \Option{institute logo}\WithValues{\meta{filename}} Ein Firmenlogo kann dieser Option übergeben werden. Dieses wird automatisch auf den voreingestellten Titelseiten verwendet. Der \meta{filename} sollte ohne Dateiendung angegeben werden.\medskip - + \Option{student id}\WithValues{\meta{value}} Mit der Option wird die Matrikelnummer des Studenten angegeben.\medskip - - \Option{course}\WithValues{\meta{value}} + + \Option{course/id}\WithValues{\meta{value}} Mit der Option wird die Kurskennung angegeben.\medskip - + + \Option{course/name}\WithValues{\meta{value}}\AndDefault{Informationstechnik} + Mit der Option wird die Langform des Studiengangs angegeben.\medskip + \Option{supervisor}\WithValues{\meta{value}} Mit der Option wird der Betreuer der Arbeit angegeben.\medskip - + \Option{processing period}\WithValues{\meta{value}} Mit der Option wird der Zeitraum der Arbeit angegeben. Bei Arbeiten über zwei Semester kann die Angabe beispielsweise wie folgt erfolgen: \begin{verbatim} @@ -193,40 +207,42 @@ processing period = {01.01. - 31.03.17, 25.05. - 31.09.17} } \end{verbatim} - + \subsection{Allgemeine Makros}\label{subsec:macro} \DescribeMacro\dhbwsetup{\meta{key}=\meta{value}} Das Makro ermöglicht die Angabe aller hier aufgelisteten Optionen einzustellen. Dabei werden die Option als \meta{key} angegeben und der einzustellende Wert als \meta{value}. - + \DescribeMacro\dhbwtitlepage Das Makro erstellt eine Titelseite. Dabei wird bei den vordefinierten Titelseiten (s.~\opt{thesis type}) auf die \textbf{zuvor} gesetzt Optionen zurück gegriffen. Eine eigene Definition einer Titelseite kann durch die Option \opt{titlepage} angegeben werden. - + \DescribeMacro\dhbwdeclaration Für das Setzen einer allgemeinen vordefinierten Selbstständigkeitserklärung (Eigenerklärung) ist das Makro zu verwenden. Eine eigene Definition kann mittels der Option \opt{declaration} übergeben werden. - + \DescribeMacro\getAuthor Abfrage des Autor, welcher durch \opt{author} übergeben wurde. - + \DescribeMacro\getDate Abfrage des Datum, welches durch \opt{date} übergeben wurde. Falls kein Datum angegeben wurde, wird \verb|\today| als Standard verwendet. - + \DescribeMacro\getThesisTitle Abfrage des Titel der Arbeit, welcher durch \opt{thesis title} übergeben wurde. - + \DescribeMacro\getThesisSecondTitle Abfrage des zweiten Titels, welcher durch \opt{thesis second title} übergeben wurde. - + \DescribeMacro\getLocation Abfrage des Orts, welcher durch \opt{location} übergeben wurde. - + \DescribeMacro\getSupervisor Abfrage des Betreuer, welcher durch \opt{supervisor} übergeben wurde. - - \DescribeMacro\getCourse Abfrage des Kurses, welcher durch \opt{course} übergeben wurde. - + + \DescribeMacro\getCourseId Abfrage des Kurses, welcher durch \opt{course/id} übergeben wurde. + + \DescribeMacro\getCourseName Abfrage des Studiengangs, welcher durch \opt{course/name} übergeben wurde. + \DescribeMacro\getStudentId Abfrage der Matrikelnummer, welche durch \opt{student id} übergeben wurde. - + \DescribeMacro\getInstitute Abfrage des Firmenname, welcher durch \opt{institute} übergeben wurde. - + \DescribeMacro\getInstituteSection Abfrage der Abteilung, welche durch \opt{institute section} übergeben wurde. - + \DescribeMacro\getProcessingPeriod Abfrage des Bearbeitungszeitraum, welcher durch \opt{author} übergeben wurde. - + \section{Beispiele und Anwendungen} \subsection{Eigene Titelseite definieren} Es kann vorkommen, dass man die Klasse verwenden möchte, jedoch die vordefinierten Titelseiten einem nicht gefallen oder modifizieren möchte. Hierzu stehen einem zwei Varianten zur Verfügung. - + \minisec{Titelseite mit \cs{maketitle}} Dabei wird auf das herkömmliche Makro \verb|\maketitle| zurückgegriffen. Allerdings ist es dann notwendig, dass die Attribute selbstständig gesetzt werden. \begin{verbatim} @@ -236,18 +252,18 @@ ... \maketitle \end{verbatim} - + \minisec{Titelseite mit der Umgebung \env{titlepage}} Diese Variante bietet eine größere gestalterische Freiheit. Das Grundgerüst kann den beiliegenden Templates entnommen werden. Anschließend kann dann über die Option \opt{titlepage} = \meta{filename} die eigene Titelseite angegeben werden. Die Dateiendung kann bei Angabe des \meta{filename} weggelassen werden. - + \section{Eigene Erklärung definieren} Eine eigene (Eigenständigkeits-) Erklärung kann über die Option \opt{declaration} = \meta{filename} übergeben werden. Auf die Angabe der Dateiendung kann verzichtet werden. - - + + \section{Installation} \subsection{Lokale Installation} Eine eigene Installation des Paket kann in einem lokalen texmf Ordner (lokales Repository) erfolgen. Das Bundle kann manuell aus dem Git-Repository heruntergeladen werden. - + \subsubsection{MiKTeX} \begin{enumerate} \item Lokales Repository anlegen, welches der \href{http://tug.ctan.org/tds/tds.html}{Verzeichnisstruktur für \LaTeX Dateien} entspricht. Die Verzeichnisstruktur könnte wie folgt aussehen:\par \verb|C:\Users\\localtexmf\tex\latex\iodhbwm| @@ -255,22 +271,22 @@ \item Unter dem Reiter ,,Roots'' das Verzeichnis hinzufügen\par \verb|C:\Users\\localtexmf| \item Anschließend unter ,,General'' auf den Button Refresh FNDB klicken \end{enumerate} - + Der letzte Schritt muss immer wieder ausgeführt werden, wenn ein neues Release heruntergeladen wurde. - + Eine ausführliche Beschreibung befindet sich auf \url{https://tex.stackexchange.com/a/69484/142408}. - + \subsubsection{TeXlive} - + \begin{enumerate} \item \verb|path=$(kpsewhich -var-value TEXMFHOME)| Abfrage, welcher Ordner standardmäßig hinterlegt ist. \verb|$path| entspricht vermutlich dem Pfad\\ \verb|/home//texmf/| \item \verb|mkdir -p $path/tex/latex| anlegen des Ordners. Es kann auch ein beliebiger Ordner gewählt werden, solange dieser eine gültige TEXMF-Struktur aufweist \item \verb|cp -R iodhbwm $path/tex/latex| Kopieren des heruntergeladenen Verzeichnis \item \verb|texhash $path| ausführen, um das Verzeichnis zu aktualisieren \end{enumerate} - + Eine ausführliche Beschreibung befindet sich auf \url{https://tex.stackexchange.com/a/73017/142408}. - + \subsection{CTAN} Das Bundle wird ebenfalls über CTAN (mit Release der Version v0.1) zur Verfügung gestellt und kann deshalb über die offiziellen Paketquellen heruntergeladen und installiert werden. Diese Variante ist zu bevorzugen.