Wie Moduldokumentation nach HTML wandeln?

| Keine Kommentare | Keine TrackBacks

Bei vielen Projekten will man die Dokumentation, die in den eigenen Modulen und Skripten (hoffentlich!) haufenweise als POD vorhanden ist, nach HTML wandeln und sich so eine lokale Dokumentation erstellen.

Mit welchen Modulen / Werkzeugen erstellt Ihr Euer HTML (oder PDF oder ...)?

Ich habe gerne Pod::ProjectDocs verwendet, da das alles auf einen Rutsch erledigt. Nur das optionale Syntax Highlighting geht derzeit nicht, da Syntax::Highlight::Universal sich nicht compilieren lässt.

Nun ist mir Pod::Classdoc mit mkprojdocs aufgefallen, das zusätzlich auch noch Javadoc-ähnliche Formatierung erlaubt. Damit lassen sich dann relativ übersichtlich alle Ein/Ausgabeparameter auflisten. Bisher habe ich das gerne mit =item-Listen gemacht, aber dann wird der POD-Quelltext schnell unübersichtlich. Hierfür Javadoc zu nutzen erscheint also eine ganz brauchbare Lösung zu sein.

Es gibt ansonsten noch dutzende POD-Parser und -Konverter im CPAN; Pod::Simple mit Pod::Simple::HTMLBatch sieht evtl. auch brauchbar aus. Aber Pod::ProjectDocs bzw. Pod::Classdoc mit mkprojdocs scheint mir das einzige zu sein, dass ohne eigene Basteleien sofort funktioniert.

Update: Pod::POM::Web habe ich ganz vergessen zu erwähnen, mit dem man die Dokumentation zu allen lokal installierten Modulen im Browser nutzen kann. Eine sehr praktische Sache, aber auch nicht immer geeignet.

 

Keine TrackBacks

TrackBack-URL: http://www.perl-blog.de/mt/mt-tb.cgi/88

Keine Kommentare

Es gibt auch OODoc von Marc Overmer,
habe ich vor langer Zeit mal ausprobiert, aber da klappte nicht alles, nur weiß ich nicht mehr, wo die Probleme lagen.
Rolf

Das OODoc sieht durchaus interessant aus, aber zumindest auf den ersten und zweiten Blick scheint es mir icht nur zu umfangreich und aufwendig zu sein, sondern vor allem zu weit weg von den üblichen Perl-Standards.

Jetzt kommentieren

Aktuelle Kommentare

  • Niels Dettenbach: ...schade eigentlich, das es PyPerl nicht mehr wirklich gibt. Zwar weiter lesen
  • Alvar Freude: Kannte ich noch nicht, danke für den Hinweis; allerdings ist weiter lesen
  • Ben Sieverts: Ich vermisse noch folgendes Buch auf der List: Effective Perl weiter lesen
  • Alex: Ich schlage einfach mal ganz unverschämt bei diesem Beitrag die weiter lesen
  • Marcel: Oke, danke für den Tipp. Schade natürlich. Wird euer Buch weiter lesen
  • Alvar: Nein, leider ist das noch nicht fertig. :-( Es gibt weiter lesen
  • Marcel : Hallo! gibt es dein Buch zu Perl6 schon? Wo kann weiter lesen
  • air max 2009: Nimm ein Paradigma deiner Wahl (z.b. MVC) und lerne Applikationscode weiter lesen
  • vTasker: Was ist das denn für ein MIST? Der Artikel ist weiter lesen
  • Virenschutz-Test: Das ist ja lustig hihi. Der Admin ist wohl nicht weiter lesen

Über diese Seite

Diese Seite enthält einen einen einzelnen Eintrag von Alvar Freude vom 27.03.08 12:15.

PostgreSQL: Speicherplatz einer Tabelle ist der vorherige Eintrag in diesem Blog.

brian d foy (nicht nur) in Stuttgart ist der nächste Eintrag in diesem Blog.

Aktuelle Einträge finden Sie auf der Startseite, alle Einträge in den Archiven.