Re: Wo finde ich Dokumente im pod-Format auf netfrag.org?
[nfo.faq.users]
Subject: Re: Wo finde ich Dokumente im pod-Format auf netfrag.org?
From: joko (at) netfrag.org (joko)
Newsgroups: nfo.faq.users
Organization: not organized
Date: Jan 28 2003 11:42:49
References: 1 2 3
Hey bareface,
pod ist das Perl-eigene Dokumentationsformat - "Plain Old Documentation".
--PlainOldDocumentation <-- YakkaRendererNeededHere ;-)
Es ist recht einfach aber oft ausreichend strukturiert und kann sowohl
direkt im Sourcecode als auch in externen ".pod"-Dateien verwendet werden.
pod-Bereiche werden beispielsweise mit '=pod' eingeleitet und mit '=cut'
abgeschlossen. Header-Deklarationen funktionieren mit '=header1',
'=header2', usw. Ausserdem kann man mit '=over4' eine Listeniteration
beginnen (um vier Zeichen eingerückt), innerhalb dieser mit '=item' seine
Listeneinträge füllen, um wieder mit '=back' zurück zum "normalen scope"
zu gelangen.
Als populäre Umwandler fungieren 'pod2man', 'pod2text' und 'pod2html'.
(letzteres wird v.a. bei uns hier in Zusammenhang mit Perl immer öfter
verwendet)
--joko
------------------------------------------------------------------------------
siehe auch -->
------------------------------------------------------------------------------
podlators (Russ Allbery):
http://search.cpan.org/author/RRA/podlators-1.25/
Pod::Man - Convert POD data to formatted *roff input
http://search.cpan.org/author/RRA/podlators-1.25/lib/Pod/Man.pm
Pod::Text - Convert POD data to formatted ASCII text
http://search.cpan.org/author/RRA/podlators-1.25/lib/Pod/Text.pm
Perl PODS: http://www.perldoc.com/perl5.8.0/pod.html
perlpod - the Plain Old Documentation format
http://www.perldoc.com/perl5.8.0/pod/perlpod.html
perlpodspec - Plain Old Documentation: format specification and notes
http://www.perldoc.com/perl5.8.0/pod/perlpodspec.html
------------------------------------------------------------------------------