NAAM

Locale::Po4a::Pod - POD-data van/naar PO-bestanden converteren

OVERZICHT

    use Locale::Po4a::Pod;
    my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
    # POD lezen uit STDIN en schrijven naar STDOUT.
    $parser->parse_from_filehandle;
    # POD lezen uit bestand.pod en schrijven naar bestand.txt.
    $parser->parse_from_file ('bestand.pod', 'bestand.txt');

BESCHRIJVING

Locale::Po4a::Pod is een module ter ondersteuning van de vertaling van documentatie in de POD-indeling (de voorkeurtaal bij het documenteren van Perl) naar andere [menselijke] talen.

STATUS VAN DEZE MODULE

Ik denk dat deze module extreem stabiel is, en er is enkel één bekende bug met /usr/lib/perl5/Tk/MainWindow.pod (en enkele andere pagina's, zie hieronder), welke het volgende bevat:

  C<" #n">

Bij gebrek aan geluk werd dit in de po4a-versie gesplitst op de spatie. Als gevolg daarvan bevat de man-pagna in de originele versie

 " #n"

en bevat mijn versie

 "" #n""

hetgeen logisch is, want C<foobar> wordt geconverteerd als "foobar".

Volledige lijst van de pagina's met dit probleem op mijn computer (van de 564 pagina's; merk op dat dit afhankelijk is van de gekozen kolom voor regelafbreking): /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

BINNENWERK

Als een afgeleide klasse van Pod::Parser, ondersteunt Locale::Po4a::Pod dezelfde methodes en interfaces. Zie Pod::Parser voor alle details; in het kort: men creëert een nieuwe ontleder met "Locale::Po4a::Pod->new()" en aanroept daarna ofwel parse_from_filehandle() of parse_from_file().

Met new() kunnen opties gebruikt worden in de vorm van paren van sleutel/waarde. Zij sturen het gedrag van de ontleder. De gemeenschappelijke mogelijke opties voor alle dochters van Pod::Parser zijn:

alt

Indien dit ingesteld staat op de waarde true (waar), wordt een andere indeling voor de uitvoer gebruikt, welke onder andere een andere header-stijl gebruikt en =item-elementen markeert met een dubbelepunt in de linkermarge. Staat standaard ingesteld op false (onwaar).

code

Indien dit ingesteld staat op de waarde true (waar), zullen de niet-POD onderdelen van de invoer opgenomen worden in de uitvoer. Handig voor het bekijken van code gedocumenteerd met POD-blokken, waarbij de POD weergegeven en de code intact gelaten wordt.

indent

Het aantal spaties dat gebruikt wordt voor het laten inspringen van gewone tekst, en de standaard insprongwaarde voor =over-blokken. Is standaard 4.

loose

Indien dit ingesteld staat op de waarde true (waar), zal een lege regel afgedrukt worden na een =head1-kop. Indien dit ingesteld staat op de warde false (onwaar) (de standaardinstelling), wordt geen lege regel afgedrukt na =head1, hoewel er wel nog een lege regel afgedrukt wordt na =head2. Dit is de standaardinstelling, omdat het de gebruikelijke indeling is van man-pagina's; indien u arbitraire tekstdocumenten opmaakt, zal dit instellen op de waarde true, leiden tot een aangenamer resultaat.

quotes

Stelt in welke aanhalingstekens gebruikt moeten worden rond C<> tekst. Indien de waarde bestaat uit één enkel letterteken, dan wordt dit zowel voor het linker- als voor het rechteraanhalingsteken gebruikt. Indien de waarde bestaat uit twee lettertekens, dan wordt het eerste letterteken gebruikt als het linkeraanhalingsteken en het tweede als het rechteraanhalingsteken, en indien de waarde vier lettertekens lang is, worden de eerste twee gebruikt als linkeraanhalingsteken en de laatste twee als rechteraanhalingsteken.

Dit kan ook ingesteld worden op de speciale waarde none, en in dat geval worden geen aanhalingstekens geplaatst rond C<> tekst.

sentence

Indien dit ingesteld staat op de waarde true (waar), zal Locale::Po4a::Pod aannemen dat elke zin eindigt met twee spaties en zal het deze spatiëring proberen te bewaren. Indien dit ingesteld wordt op de waarde false (onwaar), zal alle opeenvolgende witruimte in niet-letterlijke alinea's gecomprimeerd worden tot één enkele spatie. Standaard is true.

width

De kolom waarop tekst rechts moet worden afgebroken. Staat standaard op 76.

ZIE OOK

Pod::Parser, Locale::Po4a::Man(3pm), Locale::Po4a::TransTractor(3pm), po4a(7)

AUTEURS

 Denis Barbier <barbier@linuxfr.org>
 Martin Quinson (mquinson#debian.org)

COPYRIGHT EN LICENTIE

Copyright © 2002 SPI, Inc.

Dit programma is vrije software; u kunt het verder verspreiden en/of aanpassen onder de bepalingen van de GPL (zie het bestand COPYING).