Constructor¶

process(%)

Deze functie kan in één aanroep alles doen wat u moet doen met een po4a-document. De argumenten moeten als een hash worden verpakt. ACTIES:

new(%)

Een nieuw po4a document creëren. Mogelijke opties (in de hash die als parameter meegegeven wordt):

Documentbestanden behandelen¶

read($$$)

Gegevens van nog een ander invoerdocument toevoegen aan het einde van de bestaande array "@{$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).

Merk op dat dit niets ontleedt. U moet de functie parse() gebruiken wanneer u klaar bent met het inladen van invoerbestanden in het document.

write($)

Het vertaalde document schrijven naar het bestand met de opgegeven naam.

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-bestanden manipuleren¶

readpo($)

De inhoud van een bestand (waarvan de naam als argument opgegeven werd) toevoegen aan het bestaande invoerPO-bestand. De oude inhoud wordt niet verwijderd.

writepo($)

Het geëxtraheerde PO-bestand naar het bestand schrijven waarvan de naam opgegeven werd.

stats()

Geeft bepaalde statistieken weer over de tot nu toe gemaakte vertaling. Merk op dat het niet dezelfde statistieken zijn als die welke door msgfmt --statistic getoond worden. Hier gaat het om statistieken over het recente gebruik van het PO-bestand, terwijl msgfmt rapporteert over de toestand van het bestand. Het is een omhulsel voor de functie Locale::Po4a::Po::stats_get, toegepast op het invoerPO-bestand. Een gebruiksvoorbeeld:

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

Addenda manipuleren¶

addendum($)

Raadpleeg po4a(7) voor meer informatie over wat addenda zijn en hoe vertalers ze moeten schrijven. Om een addendum toe te passen op het vertaalde document, moet u gewoon de bestandsnaam ervan doorgeven aan deze functie en u bent klaar ;)

Deze functie zendt bij een fout een geheel getal terug dat geen nul is.

Invoer krijgen, uitvoer leveren¶

Er staan vier functies ter beschikking om invoer te krijgen en uitvoer af te leveren. Zij zijn erg vergelijkbaar met shift/unshift en push/pop van 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.

Het eerste paar heeft betrekking op invoer, terwijl het tweede op uitvoer betrekking heeft. Geheugensteuntje: bij invoer bent u geïnteresseerd in de eerste regel, hetgeen shift geeft, en bij uitvoer wilt u uw resultaat toevoegen aan het einde, zoals push doet.

shiftline()

Deze functie zendt de eerste te ontleden regel terug en zijn overeenkomstige referentie (verpakt als lijst) uit de lijst "@{$self->{TT}{doc_in}}" en verwijdert deze eerste 2 lijstitems. Hier wordt de referentie verstrekt door een tekenreeks "$filename:$linenum" (bestandsnaam:regelnummer).

unshiftline($$)

Plaatst de laatste met shift uit het invoerdocument verwijderde regel en zijn overeenkomstige referentie terug aan het begin van "{$self->{TT}{doc_in}}".

pushline($)

Voegt een nieuwe regel toe aan het einde van "{$self->{TT}{doc_out}}".

popline()

Verwijdert de laatste met push toegevoegde regel aan het einde van "{$self->{TT}{doc_out}}".

Tekstfragmenten als vertaalbaar markeren¶

Er wordt een functie verstrekt om de tekst die moet worden vertaald, te verwerken.

translate($$$)

Verplichte argumenten:

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

Diverse functies¶

verbose()

Geeft aan of de optie verbose opgegeven werd tijdens de creatie van de TransTractor.

debug()

Geeft aan of de optie debug opgegeven werd tijdens de creatie van de TransTractor.

get_in_charset()

Deze functie geeft de tekenset terug die als hoofdtekenset is opgegeven

get_out_charset()

Deze functie zendt terug welke tekenset gebruikt moet worden in het uitvoerdocument (gewoonlijk nuttig om de gedetecteerde karakterset van het invoerdocument te vervangen waar dit aangetroffen werd).

De aan de commandoregel gespecificeerde tekenset zal gebruikt worden. Indien daar niets gespecificeerd werd, wordt de tekenset van het invoerPO-bestand gebruikt, en indien in het invoerPO-bestand het standaard "CHARSET" vermeld staat, zal de tekenset van het invoerdocument teruggezonden worden, zodat geen tekenhercodering uitgevoerd wordt.