NAMN¶

Locale::Po4a::Po - Modul för hantering av PO-filer

SYNOPSIS¶

    use Locale::Po4a::Po;
    my $pofile=Locale::Po4a::Po->new();
    # Read PO file
    $pofile->read('file.po');
    # Add an entry
    $pofile->push('msgid' => 'Hello', 'msgstr' => 'bonjour',
                  'flags' => "wrap", 'reference'=>'file.c:46');
    # Extract a translation
    $pofile->gettext("Hello"); # returns 'bonjour'
    # Write back to a file
    $pofile->write('otherfile.po');

BESKRIVNING¶

Locale::Po4a::Po är ett modul som gör det möjligt att manipulera meddelandekataloger. Du kan ladda och skriva från/till en fil (vars filändelse ofta är po), du kan skapa nya poster direkt eller begära översättning av en sträng.

För en mer utförlig beskrivning av meddelandekataloger i PO-format och deras användning, se informationsdokumentationen för programmet gettext (nod "`PO-filer"').

Denna modul är en del av po4a-projektet, vars mål är att använda PO-filer (ursprungligen utformade för att underlätta översättning av programmeddelanden) för att översätta allt, inklusive dokumentation (man-sidor, infomanualer), paketbeskrivningar, debconf-mallar och allt annat som kan dra nytta av detta.

FLAGGOR SOM ACCEPTERAS AV DENNA MODUL¶

--porefs type

Ange referensformatet. Argumentet type kan vara never för att inte skapa någon referens, file för att endast ange filen utan radnummer, counter för att ersätta radnumret med en ökande räknare och full för att inkludera fullständiga referenser (standard: full).

--wrap-po no|newlines|number (standard: 76)

Ange hur po-filen ska formateras. Detta ger valet mellan antingen filer som är snyggt formaterade men som kan leda till git-konflikter, eller filer som är lättare att hantera automatiskt, men svårare att läsa för människor.

Historiskt sett har gettext-paketet omformaterat po-filerna vid den 77:e kolumnen av kosmetiska skäl. Denna flagga anger po4a:s beteende. Om det är inställt på ett numeriskt värde kommer po4a att bryta po-filen efter denna kolumn och efter radbrytningar i innehållet. Om det är inställt på newlines kommer po4a endast att dela upp msgid och msgstr efter radbrytningar i innehållet. Om det är inställt på no kommer po4a inte att bryta po-filen alls. Referenskommmentarerna bryts alltid av de gettext-verktyg som vi använder internt.

Observera att denna flagga inte påverkar hur msgid och msgstr bryts, dvs. hur radbrytningar läggs till i innehållet i dessa strängar.

--msgid-bugs-address email@address

Ställ in rapportadressen för msgid-buggar. Som standard har de skapade POT-filerna inga Report-Msgid-Bugs-To-fält.

--copyright-holder string

Ange upphovsrättsinnehavaren i POT-rubriken. Standardvärdet är "Free Software Foundation, Inc."

--package-name string

Ange paketnamnet för POT-rubriken. Standardvärdet är "PACKAGE".

--package-version string

Ställ in paketversionen för POT-rubriken. Standardvärdet är "VERSION".

Funktioner som rör hela meddelandekataloger¶

ny()

Skapar en ny meddelandekatalog. Om ett argument anges är det namnet på en PO-fil som vi ska ladda.

läs($)

Läser en PO-fil (vars namn anges som argument). Befintliga poster i self tas inte bort, utan de nya läggs till i slutet av katalogen.

skriv($)

Skriver den aktuella katalogen till den angivna filen.

skriv_om_nödvändigt($$)

Som skriva, men om PO- eller POT-filen redan finns kommer objektet att skrivas till en temporär fil som jämförs med den befintliga filen för att kontrollera om uppdateringen behövs (detta undviker att ändra en POT bara för att uppdatera en radreferens eller fältet POT-Creation-Date).

filter($)

Denna funktion extraherar en katalog från en befintlig katalog. Endast de poster som har en referens i den angivna filen kommer att placeras i den resulterande katalogen.

Denna funktion analyserar sitt argument, konverterar det till en Perl-funktionsdefinition, utvärderar denna definition och filtrerar de fält för vilka denna funktion returnerar true.

Ibland älskar jag Perl ;)

Funktioner för att använda en meddelandekatalog för översättningar¶

gettext($%)

Begär översättning av strängen som anges som argument i den aktuella katalogen. Funktionen returnerar den ursprungliga (oöversatta) strängen om strängen inte hittades.

Efter strängen som ska översättas kan du skicka en hash med extra argument. Här är de giltiga posterna:

stats_get()

Returnerar statistik om träfffrekvensen för gettext sedan senaste gången stats_clear() anropades. Observera att det inte är samma statistik som den som skrivs ut av msgfmt --statistic. Här är det statistik om den senaste användningen av PO-filen, medan msgfmt rapporterar filens status. Exempel på användning:

    [viss användning av PO-filen för att översätta saker]
    ($percent,$hit,$queries) = $pofile->stats_get();
    print "Hittills har vi hittat översättningar för $percent\% ($hit av $queries) av strängar.\n";
    

stats_clear()

Rensar statistiken om gettext-träffar.

Funktioner för att skapa en meddelandekatalog¶

push(%)

Lägg till en ny post i slutet av den aktuella katalogen. Argumenten ska bilda en hashtabell. Giltiga nycklar är:

Övriga funktioner¶

count_entries()

Returnerar antalet poster i katalogen (utan rubriken).

count_entries_doc()

Returnerar antalet poster i dokumentet. Om en sträng förekommer flera gånger i dokumentet räknas den flera gånger.

msgid($)

Returnerar msgid för det angivna numret.

msgid_doc($)

Returnerar msgid med den angivna positionen i dokumentet.

type_doc($)

Returnerar typen av msgid med den angivna positionen i dokumentet. Detta är förmodligen endast användbart för gettextisering, och det lagras separat från {$msgid}{'type'} eftersom den senare platsen kan skrivas över av en annan typ när $msgid dupliceras i huvuddokumentet.

get_charset()

Returnerar teckenuppsättningen som anges i PO-rubriken. Om den inte har angetts returneras "UTF-8".

gettext_wrap_opts($)

En liten verktygsfunktion som returnerar en sträng med lämpliga flaggor för C-<--no-wrap>/C-<--width> -gettext-verktygen som motsvarar det angivna B-<wrap-po> -värdet.

each_message

This method iterates over each message in the PO file and processes it. It takes a subroutine reference and executes it with two arguments: 1) the "msgid" and 2) a hash reference containing the message content, which includes fields such as "msgstr".

replant

This method takes two parameters: the current "msgid" and the new "msgid". It removes the entry with the current "msgid" from the PO instance and reinserts it under the new "msgid" value.

message_by_document_position

This method takes a document position and returns the matching message as a list containing three elements: the "msgid", the "msgctxt", and the message content (which includes fields such as "msgstr").

message_by_msgid

This method takes a "msgid" and an optional "msgctxt", and returns the first matching message content, which includes fields such as "msgstr". If no "msgctxt" is provided, an empty string value is used. If no message entry is found with the given context, the method falls back to searching for a message without context.

UPPHOVSPERSONER¶

 Denis Barbier <barbier@linuxfr.org>
 Martin Quinson (mquinson#debian.org)