Beitrag von Andreas Jurenda (32 Beiträge) am Dienstag, 29.April.2003, 10:27.
POD für ALLE
Hallo, wieder ein Tool fertiggestellt.
Hat ja lange genug gedauert (seit September wünsche ich es mir, aber es war gar nicht so leicht!).
Was ist POD?
POD steht für Plain Old Document und ermöglicht es die Programmdokumentation direkt in das Perl-Script/baseportal-Template einzufügen.
Alles notwendige findet Ihr unter http://baseportal.de/baseportal/tools/pod und den dortigen weiterführenden Links unter SEE ALSO.
Eine entsprechende Menge an Beispielen findet Ihr in der Bib.
@CB: JA, DAS IST DEFINITIF PERL-POD und basiert direkt auf Pod::Html Version 1.04 aus CPAN.
Ich hab' da eine Menge an Fehlern rausholen müssen. Auch waren einige Erweiterungen notwendig, um ein vergleichbares Ergebnis wie in http://www.perldoc.com zu erhalten.
Ich hab auch schon mit Pod::Tree:Html gearbeitet. Dieses ist zwar die bisher beste Umsetzung von pod2html(), jedoch einfach zu umfangreich (rund 300kB Quellcode) und deshalb etwas zu langsam.
@ALLE: Für dieses Projekt mußte ich einige Hürden und Klippen umschiffen, damit das beliebige (auf mehrfache) Einbinden eines Templates möglich ist, ohne daß sich dabei Probleme ergeben :-(
Lange habe ich auch herumgetüftelt um festzustellen, ob das Template jetzt gerade als Include oder als normales Template aufgerufen wird (siehe exampel4).
Herzliche Grüße vun viel Spaß von Andreas Jurenda :-})
Antworten
Beitrag von Sander (8133 Beiträge) am Dienstag, 29.April.2003, 10:43.
Re: POD für ALLE
hallo andreas...
das ist ganz klasse. ich hab noch ein paar debuginfos in deinem quelltext gefunden <!-- <font color=red><b>warn:</b> </font>: /tools/pods/pod.pod: cannot resolve L<perlmodstyle> in paragraph 49.
hast du übersehen? noch ein fehler drin?
Grüße
Sander
Antworten
Beitrag von Andreas (396 Beiträge) am Dienstag, 29.April.2003, 11:10.
Re: POD für ALLE
Na ja, die sind eigentlich immer drinnen.
Durch 'warnings' => [0|1] wird lediglich das Auskommentieren ein- bzw. ausgeschaltet.
Es ist jedoch ein Leichtes anstelle des Auskommentierens sie gar nicht einzufügen.
Wie siehst Du das?
Grüße von Andreas :-})
Antworten
Beitrag von Andreas (396 Beiträge) am Dienstag, 29.April.2003, 11:48.
Re: POD für ALLE - @Sander
OK, warnings werden bei 'warnings' => 0 überhaupt nicht mehr angezeigt (auch nicht auskommentiert).
Grüße Andreas :-})
Antworten
Beitrag von Christoph Bergmann (8110 Beiträge) am Dienstag, 29.April.2003, 13:19.
Re: POD für ALLE
Ja, so müssen Dokus aussehen ;-)
Ein Beispiel-File wär nich schlecht, z.b. das /tools/pod selbst (oder hab
ich was übersehen?). Und ne kurze Einführung in Deutsche für die Nich-so-gut-English-Speaker ,-)))
Antworten
Beitrag von Andreas (396 Beiträge) am Dienstag, 29.April.2003, 18:50.
Re: POD für ALLE
Wirf mal einen Blick in die Bib
Dort sind rund 8 Beispiele.
Solte hoffe ich reichen ;-)
Grüße Andreas :-})
Antworten
Beitrag von Christoph Bergmann (8110 Beiträge) am Mittwoch, 30.April.2003, 16:20.
Re: POD für ALLE
Antworten