Costruttore¶

processo(%)

Questa funzione può fare tutto quello che si deve fare con un documento po4a in una sola chiamata. I suoi argomenti devono essere impacchettati come un hash. AZIONI:

new(%)

Crea un nuovo documento po4a. Opzioni accettate (nell'hash passato come parametro):

Gestione file dei documenti¶

read($$$)

Aggiunge i dati di un altro documento in ingresso alla fine della schiera esistente "@{$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).

Si noti che non analizza nulla. Si dovrebbe usare la funzione parse() quando si ha finito di impacchettare i file in ingresso nel documento.

write($)

Scrive il documento tradotto con il nome file specificato.

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.

Gestione file PO¶

readpo($)

Aggiunge il contenuto di un file (il cui nome viene passato come argomento) al PO di ingresso esistente. Il vecchio contenuto non viene scartato.

writepo($)

Scrive il file PO estratto nel nome file dato.

stats()

Restituisce alcune statistiche sulla traduzione eseguita fino a quel momento. Si noti che non sono le stesse statistiche di quelle prodotte dal comando da msgfmt --statistic. Qui, sono le statistiche sull'utilizzo recente del file PO, mentre msgfmt riporta lo stato del file. È un wrapper per la funzione Locale::Po4a::Po::stats_get applicata al file PO di ingresso. Esempio d'uso:

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

Gestione addenda¶

addendum($)

Fare riferimento a po4a(7) per maggiori informazioni su cosa sono gli addenda e su come i traduttori dovrebbero scriverli. Per applicare un addendum al documento tradotto, passare semplicemente il suo nome file a questa funzione ed il gioco è fatto ;)

Questa funzione restituisce un intero non nullo in caso di errore.

Ottenere l'ingresso, fornire l'uscita¶

Vengono fornite quattro funzioni per catturare l'ingresso e restituire l'uscita. Sono molto simili a shift/unshift e push/pop di 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.

La prima coppia riguarda l'ingresso, mentre la seconda riguarda l'uscita. Mnemonico: in ingresso, si è interessati alla prima riga, cosa dà shift, e in uscita si desidera aggiungere il risultato alla fine, come fa push.

shiftline()

Questa funzione restituisce la prima riga da analizzare e il suo riferimento corrispondente (compresso come un array) dall'array "@{$self->{TT}{doc_in}}" e rilascia questi primi 2 elementi dell'array. Qui, il riferimento è fornito da una stringa "$filename:$linenum".

unshiftline($$)

Annulla lo spostamento dell'ultima riga spostata del documento in ingresso e il relativo riferimento corrispondente all'inizio di "{$self->{TT}{doc_in}}".

pushline($)

Inserisce una nuova riga alla fine di "{$self->{TT}{doc_out}}".

popline()

Estrae l'ultima riga inserita dalla fine di "{$self->{TT}{doc_out}}".

Marcatura stringhe come traducibili¶

Viene fornita una funzione per gestire il testo da tradurre.

translate($$$)

Argomenti obbligatori:

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

Funzioni varie¶

verbose()

Restituisce se l'opzione verbose è stata passata durante la creazione di TransTractor.

debug()

Restituisce se l'opzione di debug è stata passata durante la creazione di TransTractor.

get_in_charset()

Questa funzione restituisce il set di caratteri che è stato fornito come master

get_out_charset()

Questa funzione restituirà il set di caratteri che dovrebbe essere utilizzato nel documento in uscita (solitamente utile per sostituire il set di caratteri rilevato del documento in ingresso dove è stato trovato).

Userà il set di caratteri in uscita specificato nella riga di comando. Se non è stato specificato, userà il set di caratteri del PO in ingresso e se il PO in ingresso ha il "CHARSET" predefinito, restituirà il set di caratteri del documento in ingresso, in modo che non venga eseguita alcuna codifica.