DANTE e.V.

CTAN

Comprehensive TeX Archive Network

http://mirror.ctan.org
http://www.ctan.org
Suchen auf CTAN

TeX-Katalog

Alle TeX-Distributionen sind auf der DVD "TeX Collection". DANTE-Mitglieder erhalten die diese kostenlos.

TeX Live

| DVD | Netz | Bugs |

proTeXt

| DVD | Netz |

MacTeX

| DVD | Netz |

MiKTeX

| DVD | Netz |

 

Paketdokumentation und Webseitenpflege mit (niceverb.sty und) fifinddo.sty

Uwe Lück

Das nicetext-Bundel [1] versucht sich an „syntaktischem Zucker“: Schriftsatz in TeX-Qualität bei möglichst wenig TeX-artiger Auszeichnung. Das kann durch (MS) Zeichenkettenersetzung oder (auch) durch (MA) aktive Zeichen (die einige Fallunterscheidungen ausführen) erreicht werden.

Die „herrschende Lehre“ für die Dokumentation von LaTeX-Paketen ist die „dtx“-Methode, die z. B. eine spezielle Markierung des Paketcodes erfordert. makedoc.sty aus dem nicetext-Bündel dagegen setzt die gute alte Idee um, dass man Kommentarzeilen schon am Kommentarzeichen (‚%‘) erkennt!

Mit derselben Absicht verwendete Stephan Böttcher die Skriptsprache awk zur Kommentierung von lineno.sty. [2] makedoc.sty bietet stattdessen eine Skriptsprache, die wie bei docstrip.tex [3] durch die TeX-Engine selbst verarbeitet wird, zusammen mit besonderen Makros. makedoc wandelt die Paketdatei in eine Dokumentationsdatei um, indem Kommentarzeichen entfernt und Codezeilen in Listing-Umgebungen eingebettet werden. Bei dieser Gelegenheit kann auch gemäß Methode (MS) TeX-Code für typografische Feinheiten eingefügt und die MediaWiki-Gliederung umgesetzt werden.

niceverb.sty (ebenfalls in nicetext) ermöglicht weiter nach der Methode (MA) eine geradezu WYSIWYG-artige Syntaxbeschreibung für Paketmakros. Makros können "im Handumdrehen“ kommentiert werden. Vorhandene ASCII-Dokumentation kann „automatisch“ in TeX-Qualität gesetzt werden.

makedoc.sty erweitert die TeX-Skriptsprache aus fifinddo.sty zum Verarbeiten von Text-Dateien zu Text-Dateien. blog.sty aus dem morehype-Bündel setzt ebenfalls auf fifinddo auf. Im Gegensatz zu makedoc werden dabei die Makros der Quelldateien expandiert – in HTML-Tags und -Zeichen.

Der Vortrag vergleicht diese Ansätze mit denen anderer Autoren.

[1] http://ctan.org/pkg/nicetext
[2] http://ctan.org/pkg/lineno
[3] http://ctan.org/pkg/docstrip

Folien zum Vortrag.