Readme.md

DHBW Heidenheim LaTeX Template

Dieses LaTeX Template ist für alle Arbeiten der Fakultät Informatik der DHBW Heidenheim geeignet.

Features des Forks:

• Leicht angepasste Struktur
• Syntax Highlighting für eine Vielzahl von Sprachen und Formaten, die per default nicht unterstützt werden
• Run Configurations für IntelliJ-basierte IDEs

Inhalt:

• Syntax Highlighting
• IntelliJ-basierte IDEs
• Templatestruktur
• Document Types
• Komponenten einer Wissenschaftlichen Arbeit
• Contributors

Syntax Highlighting

Für das Syntax Highlighting werden minted und die Pygments Syntax Highlighting Engine genutzt. Dafür muss allerdings Pygments separat installiert werden:

1. Python installieren
2. Pygments installieren: pip install Pygments
3. Das pygmentize executable (z.B. C:\Python311\Scripts) zum PATH ("Umgebungsvariablen" auf in Windows) hinzufügen

Verwendung

Mit Standard-Stil:

\begin{code}{LANGUAGE}{CAPTION}{LABEL}
  <the actual code>
\end{code}

Stil festlegen:

\begin{code}[STYLE]{LANGUAGE}{CAPTION}{LABEL}
  <the actual code>
\end{code}

Um herauszufinden, welche Stile und Sprachen unterstützt werden, führe folgende Kommandos im Terminal aus:

pygmentize -L styles

pygmentize -L lexers

Beispiel:

\begin{code}{python}{Python Code}{lst:PythonCode}
def fibonacci(n):
  x, y = 0, 1
  for i in range(n):
      x, y = y, x + y
  return x

if __name__ == "__main__":
  import sys
  n = int(sys.argv[1])
  print(fibonacci(10))
\end{code}

Anpassung

Die Defaults des Syntax Highlighting können im entsprechenden Header (src/ads/code-highlighting-header.tex) angepasst werden.

IntelliJ-basierte IDEs

Im Ordner .run liegen Run Configurations, die von IntelliJ-basierten IDEs automatisch erkannt werden. Dafür ist jedoch das Plugin TeXiFy IDEA erforderlich! Das Plugin PDF Viewer wird ebenfalls empfohlen.

Zum Erstellen des PDFs, einfach die Run Configuration generate PDF ausführen. Falls es Probleme mit der Bibliographie geben sollte, kann es helfen, auch generate Bibliography auszuführen. Der output befindet sich im Ordner out, insbesondere das generierte PDF (als main.pdf).

Diese Run Configurations wurden für die Verwendung mit der MiKTeX LaTeX-Distribution erstellt.

Templatestruktur

Das Template ist im Wesentlichen in 6 Teile unterteilt:

• main.tex
• ads/
• lang/
• settings/
• content/
• images/

main.tex

main.tex ist die Kerndatei des Templates und damit auch die Datei, die kompiliert werden muss. Durch Importe anderer Dateien wird die Dokumentenstruktur beschrieben (kann bei Bedarf geändert werden wenn z.B. kein Sperrvermerk gewünscht wird).

ads

Im Ordner ads befinden sich folgende vordefinierte Vorlagen, welche nicht angepasst werden müssen (Anpassungen erfolgen automatisch):

• Deckblatt
• Eigenständigkeitserklärung
• Sperrvermerk
• LaTeX Document Header

lang

Im Ordner lang befinden sich alle notwendigen Übersetzungen.

settings

Der Ordner settings beinhaltet zwei Dateien:

• main.tex
• document.tex

In der Datei main.tex sind grundlegende Einstellungen vordefiniert, welche nicht geändert werden müssen.

In der Datei document.tex müssen einige Angaben über die zu schreibende Arbeit gemacht werden:

