16.11.2012 Aufrufe

floppy-isdn4linux Version 3.6.2 - Fli4l

floppy-isdn4linux Version 3.6.2 - Fli4l

floppy-isdn4linux Version 3.6.2 - Fli4l

MEHR ANZEIGEN
WENIGER ANZEIGEN

Sie wollen auch ein ePaper? Erhöhen Sie die Reichweite Ihrer Titel.

YUMPU macht aus Druck-PDFs automatisch weboptimierte ePaper, die Google liebt.

• die Module liegen woanders<br />

8. Entwickler-Dokumentation<br />

Diese Unterschiede werden zum großen Teil durch mkfli4l automatisch behandelt. Um die<br />

zur Verfügung stehenden Module zu beschreiben, kann man zum einen die zur Prüfung verwendeten<br />

checks in Abhängigkit von der <strong>Version</strong> erweitern (bedingte reguläre Ausdrücke<br />

(Seite 310)) und zum anderen erlaubt mkfli4l versionsabhängige opt/_2_4.txt und<br />

opt/_2_6.txt Dateien, die je nach <strong>Version</strong> verschiedene Dateien ins Archiv aufnehmen.<br />

8.5.9. Dokumentation<br />

Die Dokumentation wird in den Dateien<br />

• doc/deutsch/opt/.txt<br />

• doc/deutsch/opt/.html<br />

• doc/english/opt/.txt<br />

• doc/english/opt/.html<br />

abgelegt. Die HTML-Dateien können auch aufgeteilt werden, d.h. für jedes enthaltene OPT<br />

eine. Dann muss trotzdem eine .html angelegt werden, die auf die anderen Dateien<br />

verweist (siehe Paket HD). Änderungen sollten folgenden Dateien dokumentiert werden:<br />

• doc/deutsch/opt/changes/-.txt<br />

• doc/english/opt/changes/-.txt<br />

Die gesamte Text-Dokumentation darf keine Tabs enthalten und muß nach spätestens 79<br />

Zeichen einen harten Zeilenumbruch haben. Die stellt sicher, daß die Dokumentation auch mit<br />

einem Editor ohne automatischen Zeilen- umbruch richtig gelesen werden kann.<br />

Wer mag kann auch eine Dokumentation im Tex-Format erstellen und daraus dann Text,<br />

html, Postscript und PDF-<strong>Version</strong>en erzeugen. Als Beispiel kann die Dokumentation von fli4l<br />

dienen. Einen Rahmen für die Dokumentation und die minimal benötigten L ATEX-Macros kann<br />

man im Template-Paket finden. Eine kurze Beschreibung ist in den folgenden Unterabschnitten<br />

zu finden.<br />

Voraussetzungen für die Erstellung einer L ATEX-Dokumentation<br />

Zum Erstellen der Doku aus den L ATEX-Sourcen gibt es folgende Anforderungen an die Umgebung:<br />

• Linux/Unix-Umgebung: Zur einfachen Erzeugung gibt es ein Makefile, mit dem alle weiteren<br />

Aufrufe automatisiert sind (Cygwin müsste auch tun, ist aber imho noch nicht<br />

getestet)<br />

• installiertes latex2html für die HTML-<strong>Version</strong><br />

• Installiertes L ATEX(tetex unter Unix getest) mit pdftex und folgenden Paketen:<br />

322

Hurra! Ihre Datei wurde hochgeladen und ist bereit für die Veröffentlichung.

Erfolgreich gespeichert!

Leider ist etwas schief gelaufen!