Linux Certif

Toute la documentation sur la certification Linux LPI

Locale::Po4a::Pod.3pm

NAZWA

Locale::Po4a::Pod - Konwersja danych POD z/do plikA~Xw PO

SKA°XADNIA

     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 moduA°Xem uA°XatwiajA.Xcym tA°Xumaczenie dokumentacji w formacie POD (preferowany jA.Xzyk dokumentowania programA~Xw napisanych w Perlu) do innych jA.XzykA~Xw [uA°Xywanych przez ludzi].

STATUS MODUA°XU

MyA°XlA.X, A°Xe ten moduA°X jest stabilny jak skaA°Xa, ma tylko jeden znany bA°XA.Xd:

Mam problem z /usr/lib/perl5/Tk/MainWindow.pod (i innymi stronami, patrz niA°Xej) ktA~Xry zawiera:

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

Niestety, w wersji z po4a zostaA°Xo to rozdzielone na spacji podczas zawijania. W wyniku, oryginalna strona podrA.Xcznika zawiera

  " #n"
 
 

a mA~Xj zawiera

  "" #n""
 
 

co jest logiczne, skoro "coA°Xtam" jest przepisane jako ``coA°Xtam''

PeA°Xna lista stron majA.Xcych ten problem na moim komputerze (z 564 stron; proszA.X zauwaA°XyA.X, A°Xe zaleA°Xy 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 WEWNA.XTRZNE

Locale::Po4a::Pod, jako klasa dziedziczona z Pod::Parser, obsA°Xuguje te same interfejsy i metody. Wszystkie szczegA~XA°Xy moA°Xna znaleA°XA.X w Pod::Parser; w skrA~Xcie: najpierw trzeba utworzyA.X parser, uA°XywajA.Xc "Locale::Po4a::Pod->new()", a potem wywoA°XaA.X albo parse_from_filehandle() albo parse_from_file().

new() moA°Xe pobraA.X opcje, w postaci par klucz/wartoA°XA.X, kontrolujA.Xce zachowanie parsera. NastA.XpujA.Xce wspA~Xlne opcje sA.X rozpoznawane przez wszystkie dzieci Pod::Parser:

alt

JeA°Xli ustawione na true, wybiera alternatywny format wyjA°Xcia, miA.Xdzy innymi uA°Xywa innego stylu nagA°XA~Xwka i oznacza wpisy "=item" dwukropkiem na lewym marginesie. DomyA°XlnA.X wartoA°XciA.X jest false.

kod

JeA°Xli ustawione na true, czA.XA°Xci nie-POD pliku wejA°Xciowego bA.XdA.X doA°XA.Xczone do pliku wyjA°Xciowego. UA°Xyteczne podczas oglA.Xdania dokumentu majA.Xcego bloki POD z POD przeksztaA°Xconym, a kodem pozostawionym bez zmian.

indent

Liczba spacji wcinania zwykA°Xego tekstu i domyA°Xlne wcinanie blokA~Xw "=over". DomyA°Xlnie 4.

loose

JeA°Xli ustawione na true, po nagA°XA~Xwku "=head1" jest dodawana pusta linia. JeA°Xli ustawione na false (domyA°Xlnie), to nie jest wypisywana pusta linia po "=head1", ale jest wciA.XA°X wypisywana po "=head2". Jest to wartoA°XA.X domyA°Xlna, poniewaA°X jest to oczekiwane formatowanie stron podrA.Xcznika ekranowego. Podczas formatowania dowolnych dokumentA~Xw tekstowych, ustawienie tego na true moA°Xe wygenerowaA.X przyjemniejsze wyjA°Xcie.

quotes

Ustawia znaki cudzysA°Xowu uA°Xywane do otaczania tekstA~Xw C<>. JeA°Xeli wartoA°XciA.X jest pojedynczy znak, to jest on uA°Xywany jako lewy i prawy cudzysA°XA~Xw; jeA°Xli sA.X to dwa znaki, to pierwszy z nich jest lewym cudzysA°Xowem, a drugi - prawym; jeA°Xli sA.X cztery znaki, to pierwsze dwa sA.X lewym cudzysA°Xowem, a kolejne dwa - prawym.

MoA°Xe to takA°Xe przyjmowaA.X na specjalnA.X wartoA°XA.X "none", okreA°XlajA.XcA.X, A°Xe tekst C<> nie zostanie otoczony znakami cudzysA°Xowu.

sentence

JeA°Xli jest ustawione na true, Locale::Po4a::Pod przyjmie, A°Xe kaA°Xde zdanie koA°Xczy siA.X dwoma spacjami i postara siA.X to zachowaA.X. JeA°Xli ustawione na false, wszystkie kolejne biaA°Xe znaki w niedosA°Xownych akapitach sA.X zamieniane na jednA.X spacjA.X. DomyA°XlnA.X wartoA°XciA.X jest true.

width

Numer kolumny, wedA°Xug ktA~Xrej zawijaA.X tekst po jego prawej stronie. DomyA°Xlnie jest to 76.

ZOBACZ TAKA°XE

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

AUTORZY

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

TA°XUMACZENIE

  Robert Luberda <robert@debian.org>
 
 

PRAWA AUTORSKIE I LICENCJA

Copyright 2002 by SPI, inc.

Program jest wolnym oprogramowaniem; moA°Xna go redystrybuowaA.X i/lub modyfikowaA.X zgodnie z warunkami licencji GPL (patrz plik COPYING).