HowTo_Manual

Wie die Anleitung zu KOMA-Script-Klassen und -Paketen zu finden ist

Für Anwender veralteter KOMA-Script-Versionen sei darauf hingewiesen, dass bis Version 3.36 der Dateiname der deutschen KOMA-Script-Anleitung scrguide.pdf und der englischen KOMA-Script-Anleitung scrguien.pdf lautete. In nachfolgender Erklärungen sind ggf. entsprechende Ersetzungen vorzunehmen.

Zu den Hauptbestandteilen von KOMA-Script gibt es eine freie KOMA-Script-Anleitung und ein bei Lehmanns Media erschienenes KOMA-Script-Buch. Bereits in der freien KOMA-Script-Anleitung ist die Funktion der KOMA-Script-Klassen und aller offiziellen KOMA-Script-Anwenderpakete beschrieben. Diese freie Anleitung ist als scrguide-de.pdf in Deutscher Sprache und als scrguide-en.pdf in Englisch verfügbar und fester Bestandteil jeder legalen KOMA-Script-Verteilung. Beide Fassungen sind für die Verwendung am Monitor gedacht und tragen dem bezüglich Seitenformat und Randeinstellungen Rechnung. Der Umbruch ist nicht optimiert. Das KOMA-Script-Buch ist über den Buchhandel und für Mitglieder über DANTE e. V. zu erhalten.Im Gegensatz zu der freien Anleitung ist das Buch bisher nur auf Deutsch erschienen. Es enthält gegenüber der Anleitung einige inhaltliche Erweiterungen und ist natürlich im Umbruch optimiert.

Generell werden die aktuellen TeX-Distributionen, MiKTeX und TeX Live (und damit auch MacTeX) mit einem Programm ausgeliefert, das unter dem Namen texdoc angeprochen werden kann. Dieses Programm ist dazu gedacht, die Anleitungen zu den installierten Klassen und Paketen anzuzeigen. Unter MiKTeX handelt es sich dabei in Wirklichkeit um das Programm mthelp, das zur Vereinheitlichung zusätzlich unter dem Namen texdoc verfügbar ist.

Das Programm texdoc erwartet min. einen Parameter, der angibt, welches Dokument man sucht. Hier gibt man am einfachsten den Paketnamen an.

Um das Programm unter Windows zu starten drückt man einfach die Tastenkombination [WINDOWS]+[R]. Es öffnet sich ein Dialog, in dem man nun den Programmnamen gefolgt vom Parameter eingibt und mit der Eingabetaste oder dem [OK] Knopf bestätigt.

Um das Programm unter KDE oder Gnome zu starten drückt man einfach die Tastenkombination [ALT]+[F2]. Es öffnet sich ein Dialog, in dem man nun den Programmnamen gefolgt vom Parameter eingibt und mit der Taste [RETURN] oder [ENTER] bestätigt.

Wie bei anderen Linux-Desktops oder Mac OSX ein Konsole-Programm gestartet werden kann, ist der Anleitung zum jeweiligen System bzw. Desktop zu entnehmen.

In einigen Fällen wird texdoc weder eine DVI-Datei noch eine PDF-Datei, sondern nur eine einfache Textdatei als Anleitung finden. Startet man texdoc wie oben angegeben, wird dann leider meist gar nichts angezeigt, weil für die Textanzeige meist ein Terminal notwendig ist. In diesem Fall sollte eine Terminal geöffnet werden (bei KDE beispielsweise konsole. bei Gnome gnome-terminal). Darin gibt man dann direkt den Aufruf für texdoc ein. Der Start des Terminals kann übrigens analog zum Start von texdoc erfolgen. Die meisten grafischen Desktops bieten dafür aber auch Menüs oder Tastenkombinationen.

Für die die Anleitung zu scrlayer-fancyhdr wäre beispielsweise

texdoc scrlayer-fancyhdr

einzugeben. Die Anleitung zu texdoc selbst, in der weitere Möglichkeiten des Programms genannt werden, ist zumindest bei TeX Live per

texdoc texdoc

zu erreichen. Die Anleitung zu mthelp findet man in der MiKTeX Dokumentation.

Die deutsche KOMA-Script-Anleitung erhält man übrigens ggf. über den Umweg einer HTML-Vorschaltseite beispielsweise bei der Suche nach der Anleitung für eine beliebige KOMA-Script-Klasse. Mit

texdoc scrguide-de

erhält man sie dagegen auf direktem Weg.

Bitte beachte auch die Anleitung zur jeweils verwendeten TeX-Distribution. Links zu den Distributionen und damit auch zu deren Anleitungen sind oben zu finden. Teilweise sind auch diese per texdoc selbst erreichbar.

Die KOMA-Script-Anleitung der offiziellen aktuellen KOMA-Script-Version ist natürlich auch auf CTAN zu finden. Entsprechendes gilt natürlich auch für andere LaTeX-Pakete.