Конструктор¶

process(%)

Ова функција може да уради све што је потребно да се уради са po4a документом у једном позиву. Њени аргументи морају да се упакују као хеш. АКЦИЈЕ:

new(%)

Креира нови po4a документ. Прихватају се опције (у хешу који се прослеђује као параметар):

Манипулација фајловима докумената¶

read($$$)

Додаје податке из другог улазног документа на крај постојећег низа "@{$self->{TT}{doc_in}}".

This function takes two mandatory arguments and an optional one.
* The filename to read on disk;
* The name to use as filename when building the reference in the PO file;
* The charset to use to read that file (UTF-8 by default)

This array "@{$self->{TT}{doc_in}}" holds this input document data as an array of strings with alternating meanings.
* The string $textline holding each line of the input text data.
* The string "$filename:$linenum" holding its location and called as
"reference" ("linenum" starts with 1).

Имајте на уму, молим вас, да ово још ништа не парсира. Када завршите са паковањем улазних фајлова у документ, требало би да употребите функцију parse().

write($)

Уписује преведени документ у фајл са датим именом.

This translated document data are provided by:
* "$self->docheader()" holding the header text for the plugin, and
* "@{$self->{TT}{doc_out}}" holding each line of the main translated text in the array.

Манипулација PO фајловима¶

readpo($)

Додаје садржај фајла (чије име је прослеђено као аргумент) постојећем улазном PO. Стари садржај се не одбацује.

writepo($)

Уписује издвојени PO фајл у дато име фајла.

stats()

Враћа неке статистичке податке у вези до сада одрађеног превода. Имајте не уму, молим вас, да ово није иста статистика коју исписује msgfmt --statistic. Овде је то статистика у вези скорашње употребе PO фајла, док msgfmt пријављује статус фајла. То је функција која обавија функцију Locale::Po4a::Po::stats_get function примењену на улазни PO фајл. Пример употребе:

    [normal use of the po4a document...]
    ($percent,$hit,$queries) = $document->stats();
    print "We found translations for $percent\%  ($hit from $queries) of strings.\n";
    

Манипулација додацима¶

addendum($)

Молимо погледајте po4a(7) за више информација о томе шта су додаци, и како би преводиоци требало да их пишу. Да бисте применили додатак на преведени документ, једноставно проследите име његовог фајла овој функцији и то је то ;)

У случају грешке, ова функција враћа цео број различит од нуле.

Добављање улаза, обезбеђивање излаза¶

За преузимање улаза и враћање излаза се користе четири функције. Оне су врло сличне са shift/unshift и push/pop у језику Perl.

 * Perl shift returns the first array item and drop it from the array.
 * Perl unshift prepends an item to the array as the first array item.
 * Perl pop returns the last array item and drop it from the array.
 * Perl push appends an item to the array as the last array item.

Први пар се тиче улаза, док је други у вези излаза. Да се лакше упамти: за улаз вам је од интереса прва линија, а то је управо оно што враћа shift, док за излаз желите да свој резултат додате на крај, као што то ради push.

shiftline()

Ова функција враћа прву линију која треба да се парсира у њену одговарајућу референцу (упаковано као низ) из низа "@{$self->{TT}{doc_in}}" и уклања ове прве 2 ставке низа. Референцу овде обезбеђује стринг "$filename:$linenum".

unshiftline($$)

Unshift-ује последњу shift-овану линију улазног документа и њену одговарајућу референцу назад на почетак "{$self->{TT}{doc_in}}".

pushline($)

Ради push нове линије на крај "{$self->{TT}{doc_out}}".

popline()

Ради pop последње push-оване линије са краја "{$self->{TT}{doc_out}}".

Обележавање стрингова као преводивих¶

Достављена је једна функција која обрађује текст предвиђен за превођење.

translate($$$)

Обавезни аргументи:

  $self->translate("string","ref","type",
                   'wrap' => 1);

Разне функције¶

verbose()

Враћа информацију да ли је током креирања објекта TransTractor прослеђена опција детаљног извештавања.

debug()

Враћа информацију да ли је приликом креирања објекта TransTractor била прослеђена опција детаљнијег извештавања.

get_in_charset()

Ова функција враћа скуп карактера који је наведен као мастер скуп карактера

get_out_charset()

Ова функција ће да врати скуп карактера који би требало да се користи у излазном документу (обично је корисно за замену скупа карактера детектованог у улазном документу у коме је пронађен).

Користиће излазни скуп карактера наведен у командној линији. Ако није био задат, користиће се скуп карактера улазног PO, а ако улазни PO има подразумевану вредност „CHARSET”, вратиће скуп карактера улазног документа, тако да се не обавља кодирање..