Diplomarbeit schreiben mit

Eine praktische Einführung

Referent: Alexander Eschler

Gliederung

Was ist das? Wieso eigentlich? Worum geht es? Was brauche ich? Wie geht das?

Was ist das? TeX/LaTeX ist ein äußerst flexibles, rechner- und

betriebssystemunabhängiges Satzsystem, das zur Erstellung von Dokumenten in Buchdruckqualität geeignet ist.

Reduzierung auf das Wesentliche Verwendung logischer Markups und Regeln zu deren

Funktion bzw. Ihrem Erscheinungsbild Keine Definition einer grafischen Oberfläche Vollständige Kontrolle Seit über 15 Jahren in stabiler Version

Wieso eigentlich? Vorteile

Beschränkung auf die logische Struktur und nicht auf die gestalterischen Details.

Mathematische Formeln Anspruchsvolle Strukturen werden mit wenig Aufwand

unterstützt Automatische Aktualisierungen Kein Problem mit (sehr) langen Dokumenten Mäßiger Ressourcenbedarf und hohe Stabilität Standardisierung und Portierbarkeit

Nachteile Erheblicher Aufwand bei Anpassungen Rechtschreibprüfung Lesbarkeit/Unübersichtlichkeit

Worum geht es?

Was dieser Kurs nicht abdeckt: Erschöpfende Darlegung Technische Details (Vorsicht: Halbwissen!) Eigenständige Erweiterungen

Das Ziel ist es also, ausreichendes Anwendungswissen zu erlangen, um

mit gegebenen Vorlagen und der Unterstützung von Nachschlagewerken eine formvollendete Diplomarbeit zu schreiben!

Was brauche ich? (1/2) LaTeX-System

MiKTeX: www.miktex.org Editor

TeXnicCenter: www.toolscenter.org Tools

