LOCALE::PO4A::TRANSTRACTOR.3PM(1)

NAAM
Locale::Po4a::TransTractor - generieke vertaler en extractor.

BESCHRIJVING
Het doel van het project po4a (PO voor alles) is om de vertaalwerkzaamheden (en interessanter nog, het onderhoud van vertalingen) te vergemakkelijken met behulp van gettext-hulpmiddelen in domeinen waarin deze niet meteen verwacht worden, zoals documentatie.

Deze klasse is de voorouder van alle po4a-ontleders die gebruikt worden om een document te ontleden, vertaalbare tekstfragmenten op te zoeken, deze naar een PO-bestand te extraheren en deze te vervangen door hun vertaling in het uitvoerdocument.

Meer formeel neemt ze de volgende argumenten als invoer:

-   een te vertalen document;

-   een PO-bestand dat de te gebruiken vertalingen bevat.

Als uitvoer produceert ze:

-   nog een PO-bestand als het resultaat van de extractie van vertaalbare tekstfragmenten uit het invoerdocument;

-   een vertaald document met dezelfde structuur als het invoerdocument, maar waarin alle vertaalbare tekstfragmenten vervangen werden door de vertalingen die in het als invoer verstrekte PO-bestand aangetroffen werden.

Hier volgt een grafische voorstelling:

   Input document --\                             /---> Output document
                     \                           /       (translated)
                      +-> parse() function -----+
                     /                           \
   Input PO --------/                             \---> Output PO
                                                         (extracted)

FUNCTIES DIE UW ONTLEDERER MOET OVERSTIJGEN

parse()
    Dit is waar al het werk gebeurt: het ontleden van invoerdocumenten, het genereren van uitvoer en het extraheren van de vertaalbare tekstfragmenten. Dit is redelijk eenvoudig met de hieronder in de sectie INTERNE FUNCTIES verstrekte functies. Bekijk ook het OVERZICHT met daarin een voorbeeld.

    Deze functie wordt aangeroepen door de functie process() hieronder, maar indien u ervoor kiest de functie new() te gebruiken en handmatig inhoud toe te voegen aan uw document, zult u deze functie zelf moeten aanroepen.

docheader()
    Deze functie geeft de header terug die we aan het geproduceerde document moeten toevoegen, passend aangehaald om in de doeltaal als commentaar te gelden. Raadpleeg de sectie Ontwikkelaars onderrichten over vertalingen van po4a(7) over waarvoor dit goed is.

OVERZICHT
Inhet volgende voorbeeld wordt een lijst alinea's die beginnen met "<p>", ontleed. Gemakshalve gaan we ervan uit dat het document goed is opgemaakt, d.w.z. dat '<p>'-tags de enige aanwezige tags zijn, en dat deze tag helemaal aan het begin van elke alinea staat.

 sub parse {
   my $self = shift;

   PARAGRAPH: while (1) {
       my ($paragraph,$pararef)=("","");
       my $first=1;
       my ($line,$lref)=$self->shiftline();
       while (defined($line)) {
           if ($line =~ m/<p>/ && !$first--; ) {
               # Not the first time we see <p>.
               # Reput the current line in input,
               #  and put the built paragraph to output
               $self->unshiftline($line,$lref);

               # Now that the document is formed, translate it:
               #   - Remove the leading tag
               $paragraph =~ s/^<p>//s;

               #   - push to output the leading tag (untranslated) and the
               #     rest of the paragraph (translated)
               $self->pushline(  "<p>"
                               . $self->translate($paragraph,$pararef)
                               );

               next PARAGRAPH;
           } else {
               # Append to the paragraph
               $paragraph .= $line;
               $pararef = $lref unless(length($pararef));
           }

           # Reinit the loop
           ($line,$lref)=$self->shiftline();
       }
       # Did not get a defined line? End of input file.
       return;
   }
 }

Nadat u de ontleedfunctie geïmplementeerd heeft, kunt u uw documentklasse gebruiken met behulp van de openbare interface die in de volgende sectie voorgesteld wordt.

