Konstruktor¶

process(%)

Diese Funktion kann alles tun, was Sie mit einem Po4a-Dokument in einem Aufruf tun müssen. Ihre Argumente müssen als ein Hash gepackt sein. AKTIONEN:

new(%)

erstellt ein neues Po4a-Dokument; akzeptiert Optionen (aber nur in Form eines Hashs):

Manipulieren von Dokumentdateien¶

read($$)

fügt am Ende des existierenden Feldes "@{$self->{TT}{doc_in}}" ein weiteres Eingabedokument ein. Das Argument ist der zu lesende Dateiname. Falls ein zweiter Dateiname bereitgestellt wird, ist dies der in der Referenz zu verwendende Dateiname.

Das Feld "@{$self->{TT}{doc_in}}" hält die Eingabedokumentdaten als ein Feld von Zeichenketten mit abwechselnden Bedeutungen.
* Die Zeichenkette $textline hält jede Zeile der Eingabetextdaten.
* Die Zeichenkette "$filename:$linenum" hält ihren Ort und wird
»reference« genannt ("linenum" beginnt mit 1).

Bitte beachten Sie, dass es nichts auswertet. Sie sollten die Funktion parse() benutzen, wenn Sie damit fertig sind, Eingabedateien in das Dokument zu packen.

write($)

schreibt das übersetzte Dokument in den angegebene Dateinamen

Diese übersetzten Dokumentdaten werden bereitgestellt durch:
* "$self->docheader()" hält den Kopftext für die Erweiterung und
* "@{$self->{TT}{doc_out}}" hält jede Zeile des übersetzten Haupttextes in dem Feld.

PO-Dateien bearbeiten¶

readpo($)

fügt den Inhalt einer Datei (deren Name als Argument übergeben wird) der existierenden Eingabe-PO-Datei hinzu. Der alte Inhalt wird nicht verworfen.

writepo($)

schreibt die extrahierte PO-Datei in den angegebene Dateinamen

stats()

gibt einige Statistiken über bisher erledigte Übersetzungen zurück. Bitte beachten Sie, dass es sich nicht um die gleichen Statistiken handelt, die »msgfmt --statistics« ausgibt. Hier geht es um den aktuellen Gebrauch der PO-Datei, während Msgfmt den Status der Datei ausgibt. Es ist ein Wrapper für die Funktion Locale::Po4a::Po::stats_get, die auf die Eingabe-PO-Datei angewandt wird. Beispiel für die Benutzung:

    [normale Benutzung des Po4a-Dokuments …]
    ($percent,$hit,$queries) = $document->stats();
    print "Es wurden Übersetzungen für $percent\%  ($hit von $queries) der Zeichenketten gefunden.\n";
    

is_po_uptodate()

Liefert ($uptodate, $diagnostic) zurück, wobei $uptodate angibt, ob die Eingabe-Po und die Ausgabe-Po übereinstimmen (falls nicht, bedeutet dies, dass die Eingabe-Po aktualisiert werden sollte). $diagnostic ist eine Zeichenkette, die erklärt, warum die Po-Datei nicht aktuell ist, wenn das passiert.

Addenda manipulieren¶

addendum($)

Weitere Informationen, was Addenda sind und wie Übersetzer sie schreiben sollten, finden Sie unter po4a(7). Um ein Addendum auf ein übersetztes Dokument anzuwenden, übergeben Sie einfach dieser Funktion seinen Dateinamen und Sie sind fertig. ;)

Diese Funktion gibt bei einem Fehler eine Ganzzahl ungleich Null zurück.

Eingaben erhalten, Ausgaben bereitstellen¶

Es werden vier Funktionen bereitgestellt, um Eingaben zu erhalten und Ausgaben zurückzuliefern. Sie sind den Funktionen shift/unshift und push/pop von Perl sehr ähnlich.

 * Perl shift liefert den ersten Feldeintrag zurück und entfernt ihn aus dem Feld.
 * Perl unshift hängt einen Eintrag als ersten Feldeintrag vor das Feld.
 * Perl pop liefert den letzten Feldeintrag zurück und entfernt ihn aus dem Feld.
 * Perl push hängt einen Eintrag als letzten Feldeintrag an das Feld an.

Das erste Paar handelt von der Eingabe, während das Zweite von der Ausgabe handelt. Merkhilfe: In der Eingabe sind Sie an der ersten Zeile interessiert, was Shift ausgibt und in der Ausgabe möchten Sie Ihr Ergebnis an das Ende hinzufügen, wie dies Push tut.

shiftline()

Diese Funktion liefert die erste auszuwertende Zeile und ihre entsprechende Referenz (als Feld gepackt) aus dem Feld "@{$self->{TT}{doc_in}}" zurück und entfernt diese ersten zwei Feldeinträge. Hier wird die Referenz durch eine Zeichenkette "$filename:$linenum" bereitgestellt.

unshiftline($$)

Schiebt die letzte geschobene Zeile des Eingabedokuments und seiner entsprechenden Referenz an den Kopf von "{$self->{TT}{doc_in}}" zurück.

pushline($)

Schiebt eine neue Zeile an das Ende von "{$self->{TT}{doc_out}}".

popline()

Holt die zuletzt geschobene Zeile vom Ende von "{$self->{TT}{doc_out}}".

Zeichenketten als übersetzbar markieren¶

Eine Funktion wird bereitgestellt, um den Text zu handhaben, der übersetzt werden soll.

translate($$$)

vorgeschriebene Argumente:

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

Verschiedene Funktionen¶

verbose()

kehrt zurück, falls die Option »verbose« während der Erstellung von TransTractor übergeben wurde

debug()

kehrt zurück, falls die Option »debug« während der Erstellung von TransTractor übergeben wurde

detected_charset($)

Dies teilt TransTractor mit, dass ein neuer Zeichensatz (das erste Argument) vom Eingabedokument festgestellt wurde. Er kann üblicherweise aus den Kopfzeilen des Dokuments gelesen werden. Nur der erste Zeichensatz, der entweder von dem process()-Argumenten kommt oder aus dem Dokumente ermittelt wird, wird übrigbleiben.

get_out_charset()

Diese Funktion wird den Zeichensatz zurückgeben, der im ausgegebenen Dokument benutzt werden sollte (üblicherweise nützlich, um den ermittelten Zeichensatz des Eingabedokuments zu ersetzen, wo er gefunden wurde).

Sie wird den auf der Befehlszeile angegebenen Zeichensatz verwenden. Falls er nicht angegeben wurde, wird sie den Zeichensatz der Eingabe-PO-Datei benutzen und falls die Eingabe-PO-Datei die Vorgabe »CHARSET« hat, wird sie den Zeichensatz des Eingabedokuments zurückgeben, so dass die Kodierung durchgeführt wird.

recode_skipped_text($)

Diese Funktion gibt den vom Zeichensatz des Eingabedokuments in den Zeichensatz des Ausgabedokuments neu kodierten Text zurück, der als Argument übergeben wurde. Dies ist nicht nötig, wenn eine Zeichenkette übersetzt wird (translate() kodiert selbst alles neu), aber es ist nötig, wenn Sie eine Zeichenkette des Eingabedokuments überspringen und wenn Sie wollen, dass das Ausgabedokument über eine einheitliche globale Kodierung verfügt.