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 (maar in een hash):

Documentbestanden behandelen¶

read($$)

Nog andere invoerdocumentgegevens toevoegen aan het einde van de bestaande array "@{$self->{TT}{doc_in}}". Het argument is de naam van het in te lezen bestand. Indien een tweede argument gegeven wordt, is dit de in de referenties te gebruiken bestandsnaam.

Deze lijst "@{$self->{TT}{doc_in}}" bevat deze invoerdocumentgegevens als een lijst van tekenreeksen met afwisselende betekenis.
* De tekenreeks $textline bevat iedere regel van de invoertekstgegevens.
* De tekenreeks "$filename:$linenum" bevat de locatie ervan en wordt aangeroepen
via "referentie" ("linenum" begint bij 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.

Deze vertaalde-documentgegevens worden verstrekt door:
* "$self->docheader()" dat de header-tekst voor de plug-in bevat, en
* "@{$self->{TT}{doc_out}}" dat in een lijst elke regel bevat van de vertaalde hoofdtekst.

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:

    [normaal gebruik van het po4a-document...]
    ($percent,$vertaald,$totaal) = $document->stats();
    print "We vonden vertalingen voor $percent\%  ($vertaald op $totaal) tekstfragmenten.\n";
    

is_po_uptodate()

Zendt ($uptodate, $diagnostic) terug, waarbij $uptodate aangeeft of de invoer-PO en de uitvoer-PO overeenkomen (indien niet, dan wil dit zeggen dat het invoerPO-bestand bijgewerkt moet worden), en $diagnostic een tekstfragment is, waarin in voorkomend geval uitgelegd wordt waarom het PO-bestand niet up-to-date is.

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.

 * shift in Perl zendt het eerste item uit de lijst terug en haalt het weg uit de lijst.
 * unshift in Perl voegt een item toe aan de lijst als het eerste item van de lijst.
 * pop in Perl zendt het laatste item uit de lijst terug en haalt het weg uit de lijst.
 * push in Perl voegt een item toe aan de lijst als het laatste item van de lijst.

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("tekstfragment","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.

detected_charset($)

Dit informeert TransTractor dat een nieuwe tekenset (het eerste argument) aangetroffen werd in het invoerdocument. Gewoonlijk kan dit uit de header van het document gehaald worden. Enkel de eerste tekenset blijft behouden, afkomstig van de argumenten bij de functie process() of gedetecteerd in het document.

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.

recode_skipped_text($)

Deze functie zendt de als argument opgegeven tekst gehercodeerd terug van de tekenset uit het invoerdocument naar de tekenset van het uitvoerdocument. Dit is niet nodig bij de vertaling van een tekstfragment (translate() hercodeert alles zelf), maar wel wanneer u een tekstfragment uit het invoerdocument overslaat en u wilt dat het uitvoerdocument consistent is met de algemene codering.