IMTEK-Diplomarbeitsvorlage ∗
Simon Dreher [email protected]
1. Januar 2010
Zusammenfassung
Diese Layoutvorlage für Diplom-, Bachelor- und Masterarbeiten am Institut für Mikrosystemtechnik (IMTEK) der Uni Freiburg wurde in Abstimmung mit mehreren Lehrstühlen erstellt, um den Studierenden bei der Erstellung ihrer Arbeit eine Hilfestellung zu geben. Das Layout ist als Empfehlung gedacht und stellt keine verbindliche Richtlinie dar.
Inhaltsverzeichnis
1 Einleitung 2
2 Allgemeines zur Arbeit 2
3 Bedienung der KlasseIMTEKda 3
3.1 Titelei . . . 3
3.2 Zusammenfassung und Verzeichnisse . . . 4
4 Pakete und Befehle 4 4.1 Sprachenwahl . . . 5
4.2 Schriften. . . 5
4.3 Literaturzitate und Bibliographie . . . 6
4.4 Schreib- und Korrekturhilfen . . . 7
4.5 Text . . . 8
4.5.1 Links und PDF-Informationen . . . 8
4.5.2 Seitenlayout. . . 8
4.5.3 Manuelle Layoutkorrekturen. . . 9
4.5.4 Anführungszeichen, Bindestriche etc. . . 9
4.5.5 Leerstellen, Absätze, Zeilenumbrüche etc. . . 9
4.5.6 Mögliche Trennstellen . . . 10
4.5.7 Listen . . . 10
4.6 Einheiten, chemische Formeln, Mathematik etc. . . 10
4.7 Bilder und Tabellen sowie Programmcode etc.. . . 11
4.7.1 Bilder . . . 12
4.7.2 Tabellen . . . 13
4.7.3 Programmcode und Ähnliches. . . 13
∗Dokumentation zuIMTEKdav1.7, 2010/01/01.
5 Implementierung der Klasse 14
5.1 Optionen und Initialisierungen . . . 14
5.2 Definition sprachenabhängiger Begriffe . . . 15
5.3 Definition eigener Makros und Umgebungen . . . 16
5.4 Setzen der Titelei . . . 17
5.5 Weitere Voreinstellungen. . . 22
1 Einleitung
Diese Vorlage basiert auf einer alten Diplomarbeitsvorlage von Jan Lienemann.
Sie wurde an vielen Stellen aktualisiert und vonbookals Elternklasse aufscrbook umgestellt, um vor allem eine leichtere Verwaltung der Schriften und anderer Lay- outparameter zu gewährleisten. Da Diplomarbeiten häufig auch auf Englisch ge- schrieben werden, wurden auch hierfür Anpassungen eingeführt. Ein wichtiger Teil, der neu mit in die Vorlage aufgenommen wurde, ist eine Sammlung vieler LATEX-Tipps und -Tricks sowie empfohlener Pakete für diverse häufiger auftreten- de Aufgabenstellungen.
2 Allgemeines zur Arbeit
Der Aufbau bzw. die Gliederung einer Diplomarbeit hängt sehr von der bearbei- teten Thematik ab. Das Beispiel ist für eine Arbeit gedacht, die einen experimen- tellen Teil enthält. Bei theoretischen Arbeiten oder Programmierungen kann ein anderer Aufbau der Arbeit als der im Template vorgestellte sinnvoll sein. Der Um- fang einer Diplomarbeit beträgt üblicherweise 60 bis 100 Seiten inkl. Anhang. Viel mehr als 110 Seiten werden ungern gesehen, schließlich soll die Arbeit ja auch noch lesbar bleiben. Die Sprache ist bei den meisten Lehrstühlen Deutsch, oft kann die Arbeit aber auch auf Englisch verfasst werden.
Ein wichtiger Hinweis zumAusdrucken eines mit LATEX erzeugten pdf-Files aus dem Acrobat Reader: Im Drucken-Dialog sollte die Option „Shrink oversized pages to paper size“ (bzw. ihr deutsches Äquivalent)nicht eingeschaltet sein, sonst stimmen die Schriftgröße und der Satzspiegel nicht mehr.
Allgemeine Notationen wie Normen oder Schriftarten sollten im Vorwort kurz erklärt werden, falls sie für ein schnelles Verständnis notwendig sind. Symbole und Abkürzungen kommen in eine Nomenklatur, die hinter dem Inhaltsverzeichnis steht.
Am Ende der Zusammenfassung müssen Stichwörter zu den wichtigsten The- mengebieten, in die die Arbeit passt, angegeben werden. Diese Stichwörter sollten ebenso (sowohl auf Deutsch als auch auf Englisch) als pdfkeywords angegeben werden, siehe dazu auch Abschnitt4.5.1.
Bei der Verwendung von Gliederungsebenen gibt es folgendes zu beachten:
• Es sollten nicht mehr als 3 Gliederungstiefen nummeriert werden.
• Unterkapitel sind nur dann sinnvoll, wenn es auch mehrere Untergliederun- gen gibt. Ein Unterkapitel 2.1.1 sollte somit nur dann verwendet werden, wenn es auch 2.1.2 gibt.
Wichtige Gleichungen, die in der Arbeit häufiger zitiert werden, sollten eine automatische Gleichungsnummer erhalten. Die Nummerierung beginnt in jedem
Kapitel neu und enthält die Kapitelnummer, dieses Standardverhalten sollte bei- behalten werden. Beim Zitieren von Gleichungen steht die Formelnummer nicht in Klammern, falls sie zusammen mit der Bezeichnung „Gleichung“ verwendet wird (also z. B. Gleichung 1). Wird in Herleitungen ein Querverweis auf eine andere Formel gesetzt, so wird hier nur die Formelnummer gesetzt, hier allerdings in Klammern. Bei Verwendung des Paketsamsmathgeht dies am einfachsten, indem zum Referenzieren\eqref{hlabeli}verwendet wird. Ein Beispiel ist
\eqref
a+b=c (1)
b+c=a+ 2b aus (1) (2)
3 Bedienung der Klasse IMTEKda
Die Klasse IMTEKda basiert auf der Klasse scrbook aus KOMA - Script. Außer diesem Paket müssen die Pakete graphicx, textpos und calc sowie ein Paket zur graphicx
textpos calc
Sprachumschaltung (vorzugsweisebabel) verfügbar sein. Da das Pakettextposmit der Option absolutefür die Positionierung des neuen Uni-Logos benötigt wird, kann dieses Paket leider nicht mehr für die Positionierung relativ zur aktuellen Position genutzt werden.
Als Klassenoptionen können alle Optionen vonscrbook verwendet werden [8].
Die Optionen titlepage und notitlepage sind jedoch nicht sinnvoll und wer- titlepage
notitlepage den daher ignoriert. Ebenso sind die Optionen zum Papierformat a4paper und a4paper pagesizenicht notwendig, da diese automatisch geladen werden.
pagesize Da die Arbeit ja irgendwie gebunden wird, muss in den Klassenoptionen ein Wert für die BindekorrekturBCOR angegeben werden, der dem Seitenrand in der BCOR
Mitte entspricht, der in der Bindung verschwindet [8]. Der im Template angegebene Wert von 10 mm ist eine erste grobe Abschätzung für die üblichen Klebebindungen.
Der Typ der Arbeit wird mit einer der Klassenoptionendiplom,bachelorund diplom
bachelor masterangegeben. Entsprechend wird die Titelei angepasst, d. h. die Bezeichnung master der Arbeit und die notwendigen Angaben im offiziellen Vorspann werden entspre-
chend gesetzt.
Seit der Umstellung auf das neue Corporate Design 2010 wird mit der Option oldcd auf das bisherige Layout umgestellt. Diese Option ist nur für die Kompa- oldcd
tibilität zu alten Arbeiten gedacht und soll keinesfalls bei neuen Bachelor- oder Masterarbeiten verwendet werden!
3.1 Titelei
Die Titelei wird standardmäßig in der Sprache der Arbeit gesetzt (also Englisch oder Deutsch), mit der Klassenoptionnoenglishpreamble kann jedoch auch bei noenglishpreamble
einer auf Englisch geschriebenen Arbeit die Titelei auf Deutsch gesetzt werden. Der Vollständigkeit halber ist auch eine Option englishpreamble definiert, die eine englishpreamble
englische Titelei einstellt (auch bei deutschem Text, was allerdings nicht sinnvoll ist).
Wie in den Standardklassen werden mit\author{hNamei}und\title{hTiteli}
\author
\title Autor und Titel festgelegt. Neu definiert wurden
\dpoversion{hDPOi}für die gültige DPO,
\dpoversion
\chair{hLehrstuhli}für den Lehrstuhl,
\chair
\referees{hGutachteri}für den Gutachter,
\referees
\thesistime{hBearbeitungszeitraumi}für den Bearbeitungszeitraum und
\thesistime
\supervisor{hBetreueri}für den Betreuer.
\supervisor
Diese müssen vor dem eigentlichen Setzen der Titelei mit \maketitle festge-
\maketitle
legt sein. Um eine korrekte Bearbeitung von Sonderzeichen in Namen zu er- reichen, sollten diese Befehle nicht in der Präambel stehen, sondern erst nach
\begin{document}.
Der Befehl \extratitle aus KOMA - Script ist für eine Diplom-, Bachelor-
\extratitle
oder Masterarbeit nicht sinnvoll, sodass dieser Befehl wirkungslos bleibt. Von den Elementen der Titelseite, die in der Klassescrbook vordefiniert sind [8], sind
\titleheadund\subjectbereits definiert und dürfen nicht neu definiert werden.
\titlehead
\subject Alle hier nicht genannten Elemente ausscrbook können auch verwendet werden.
Eine ausführliche Beschreibung aller Möglichkeiten und Hintergrundinformationen befinden sich imscrguide.pdf [8].
Ein Titelbild wird mit\titlepic{hBildi}gesetzt. Dabei muss für hBildider
\titlepic
LATEX-Code zum Einbinden (oder Zeichnen) des Bilds eingesetzt werden, nicht nur ein Dateiname. Die Bildbeschreibung wird mit\titlepicdesc{hBildi}deklariert.
\titlepicdesc
3.2 Zusammenfassung und Verzeichnisse
Als neue Umgebung wurde abstract enstsprechend der abstract-Umgebung abstract
der article-Klasse definiert. Diese Umgebung sollte doppelt verwendet werden, um zweisprachige Zusammenfassungen zu erhalten. Bei einer der beiden Um- gebungen muss dabei die Sprache auf die Alternativsprache (Englisch oder Deutsch) umgeschaltet werden. Falls das Paket hyperref verwendet wird, sollte
\pdfbookmark{\abstractname}{abstract} vor der erstenabstract-Umgebung
\pdfbookmark
eingefügt werden, um ein PDF-Lesezeichen zu erstellen.
Nach den Zusammenfassungen sollte mit \tableofcontentsdas Inhaltsver-
\tableofcontents
zeichnis gesetzt werden. Damit auch dieses in den PDF-Lesezeichen auftaucht, muss auch hier wieder \cleardoublepage\pdfbookmark{\contentsname}{toc}
direkt davor eingefügt werden.
Eine weitere neue Umgebung istnomenclature, in der die Nomenklatur gesetzt nomenclature
wird. Sie sollte nach dem Inhaltsverzeichnis gesetzt werden. Als neue Klassenop- tion wurde nomtotoc definiert, die im Inhaltsverzeichnis einen Eintrag für die nomtotoc
Nomenklatur erstellt. Da diese immer zwischen Inhaltsverzeichnis und Tabellen- und Abbildungsverzeichnis steht, müssen diese Verzeichnisse nicht ins Inhalts- verzeichnis eingetragen werden. Abbildungs- und Tabellenverzeichnis werden mit
\listoffiguresund\listoftableserstellt. Diese beiden Verzeichnisse können
\listoffigures
\listoftables auch mit der Klassenoptionliststotocins Inhaltsverzeichnis aufgenommen wer- liststotoc den, was allerdings auch nicht notwendig ist.
4 Pakete und Befehle
In diesem Abschnitt habe ich Lösungen für die häufigsten Probleme zusammen- gefasst und Tipps gesammelt. Er kann und soll allerdings nicht eine gute LATEX- Einführung ersetzen. Eine ganz knappe Einführung zum vorneweg durchlesen ist [1], eine etwas ausführlichere Anleitung (allerdings ohne Formelsatz) ist [2]. Die absoluten Standardwerke, von denen jeder mindestens eines durchgelesen haben sollte, sind [3] auf Deutsch, [4] als etwas ausführliche englische Variante und [5]
als weiteres englisches Benutzerhandbuch. Weitere Literaturtipps sind in der Bi- bliographie angegeben.
Die Dokumentation zu den einzelnen Paketen ist jeweils auch zu Rate zu ziehen.
Man findet sie bei installierten Paketen, indem man auf einer Kommandozeile den Befehl texdoc hPaketnamei eingibt. In wenigen Fällen kann es nötig sein, die Dokumentation manuell in der TEX-Installation zu suchen, falls sie nicht aus einem Dokument mit dem Paketnamen als Dateinamen besteht. Sie liegt dann aber in einem Verzeichnis mit dem Paketnamen.
4.1 Sprachenwahl
In der Vorlage wird zur Sprachenwahl dasbabel-Paket verwendet. Die Sprachen- babel
auswahl muß dabei global als Klassenoption gesetzt werden, damit einige spra- chenabhängige Definitionen in der Titelei richtig gesetzt werden. Die entspre- english
ngerman chenden Optionen sindenglishundngerman1, wobei die letzte Sprachoption die Dokumentsprache angibt, Alternativsprachen werden davor angegeben. Falls die Diplomarbeit auf Englisch abgefasst werden soll, müssen somit die Klassenoptio- nen english und ngerman gegenüber dem deutschen Beispiel im Template ver- tauscht werden. Die deutsche Zusammenfassung muss dann statt der englischen in \begin{otherlanguage}{ngerman} . . .\end{otherlanguage} eingeschlossen werden.
Falls das babel-Paket aus irgendeinem Grund nicht verwendet werden kann (wenn möglich, sollte allerdings unbedingt babel verwendet werden!), kann auch das Paketngermanverwendet werden; diebabel-Anweisungen aus der Vorlage müs- sen dann durch die entsprechenden Anweisungen dieses Pakets ersetzt werden [11].
4.2 Schriften
KOMA - Script setzt die Überschriften standardmäßig in Sansserif, um leichtere Überschriften zu erhalten, was empfehlenswert ist. Wer trotzdem das Verhalten der Standardklassen wiederherstellen will, kann in die Präambel die Zeile
\setkomafont{sectioning}{\normalfont\normalcolor\bfseries}
einfügen.
Mit \usepackage[latin1]{inputenc} können Umlaute in latin1-codierten inputenc
TEX-Dateien direkt eingegeben werden. Diese Codierung wird üblicherweise von Texteditoren unter Windows und alten Versionen von Linux und MacOS verwen- det. Bei aktuellen Linux-Distributionen und MacOS X wird allerdings die UTF 8- Codierung standardmäßig benutzt, so dass man hier entweder manuell im Editor die Zeichencodierung umstellen oder stattdessen\usepackage[utf8]{inputenc}
verwenden muss.
Das Paket \usepackage[T1]{fontenc} benutzt die neuere Schriftcodierung fontenc
T1 statt der OT1-Codierung. Damit werden einige Fehler bei Umlauten um- gangen und es stehen erweiterte Zeichensätze zur Verfügung. Da die Standard- schrift ComputerModern nur in OT1-Codierung verfügbar ist (und damit Um- laute, Akzente und manche Sonderzeichen nur unzureichend unterstützt), schaltet
\usepackage[T1]{fontenc}auf die EC-Schrift (eine erweiterte Version der Com- puterModern) um. Diese gibt es aber leider nicht als type1-Schrift, d. h. sie wird als Pixelschrift in der Auflösung des Ausgabetreibers (z. B. dvips oder pdfLATEX,
1IMTEKdaakzeptiert übrigens auchgerman, das auf die alte Rechtschreibung angepasst ist.
hier meist 600 dpi) in die Ausgabedatei eingebunden. Damit ist die Bildschirm- darstellung von PDFs im AdobeReader ziemlich schlecht.2 Außerdem sollte hier bei Schriftgrößen über 10 pt\usepackage{exscale}verwendet werden, um einige exscale
mathematische Zeichen zu skalieren, die hier fehlen.
Eine empfehlenswerte Variante der EC-Schrift, die als type1-Schrift vorliegt, lmodern
ist die LatinModern, die mit\usepackage{lmodern}geladen wird.
Eine weitere empfehlenswerte Schriftkombination ist die URW Garamond mit mathdesign
berasans beramono
der Bera als Sansserif- und Schreibmaschinenschrift. Man lädt sie mit
\usepackage[garamond,sfscaled=false,ttscaled=false]{mathdesign}
\usepackage[scaled=0.9]{berasans,beramono}.
Die häufig verwendete Times ist für die relativ breiten Seiten einer Diplomar- mathptmx
helvet courier
beit wenig geeignet. Da mittlerweile alle Schriften in PDFs eingebunden werden, bringt hier auch ihre Verwendung als Systemschrift keinerlei Vorteile mehr. Wer trotzdem als Schriftart unbedingt Times, Helvetica und Courier verwenden will, sollte sie mit
\usepackage{mathptmx}
\usepackage[scaled=.92]{helvet}
\usepackage{courier}
laden.
4.3 Literaturzitate und Bibliographie
Für wissenschaftliche Arbeiten ist es günstig, die Literaturzitate fortlaufend zu nummerieren und so anzugeben, dass die Literatur auch wiedergefunden werden kann. Bei dickeren Büchern sollte das entsprechende Kapitel oder die Seitenzahl angegeben werden, falls generell nur aus einem Kapitel zitiert wird im Literatur- verzeichnis, sonst mit dem optionalen Argument von \cite.
Für die Bibliographie sollte eine BibTEX-Literaturdatenbank verwendet wer- BibTEX
den. Es bietet sich dabei an, die Literaturliste mit einem Programm zu verwal- ten. Als sehr komfortabel hat sich das freie Javaprogramm JabRef [16] erwiesen.
JabRef
BibTEX-Zitate können damit von Literaturdatenbanken aus dem Internet direkt übernommen werden, ansonsten ist die Eingabe über selbsterklärende Eingabe- masken möglich.
In der BibTEX-Datenbank sollten die Autoren als hNachnamei, hVornameni oderhvoni hNachnamei, hVornamenioderhvoni hNachnamei,hJri, hVornameni eingegeben werden. Mehrere Autorennamen werden durchand(auch für deutsche Einträge) getrennt. Dies ist notwendig, damit BibTEX erkennt, dass mehrere Au- toren angegeben sind, dasandwird ggf. je nach Zitier- und Verzeichnisstil ersetzt, z. B. durch ein Komma oder ein deutsches „und“.
Die Bibliographie selbst wird mit dem Befehl\bibliography{hBiblioi}ausge-
\bibliography
geben.hbiblioisteht darin für den Dateinamen der Bibliographie ohne die Endung .bib. Wenn Referenzen aus verschieden BibTEX-Dateien verwendet werden sol- len, kann hier auch eine mit Kommata getrennte Liste von Dateien stehen. Nach dem ersten LATEX-Lauf muss zur eigentlichen Berechnung der benötigten Einträ- ge BibTEX als Hilfsprogramm aufgerufen werden (mitbibtex hdokumenti, wobei hdokumenti durch den Dateinamen der LATEX-Hauptdatei ohne Endung zu er- setzen ist). Bei den meisten LATEX-Entwicklungsumgebungen wie TechnicCenter
2Der AdobeReader 7 scheint mittlerweile auch die Pixelschriften akzeptabel darzustellen, so dass diese Einschränkung weniger wichtig geworden ist.
(Windows) oder Kile (Linux) kann dies beim Erstellen des Dokuments automatisch mit ausgeführt werden. Danach sind weitere ein bis zwei LATEX-Läufe notwendig, um das Verzeichnis korrekt einzubinden.
Generell sollte \usepackage[comma,numbers,sort&compress]{natbib} für natbib
einen schönen und richtigen Zitierstil innerhalb des Textes benutzt werden. Für den Stil des Literaturverzeichnisses ist dann\bibliographystyle{plainnat}zu-
\bibliographystyle
ständig. Dabei kannplainnatauch durchabbrvnatoderunsrtnatersetzt wer- den, wenn z. B. Vornamen und Journalnamen abgekürzt werden sollen oder die Einträge unsortiert, d. h. in der Reihenfolge der Zitate erscheinen sollen. natbib stellt zusätzlich zu \cite noch weitere Befehle zur Verfügung, unter anderem
\citetund\citep, die Zitate mit Autorenangabe im Textfluss erlauben. Sie sind in Kapitel 4 der Dokumentation zunatbib[10] sehr schön beschrieben.
Es wird außerdem empfohlen, das Paketbabelbib zu verwenden, um Einträge babelbib
für deutsche Literatur auch auf Deutsch zu formatieren – standardmäßig setzt LATEX die Literaturliste unabhängig von der Dokumentsprache auf Englisch (also auch den automatisch erzeugten Text wie and zwischen den Autoren, volume statt Band usw.). Dieses Paket benutzt ein BibTEX-Feld language, das als Wert die babel-Sprachbezeichnung für den jeweiligen Literatureintrag hat (also ngerman oder english). Um die Sprachanpassung nutzen zu können, muss der Stil des Literaturverzeichnisses mit\bibliographystyle{babplain}stattplainnatbzw.
bababbrvoderbabunsrtstattabbrvnatoderunsrtnatauf die angepassten Stile umgeändert werden. Leider werden mit diesen Stilen die zusätzlichen Zitier-Befehle aus natbib wie \citet und \citep nicht unterstützt, sondern nur der normale
\cite-Befehl.
Um ein Feld in JabRef für die Sprachumschaltung mit babelbib einzufügen, JabRef
muss einmal unter Options → Set up general fields bei General am Schluß
;language angefügt werden, dann ist dieses Feld unter dem Reiter General im Editierfenster zu finden.
Als Ersatz fürnatbibundbabelbibkann auch das recht neue Paketbiblatexein- biblatex
gesetzt werden. Es bietet wienatbib viele Zitier-Möglichkeiten und lässt sich sehr leicht konfigurieren. Die Zitierstile werden dabei durch LATEX-Makros bestimmt, was eine Anpassung an eigenen Wünsche erheblich vereinfacht.
4.4 Schreib- und Korrekturhilfen
Beim schnelleren Auffinden von zu langen Zeilen, die durch zu große Tabellen, draft
Bilder und Gleichungen oder durch schwer trennbare Wörter entstehen, hilft die Klassenoption draft, die diese Zeilenenden dick markiert. Mit ihr werden auch statt den Bildern nur Platzhalter eingefügt, was die Zeit zum Erstellen des Doku- ments erheblich verkürzt.
Damit man Labels von Gleichungen, Bildern usw. im Probeausdruck angezeigt bekommt und nicht den gesamten Quelltext nach einem Gleichungslabel durch- suchen muss, um eine Referenz darauf zu erzeugen, ist das Paket showkeys sehr showkeys
hilfreich. Für die Endfassung braucht man nur die Klassenoptionfinalangeben, die intern verwendeten Labels werden dann nicht mehr gedruckt.
Es ist sinnvoll, einzelne Teile der Arbeit in eigenen .tex-Dateinen auszula-
\input
\include
\includeonly
gern. Solche Dateien können in der Haupt-Datei mit\input{hDateii}eingefügt werden, wobeihDateiider Dateiname ohne Dateiendung.texist. Werden gesamte Kapitel in einzelne Dateien geschrieben, so sollten diese mit \include{hDateii}
eingefügt werden. Im Gegensatz zu\input{hDateii}werden hier jedoch vor und
hinter dem eingefügten Code neue Seiten begonnen, so dass hier ganze Kapitel in der Datei stehen sollten. Mit\includeonly{hDatei1,Datei2,. . .i}kann bei so ein- gefügten Kapiteln die Ausgabe von ausgewählten Kapiteln erzeugt werden. Wenn irgendwann vorher ein LATEX-Lauf mit allen Kapiteln gelaufen ist, werden sogar Referenzen und Seitenzahlen wie im Gesamtdokument erhalten.
Werden eingebundene Dateien in Unterordner verteilt und darin wieder Einzel- dateien mit\inputeingebunden, können mit den Befehlen aus dem Paketimport import
auch Pfadangaben relativ zur aktuellen Datei statt zur Hauptdatei angegeben werden. Zum Erweitern des Suchpfads siehe auch Abschnitt4.7.1
4.5 Text
4.5.1 Links und PDF-Informationen
Um Referenzen, Inhaltsverzeichnis usw. in einer PDF-Ausgabe als Links zu erhal- ten, muss als eines der letzten Pakete hyperref geladen werden. Dies funktioniert hyperref
auch, wenn das PDF über PS aus einem DVI erzeugt wird.
Zusätzlich zum Befehl\refist inhyperrefein Befehl\autorefdefiniert. Dieser
\autoref
setzt vor die Nummer des referenzierten Elements seine Bezeichnung. Um auch hier die Abkürzungen für Abbildung und Tabelle zu verwenden, muss bei Verwendung vonbabel
\addto{\extrasngerman}{\renewcommand*{\figureautorefname}{Abb.}}
\figureautorefname
\addto{\extrasngerman}{\renewcommand*{\tableautorefname}{Tab.}}
\tableautorefname
im Vorspann eingefügt werden
Fallshyperrefverwendet wird, werden pdftitle,pdfauthorundpdfsubject pdftitle
pdfauthor pdfsubject
auf die entsprechenden Werte der Titelseite gesetzt und können nicht mehr anders belegt werden.pdfkeywordskönnen (und sollen) aber noch gesetzt werden.
pdfkeywords Werden die durch hyperref erzeugten Links bei Referenzen auf Bilder und Tabellen angeklickt, springt der PDF-Viewer auf die Bild- oder Tabellenun- terschrift (nicht auf das Bild oder die Tabelle selbst). Dieses Verhalten korri- giert das Paket hypcap, das mit der Option all geladen werden sollte (also hypcap
\usepackage[all]{hypcap}). Es stellt auch Befehle zur Verfügung, die ein ma- nuelles Setzen der Anker für von Hand platzierte Bilder (siehe Abschnitt 4.7) erlauben.
Werden in Überschriften LATEX-Befehle verwendet, so führt dies oft zu Fehlern hypbmsec
oder unlesbaren Einträgen in den PDF-Bookmarks. Hier hilft das Pakethypbmsec, indem es zusätzlich zu dem optionalen Argument der Gliederungsbefehle ein wei- teres optionales Argument erlaubt, mit dem der Text des PDF-Bookmarks einzeln angegeben werden kann (auch mit direkter Eingabe von manchen Sonderzeichen).
4.5.2 Seitenlayout
Für Probeausdrucke kann man getrost die Klassenoption openany verwenden openany
openright (spart die leeren Seiten gegenüber den Kapitelanfängen ein), die endgültige Ver- sion muss aber ohne diese Option (bzw. mit openright) erstellt werden. Wen cleardoubleplain
cleardoubleempty auf den leeren Seiten die Kolumnentitel stören, der kann mit den Klassenoptio- nencleardoubleplainodercleardoubleempty(ausKOMA - Script) diese unter- drücken.cleardoubleplainschaltet auf den eingefügten Seiten auf den Seitenstil plainum,cleardoubleemptyauf den Seitenstilempty.
4.5.3 Manuelle Layoutkorrekturen
Gelegentlich kann es vorkommen, dass eine Seite um eine Zeile zu kurz ist, so dass an einem Kapitelende eine fast leere neue Seite angefangen wird. Wennkeine anderen Änderungen mehr gemacht werden, kannganz zum Schluss die zu kleine Seite mit \enlargethispage{1\baselineskip} um eine Zeile (d. h. die Länge
\enlargethispage
\baselineskip) vergrößert werden.
Ebenso können manuelle Umbrüche oder eine Seitenvergrößerung im Inhalts- verzeichnis oder einem der anderen Verzeichnisse notwendig werden. Die dazu notwendigen Befehle werden mit\addtocontents{hDateiendungi}{hBefehlei}in
\addtocontents
die Verzeichnisse geschrieben.3
4.5.4 Anführungszeichen, Bindestriche etc.
Allgemeine Tipps zu Schreibweisen und wie man sie mit LATEX erreicht, findet man in [14] und [15]. Für die Schreibweisen im Deutschen lohnt sich – auch wenn man zur Sprachumstellung babelverwendet – ein Blick in [11].
Die wichtigsten Schreibweisen hier im Überblick:
"‘und"’ deutsche Anführungszeichen („ und “, ohne Leerzeichen)
‘‘und’’ englische Anführungszeichen (“ und ”, ohne Leerzeichen)
’ Apostroph (Auslassung von Buchstaben, sparsam verwenden!) - Trenn-, Bindestrich (nur im Textmodus definiert!)
- Minus (nur im Mathemodus definiert!)
-- Gedankenstrich (mit Leerzeichen); von–bis (ohne Leerzeichen)
’ Fuß, Minute (0) (nur Mathemodus, ohne Abstand zur Zahl)
’’ Zoll, Sekunde (00) (nur Mathemodus, ohne Abstand zur Zahl)
\dots Auslassungspunkte
Wer sich um die richtigen Anführungszeichen keine Gedanken mehr machen will, kann auch das Paketcsquotes verwenden.
csquotes
4.5.5 Leerstellen, Absätze, Zeilenumbrüche etc.
Absätze im laufenden Text werden mit einer Leerzeile im Quelltext eingegeben.
Alternativ kann stattdessen auch der Befehl \par verwendet werden. Diese Be-
\par
fehle dürfen auf keinen Fall mit dem Befehl \\ verwechselt werden. Dieser fügt
\\
einen Zeilenumbruch ein, als optionales Argument kann dabei noch ein vertikaler Abstand eingegeben werden (also mit\\[hAbstandi]). Zusätzlicher vertikaler Ab- stand nach einem Absatz (nur in Sonderfällen zu verwenden!) kann mit\bigskip
\bigskip
eingefügt werden.
Im Text werden verschiedene Leerzeichen häufig gebraucht:
„normales“ Leerzeichen. Nach einem Punkt wird evtl. ein größerer Zwischen- raum eingefügt, deshalb nach Abkürzung die folgende Variante wählen
\ „normales“ Leerzeichen, das auf jeden Fall gesetzt wird (auch nach Befehlen und nach einem Punkt); Zeilenumbruch möglich
~ geschütztes Leerzeichen (Zeilenumbruch wird danach unterdrückt, z. B. in Abb.~\ref{fig:bild})
\, Spatium (halbes Leereichen), zwischen mehrteiligen Abkürzungen wie in z.\,B.sowie als zusätzlichen Zwischenraum in Formeln
3Durch das verzögerte Schreiben der Hilfsdateien darf dieser Befehl nicht als erster Befehl in einer mit\includeeingebundenen Datei oder direkt nach dem\includestehen, sondern muss stattdessen am Ende der letzten eingebundenen Datei sein.
4.5.6 Mögliche Trennstellen
Um der automatischen Silbentrennung zu helfen, ist es gelegentlich nötig, zusätz- liche mögliche Trennstellen einzufügen oder die Trennung eines Worts zu verhin- dern. Für häufig vorkommende Wörter, die nicht oder falsch getrennt werden, kann in der Präambel mit\hyphenation{Mi-kro-sys-tem,Mi-kro-sys-tem-tech-nik}
\hyphenation
eine Liste mit expliziten Trennmustern hinterlegt werden. Im Text können mit fol- genden Befehlen Trennschwierigkeiten beseitigt werden:
\mbox{hWorti} Unterdrückung aller Trennungen - Bindestrich, der andere Trennungen unterdrückt
"= Bindestrich, der andere Trennungen erlaubt:Ruhr"=Universit"at
"~ Bindestrich, an dem nicht getrennt werden darf:Ein"~ und Ausg"ange
\- Trennmöglichkeit, die andere Trennungen ausschließt:Ur\-instinkt
"- Trennmöglichkeit, die andere Trennungen nicht ausschließt
"" Trennmöglichkeit, bei der kein Trennstrich benötigt wird:(Ein"~)""G"ange
"| Auflösen einer Ligatur und Trennmöglichkeit:Auf"|forderung
Von diesen Befehlen sind im Englischen leider nur \mbox, - und \- erlaubt, alle anderen werden vonbabel,germanoderngermannur für die deutsche Sprache bereitgestellt.
4.5.7 Listen
Oft ist es schöner, Aufzählungen als Text zu formulieren. Hierfür lohnt sich das paralist
Paketparalist, das außerdem engere Listen- und Aufzählungsvarianten bietet.
4.6 Einheiten, chemische Formeln, Mathematik etc.
Um verbesserte Mathematik-Umgebungen zu laden, muss das Paketamsmathver- amsmath
wendet werden, mit dem Paket amssymbwerden weitere mathematische Zeichen amssymb
geladen. Die Dokumentation zu amsmathist [13], sie sollte auf jeden Fall gelesen werden.
Werden in Indizes Beschreibungen abgekürzt (z. B. max oder in und out), so
\text gensymb textcomp
werden diese als Text (also nicht im Mathemodus) gesetzt. Dies erreicht man am einfachsten mit dem Befehl \text{hTexti} aus dem amsmath-Paket. Um einige Sonderzeichen wie\micro (µ in aufrechter Schreibweise, für Einheiten),\ohm (W
\micro
\ohm für Einheiten),\celsius(℃) oder\degree(°) im Text- und Mathemodus nutzen
\celsius
\degree
zu können, müssen die Pakete gensymbundtextcompverwendet werden.
Einheiten sollten mit den Befehlen aus einem der Pakete units oder SIunits units
SIunits
gesetzt werden. Diese Pakete sorgen für korrekte Abstände zwischen Zahl und Einheit und für deren korrekte und einheitliche Formatierung, die sonst ziemlich umständlich wären. Fallsunitsverwendet wird, sollte als µ\microaus dem Paket gensymbverwendet werden (s. o.).
Um chemische Summenformeln und Reaktionsgleichungen zu setzen, sind die bpchem
Paketebpchem oderchemsym jeweils in Verbindung mitchemarr oder das Paket chemsym
chemarr mhchem zu empfehlen.
mhchem Wer Zahlen mit einem Komma statt einem Punkt als Dezimaltrenner schreiben will, sollte das Paket icomma verwenden. Dann muss aber im Mathemodus in icomma
Listen nach dem Komma jeweils ein Leerzeichen stehen.
Eine sehr schöne Dokumentation zu fast allem, was man im Mathe-Modus machen kann, ist [12].
Ein neues, nettes Paket mit abkürzenden Schreibweisen einiger häufiger Mathe- Befehle (Klammern, partiellen Ableitungen, Grenzen usw.) ist commath. Wahr- commath
scheinlich wird es noch erweitert, d. h. man sollte öfters mal nach der aktuellen Version schauen.
4.7 Bilder und Tabellen sowie Programmcode etc.
Bilder und Tabellen sollten in den Gleitumgebungen figurebzw. table gesetzt figure
table werden. Eine gute Dokumentation über alles zum Thema Grafiken und Gleit- umgebungen ist [9]. Sollen einzelne Bilder oder Tabellen ausnahmsweise nicht capt-of
nofloat automatisch plaziert werden (beispielsweise Tabellen oder technische Zeichnun- gen im Anhang), so bieten die Paketecapt-of und ggf. auch nofloat Befehle, um nicht gleitende Objekte einzufügen und vor allem Bild- oder Tabellenbeschreibun- gen einzugeben. Umfangreichere Pakete sind floatundrotfloat(Erweitertung von float
rotfloat floatrow
float, die auch gedrehte Querformat-Bilder erlaubt, wie mitrotating) sowiefloatrow als weitere Erweiterung. Mit diesen Paketen können neben Bild- und Tabellenun- terschriften von nicht-gleitenden Bildern und Tabellen (für den Anhang) auch Tabellenbeschriftungen global als Über- oder Unterschriften formatiert werden, unabhängig von der Position des\caption-Befehls.
Breite Bilder und Tabellen, die nur im Querformat auf der Seite Platz finden, rotating
sidewaysfigure sidewaystable
können statt in normale figure- bzw. table-Umgebungen in sidewaysfigure bzw. sidewaystable gesetzt werden. Diese werden vomrotating-Paket bereitge- stellt. Falls rotfloat oder floatrow verwendet werden, sind die Befehle ebenfalls definiert, rotating darf dann nicht mehr geladen werden. Statt der Kombination ausfloatundrotatingmuss das Paketrotfloatverwendet werden.
Falls LATEX bei Kapiteln mit vielen Bildern Probleme beim Platzieren der ein-
\textfraction
\topfraction
\bottomfraction
\floatpagefraction
zelnen Floats hat, können großzügigere Vorschriften mit
\renewcommand{\textfraction}{0.15}
\renewcommand{\topfraction}{0.85}
\renewcommand{\bottomfraction}{0.70}
\renewcommand{\floatpagefraction}{0.66}
in der Präambel erreicht werden. Um zu verhindern, dass ein Bild nach einer placeins
\FloatBarrier bestimmten Stelle gesetz wird, kann an der entsprechenden Stelle der Befehl
\FloatBarrieraus dem Paketplaceinsgeschrieben werden.
Beschreibungen zu Abbildungen und Tabellen stehen unter dem Bild und wer-
\caption
den innerhalb der Gleitumgebung in\caption{hBeschriftungi}. (Manche platzie- ren auch die Tabellenbeschreibungen oberhalb der Tabelle, dafür bitte die Klassen- optiontablecaptionabove verwenden!) Wenn das Wort Abbildung bzw. Tabelle tablecaptionabove
am Satzanfang steht, wird es ausgeschrieben, innerhalb eines Satzes wird es übli- cherweise abgekürzt. Wer die Bildunterschriften vom Text absetzen will, kann sie mit \addtokomafont{caption}{\footnotesize} in der Präambel in einer klei- neren Schriftgröße setzen.
Wenn viele große Bilder eingebunden werden, wird die Dateigröße des erzeug- Acrobat: PDF optimiert
ten PDFs leicht riesig. Für eine elektronische Fassung der Arbeit kann das PDF deutlich kleiner gemacht werden, indem mit dem Adobe Acrobat bei „Speichern unter“ als Dateiformat „Adobe PDF-Dateien, optimiert“ ausgewählt wird. Unter
„Einstellungen. . . “ können dann verschiedene Optimierungen des fertigen PDFs
eingestellt werden, z. B. ein Downsampling aller Bilder auf eine moderate Endauf- lösung (ergibt viel kleinere Dateien).
4.7.1 Bilder
Die Dateinamen eingefügter Bilder sollten ohne Endung angegeben werden. Dies erleichtert die Verwendung von pdfLATEX und LATEX mit derselben TEX-Datei.
Sollen Bilder in Unterordnern des aktuellen Arbeitsverzeichnisses abgelegt werden,
\graphicspath
können diese mit\graphicspath{hPfadlistei}zum Suchpfad hinzugefügt werden.
hPfadlisteibesteht dabei aus einer Liste nochmals geklammerter Pfade, also z. B.
\graphicspath{{figures/}{fotos/}}4. Besonders angenehm ist dieser Befehl bei Verwendung von GnuPlot mit dem Ausgabeterminal epslatex, da hier TEX- Dateien mit darin eingebundenen eps-Bildern erzeugt werden, die natürlich keine Unterordner berücksichtigen. Ordner können auch zum allgemeinen TEX-Such-
\input@path
pfad hinzugefügt werden, indem
\makeatletter
\newcommand*{\input@path}{hPfadlistei}
\makeatother
in der Präambel (vor dem Einbinden desgraphicx-Pakets, falls auch zum Grafik- Pfad) eingefügt wird. Für Pfade relativ zur gerade eingebundenen Datei siehe auch Abschnitt4.4.
Sollen Bilder neben Text ausgerichtet werden, z. B. in einer Tabelle mit Be- schreibungstext inder einen Spalte und den dazugehörigen Bildern in der anderen, so richtet LATEX normalerweise die baselines des Textes und des Bildes aneinander aus (auch bei der Ausrichtung von parboxen oder minipages mit der Positionie- rungsangabe t). Dies kann man umgehen, wenn man im Vorspann einen Befehl
\setgraphicsbaselinedefiniert durch
\setgraphicsbaseline
\newcommand{\setgraphicsbaseline}[1]{%
\raisebox{-\height+\heightof{M}}[\heightof{M}]%
[\totalheight-\heightof{M}]{#1}%
}
Dabei muss das Paket calc geladen sein, um die Berechnungen zu ermöglichen.
calc
Mit \setgraphicsbaseline{hBildi}(hBildisteht hier für den LATEX-Code zum Einbinden oder Zeichnen des Bildes) wird dann die baseline des Bildes so an- gepasst, dass die Oberkante des Bildes mit der Oberkante des Buchstabens M zusammenfällt.
Wird pdfLATEX verwendet, Vektorgrafiken aber als EPS-Bilder erzeugt, so epstopdf
können diese auch direkt beim pdfLATEX-Lauf konvertiert werden. Dazu wird das Paket epstopdf eingebunden, wobei die Ausführung des Konvertierungspro- gramms epstopdf per Kommandozeilenoption oder Konfigurationsdatei erlaubt werden muss. Nützlich ist das Paket z. B. bei Verwendung des Plotprogramms GnuPlot mit dem Ausgabeterminal epslatex, allerdings müssen hier bei verän- derten Plots die alten pdf-Dateien gelöscht werden.
Falls EPS-Grafiken aus anderen Programmen (z. B. OpenOfficeOrg Draw) ein- psfrag
pst-pdf gebunden werden sollen, kann Beschriftung innerhalb der Bilder mit dem Paket psfragangepasst werden. Um Postscript bzw. EPS auch mit pdfLATEX verwenden zu können, lohnt sich auch ein Blick auf das Paketpst-pdf.
Falls mehrere kleine Bilder nebeneinander gesetzt oder verglichen werden sol- subfig
4Achtung Mac-User: Bei MacOS müssen die Pfade ggf. mit den Mac-typischen Verzeichnis- trennern geschrieben werden.
len, ist das Paket subfig sehr empfehlenswert. Eventuell muss dabei mit der Paketoption caption=falsedie Formatierung der Bildunterschriften wieder der KOMA - Script-Klasse (die intern von IMTEKdaaufgerufen wird) überlassen wer- den.
Sollen ganze Seiten aus anderen PDF-Dokumenten eingebunden werden, bei- pdfpages
spielsweise technische Zeichnungen im Anhang, so ist das Paketpdfpageszu emp- fehlen.5
Falls PDF-Dateien in EPS-Dateien umgewandelt werden sollen, kann dafür das pdftops
Programm pdftops verwendet werden. Man ruft es auf mit pdftops -paper match hDatei.pdfi
Die umgekehrte Konvertierung kann mit epstopdf hDatei.epsi erreicht werden.
epstopdf
Konvertierungen in beiden Richtungen können auch mit dem Programm epspdf epspdf
durchgeführt werden. Es bietet viele Optionen beim Konvertieren wie z. B. das Entfernen weißer Ränder oder Konvertierung in Graustufen. Auch eine Variante mit grafischer Benutzeroberfläche, epspdftk, ist verfügbar.
4.7.2 Tabellen
Für Tabellen innerhalb der Diplomarbeit sollte das Paketbooktabsverwendet wer- booktabs
longtable den. Bei langen Tabellen, die umbrochen werden können (z. B. in der Nomenkla- tur), sollte das Paketlongtableoder ein entsprechendes Paket verwendet werden.
Das Paket array bietet weitere Spaltendefinitionen und bietet Möglichkeiten, array
um LATEX-Befehle vor oder nach jedem Tabellenfeld in einer bestimmten Spalte einzufügen und so gezielt eine Spalte anders zu formatieren.
Blocksatz in Tabellen wirkt oft unschön, da die Wortzwischenräume zu stark gedehnt werden müssen (was auch viele Warnungen erzeugt). In schmalen Spal- ten sollte daher linksbündiger Flattersatz verwendet werden. Da das normale
\raggedright Worttrennungen unterdrückt, sollte man hier das Paket ragged2e ragged2e
verwenden, das neue Kommandos für Flattersatz bereitstellt. Für linksbündigen Text ist dies\RaggedRight. Dieser Befehl ist besonders in den Spaltenmodifika-
\RaggedRight
toren desarray-Pakets zu empfehlen.
Um Tabellen in Seitenbreite zu erstellen, kann das Pakettabularx verwendet tabularx
werden. Eine Anpassung dieses Pakets fürlongtableistltxtable.
ltxtable
Um die Breite einer Spalte in einer Tabelle in Seitenbreite zu berechnen, kann die Längenangabe auch als Berechnung angegeben werden, falls das Paket calc calc
geladen wurde, also z. B. mit
\begin{tabular}[t]{p{0.2\textwidth}p{0.8\textwidth-4\tabcolsep}}
. . .
\end{tabular}
wobei die Abstände zwischen den Spalten (je Spalte einer links und rechts) hier von der Breite der zweiten Spalte subtrahiert werden. Falls vor der Tabelle ein neuer Absatz begonnen hat, muss davor noch der Absatzeinzug mit \noindent entfernt werden.
4.7.3 Programmcode und Ähnliches
Zum Einfügen von Programmcode-Auszügen ist das Paketlistingssehr zu empfeh- listings
len. Es bietet Umgebungen, um Programmcode verbatim in den Text einzubinden.
5pdfpagesfunktioniert nur mit pdfLATEX.
Dabei wird sogar Syntax Highlighting für sehr viele Programmier- und Skriptspra- chen unterstützt. Es gibt auch eine Funktion, um Programmcode direkt aus einer Quelldatei einzubinden (auch einzelne Teile daraus), so dass der Code nicht extra aufgearbeitet und in die LATEX-Datei eingefügt werden muss.
5 Implementierung der Klasse
5.1 Optionen und Initialisierungen
Zunächst werden die Abfragen für die Optionennomtotocundenglishpreamble definiert und initialisiert sowie eine Abfrage, ob die Sprache für die Präambel festgelegt wurde.
1\newif\if@nomtotoc\@nomtotocfalse
2\newif\if@englishpreamble\@englishpreambletrue
3\newif\if@preamblelangdef\@preamblelangdeffalse
Dasselbe für die Sprachumschaltung per Klassenoption aufgermanbzw.ngerman
4\newif\if@germanopt\@germanoptfalse
5\newif\if@ngermanopt\@ngermanoptfalse nomtotoc
noenglishpreamble englishpreamble
Die Optionennomtotoc,noenglishpreambleund (nur der Vollständigkeit halber) englishpreamblesowie die Sprachoptionengermanundngermanwerden definiert und schalten die Umschalter auf die entsprechenden Werte.
6\DeclareOption{nomtotoc}{\@nomtotoctrue}
7\DeclareOption{noenglishpreamble}%
8 {\@preamblelangdeftrue\@englishpreamblefalse}
9\DeclareOption{englishpreamble}%
10 {\@preamblelangdeftrue\@englishpreambletrue}
11\DeclareOption{german}%
12 {\PassOptionsToClass{\CurrentOption}{scrbook}\@germanopttrue}
13\DeclareOption{ngerman}%
14 {\PassOptionsToClass{\CurrentOption}{scrbook}\@ngermanopttrue}
Abfragen für den Typ der Arbeit: Diplom, Bachelor oder Master sowie einer Ab- frage, ob eine dieser Optionen gesetzt wurde
15\newif\if@diplom\@diplomtrue
16\newif\if@bachelor\@bachelorfalse
17\newif\if@master\@masterfalse
18\newif\ifh@snothesistype\h@snothesistypetrue diplom
bachelor master
Definition der Optionendiplom,bachelorundmasterund Setzen der dazugehö- rigen Abfragen
19\DeclareOption{diplom}%
20 {\@diplomtrue\@bachelorfalse\@masterfalse\h@snothesistypefalse}
21\DeclareOption{bachelor}%
22 {\@diplomfalse\@bachelortrue\@masterfalse\h@snothesistypefalse}
23\DeclareOption{master}%
24 {\@diplomfalse\@bachelorfalse\@mastertrue\h@snothesistypefalse}
Falls keine dieser Optionen gesetzt ist, wird eine Warnung ausgegeben.
Noch eine Variable für die Optionoldcd, die auf das alte Corporate Design um- schaltet
25\newif\if@oldcd\@oldcdfalse
oldcd Die Klassenoptionoldcdschaltet auf das alte (bisherige) Layout um
26\DeclareOption{oldcd}%
27 {\@oldcdtrue}
Alle weiteren Optionen werden weitergegeben und als Basis-Klasse scrbook mit der Default-Option a4paper geladen. Für die Einbindung der Logos und Bilder wirdgraphicxbenötigt, für die Berechnung der Tabellenbreiten in der Titeleicalc.
28\DeclareOption*{\PassOptionsToClass{\CurrentOption}{scrbook}}
29\ProcessOptions\relax
30\ifh@snothesistype
31 \@latex@warning@no@line{%
32 Eine der Optionen diplom, bachelor oder master
33 \MessageBreak muss angegeben werden. Nehme diplom.%
34 }%
35\fi
36\LoadClass[a4paper,pagesize]{scrbook}
37\AtBeginDocument{\RequirePackage{graphicx}}
38\RequirePackage{calc}
39\RequirePackage[absolute]{textpos}
5.2 Definition sprachenabhängiger Begriffe
\nomname Definition des Nomenklatur-Namens (auf Englisch)
40\def\nomname{Nomenclature}
Fürbabel: Definition des deutschen Nomenklatur-Namens sowie der Kurzfassung von\figurename und\tablename
41\AfterPackage*{babel}{
42\iflanguage{german}{\@englishpreamblefalse}%
43 {\if@preamblelangdef\else\@englishpreambletrue\fi}
44 \addto{\captionsgerman}{\renewcommand*{\figurename}{Abb.}}
45 \addto{\captionsgerman}{\renewcommand*{\tablename}{Tab.}}
46 \addto{\captionsgerman}{\def\nomname{Nomenklatur}}
47\iflanguage{ngerman}{\@englishpreamblefalse}%
48 {\if@preamblelangdef\else\@englishpreambletrue\fi}
49 \addto{\captionsngerman}{\renewcommand*{\figurename}{Abb.}}
50 \addto{\captionsngerman}{\renewcommand*{\tablename}{Tab.}}
51 \addto{\captionsngerman}{\def\nomname{Nomenklatur}}
52}
Dasselbe für die Paketegermanundngerman
53\AfterPackage*{german}{
54 \@englishpreamblefalse\@germanopttrue
55 \renewcommand*{\figurename}{Abb.}
56 \renewcommand*{\tablename}{Tab.}
57 \newcommand*{\captionsgermansav}{}
58 \let\captionsgermansav\captionsgerman
59 \renewcommand*{\captionsgerman}%
60 {\captionsgermansav\def\figurename{Abb.}%
61 \def\tablename{Tab.}\def\nomname{Nomenklatur}}
62}
63\AfterPackage*{ngerman}{
64 \@englishpreamblefalse\@ngermanopttrue
65 \renewcommand*{\figurename}{Abb.}
66 \renewcommand*{\tablename}{Tab.}
67 \newcommand*{\captionsngermansav}{}
68 \let\captionsngermansav\captionsngerman
69 \renewcommand*{\captionsngerman}%
70 {\captionsngermansav\def\figurename{Abb.}%
71 \def\tablename{Tab.}\def\nomname{Nomenklatur}}
72}
5.3 Definition eigener Makros und Umgebungen
\titlepic
\titlepicdesc
Definition des Makros \titlepicfür ein Titelbild sowie \titlepicdesc für die dazugehörige Bildbeschreibung. Ebenso Definition und Initialisierung der Abfra- gen, ob Titelbild und Beschreibung des Titelbilds existieren
73\newif\ifh@stitlepic\h@stitlepicfalse
74\def\titlepic#1{\gdef\@titlepic{#1}\h@stitlepictrue}
75\newif\ifh@stitlepicdesc\h@stitlepicdescfalse
76\def\titlepicdesc#1{\gdef\@titlepicdesc{#1}\h@stitlepicdesctrue}
\dpoversion
\chair
\referees
\thesistime
\supervisor
Definition der Makros für Prüfungsordnung, Lehrstuhl, Gutachter, Betreuer und Bearbeitungszeitraum. Wenn eines dieser Makros nicht definiert ist, wird eine Fehlermeldung ausgegeben.
77\def\dpoversion#1{\gdef\@dpoversion{#1}}
78\def\@dpoversion{\@latex@error{No \noexpand\dpoversion given}\@ehc}
79\def\chair#1{\gdef\@chair{#1}}
80\def\@chair{\@latex@error{No \noexpand\chair given}\@ehc}
81\def\referees#1{\gdef\@referees{#1}}
82\def\@referees{\@latex@error{No \noexpand\referees given}\@ehc}
83\def\supervisor#1{\gdef\@supervisor{#1}}
84\def\@supervisor{\@latex@error{No \noexpand\supervisor given}\@ehc}
85\def\thesistime#1{\gdef\@thesistime{#1}}
86\def\@thesistime{\@latex@error{No \noexpand\thesistime given}\@ehc}
abstract Ergänzung der Abstract-Umgebung (die inscrbook nicht definiert ist)
87\newenvironment{abstract}{\addchap*{\abstractname}}{}
nomenclature Definition der Nomenklatur und Anpassen der Kopfzeile. Bei der Optionnomtotoc wird die Nomenklatur ins Inhaltsverzeichnis aufgenommen.
88\newenvironment{nomenclature}{%
89 \if@nomtotoc
90 \addchap{\nomname}
91 \@mkboth{\nomname}{\nomname}
92 \else
93 \if@hyperref
94 \if@openright\cleardoublepage\else\clearpage\fi
95 \phantomsection\pdfbookmark{\nomname}{nom}%
96 \fi
97 \chapter*{\nomname}
98 \@mkboth{\nomname}{\nomname}
99 \fi
100}{%
101}
5.4 Setzen der Titelei
\titlehead
\subject
\date
Definition der inscrbookvorgesehenen Felder der Titelei, die statisch belegt wer- den. Für\subjectwird intern auch eine unformatierte Variante definiert, die für die PDF-Informationen benötigt wird.
\LLogo
\RLogo
\BLogo
Logos werden gesetzt, falls sie vorhanden sind, sonst werden eine Fehlermeldung und ein Ersatztext ausgegeben.
102\newcommand{\LLogo}{\parbox[b][2.2cm]{0.3\textwidth}{%
103 \texttt{figures/IMTEK\_Logo\_Farbe.*}
104 von \texttt{http://intern.imtek.de} downloaden}}
105\newcommand{\RLogo}{\parbox[b][2.2cm]{0.3\textwidth}{%
106 \texttt{figures/Uni\_Siegel.*}
107 von \texttt{http://intern.imtek.de} downloaden}}
108\newcommand{\BLogo}{\parbox[b][2.2cm]{7.5cm}{%
109 \texttt{figures/Uni\_Logo\_E2\_A4\_CMYK.*}
110 von \texttt{http://www.uni-freiburg.de/go/cd} downloaden}}
111\newcommand{\l@g@error}{%
112 \ClassError{IMTEKda}{Logo file(s) not found}
113 {One or more of the files\MessageBreak
114 \space\space\space\space figures/IMTEK_Logo_Farbe.eps \MessageBreak
115 \space\space\space\space figures/IMTEK_Logo_Farbe.pdf \MessageBreak
116 \space\space\space\space figures/Uni_Siegel.eps \MessageBreak
117 \space\space\space\space figures/Uni_Siegel.pdf \MessageBreak
118 \space\space\space\space figures/Uni_Logo_E2_A4_CMYK.eps \MessageBreak
119 \space\space\space\space figures/Uni_Logo_E2_A4_CMYK.pdf \MessageBreak
120 are not installed properly. \MessageBreak
121 Install this subdirectory with the logo files \MessageBreak
122 together with the class file, see README.\MessageBreak
123 Type <return> to proceed without the logos.}
124 }
125\IfFileExists{figures/IMTEK_Logo_Farbe.eps}%
126 {\IfFileExists{figures/IMTEK_Logo_Farbe.pdf}%
127 {\renewcommand{\LLogo}%
128 {\includegraphics[height=2.2cm]{figures/IMTEK_Logo_Farbe}}}%
129 {\l@g@error}%
130 }{\l@g@error}
131\if@oldcd
132 \IfFileExists{figures/Uni_Siegel.eps}%
133 {\IfFileExists{figures/Uni_Siegel.pdf}%
134 {\renewcommand{\RLogo}%
135 {\includegraphics[height=2.2cm]{figures/Uni_Siegel}}}%
136 {\l@g@error}%
137 }{\l@g@error}
138 \renewcommand{\BLogo}{\null}%
139\else
140 \IfFileExists{figures/Uni_Logo_E2_A4_CMYK.eps}%
141 {\IfFileExists{figures/Uni_Logo_E2_A4_CMYK.pdf}%
142 {\renewcommand{\BLogo}%
143 {\includegraphics{figures/Uni_Logo_E2_A4_CMYK}}}%
144 {\l@g@error}%
145 }{\l@g@error}
146 \renewcommand{\RLogo}{\null}%
147\fi
148\titlehead{\LLogo\hfill\RLogo}
149\def\s@bject{%
150 \if@diplom\if@englishpreamble{Diploma Thesis}\else{Diplomarbeit}\fi%
151 \else%
152 \if@bachelor\if@englishpreamble{Bachelor’s Thesis}\else{Bachelorarbeit}\fi%
153 \else
154 \if@englishpreamble{Master’s Thesis}\else{Masterarbeit}\fi%
155 \fi
156 \fi}
157\subject{\titlefont{\s@bject}}
158\date{}
\maketitle Neudefinition der Titelei. Die Definition der Titelseite wurde aus scrbook im we- sentlichen übernommen, danach allerdings noch zwei Seiten mit offiziellen Anga- ben ergänzt. Die Abfrage der Optiontitlepagewird nicht berücksichtigt.
159 \renewcommand*\maketitle[1][1]{\begin{titlepage}%
160 \begin{textblock*}{0pt}[0,1](\paperwidth-17pt, \paperheight-36pt)
161 \llap{\BLogo}
162 \end{textblock*}
Die Titelseite wird gegenüberscrbookvergrößert
163 \enlargethispage{2cm}
164 \setcounter{page}{#1}
165 \let\footnotesize\small
166 \let\footnoterule\relax
167 \let\footnote\thanks
168 \renewcommand*\thefootnote{\@fnsymbol\c@footnote}%
169 \let\@oldmakefnmark\@makefnmark
170 \renewcommand*{\@makefnmark}{\rlap\@oldmakefnmark}
Ein Schmutztitel wird nicht vorgesehen
171 \ifx\@titlehead\@empty \else
172 \noindent\begin{minipage}[t]{\textwidth}
173 \@titlehead
174 \end{minipage}\par
175 \fi
176 \null\vfill
177 \begin{center}
178 \ifx\@subject\@empty \else
179 {\Large \@subject \par}
180 \vskip 3em
181 \fi
182 {\titlefont\huge \@title\par}
183 \vskip 3em
Das Titelbild wird ggf. eingefügt
184 \ifh@stitlepic
185 \ifh@stitlepicdesc\relax\else
186 \@latex@error{No \noexpand\titlepicdesc given}\@ehc
187 \fi
188 \@titlepic\par
189 \vskip 3em
190 \fi
191 {\Large \lineskip 0.75em
192 \begin{tabular}[t]{c}
193 \@author
194 \end{tabular}\par}
195 \vskip 1.5em
196 {\Large \@date \par}
197 \vskip \z@ \@plus3fill
198 {\Large \@publishers \par}
199 \vskip 3em
200 \end{center}\par
201 \@thanks
202 \vfill\null
203 \if@twoside\next@tpage
204 \noindent\begin{minipage}[t]{\textwidth}
205 \@uppertitleback
206 \end{minipage}\par
207 \vfill
208 \noindent\begin{minipage}[b]{\textwidth}
209 \@lowertitleback
210 \end{minipage}
211 \fi
Eine neue Seite ohne Kopf und Fuß wird für Organisatorisches eingefügt. Für die Berechnung der Tabellenbreiten wird das Paketcalcbenötigt.
212 \clearpage\thispagestyle{empty}
213 \noindent%
Schreiben der englischen Variante
214 \if@englishpreamble
215 \noindent
216 \begin{tabular}[t]{p{0.24\textwidth}p{0.76\textwidth-4\tabcolsep}}
217 &A \if@diplom{diploma}%
218 \else{\if@bachelor{bachelor’s}\else{master’s}\fi}\fi{}
219 thesis submitted in partial fulfillment of the
220 requirements for the degree of
221 \\[1em]
222 &\if@diplom{Graduate Engineer of Microsystems Engineering}\else
223 {\if@bachelor{Bachelor of Science of Microsystems Engineering}\else
224 Master of Science of Microsystems Engineering\fi}\fi
225 \\[1em]
226 &according to the examination regulations
227 at the University of Freiburg for the
228 \if@diplom{Diploma}\else{\if@bachelor{Bachelor’s degree}%
229 \else{Master’s degree}\fi}\fi{}
230 in Microsystems Engineering of \@dpoversion{}.\\[1em]
231 &\@chair\\
232 &Department of Microsystems Engineering (IMTEK)\\
233 &University of Freiburg\\
234 &Freiburg im Breisgau, Germany
235 \end{tabular}
236 \vfil
237 \noindent
238 \begin{tabular}[t]{p{0.24\textwidth}p{0.76\textwidth-4\tabcolsep}}
239 \bfseries Author&
240 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
241 \@author\end{minipage}
242 \end{tabular}
243 \vfil
244 \noindent
245 \begin{tabular}[t]{p{0.24\linewidth}p{0.76\textwidth-4\tabcolsep}}
246 \bfseries Thesis period&
247 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
248 \@thesistime\end{minipage}\\&\\
249 \bfseries Referees&
250 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
251 \@referees\end{minipage}\\&\\
252 \bfseries Supervisor&
253 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
254 \@supervisor\end{minipage}\\
255 \end{tabular}
256 \ifh@stitlepicdesc
257 \vfil
258 \noindent
259 \begin{tabular}[t]{p{0.24\linewidth}p{0.76\textwidth-4\tabcolsep}}
260 \bfseries Title page&
261 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
262 \@titlepicdesc\end{minipage}
263 \end{tabular}
264 \fi
265 \clearpage\thispagestyle{empty}
266 \null\vfill
267 \noindent
268 \begin{tabular}[t]{p{0.24\linewidth}p{0.76\textwidth-4\tabcolsep}}
269 \bfseries\large Declaration&according to
270 \if@diplom\S9(5) of the\else\if@bachelor\S22(8) of the\else{the}\fi\fi{}
271 Examination Regulations:\\[1em]
272 &I hereby confirm to have written the following thesis on my own,
273 not having used any other sources or resources than those listed.
274 All passages taken over literally or correspondingly from published
275 sources have been marked accordingly. Additionally, this thesis has not
276 been prepared or submitted for another examination, neither partially
277 nor completely.
278 \\[1em]
279 &Freiburg, \today\\[2cm]
280 &\begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
281 \@author\end{minipage}
282 \end{tabular}
Schreiben der deutschen Variante
283 \else
284 {\if@ngermanopt\selectlanguage{ngerman}%
285 \else\if@germanopt\selectlanguage{german}%
286 \fi%
287 \fi%
288 \noindent%
289 \begin{tabular}[t]{p{0.24\textwidth}p{0.76\textwidth-4\tabcolsep}}
290 &Eingereichte \if@diplom{Diplomarbeit}\else{\if@bachelor{Bachelorarbeit}%
291 \else{Masterarbeit}\fi}\fi{} gem\"a\ss{} den Bestimmungen der
292 Pr\"ufungsordnung
293 der Universit\"at Freiburg f\"ur den
294 \if@diplom{Diplomstudiengang}\else{\if@bachelor{Bachelorstudiengang}%
295 \else{Masterstudiengang}\fi}\fi{}
296 Mikrosystemtechnik vom \@dpoversion\\[1em]
297 &\@chair\\
298 &Institut f\"ur Mikrosystemtechnik (IMTEK)\\
299 &Albert-Ludwigs-Universit\"at Freiburg\\
300 &Freiburg im Breisgau
301 \end{tabular}
302 \vfil
303 \noindent
304 \begin{tabular}[t]{p{0.24\linewidth}p{0.76\textwidth-4\tabcolsep}}
305 \bfseries Autor&
306 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
307 \@author\end{minipage}
308 \end{tabular}
309 \vfil
310 \noindent
311 \begin{tabular}[t]{p{0.24\linewidth}p{0.76\textwidth-4\tabcolsep}}
312 \bfseries Bearbeitungszeit&
313 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
314 \@thesistime\end{minipage}\\&\\
315 \bfseries Gutachter&
316 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
317 \@referees\end{minipage}\\&\\
318 \bfseries Betreuer&
319 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
320 \@supervisor\end{minipage}\\
321 \end{tabular}
322 \ifh@stitlepicdesc
323 \vfil
324 \noindent
325 \begin{tabular}[t]{p{0.24\textwidth}p{0.76\textwidth-4\tabcolsep}}
326 \bfseries Titelseite&
327 \begin{minipage}[t]{0.76\textwidth-4\tabcolsep}%
328 \@titlepicdesc\end{minipage}
329 \end{tabular}
330 \fi
331 \clearpage\thispagestyle{empty}
332 \null\vfill
333 \noindent
334 \begin{tabular}[t]{p{0.24\textwidth}p{0.76\textwidth-4\tabcolsep}}
335 \bfseries\large Erkl\"arung&nach
336 \if@diplom\S9(5) der Diplompr\"ufungsordnung\else
337 {\if@bachelor\S22(8) der Pr\"ufungsordnung%
338 \else der Pr\"ufungsordnung\fi}\fi{}:\\[1em]
339 &Hiermit erkl\"are ich, dass ich diese Abschlussarbeit
340 selbst\"andig verfasst habe, keine anderen als die
341 angegebenen Quellen und Hilfsmittel benutzt habe und alle Stellen,
342 die w\"ortlich oder sinngem\"a\ss\ aus ver\"offentlichten Schriften
343 entnommen wurden, als solche kenntlich gemacht habe. Dar\"uberhinaus
344 erkl\"are ich, dass diese Abschlussarbeit nicht, auch nicht
345 auszugsweise, bereits f\"ur eine andere Pr\"ufung angefertigt
346 wurde.\\[1em]
347 &Freiburg, den \today\\[2cm]
348 &\begin{minipage}[t]{0.76\textwidth-4\tabcolsep}
349 \@author\end{minipage}
350 \end{tabular}%
351 }
352 \fi
Ggf. Einfügen einer Widmung
353 \ifx\@dedication\@empty \else
354 \next@tpage\null\vfill
355 {\centering \Large \@dedication \par}
356 \vskip \z@ \@plus3fill
357 \if@twoside \next@tpage\cleardoublepage \fi
358 \fi
359 \end{titlepage}
Zurücksetzen der Titelei-spezifischen Definitionen
360 \setcounter{footnote}{0}%
361 \global\let\thanks\relax
362 \global\let\maketitle\relax
363 \global\let\@thanks\@empty
364 \global\let\@author\@empty
365 \global\let\@date\@empty
366 \global\let\@title\@empty
367 \global\let\@titlehead\@empty
368 \global\let\@subject\@empty
369 \global\let\@publishers\@empty
370 \global\let\@uppertitleback\@empty
371 \global\let\@lowertitleback\@empty
372 \global\let\@dedication\@empty
373 \global\let\author\relax
374 \global\let\title\relax
375 \global\let\extratitle\relax
376 \global\let\titlehead\relax
377 \global\let\subject\relax
378 \global\let\publishers\relax
379 \global\let\uppertitleback\relax
380 \global\let\lowertitleback\relax
381 \global\let\dedication\relax
382 \global\let\date\relax
383 \global\let\and\relax}
5.5 Weitere Voreinstellungen
Definition und Initialisierung einer Abfrage, obhyperrefverwendet wird
384\newif\if@hyperref\@hyperreffalse
Definition einiger PDF-Infos bei Verwendung deshyperref-Pakets
385\AfterPackage*{hyperref}{%
386 \@hyperreftrue
387 \newcommand{\org@maketitle}{}%
388 \let\org@maketitle\maketitle
389 \def\maketitle{%
390 \hypersetup{
391 pdftitle={\@title},
392 pdfauthor={\@author},
393 pdfsubject={\s@bject}
394 }%
395 \org@maketitle
396 }
397}
Literatur
[1] Sascha Frank. Erste Schritte mit LATEX. Druckbares PDF: http://www.
informatik.uni-freiburg.de/~frank/latex/handout-4-auf-1.pdf, Bildschirmversion: http://www.informatik.uni-freiburg.de/~frank/
latex/kurs.pdf. Anm.: Kurze Anleitung der Poolmanager, gut für die allerersten Dokumente (à la „Hello World“).
[2] Peter Flynn. A beginner’s introduction to typesetting with LATEX. http:
//www.ctan.org/tex-archive/info/beginlatex/beginlatex-3.6.pdf.
Anm.: LATEX-Grundlagen mit Anleitung zur Installation unter verschiedenen Betriebssystemen; ohne Formelsatz.
[3] Walter Schmidt, Jörg Knappen, Hubert Partl, and Irene Hyna. l2kurz:
LATEX 2ε-Kurzbeschreibung. http://www.ctan.org/tex-archive/info/
lshort/german/l2kurz2.pdf. Anm.: Sehr gute Einsteigerlektüre für An- fänger, Pflichtlektüre!
[4] Tobias Oetiker, Hubert Partl, Irene Hyna, and Elisabeth Schlegl.lshort: The not so short introduction to LATEX 2ε. http://www.ctan.org/tex-archive/
info/lshort/english/lshort.pdf. Anm.: Erweiterte, englische Version von [3].
[5] LATEX3 Project Team. LATEX 2ε for authors, Juli 2001. http://www.ctan.
org/tex-archive/macros/latex/doc/usrguide.pdf. Anm.: Weitere Stan- dard-Einsteigerlektüre, ähnlich wie [3].
[6] Thomas F. Sturm. LATEX – Einführung in das Textsatzsystem. RRZN- Handbuch, 2006. Anm.: Das Handbuch kann beim Rechenzentrum gekauft werden. Empfehlenswerte Einführung in LATEX, beschreibt auch ausgewählte, wichtige Zusatzpakete.
[7] Frank Mittelbach, Michel Goossens, and Johannes Bahms.The LATEX compa- nion. Addison-Wesley, 2. Auflage, 2004. Deutsche Ausgabe: Frank Mittelbach, Michel Goossens.Der LATEX-Begleiter. Pearson Studium, 2. überarbeitete und erweiterte Auflage, 2005. Anm.: Die LATEX-„Bibel“, auch als „Bernhardiner“
bekannt; 2. Auflage hat sich sehr gegenüber der 1. verbessert.
[8] Markus Kohm und Jens-Uwe Morawski. KOMA-Script – Die An- leitung. http://www.ctan.org/tex-archive/macros/latex/contrib/
koma-script/scrguide.pdf Als Buch erhältlich unter: Markus Kohm und Jens-Uwe Morawski.KOMA-Script – Die Anleitung. DANTE e. V., Lehmanns Fachbuchhandlung, 2., verbesserte Auflage, Mai 2005.
[9] Keith Reckdahl. Using imported graphics in LATEX and pdfLATEX. http://
www.ctan.org/tex-archive/info/epslatex.pdf. Anm.: Alles zum Thema Bilder und Floats,das Nachschlagewerk bei Problemen damit.
