Prty::Pod - POD-Generator
Prty::Hash
Ein Objekt der Klasse repräsentiert einen POD-Generator. Die Methoden der Klasse erzeugen die Konstrukte, aus denen ein POD-Dokument aufgebaut ist.
Einrücktiefe bei Code-Abschnitten und Listen.
$pg = $class->new(@keyVal);
Instanziiere einen POD-Generator und liefere eine Referenz auf dieses Objekt zurück.
Generiere POD mit Einrückung 2:
$pg = Prty::Pod->new( indentation=>2, );
Anmerkung: Die Methoden ergänzen den generierten POD-Code um eine Leerzeile am Ende, so dass das nächste Konstrukt direkt angefügt werden kann. Diese Leezeile ist in den Beispielen nicht wiedergegeben.
$pod = $pg->encoding($encoding);
Erzeuge eine Deklaration des Encodings $encoding und liefere den resultierenden POD-Code zurück.
$pg->encoding('utf-8');
erzeugt
=encoding utf-8
$pod = $pg->section($level,$title,$body);
Erzeuge einen Abschnitt der Tiefe $level mit dem Titel $title und dem Abschnitts-Körper $body und liefere den resultierenden POD-Code zurück.
$pg->section(1,'Test',"Dies ist\nein Test.");
=head1 Test Dies ist ein Test.
$pod = $pg->code($text);
Erzeuge einen Code-Abschnitt mit Text $text und liefere den resultierenden POD-Code zurück.
$pg->code("sub f {\n return 1;\n}");
$n Leerzeichen ---- sub f { return 1; }
Der Code ist um $n Leerzeichen (den Wert des Objekt-Attributs "indentation") eingerückt.
$pod = $pg->bulletList(\@items);
Erzeuge eine Punkte-Liste mit den Elementen @items und liefere den resultierenden POD-Code zurück.
$pg->bulletList(['Eins','Zwei']);
=over 4 =item * Eins =item * Zwei =back
$pod = $pg->orderedList(\@items);
Erzeuge eine Aufzählungs-Liste mit den Elementen @items und liefere den resultierenden POD-Code zurück.
$pg->orderedList(['Eins','Zwei']);
=over 4 =item 1. Eins =item 2. Zwei =back
$pod = $pg->definitionList(\@items);
Erzeuge eine Definitions-Liste mit den Elementen @items und liefere den resultierenden POD-Code zurück.
Die Aufrufe
$pg->definitionList([A=>'Eins',B=>'Zwei']);
oder
$pg->definitionList([['A','Eins'],['B','Zwei']]);
=over 4 =item A Eins =item B Zwei =back
$pod = $pg->cut;
Erzeuge die Markierung, die einen POD-Abschnitt beendet, wenn danach Perl-Code folgen soll.
$pg->cut;
=cut
$str = $this->fmt($type,$text);
Erzeuge Inline-Segment vom Typ $type (B, I, C usw.) und liefere den resultierenden POD-Code dieses zurück.
Die Methode sorgt dafür, dass das Segment korrekt generiert wird, wenn in $text die Zeichen '<' oder '>' vorkommen.
Nomal:
$pg->fmt('C','$x'); => C<$x>
Eingebettet >:
$pg->fmt('C','$class->new()'); => C<< $class->new() >>
2x Eingebettet >:
$pg->fmt('C','$x >> $y'); => C<<< $x >> $y >>>
1.07
Frank Seitz, http://fseitz.de/
Copyright (C) 2016 Frank Seitz
This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Prty, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Prty
CPAN shell
perl -MCPAN -e shell install Prty
For more information on module installation, please visit the detailed CPAN module installation guide.