Locale::Po4a::Pod

ИМЕ

Locale::Po4a::Pod - двосмерна конверзија POD података и PO фајлова

СИНОПСИС

    use Locale::Po4a::Pod;
    my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
    # Чита POD са STDIN и уписује на STDOUT.
    $parser->parse_from_filehandle;
    # Чита POD из фајл.pod и уписује у фајл.txt.
    $parser->parse_from_file ('фајл.pod', 'фајл.txt');

ОПИС

Locale::Po4a::Pod је модул који помаже превођење документације у POD формату (препоручени језик за документовање Perl кода) на друге [људске] језике.

СТАТУС ОВОГ МОДУЛА

Мислим да је овај модул чврст као стена, и постоји само један познати баг са /usr/lib/perl5/Tk/MainWindow.pod (и неким другим страницама, погледајте ниже) које садрже:

  C<" #n">

Нема среће, у po4a верзији, ово је било подељено обавијањем на размаку. Као резултат, у оригиналној верзији, man страница садржи

 " #n"

а моја садржи

 "" #n""

што је и логично јер се C<foobar> поново исписује као "foobar".

Комплетна листа страница на мојој машини које имају овај проблем (од 564 страница; приметите да зависи од изабране колоне обавијања): /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

ДЕТАЉИ ИНТЕРНОГ ФУНКЦИОНИСАЊА

Као класа изведена из Pod::Parser, Locale::Po4a::Pod подржава исте методе и интерфејсе. Погледајте Pod::Parser за све детаље; укратко, креира се нови парсер са "Locale::Po4a::Pod->new()" и затим се позива или parse_from_filehandle() или parse_from_file().

new() може да прихвати опције у облику парова кључ/вредност које контролишу понашање парсера. Препознају се опције заједничке за све класе изведене из Pod::Parser:

alt: Ако је постављено на истиниту вредност, одабира алтернативни излазни формат који, између осталог, користи другачији стил наслова и обележава =item ставке са две тачке на левој маргини. Подразумевана вредност је нетачно.

code: Ако је постављено на истиниту вредност не-POD делови улазног фајла ће бити укључени у излаз. Корисно је да се види код који документују POD блокови тако да је POD обрађен, а код остављен недирнут.

indent: Број размака којим се увлачи обичан текст, и подразумевано увлачење за =over блокове. Подразумевана вредност је 4.

loose: Ако се постави на истиниту вредност, након =head1 наслова се штампа празна линија. Ако се постави на нетачну вредност (што је подразумевано), након =head1 се не штампа празна линија, мада се једна и даље штампа након =head2. Ово је подразумевано јер је то очекивано форматирање за странице упутства; ако форматирате документе са произвољним текстом, постављањем ове опције на истиниту вредност можете да добијете лепши испис.

quotes: Поставља знаке навода који се користе за уоквиравање C<> текста. Ако је вредност један карактер, он се користи и за леви и за десни знак навода; ако су два карактера, први се користи као леви знак навода, а други као десни; а ако је четири карактера, прва два се користе као леви знак навода, а друга два као десни знак навода. Ово такође може да се постави на специјалну вредност none, и у том случају се око C<> текста не постављају знаци навода.

sentence: Ако се постави на истиниту вредност, Locale::Po4a::Pod ће сматрати да се свака реченица завршава са два размака, и покушаће да задржи такво раздвајање. Ако се постави на неистиниту вредност, сви накнадни празни карактери у пасусима који нису обележени као дословни се сабијају у један знак размака. Подразумевано је истинита вредност.

width: Колона на којој се врши обавијање текста на десној страни. Подразумевано је 76.

ПОГЛЕДАЈТЕ ТАКОЂЕ

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

АУТОРИ

 Дени Барбије <[email protected]>
 Мартин Квинсон (mquinson#debian.org)

ПРАВА УМНОЖАВАЊА И ЛИЦЕНЦА

Овај програм је слободан софтвер; можете да га редистрибуирате и/или мењате под условима GPL (погледајте фајл COPYING).

2023-01-03

Po4a