Sie sind hier

Die Einleitung introduction.tex

Bild von Markus Kohm

Die Datei introduction.tex enthält nun das erste Kapitel des Beispiels. Diese Datei verwendet wiederum Unix/Linux-Zeilenenden (nur LF), wie sie für Pakete und Vorlagen gebräuchlich sind.

introduction.tex:

%% introduction.tex
%%

Diese Datei hat nun auch wieder eine Art Kopfkommentar, in dem zumindest der Original-Dateiname angegeben ist. Wirklich ausreichend ist das aber nicht.
Im Kopf einer Vorlagendatei oder einer anderen Datei, die man weitergibt, sollte neben dem Original-Dateinamen auch der Urheber, die Lizenz und idealer Weise der Zweck der Datei angegeben sein.

introduction.tex:

%% ==============================
\chapter{Introduction}
\label{ch:Introduction}
%% ==============================
 
\cite{becker2008a}
\dots

In dieser Datei sind auch erneut Markierungen zu finden. Leider haben diese wiederum eine andere Form als in den bisherigen Dateien. Außerdem erscheint es mir unlogisch nur die Überschrift und das Label zum Kapitel regelrecht einzurahmen, nicht jedoch den Inhalt des Kapitels. Ich könnte mir viel eher vorstellen, dass man zwischen dem gesamten Kapitelkopf einschließlich einer Einleitung und einem nachfolgenden Abschnitt eine gewisse Hervorhebung durchführt.
Kommentare, die der Hervorhebung oder Strukturierung des Quellcodes dienen, sollten sich an der Struktur des Dokuments orientieren.

Sehr schön ist, dass das Kapitel mit einem Label versehen wurde. Hier wurde auch der Konvention gefolgt, Labelnamen an die Dokumentstruktur anzulehnen, etwa Label auf Kapitel mit »ch:« oder »cha:«, auf Abschnitte mit »sec:« und auf Abbildungen mit »fig:« zu beginnen.
Labelnamen sollten wie im Beispiel gezeigt, der Struktur des Dokuments folgen.

Ein Literaturverweis wurde an dieser Stelle ebenfalls bereits vorgeführt. Dagegen ist nichts einzuwenden. Allerdings fehlt mir hier ein Kommentar, der darauf hinweist. So wirkt der Verweis doch etwas sehr verloren.

Für ein Beispiel sehr gut finde ich, dass das Beispiel quasi nebenbei in die empfohlene Gliederung für Dokumente der Zielgruppe einführt. Das erste Kapitel einer wissenschaftlichen Arbeit der genannten Art sollte immer eine Art Einführung oder Motivation der Arbeit sein.

Comments for "Die Einleitung introduction.tex" abonnieren