Auf dieser Seite sind Verbesserungsvorschläge für Schwächen aufgeführt, die in bisherigen Seminararbeiten und Folien auftraten. Die Seite wird laufend ergänzt. Lernen Sie aus den Fehlern der Anderen!
Dokumentanfang: Der Kopf der Seminararbeit sollte etwa so aussehen:
\documentclass[a4paper,11pt]{scrartcl}
\usepackage[austrian]{babel} % falls der Artikel auf Deutsch verfasst ist
% Verwenden Sie nur EINE der beiden folgenden Zeilen, je nachdem, ob Ihr
% Betriebssystem LATIN1 (=ISO-8859-1) oder UTF8 als Zeichenkodierung
% verwendet. Ob Sie die richtige verwenden, merken Sie daran, dass
% die Umlaute richtig im Dokument dargestellt werden.
\usepackage[latin1]{inputenc}
\usepackage[utf8]{inputenc}
\newenvironment{keywords}%
{\begin{trivlist}\item[]{\bfseries\sffamily Schlagworte:}\ }% oder "Keywords:"
{\end{trivlist}}
\begin{document}
\title{Titel der Arbeit}
\author{Mein Name%
\thanks{E-mail: \texttt{e1234567@student.tuwien.ac.at}}}
\date{November 2001}
\maketitle
\begin{abstract}
Das ist die Kurzfassung.
\end{abstract}
\begin{keywords}
\LaTeX, Beispieldatei, Seminararbeit.
\end{keywords}
\section{Einleitung}
An Stelle von scrartcl können Sie auch article als Dokumentklasse verwenden; report oder book hingegen sind für ein kleines Dokument ungeeignet.
Inhaltsverzeichnis, Abbildungsverzeichnis, laufende Kopfzeile, eigene Titelseite etc.: Diese Dinge lassen sich zwar mit je einem Kommando automatisch erstellen, sind aber bei einem kurzen Dokument wie einer Seminararbeit fehl am Platz.
Visual Markup: Verzichten Sie für's Erste (und auch Zweite) auf alle Formen der visuellen Formatierung; vertrauen Sie den Voreinstellungen der gewählten Dokumentklasse. Sobald Sie beginnen, Kommandos wie \vspace, \hspace, \newpage, \newline, \\, oder Längenmaße wie pt, mm, ex zu verwenden, sind Sie auf dem Holzweg.
Absatzformatierung: Absätze werden durch Leerzeilen (oder gleichwertig durch das Kommando \par) markiert. Verwenden Sie zu diesem Zweck nicht das Kommando \\, um etwa Einrückungen zu vermeiden. Wenn Sie eine von den Voreinstellungen abweichende Absatzformatierung erreichen wollen, lässt sich das über globale Parameter steuern. Wenn Sie etwa in der Präambel (d.h., vor \begin{document}) die Zeilen
\parindent=0cm \parskip=1mm
einfügen, wird statt der Einrückung des Absatzanfanges ein Abstand zwischen den Absätzen eingefügt. Aber warum wollen Sie überhaupt an den Voreinstellungen etwas ändern?
Logical Markup: Markieren Sie wiederkehrende Strukturen (etwa Beispiele) durch selbstdefinierte begin-end Konstrukte. Dadurch kann das Erscheinungsbild dieser Struktur an einer einzigen Stelle für das ganze Dokument festgelegt werden (vgl. auch HTML und Style Sheets). Um etwa "Examples" einheitlich formatieren zu können, definieren Sie in der Präambel (d.h., vor \begin{document}) zum Beispiel:
\newenvironment{example}%
{\begin{trivlist}\item[]\textit{Example.}\ }%
{\end{trivlist}}
Im Text werden alle Beispiele in ein example-Environment gestellt:
\begin{example}
This is an example.
\end{example}
Bibliographie: Jede seriöse Arbeit zitiert die Quellen, aus denen geborgtes Material stammt bzw. die verwandte Themen behandeln. In den Geisteswissenschaften und anderen geschieht dies oft durch Fußnoten, in technischen und naturwissenschaftlichen Arbeiten in der Regel durch Nummern oder Buchstaben in eckigen Klammern, die auf eine Literaturliste am Ende der Arbeit verweisen. Für die Formatierung sowohl der Verweise im Text als auch der Literaturangaben am Ende gibt es verschiedene Konventionen. Insbesondere ist darauf zu achten, dass die Literaturangaben vollständig sind, sodass die zitierten Quellen tatsächlich an Hand der gemachten Angaben aufgespürt werden können. Weiters ist es üblich, in die Literaturliste nur solche Quellen aufzunehmen, auf die auch tatsächlich im Text Bezug genommen wird.
Wie Bibliographien und Literaturverweise in LaTeX richtig verwendet werden, kann man etwa dem LaTeX Kochbuch, Kapitel 9 entnehmen.
Zeilenumbruch, overfull \hbox: Manchmal hat TeX Schwierigkeiten, geeignete Stellen für die Silbentrennung zu finden. Als Folge entstehen überlange Zeilen, die in den Rand ragen und im Logfile als "overfull \hbox" angezeigt werden. Dies tritt insbesondere bei Texten auf, die Umlaute oder akzentuierte Buchstaben enthalten. Die einfachste Lösung besteht darin, TeX mit dem Kommando \- explizit über mögliche Trennstellen im überschießenden Wort zu informieren:
Das Wort Pass\-wör\-ter darf an zwei Stellen getrennt werden.
Bei Folien und anderen Dokumenten mit einer geringen Zeilenlänge kann man TeX global veranlassen, weniger strenge Maßstäbe an den Zeilenumbruch zu legen, indem man in die Präambel das Kommando \sloppy aufnimmt. Abzuraten ist von händischem Zeilenumbruch mittels \newline oder \linebreak, da dies bei nachträglichen Dokument- oder Formatänderungen zu Umbrüchen an der falschen Stelle führt.
Weblinks, Dateinamen, Email-Adressen und dergleichen sollten erstens in einem eigenen Font gesetzt und zweitens an geeigneten Stellen umgebrochen werden. Außerdem wäre es schön, wenn die Links nach Umwandlung des Dokuments in das PDF-Format klickbar wären. Es gibt (mindestens) zwei Möglichkeiten:
Makropaket hyperref: Geben Sie in der Präambel die Zeile \usepackage[breaklinks]{hyperref} an. Im Text sind dann Links, Mailadressen etc. wie folgt zu schreiben:
Diese Tipps befinden sich auf der Webseite
\url{http://www.logic.at/lvas/gma_crypt/tipps.html#urls}.
Die Datei \nolinkurl{hyperref.sty} befindet sich auf meinem Rechner im Verzeichnis
\nolinkurl{/usr/share/texmf-texlive/tex/latex/hyperref}.
Das \url-Kommando erzeugt einen klickbaren Link, während das Argument eines \nolinkurl-Kommandos wie ein Link gesetzt und umgebrochen, aber nicht klickbar wird. Darüber hinaus sind auch Fußnoten, Referenzen und Inhaltsverzeichnis klickbar. Eine Beschreibung aller Optionen und Kommandos dieses Makropaketes gibt es unter http://www.tug.org/applications/hyperref/manual.html.
(Dank an Andreas Bartels, Uni Bremen, für eine Ergänzung zur Verwendung des Hyperref-Pakets.)
Makropaket url: Geben Sie in der Präambel die Zeile \usepackage{url} an. Im Text sind dann Links, Mailadressen etc. wie folgt zu schreiben:
Diese Tipps befinden sich auf der Webseite
\url{http://www.logic.at/lvas/gma_crypt/tipps.html#urls}.
Die Datei \url{url.sty} befindet sich auf meinem Rechner im Verzeichnis
\url{/usr/share/texmf-texlive/tex/latex/ltxmisc}.
Fonts im Mathematik-Modus: Der Mathematik-Modus wird im Fließtext mit Dollarzeichen - $Formel$ - oder runden Klammern - \(Formel\) - eingeleitet und beendet, bei hervorgehobenen (zentrierten) Formeln hingegen mit Doppeldollarzeichen - $$Formel$$ - oder eckigen Klammern - \[Formel\]. Er sorgt dafür, dass Formeln und Operatoren richtig gesetzt werden. Darüber hinaus wird automatisch ein schräggestellter Font mit besonderem Spacing verwendet, der davon ausgeht, dass jeder Buchstabe eine eigenständige mathematische Variable bezeichnet. Das führt allerdings dazu, dass aus mehreren Buchstaben bestehende Bezeichnungen typographisch falsch gesetzt werden; etwa wird $umfang$ von TeX als das Produkt von sechs Variablen interpretiert und mit Zwischenräumen gesetzt.
Abhilfe bieten die Kommandos \mathit und \mathrm, die einen "normalen" schräg- bzw. geradegestellten Zeichensatz auswählen, wobei der erste für mathematische Variablen und der zweite für Bezeichnungen mit vordefinierter Bedeutung verwendet werden sollte. Beispiel:
\[ \mathit{umfang} = \mathit{durchmesser}\cdot\pi \]
Tritt ein Name mehrfach auf, helfen neu definierte Kommandos
die Formatierung des Namens an einer Stelle zu konzentrieren und
die Lesbarkeit zu erhöhen:
\newcommand\umfang{\mathit{umfang}}
\newcommand\durchmesser{\mathit{durchmesser}}
\[ \umfang = \durchmesser\cdot\pi \]
Abstände nach Punkten: Bei Punkten nach Kleinbuchstaben nimmt TeX an, dass es sich um ein Satzende handelt und lässt einen etwas größeren Abstand. Das führt bei Abkürzungen im Satz zu falschen Wortabständen. Zur Korrektur muss statt ". " entweder ".\ " (Punkt-Backslash-Leerzeichen) oder ".~" (Punkt-Tilde) verwendet werden; die zweite Variante verhindert zusätzlich einen Zeilenumbruch nach dem Punkt.
Punkte in Auslassungen und Aufzählungen: Verwenden Sie statt "..." das Kommando "\dots", das für das richtige Spacing zwischen den Punkten sorgt. Im Mathematik-Modus können Punkte in halber Höhe zwischen Operatoren mit dem Kommando "\cdots" erzeugt werden. Beispiele:
\dots\ und sie dreht sich doch! $x_1 + x_2 + \cdots + x_n$ $f(x_1,\dots,x_n)$
Gedankenstriche: Gedankenstriche in deutschen Texten werden in LaTeX als "~-- " (Tilde-Minus-Minus-Leerzeichen) geschrieben, etwa so:
Gedankenstriche sollten~-- wenn tatsächlich notwendig~-- richtig gesetzt werden.
Die Tilde (Wellenlinie) verhindert einen Zeilenumbruch vor dem Gedankenstrich, die beiden Minuszeichen erzeugen einen einzigen Strich der richtigen Länge. In englischen Texten kann entweder der "deutsche" Gedankenstrich verwendet werden oder gemäß diverser Style Guides ein noch längerer Strich ohne Leerzeichen zu den angrenzenden Worten. Dieser noch längere Strich wird in TeX durch "---" erzeugt:
Dashes should---if really necessary---be typeset properly.
Bindestriche: Zusätzlich zu Gedankenstrichen unterscheidet (La)TeX gemäß den Regeln guter Typographie zwei Arten von Bindestrichen. Bindestriche, die die Bestandteile eines Begriffes zusammenhalten, werden durch ein einfaches Minus gesetzt:
E-Mail, Hans-Mandl-Berufsschule
Hat der Bindestrich die Bedeutung von "bis" wie bei Seiten- oder Jahresangaben, ist ein längerer Strich erforderlich, der durch zwei aufeinanderfolgende Minuszeichen erzeugt wird:
Siehe die Seiten 89--95. Der zweite Weltkrieg (1939--45) zog alle Kontinente in Mitleidenschaft.
Beachten Sie, dass echte Minuszeichen (d.h., Striche, die
tatsächlich die Differenz symbolisieren) im Mathematik-Modus
gesetzt werden müssen.
Falsch:
Sei die Differenz x-y positiv.
Richtig:
Sei die Differenz $x-y$ positiv.
Unbestimmter Artikel: Ob "a" oder "an" zu verwenden ist, entscheidet die Aussprache, nicht die Schreibung. Beispiel: es heisst "a NATO general", aber "an NGO member" oder "for an n smaller 0".
Beistriche: Im Englischen werden wesentlich weniger Beistriche als im Deutschen gesetzt, überdies gibt es nur wenige Regeln. Eine davon ist, dass vor "that" (entsprechend dem deutschen "dass") kein Beistrich gesetzt wird. Meist setzt man Beistriche nur dort, wo ein Satz andernfalls falsch oder schwer verstanden werden würde.
Kurzformen (negierter) Hilfszeitworte: Kurzformen wie "haven't", "can't"und "won't" sind zwar im informellen Sprachgebrauch (gesprochener Text, Emails, ...) zunehmend die Regel, sollten aber in "formal writing", zu dem auch wissenschaftliche Abhandlungen und technische Berichte zählen, zugunsten von "have not", "cannot", "would not" etc vermieden werden.
Gernot Salzer