Variable	Beschreibung	Mögliche Werte
documentLanguage	Sprache der Arbeit	de en
documentType	Art der Arbeit	T2\_1000 Projektarbeit (Semester 1 & 2) T2\_2000 Projektarbeit (Semester 3 & 4) T2\_3100 Studienarbeit (Semester 5) T2\_3300 Bachelorarbeit Für andere Arbeiten den Typ direkt eintragen
multipleAuthors	Wurde die Arbeit von mehreren Autoren verfasst?	true false
documentAuthor	Autor der Arbeit
documentTitle	Titel der Arbeit
documentPeriod	Dauer der Arbeit
matriculationNumber	Matrikelnummer des Autors
locationUniversity	Standort der DHBW	Heidenheim
department	Fakultät der DHBW in der sich der Autor befindet
course	Kurs in dem sich der Autor befindet
degree	Abschluss, welcher mit dieser Arbeit angestrebt wird	Bachelor of Science (INF2014-MI - INF2016-MI) Bachelor of Engineering (INF2014-IA/IM - INF2016-IA/IM) Bachelor of Science (INF2017-IM/MI/IA)
lecture	Vorlesung, für die die Arbeit geschrieben wurde
showLecture	Ob die Vorlesung auf dem Deckblatt gezeigt werden soll	true false
releaseDate	Abgabedatum
releaseLocation	Abgabeort	Heidenheim
companyName	Name des Unternehmens in dem der Autor angestellt ist
companyLocation	Firmensitz
tutor	Betrieblicher Betreuer der Arbeit
evaluator	Zweitkorrektor der Arbeit
linkColor	Farbe von Verlinkungen	000000 (schwarz)

content

images

Document Types

Das Template bietet die folgenden verschiedenen Document Types an:

• T3_1000 Project Thesis (Semester 1 & 2)
• T3_2000 Project Thesis (Semester 3 & 4)
• T3_3100 Seminar Paper (Semester 5 & 6)
• T3_3300 Bachelor Thesis
• Sonstige

Das Template passt alle relevanten Einstellungen automatisch an, sobald der Document Type geändert wird.

Document Type spezifische Besonderheiten

T3_3100

Die Studienarbeit ist eine reine Hochschularbeit. Aus diesem Grund wird der Ort der Firma und der Sperrvermerk entfernt. Desweiteren ist es möglich die Studienarbeit als Gruppe abzugeben. Hierfür gibt es die Variable multipleAuthors. Ist diese auf true gesetzt, passt sich die Eigenständigkeitserklärungs selbst von der Ich- zur Wir-Form an. Mehrere Autoren sind lediglich mit Komma getrent in die Variable documentAuthor einzutragen.

Sonstige

Für andere als die vordefinierten Types kann der Dokumenttyp direkt in das Feld documentType eingetragen werden (z.B. Hausarbeit). Unternehmensinformationen werden dann ausgeblendet.

Komponenten einer Wissenschaftlichen Arbeit

Abstract

An abstract is a brief summary of a research article, thesis, review, conference proceeding or any in-depth analysis of a particular subject or discipline, and is often used to help the reader quickly ascertain the paper's purpose. When used, an abstract always appears at the beginning of a manuscript, acting as the point-of-entry for any given scientific paper or patent application. Abstracting and indexing services for various academic disciplines are aimed at compiling a body of literature for that particular subject.

The terms précis or synopsis are used in some publications to refer to the same thing that other publications might call an abstract''. In management'' reports, an executive summary usually contains more information (and often more sensitive information) than the abstract does.

Quelle: http://en.wikipedia.org/wiki/Abstract_(summary)

Acronyms

Nur verwendete Akronyme werden letztlich im Abkürzungsverzeichnis des Dokuments angezeigt.

Verwendung:

• \ac{Abk.} --> fügt die Abkürzung ein, beim ersten Aufruf wird zusätzlich automatisch die ausgeschriebene Version davor eingefügt bzw. in einer Fußnote (hierfür muss in header.tex \usepackage[printonlyused,footnote]{acronym} stehen) dargestellt
• \acs{Abk.} --> fügt die Abkürzung ein
• \acf{Abk.} --> fügt die Abkürzung UND die Erklärung ein
• \acl{Abk.} --> fügt nur die Erklärung ein
• \acp{Abk.} --> gibt Plural aus (angefügtes 's'); das zusätzliche 'p' funktioniert auch bei obigen Befehlen

