ÜBERSICHT

use Locale::Po4a::Pod;
my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
# POD von STDIN lesen und nach STDOUT schreiben
$parser->parse_from_filehandle;
# POD aus Datei.pod lesen und nach Datei.txt schreiben
$parser->parse_from_file ('Datei.pod', 'Datei.txt');

BESCHREIBUNG

Locale::Po4a::Pod ist ein Modul, um bei der Übersetzung von Dokumentation in dem POD-Format (dem für Perl-Dokumentierung bevorzugten Format) in andere [natürliche] Sprachen zu helfen.

STATUS DIESES MODULS

Ich denke, dieses Modul ist stabil wie ein Felsen und es gibt nur einen bekannten Fehler mit /usr/lib/perl5/Tk/MainWindow.pod (und einigen anderen Seiten, siehe unten), in der Folgendes steht:

  C<" #n">

Durch fehlendes Glück wurde in der Po4a-Version dies beim Leerzeichen umgebrochen. Dadurch enthielt die Ursprungsversion des Handbuchs

 " #n"

und meine enthielt

 "" #n""

was logisch ist, da C<foobar> in ``foobar'' umgeschrieben wird.

Vollständige Liste von Seiten, die auf meiner Maschine dieses Problem haben (von 564 Seiten, beachten Sie, dass dies von der gewählten Umbruchspalte abhängt): /usr/lib/perl5/Tk/MainWindow.pod /usr/share/perl/5.8.0/overload.pod /usr/share/perl/5.8.0/pod/perlapi.pod /usr/share/perl/5.8.0/pod/perldelta.pod /usr/share/perl/5.8.0/pod/perlfaq5.pod /usr/share/perl/5.8.0/pod/perlpod.pod /usr/share/perl/5.8.0/pod/perlre.pod /usr/share/perl/5.8.0/pod/perlretut.pod

INTERNA

Als abgeleitete Klasse von Pod::Parser unterstützt Locale::Po4a::Pod die gleichen Methoden und Schnittstellen. Lesen Sie Pod::Parser für alle Details; in Kürze, ein neuer Parser wird mit "Locale::Po4a::Pod->new()" erstellt und dann wird entweder parse_from_filehandle() oder parse_from_file() aufgerufen.

new() akzeptiert Optionen in der Form von Schlüssel/Wert-Paaren, die das Verhalten des Parsers steuern. Die von allen Pod::Parser-Kindern erkannten Optionen sind:

alt

Falls dies auf einen wahren Wert gesetzt wird, wird unter anderem ein alternatives Ausgabeformat ausgewählt, ein anderer Stil für Überschriften gewählt und =item-Einträge mit einem Doppelpunkt in der linken Spalte markiert. Standardmäßig »false«.

code

Falls dies auf einen wahren Wert gesetzt wird, wird der nicht POD-Teil der Eingabedatei in der Ausgabe eingeschlossen. Nützlich, um Code, der mit POD-Blöcken dokumentiert ist, mit dem dargestellten POD und dem inktakt verbliebenen Code anzuschauen.

indent

Die Anzahl der Leerzeichen, um regulären Text einzurücken sowie die Vorgabe für die Einrückung für =over-Blöcke. Standardmäßig 4.

loose

Falls dies auf einen wahren Wert gesetzt wird, wird eine Leerzeile nach einer =head-Zeile ausgegeben. Falls auf den Standardwert »false« gesetzt, wird keine Leerzeile nach =head1 ausgegeben, obwohl nach =head2 weiterhin eine ausgegeben wird. Dies ist die Vorgabe, da dies der bei Handbuchseiten erwarteten Formatierung entspricht; falls Sie beliebige Texte formatieren, könnte das Setzen auf »true« zu einer schöneren Ausgabe führen.

quotes

Setzt die Anführungszeichen, die C<>-Text umfassen sollen. Falls der Wert ein einzelnes Zeichen ist, wird dieses sowohl als linkes als auch als rechtes Anführungszeichen verwandt. Falls es sich um zwei Zeichen handelt, wird das erste als öffnendes Anführungszeichen (links) und das zweite als schließendes Anführungszeichen (rechts) verwandt. Falls es sich um vier Zeichen handelt, werden die ersten zwei als öffnende und die anderen zwei als schließende Anführungszeichen verwandt.

Dies kann auch auf den speziellen Wert none gesetzt werden. In diesem Fall werden um C<>-Text keine Anführungszeichen gesetzt.

sentence

Falls dies auf einen wahren Wert gesetzt wird, wird Locale::Po4a::Pod annehmen, dass jeder Satz mit zwei Leerzeichen endet und versuchen, diese Leerzeichen zu erhalten. Falls auf »false« gesetzt, werden alle direkt aufeinander folgenden Leerzeichen in Absätzen, die nicht direkt ausgegeben werden, in ein einzelnes Leerzeichen zusammengefasst. Standardmäßig »true«.

width

Die Spalte, an der Text auf der rechten Seite umgebrochen werden soll. Standardmäßig 76.

AUTOREN

 Denis Barbier <[email protected]>
 Martin Quinson (mquinson#debian.org)

URHEBERRECHT UND LIZENZ

Copyright 2002 SPI, Inc.

Dieses Programm ist freie Software; Sie können es unter den Bedingungen der GPL (siehe die Datei COPYING) vertreiben und/oder verändern.