OPENBARE INTERFACE voor scripts die uw ontleder gebruiken

  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:

    a.  Leest alle in po_in_name vermelde PO-bestanden

    b.  Leest alle in file_in_name vermelde documenten

    c.  Ontleedt het document

    d.  Leest alle opgegeven addenda en past deze toe

    e.  Schrijft het vertaalde document naar file_out_name (indien gespecificeerd)

    f.  Schrijft het geëxtraheerd PO-bestand naar po_out_name (indien gespecificeerd)

    ARGUMENTEN, behalve die welke door new() geaccepteerd worden (met verwacht type):

    file_in_name (@)
        Lijst met namen van bestanden waaruit we het invoerdocument moeten lezen.

    file_in_charset ($)
        In het invoerdocument gebruikte tekenset (Indien dit niet gespecificeerd werd, zal UTF-8 gebruikt worden).

    file_out_name ($)
        Naam van het bestand waarnaar we het uitvoerdocument moeten schrijven.

    file_out_charset ($)
        In het uitvoerdocument gebruikte tekenset (Indien dit niet gespecificeerd werd, zal UTF-8 gebruikt worden).

    po_in_name (@)
        Namenlijst van de bestanden waaruit we de invoerPO-bestanden moeten lezen, welke de vertaling bevatten die gebruikt zal worden om het document te vertalen.

    po_out_name ($)
        Naam van het bestand waarin we het uitvoerPO-bestand moeten schrijven, dat de tekstfragmenten bevat die uit het invoerdocument geëxtraheerd werden.

    addendum (@)
        Namenlijst van de bestanden waaruit we de addenda moeten inlezen.

    addendum_charset ($)
        Tekenset voor de addenda.

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

    verbose ($)
        Stelt in hoeveel informatie gegeven wordt.

    debug ($)
        Stelt het debuggen in.

    wrapcol ($)
        De kolom waar de regelafbreking moet gebeuren in het uitvoerdocument (standaard: 76).

        Een negatieve waarde betekent dat er helemaal geen regelafbreking moet gebeuren.

    Het accepteert ook de volgende opties voor onderliggende Po-bestanden: porefs, copyright-holder, msgid-bugs-address, package-name, package-version, wrap-po.

  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.

INTERNE FUNCTIES welke gebruikt worden voor het schrijven van afgeleide ontleders

  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:

    -   Een te vertalen tekstfragment

    -   De referentie van dit tekstfragment (d.w.z. positie in het invoerbestand)

    -   Het type van dit tekstfragment (d.w.z. de letterlijke beschrijving van zijn structurele rol; gebruikt in Locale::Po4a::Po::gettextization(); zie ook po4a(7), afdeling Het gettextize-proces: hoe werkt dit?)

    Aan deze functie kunnen ook enkele extra argumenten meegegeven worden. Zij moeten als een hash georganiseerd worden. Bijvoorbeeld:

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

    wrap
        Booleaanse operator die aangeeft of we witruimte in tekstfragmenten al dan niet als belangrijk moeten beschouwen. Indien ja, dan canoniseert de functie het tekstfragment voordat ze op zoek gaat naar een vertaling of voordat ze dit fragment extraheert, en past ze regelafbreking toe op de vertaling.

    wrapcol
        de kolom waarop de regelafbreking moet gebeuren (standaard: de waarde van wrapcol die is opgegeven tijdens het maken van de TransTractor of 76).

        De negatieve waarde wordt afgetrokken van de standaardwaarde.

    comment
        een aan het element toe te voegen extra commentaar.

    Acties:

    -   Duwt tekstfragment, referentie en type naar po_out.

    -   Zendt de vertaling van het tekstfragment (zoals gevonden in po_in) terug, zodat de ontleder het doc_out kan bouwen.

    -   Gebruikt de tekensets voor het hercoderen van de tekstfragmenten vooraleer deze naar po_out gezonden worden en voorafgaand aan het terugzenden van de vertalingen.

  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.

RICHTINGEN VOOR DE TOEKOMST
Een tekortkoming van het huidige TransTractor is dat het niet overweg kan met vertaalde documenten welke alle talen bevatten, zoals debconf-sjablonen of .desktop-bestanden.

Om dit probleem aan te pakken, zijn de enige noodzakelijke aanpassingen aan de interface:

-   voor po_in_name het (Perl) variabeletype hash gebruiken (een lijst per taal)

-   een te vertalen argument toevoegen om de doeltaal aan te geven

-   een pushline_all-functie maken, die pushline zou toepassen voor zijn inhoud voor alle talen met behulp van een kaartachtige syntaxis:

        $self->pushline_all({ "Description[".$langcode."]=".
                              $self->translate($line,$ref,$langcode)
                            });

We zullen zien of dit volstaat ;)

AUTEURS
 Denis Barbier <barbier@linuxfr.org>
 Martin Quinson (mquinson#debian.org)
 Jordi Vilalta <jvprat@gmail.com>