Siehe auch: http://golatex.de/wiki/\acronym

Beispiel:

\acro{AGPL}{Affero GNU General Public License}
\acro{WSN}{Wireless Sensor Network}

Appendix

(Beispielhafter Anhang)

{\Large
\begin{enumerate}[label=\Alph*.]
	\item Assignment 
	\item List of CD Contents
	\item CD 
\end{enumerate}
}
\pagebreak
%\includepdf[pages=-,scale=.9,pagecommand={}]{Aufgabenstellung.pdf} % PDF um 10% verkleinert einbinden --> Kopf- und Fußzeile  werden so korrekt dargestellt. Die Option `pages' ermöglicht es, eine bestimmte Sequenz von Seiten (z.B. 2-10 oder `-' für alle Seiten) auszuwählen.
\pagebreak
\section*{B. Auflistung der Begleitmaterial-Archivdatei }
Die Archivdatei wurde zusammen mit der Online-Version dieser Ausarbeitung auf die Lernplattform hochgeladen.
\begin{tabbing}
	mm \= mm \= mmmmmmmmmmmmmmmm \= \kill
	$\vdash$ \textbf{Literature/} \\ 
	| \> $\vdash$ \textbf{Citavi-Project(incl pdfs)/} \> \> $\Rightarrow$ \textit{Citavi (bibliography software) project with}\\
	| \> | \> \> \textit{almost all found sources relating to this report.} \\
	| \> | \> \> \textit{The PDFs linked to bibliography items therein} \\
	| \> | \> \> \textit{are in the sub-directory `CitaviFiles'}\\
	| \> | \>  -- bibliography.bib  \> $\Rightarrow$ \textit{Exported Bibliography file with all sources}\\
	| \> | \>  --	Studienarbeit.ctv4  \>  $\Rightarrow$ \textit{Citavi Project file}\\
	| \> | \>  $\vdash$ \textbf{CitaviCovers/} \>  $\Rightarrow$ \textit{Images of bibliography cover pages}\\
	| \> | \>  $\vdash$ \textbf{CitaviFiles/} \> $\Rightarrow$ \textit{Cited and most other found PDF resources}\\ %\llcorner
	| \> $\vdash$ \textbf{eBooks/} \\
	| \> $\vdash$ \textbf{JournalArticles/} \\
	| \> $\vdash$ \textbf{Standards/}\\
	| \> $\vdash$ \textbf{Websites/} \\ %\llcorner
	|\\
	$\vdash$ \textbf{Presentation/} \\
	| \>  --presentation.pptx\\
	| \>  --presentation.pdf\\
	|\\
	$\vdash$ \textbf{Report/} \\ %\llcorner
	\>  -- Aufgabenstellung.pdf\\
	\>  -- Studienarbeit2.pdf\\
	\>  $\vdash$ \textbf{Latex-Files/}   $\Rightarrow$ \textit{editable \LaTeX~files and other included files for this report}\\ %\llcorner
	\> \>  $\vdash$  \textbf{ads/}   	\> $\Rightarrow$ \textit{Front- and Backmatter}\\
	\> \>  $\vdash$  \textbf{content/}  \> $\Rightarrow$ \textit{Main part}\\
	\> \>  $\vdash$  \textbf{images/}   \> $\Rightarrow$ \textit{All used images}\\
	\> \>  $\vdash$  \textbf{lang/}  \> $\Rightarrow$ \textit{Language files for \LaTeX~template}\\ %\llcorner
\end{tabbing}

Contributors

• Tobias Dreher
• Yves Fischer
• Michael Gruben
• Markus Barthel
• Prof. Dr. Rolf Assfalg
• Stefan Schneider
• Andreas Kießling
• Sarah Willibald