Linux Certif

Toute la documentation sur la certification Linux LPI

Locale::Po4a::Pod.3pm

NAZWA

Locale::Po4a::Pod - Konwersja danych POD z/do plikow PO

SKXADNIA

     use Locale::Po4a::Pod;
     my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
 
     # Czytanie POD ze STDIN i zapisanie do STDOUT.
     $parser->parse_from_filehandle;
 
     # Czytanie POD z plik.pod i zapisanie do plik.txt.
     $parser->parse_from_file ('plik.pod', 'plik.txt');
 
 

OPIS

Locale::Po4a::Pod jest moduXem uXatwiajXcym tXumaczenie dokumentacji w formacie POD (preferowany jXzyk dokumentowania programow napisanych w Perlu) do innych jXzykow [uXywanych przez ludzi].

STATUS MODUXU

MyXlX, Xe ten moduX jest stabilny jak skaXa, ma tylko jeden znany bXXd:

Mam problem z /usr/lib/perl5/Tk/MainWindow.pod (i innymi stronami, patrz niXej) ktory zawiera:

   CE<lt>" #n"E<gt>
 
 

Niestety, w wersji z po4a zostaXo to rozdzielone na spacji podczas zawijania. W wyniku, oryginalna strona podrXcznika zawiera

  " #n"
 
 

a moj zawiera

  "" #n""
 
 

co jest logiczne, skoro "coXtam" jest przepisane jako ``coXtam''

PeXna lista stron majXcych ten problem na moim komputerze (z 564 stron; proszX zauwaXyX, Xe zaleXy to od wyboru kolumny zawijania): /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

STRUKTURY WEWNXTRZNE

Locale::Po4a::Pod, jako klasa dziedziczona z Pod::Parser, obsXuguje te same interfejsy i metody. Wszystkie szczegoXy moXna znaleXX w Pod::Parser; w skrocie: najpierw trzeba utworzyX parser, uXywajXc "Locale::Po4a::Pod->new()", a potem wywoXaX albo parse_from_filehandle() albo parse_from_file().

new() moXe pobraX opcje, w postaci par klucz/wartoXX, kontrolujXce zachowanie parsera. NastXpujXce wspolne opcje sX rozpoznawane przez wszystkie dzieci Pod::Parser:

alt

JeXli ustawione na true, wybiera alternatywny format wyjXcia, miXdzy innymi uXywa innego stylu nagXowka i oznacza wpisy "=item" dwukropkiem na lewym marginesie. DomyXlnX wartoXciX jest false.

kod

JeXli ustawione na true, czXXci nie-POD pliku wejXciowego bXdX doXXczone do pliku wyjXciowego. UXyteczne podczas oglXdania dokumentu majXcego bloki POD z POD przeksztaXconym, a kodem pozostawionym bez zmian.

indent

Liczba spacji wcinania zwykXego tekstu i domyXlne wcinanie blokow "=over". DomyXlnie 4.

loose

JeXli ustawione na true, po nagXowku "=head1" jest dodawana pusta linia. JeXli ustawione na false (domyXlnie), to nie jest wypisywana pusta linia po "=head1", ale jest wciXX wypisywana po "=head2". Jest to wartoXX domyXlna, poniewaX jest to oczekiwane formatowanie stron podrXcznika ekranowego. Podczas formatowania dowolnych dokumentow tekstowych, ustawienie tego na true moXe wygenerowaX przyjemniejsze wyjXcie.

quotes

Ustawia znaki cudzysXowu uXywane do otaczania tekstow C<>. JeXeli wartoXciX jest pojedynczy znak, to jest on uXywany jako lewy i prawy cudzysXow; jeXli sX to dwa znaki, to pierwszy z nich jest lewym cudzysXowem, a drugi - prawym; jeXli sX cztery znaki, to pierwsze dwa sX lewym cudzysXowem, a kolejne dwa - prawym.

MoXe to takXe przyjmowaX na specjalnX wartoXX "none", okreXlajXcX, Xe tekst C<> nie zostanie otoczony znakami cudzysXowu.

sentence

JeXli jest ustawione na true, Locale::Po4a::Pod przyjmie, Xe kaXde zdanie koXczy siX dwoma spacjami i postara siX to zachowaX. JeXli ustawione na false, wszystkie kolejne biaXe znaki w niedosXownych akapitach sX zamieniane na jednX spacjX. DomyXlnX wartoXciX jest true.

width

Numer kolumny, wedXug ktorej zawijaX tekst po jego prawej stronie. DomyXlnie jest to 76.

ZOBACZ TAKXE

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

AUTORZY

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

TXUMACZENIE

  Robert Luberda <robert@debian.org>
 
 

PRAWA AUTORSKIE I LICENCJA

Copyright 2002 by SPI, inc.

Program jest wolnym oprogramowaniem; moXna go redystrybuowaX i/lub modyfikowaX zgodnie z warunkami licencji GPL (patrz plik COPYING).