für BibTeX: JabRef (http://jabref.sourceforge.net) oder BibEdit (http://www.iui.se/staff/jonasb/bibedit)

für Tabellen: LaTable (http://g32.org/latable) Diplomarbeitsvorlage

vom Lehrstuhl (UniBA) oder die wise-Vorlage der TU Dresden Dokumentation (Hilfe)

z.B. LaTeX-Kochbuch: http://www.uni-giessen.de/hrz/tex/cookbook/cookbook.html

Was brauche ich? (2/2)

Installation des Basissystems und aller benötigter Tools/Komponenten

Vorstellung der LaTeX-Management-Programme

Verwalten und Hinzufügen von Paketen Erster Start des Editors

Wie geht das? Eine Übersicht Der typische Arbeitsablauf Ein einfaches LaTeX-Dokument Syntaktische Grundlagen Die grundlegende Dokumentenstruktur Dokumentenklassen Satztechnische Grundlagen Zeichensatz Verwendung von Vorlagen Los gehts!

Der typische Arbeitsablauf

1. Eingabedatei mit Text und LaTeX-Kommandos schreiben

2. „Kompilieren“ mit dem LaTeX-System. Es entsteht eine geräteunabhängiges Anzeigeformat (.ps, .pdf, .dvi)

3. „Probeausdruck“ auf dem Bildschirm4. Ergebnis ok? Sonst zurück zu Schritt 25. Ausgabedatei drucken

Ein einfaches LaTeX-Dokument\documentclass{article}\begin{document}% Jetzt folgt der TextDie Hobbits sind ein unauffälliges, aber sehr altes Volk, das früher zahlreicher war als heute; denn sie lieben Frieden und Stille und einen gut bestellten Boden: eine wohlgeordnete und wohlbewirtschaftete ländliche Gegend war ihr bevorzugter Aufenthaltsort.Kompliziertere Maschinen als einen Schmiede-Blasebalg, eine Wassermühle oder einen Handwebstuhl verstehen und verstanden oder mochten sie auch nicht, obwohl sie mit Werkzeugen sehr geschickt umgingen.\end{document}

Syntaktische Grundlagen LaTeX-Befehle beginnen immer mit

\ (backslash) Syntaktische Struktur eines LaTeX-Befehls:

\befehl[optionen]{inhalt} Wobei inhalt in der Bedeutung von LaTeX-

Schlüsselwort oder anzuwendendem Text vorkommen kann!

Kommentare beginnen immer mit %

Die grundlegende Dokumentenstruktur

\documentclass[x]{y}...weitere globale Befehle...

\begin{document}

...Inkludierung von Komponenten und/oder freier Text...

\end{document}

Präambel

Schriftstück

Dokumentenklassen

Die definierte „Klasse“ eines Dokuments enthält Vereinbarungen über das Layout und die logischen Strukturen, z.B. die Gliederungs-einheiten (Kapitel etc.), die alle Dokumente dieses Typs gemeinsam haben.

Syntax: \documentclass[optionen]{klasse} Beispiel: \documentclass[11pt,a4paper]{article}

Satztechnische Grundlagen (1/3)

Zeilenlänge und Umbrüche im Editor haben keine Auswirkungen auf das Schriftbild Ausnahme: Absatz nach zwei Umbrüchen! expliziter Zeilenwechsel ohne Absatz mit \\ oder \newline

Satzendezeichen bewirken einen vergrößerten Abstand zum neuen Satz Ausnahme: Satz endet mit Großbuchstaben!

Satzende explizit mit \@ einleiten Nach einem Leerzeichen kann generell immer ein

Umbruch erfolgen mitunter unerwünscht!

Nicht umzubrechende Textteile mit ~ kennzeichnen

Satztechnische Grundlagen (2/3)

Manche Konstrukte hätten so einen zu kurzen oder gar keinen Abstand verkürzter Abstand mit \,

Der Bindestrich dient nur als Trennzeichen für unvollständige Textteile Es gelten implizite LaTeX-Trennungsregeln Eigene Trennungsvorgabe mit \- einleiten, z.B. Archaeo\-pterix

Globale Vorgabe für die Trennung einrichten:\hyphenation{Archaeo-pterix}

Satztechnische Grundlagen (3/3)

Anführungszeichen können nicht einfach offen geschrieben werden. Mit dem Paket ngerman stehen Befehle für die deutsche Version zur Verfügung: "` (unten) "' (oben)

In TeXnicCenter erfolgt die Umformatierung automatisch bei der Eingabe

Texthervorhebungen \textsl{}

schräg \textit{}

kursiv \textbf{}

fett \textsc{}

Kapitälchen \texttt{}

nicht-proportional

Zeichensatz Lokalisierung: deutscher Zeichensatz\usepackage[latin9]{inputenc}

deutsche Trennungsregeln laden:\usepackage{ngerman}

Unzulässige Zeichen:(weil Steuerzeichen)

!?

So viel zu den einfachen Grundlagen... Wir sind jetzt bereit, ein einfaches

Dokument zu schreiben und zu formatieren!

Dann geht es weiter mit Vorlagen und der Sicht auf das gesamte Dokument.

Verwenden von Vorlagen

Notwendige Pakete: Enthaltene Dateien:

wise.cls (Standardeinstellungen, zusätzliche/redefinierte Befehle, Umgebungen)

wiseapp.sty (Def. Textbausteine) wisetext.sty (Def. Anhänge)MikTeX/tex/latex/wise wisealpha.bst (Literaturvorlage)MikTeX/bibtex/wise

Beispiel: wise-Vorlage der TU Dresden (Lehrstuhl für Systementwicklung) angepasst für die Uni Bamberg

Die wise-Vorlage: Features angepasste DA-Titelseite

\diplomatitlepage{angaben} ehrenwörtliche Erklärung

\declaration erweiterte Kopfzeile Umgebung für Einleitung

\introduction erweitertes Abkürzungsverzeichnis

\listofabbreviations, \abbreviation{abk.}{normal} erweiterte Zitierungen

\shortcite{}{}, \longcite{}{}, \doublelongcite{}{}{}{} standardisiertes und fehlerbereinigtes Literaturverzeichnis basiert auf Dokumentenklasse scrbook (koma-script) In der erweiterten Version noch vieles mehr!

Erstellung der Hauptdatei Die Hauptdatei bestimmt die Struktur der

eigenen Diplomarbeit und dient der Einstellung (weiterer) zentraler Vorgaben

neutrale Benennung, z.B. arbeit.tex entspricht dem Projektnamen in TeXnicCenter beim Kompilieren von LaTeX erzeugte Dateien tragen dann auch

diese Bezeichnung. Einbinden der verwendeten Vorlage:\documentclass[optionen]{wise}

Die Textabschnitte (z.B. die Kapitel) befinden sich in externen Dateien und werden in die Hauptdatei inkludiert: \include{dir/file}

Projektstruktur: Allgemeines

Aus Gründen der Übersichtlichkeit empfiehlt sich eine derartige Gliederung der Projekt- bzw. Verzeichnisstruktur:

/diplomarbeit (Projektverzeichnis mit Hauptdatei, etc.)

/text (Textdateien zu den Abschnitten) /images (Bilder, Zeichnungen, etc.) /listings (Klassen, Code-Snippets, etc.) /tabellen (Tabellen)

Dokumenten-KonventionenTitelseite \diplomatitlepage{...}

\listoffiguresAbbildungsverz.

\listoftablesTabellenverz.

\lstlistoflistingsQuellcodeverz.

\listofabbreviations

\bibliography{diplomarbeit}

Abkürzungsverz.

EIGENTLICHER INHALT DER ARBEIT\include(kap1)\include(kap2)...\include(kap41)

Literaturverz.

ANHÄNGE ZUR ARBEIT\include(anhang1)

\printindexIndex

\declarationErklärung

document

preface

appendices

\tableofcontentsInhaltsverz.

Gliederung der Arbeit \part (logische Untergliederung in Teile, z.B. „ Teil I - Grundlagen“)

\chapter (z.B. „Kapitel 2 - Information Retrieval“) \section (z.B. „2.1 - Termreduktion“)

\subsection (z.B. „2.1.1 – Stammformreduktion“) \subsubsection (optional)

· \paragraph (ohne Nummerierung)...

Mit (z.B.) \chapter*{Geheimes Kapitel} kann man verhindern, dass ein Gliederungspunkt in das Inhaltsverzeichnis aufgenommen wird

wise bietet eine Einleitungsumgebung (\introduction) an, die bei der Kapitelnummerierung 0 beginnt

generell ist die Verfügbarkeit und die Gestalt von Gliederungsebenen von der Dokumentenklasse abhängig. book-Klassen bieten die meisten Möglichkeiten

Verweise Das LaTeX-Verweissystem ermöglicht automatische

Referenzen auf nummerierte Textabschnitte und Objekte (z.B. Formeln, Tabellen, Bilder).

Dazu muss Abschnitten und Objekten ein Ansprungspunkt zugewiesen werden: \chapter{Einleitung}\label{chap:einleitung}

Jetzt kann von jeder beliebigen Stelle aus verwiesen werden: \ref{chap:einleitung}

Bei Änderungen an der Struktur werden die Referenzen automatisch aktualisiert (evtl. mehrmals kompilieren)

In \label und \ref sind leider keine Umlaute erlaubt \pageref{label} zeigt noch die zugehörige Seite

Die Titelseite Das Kommando \diplomatitlepage erwartet

folgende Parameter: {Titel der Arbeit} {zu erlangender Grad, z.B. Diplom-Wirtschaftsinformatiker} {Name des Diplomanden} {Matrikelnummer, z.B. 1234567} {Titel und Name 1. Betreuer, z.B. Professor} {Titel und Name 2. Betreuer, z.B. wiss. Mitarbeiter} {Datum der Anmeldung, z.B. 01.06.2005} {Datum der Abgabe, z.B. 30.11.2005}

Die uni-spezifischen Daten stehen in der Style-Datei wisetext.sty

Verzeichnisse Bis auf das Literaturverzeichnis, das eine eigene

„Datenbank“ verwendet, arbeiten alle Verzeichniss grob nach folgendem Schema: zwei Befehlstypen:

zum „Ausdrucken“ (z.B. \listoftables) für zugehörige Objekte (z.B. \begin{tabular} ...)

beim Kompilieren werden dann zuerst alle zugehörigen Objekte „eingesammelt“ und in einem zweiten Schritt ins Verzeichnis geschrieben.

Verzeichnisse sind für alle Objekttypen (z.B. auch Formeln) verfügbar

Objekte: Abbildungen Typische Kontrollstruktur:

\begin{figure}[optionen1]\centering\includegraphics[optionen2]{images/image1.eps}\caption{Die Abbildung zeigt...}\label{fig:image1}\end{figure}

Mit [h!tbp] kann die Platzierung an der gewünschten Stelle forciert werden

Abbildungsverzeichnis

Abbildungen: Probleme LaTeX kann eigentlich nur mit Postscript-Grafiken

umgehen (also .eps) Einbindung anderer Formate (.jpg, .png, etc.) möglich,

aber mitunter problematisch für Jpegs muss zuerst eine sog. bouncing box erstellt werden

Miktex-Kommando ebb file.jpg Best practices:

Jpegs erstellen und nach .eps konvertieren Tool Jpeg2PS jpeg2ps file.jpg > file.eps

Zeichnungen in PDF drucken und in Acrobat nach .eps exportieren

Manchmal erfolgt auch die Platzierung nicht genau an der gewünschten Stelle statt direkt besser im Textfluss auf das Bild verweisen

Objekte: Tabellen Typische Kontrollstruktur:

\begin{table}[h]\centering

\begin{tabular}{|l|l|l|l|l|l|}\hline & & & & & & \\\hline...

\end{tabular}\caption{Beschreibung der Tabelle}\label{tab:table1}

\end{table} Tabellen „von Hand“ zu erstellen macht keinen Spass! Außerdem ist das Dokument dann schlecht lesbar

Tabellen: Best Practice Tabellen in LaTable erstellen!

grafische Oberfläche und intuitive Bedienung generierten „LaTeX-Code“ einfach kopieren und in

eine separate .tex-Datei einfügen aber: Formatierungen müssen noch gesetzt werden

angepasste Kontrollstruktur:\begin{table}[h]

\centering \include{tables/table1}\caption{Beschreibung der Tabelle}\label{tab:table1}

\end{table}

Objekte: Listings (Quellcode)

Paket listings erforderlich! Typische Kontrollstruktur:

\begin{lstlisting}[caption=Listing1,label=lst:listing1] Code\end{lstlisting}

oder:\lstinputlisting[caption=,label=]{listings/GeoController.java}

Konfiguration in der Hauptdatei über das \lstset{...}-Kommando

Objekte: Formeln Mathematische Formeln sind eine große Stärke von

LaTeX. Alle denkbaren Symbole und mehr werden unterstützt (teilweise sind aber separate Pakete notwendig)

Unterscheidung verschiedener Typen: Fließtextformeln

Formeln erscheinen im laufenden Text Absatzformeln

Formeln erscheinen zentriert in eigenem Absatz nummerierte Absatzformeln

Formeln werden im Kapitelkontext nummeriert und sind referenzierbar

Formeltypen: Kontrollstrukturen Fließtextformeln

werden z.B. einfach mit $...$ eingeschlossen Absatzformeln

Werden z.B. mit $$...$$ eingeleitet. Die Formel kann sich so auf ihre optimale Größe ausdehnen.

Nummerierte Absatzformeln \begin{equation}

a = b + c \ref{eq:formel1}

\end{equation}

Formelsyntax: Beispiele Produkt

x \times y Potenzen

x^n Bruch

\frac{Zähler}{Nenner} Indizes

x_index Summe

\sum{_{von}^{bis}{summand}

Wurzel \sqrt{Formel}

Vektor \vec{a}

Ungleichung x \leq y

Sonstiges \alpha, \beta, etc. \in (Element) \parallel \equiv

u.v.m.

Weitere Formelkonstrukte Gleichungssystem\begin{eqnarray} a & b & c \\ x & y & z\end{eqnarray} Die & dienen dabei als Ausrichtungsanker einzelne Zeilen können am Ende mit \nonumber von der

Nummerierung ausgeschlossen werden Das ganze Gleichungssystem kann mit \begin{eqnarray*} unnummeriert gesetzt werden (gilt für viele Konstrukte in LaTeX).

Weitere Objekte: Auflistungen

Spiegelstrichlisten\begin{itemize} \item Erster Punkt \item Zweiter Punkt\end{itemize}

Nummerierte Listen \begin{enumerate} \item Erster Punkt \item Zweiter Punkt\end{enumerate}

Zwei Arten von Auflistungen

Maximal vier Verschachtelungsebenen Die Marken können mit \item[irgendwas] angepasst werden

Fußnoten Wichtiges Stilmittel zur Auslagerung von erklärenden

oder weiterführenden Informationen, um den Textfluss nicht zu beinträchtigen.

LaTeX-Kommando: \footnote{Text} TeXnicCenter-Shortcut: Strg+Alt+F Innerhalb von Fußnoten kann der Text beliebig formatiert

werden. Das Handling komplexer Fußnoten ist in LaTeX kein Problem.

Fußnoten werden normalerweise innerhalb von Kapiteln fortlaufend gezählt

Literaturverzeichnis & Zitierungen

LaTeX verfügt über das sehr mächtige Literaturverwaltungssystem BibTeX.

Die Datei diplomarbeit.bib stellt die „Datenbank“ dar, in der alle Informationen zur Literatur gespeichert werden.

Jeder Eintrag entspricht einem bestimmten Literaturtyp und hat einen eindeutigen Schlüssel.

Über den Schlüssel wird im Text durch eine Zitierung die Verbindung zur „Datenbank“ hergestellt.

Schließlich erscheinen alle in der Arbeit verwiesenen Werke im Literaturverzeichnis im Anhang.

Das Literaturverzeichnis pflegen Erstellung und Pflege einer Literaturdatei z.B.

mit dem Tool BibEdit. BibTeX-Datensätze (für Copy&Paste) über

wissenschaftliche Texte z.B. bei: http://citeseer.ist.psu.edu/cs (wenn verfügbar) http://liinwww.ira.uka.de/bibliography/index.html

Mehrere Autoren mit and trennen Als Schlüssel empfiehlt sich eine Kombination

aus Autor, Jahr und erstes Titelwort, z.B. salton87term

Typischer BibTeX-Eintrag@TechReport{salton87term, pages = "21", year = "1987", type = "Technical Report", number = "TR87-881", title = "Term Weighting Approaches in Automatic Text Retrieval", bibdate = "October 14, 1993", author = "Gerard Salton and Chris Buckley", abstract = "The experimental evidence accumulated over the past 20 years

indicates that textindexing systems based on the assignment of appropriately weighted single terms produce retrieval results that are superior to those obtainable with other more elaborate text representations. These results depend crucially on the choice of effective term weighting systems...",

language= "English", institution= "Cornell University, Computer Science Department", month = nov}

LaTeX/BibTeX: Zitierungen

Einfaches LaTeX-Kommando: \cite[Seitennummer]{BibTeX-Schlüssel}

Zusätzliche wise-Kommandos: \shortcite{BibTeX-Schlüssel}{Seitennummer} \longcite{BibTeX-Schlüssel}{Seitennummer} \doublelongcite

{BibTeX-Schlüssel}{Seitennummer}{BibTeX-Schlüssel}{Seitennummer}

LaTeX/BibTeX: Einrichtung Nötige Kommandos in der Hauptdatei

\bibliography{diplomarbeit} \bibliographystyle{wisealpha}

Verknüpfung mit der Arbeit herstellen(nur einmal nötig) mindestens ein Zitat in die Arbeit aufnehmen Arbeit kompilieren In TeXnicCenter: Ausgabe BibTeX Arbeit kompilieren

appendix

Das Abkürzungsverzeichnis

Zwei Kommandos in der Hauptdatei\listofabbreviations (Ausgabe)\input{abkuerzungen.tex} (Inkludierung)

Für jeden Eintrag in der Datei abkuerzungen.tex \abbreviation{SOM}{Sematisches Objektmodell}

regelmäßig pflegen!

Der Index (1/2) Schickes Feature für die Diplomarbeit, wenn

man konsequent daran arbeitet! Gedacht für bestimmte Textstellen, z.B. wenn

ein wichtiger Begriff erstmals oder wieder in einem größeren Zusammenhang auftaucht.

Hinter den Begriff das Kommando \index{Begriff} setzen

Für jede Markierung zu einem Begriff erscheinen im Index die zugehörigen Seitenzahlen

Der Index (2/2) Vorkehrungen in der Hauptdatei

\usepackage{makeidx} Paket einbinden in der Präambel

\makeindex Indexerstellung anstoßen in der Präambel

\printindex Ausgabe in der appendix-Umgebung

Es können einige Kompilierzyklen notwendig sein, bis die Stellen auch im Index auftauchen (evtl. muss auch die .idx-Datei im Projektverzeichnis mal gelöscht werden)

Die ehrenwörtliche Erklärung

Wird zuallerletzt in der appendix-Umgebung eingebunden\declaration

Eventuell anpassen Muss nur noch unterschrieben werden!

Rechtschreibprüfung Qualität nicht von LaTeX abhängig, sondern vom Editor

und der verwendeten Wörterbücher. Qualitativ hochwertige, freie Wörterbücher sind leider

rar. In TeXnicCenter können immerhin die Wörtbücher von

OpenOffice benutzt werden: Extras Optionen Rechtschreibung Wörterbücher herunterladen .dic-Datei im TeXnicCenter-Verzeichnis language speichern TexNicCenter beenden und neu starten Einstellung unter Extras Optionen Rechtschreibung Dialekt vornehmen

LaTeX-Kommandos werden weitgehend ignoriert, so manche Syntax muss aber bekannt gemacht bzw. ignoriert werden.

Das Ausdrucken Die Vorlage ist über die Klassenoption oneside

für einseitigen Druck und anschließendes Binden ausgelegt.

Höchste Druckqualität erzielt man, wenn man die PostScript-Datei direkt ausdruckt.

Ansonsten liefert aber auch ein konvertiertes PDF eine sehr gute Qualität.

Zum Drucken immer die Option hyperref weglassen!

Nützliche Tipps Einfügen von URLs:

\url{http://www.uni-bamberg.de} Zur Projektdatei gibt es immer ein LaTeX-Logfile. Hier werden die

(Fehler)Meldungen beim Kompilieren gespeichert. ShortCuts benutzen! Mit unbekannten Optionen einfach herumspielen, die Auswirkungen

betrachten und lernen! Im WWW finden sich mannigfaltige Seiten zum Thema LaTeX und

zugehörige Pakete. Aller Anfang ist schwer und bisweilen ärgerlich. Nach wenigen

Wochen aber, wenn das LaTeX-Projekt steht, wird man mit einer stabilen Arbeitsumgebung belohnt. Wenn am Ende Hektik und Stress ausbrechen, wird immerhin die Textverarbeitung keine Probleme machen!

Die recht strengen Strukturierungsvorgaben wirken sich positiv auf die Struktur der Arbeit und somit auch auf die Note aus!