table of contents
- NAME
- BESCHREIBUNG
- ÜBERSETZEN MIT PO4A::TEX
- VON DIESEM MODUL AKZEPTIERTE OPTIONEN
- ANPASSUNGEN IM DOKUMENT
- SCHREIBEN ABGELEITETER MODULE
- INTERNE FUNKTIONEN, die zum Schreiben abgeleiteter Parser verwendet werden
- STATUS DIESES MODULS
- TODO-LISTE
- BEKANNTE FEHLER
- SIEHE AUCH
- AUTOREN
- URHEBERRECHT UND LIZENZ
other versions
- wheezy 0.42-1
Locale::Po4a::TeX(3) | User Contributed Perl Documentation | Locale::Po4a::TeX(3) |
NAME¶
Locale::Po4a::TeX - konvertiert TeX-Dokumente und Derivate von/in PO-DateienBESCHREIBUNG¶
Das Projektziel von Po4a (PO für alles) ist es, die Übersetzung (und interessanter, die Wartung der Übersetzung) zu vereinfachen, indem die Gettext-Werkzeuge auch für Gebiete verwendet werden, wo diese nicht erwartet werden, wie Dokumentation. Locale::Po4a::TeX ist ein Modul, um bei der Übersetzung von TeX-Dokumenten in andere [natürliche] Sprachen zu helfen. Es kann auch als Grundlage für die Entwicklung von Modulen für TeX-basierte Dokumente verwandt werden. Benutzer sollten wahrscheinlich das LaTeX-Modul verwenden, das vom TeX-Modul abgeleitet ist und die Definitionen von typischen LaTeX-Befehlen enthält.ÜBERSETZEN MIT PO4A::TEX¶
Dieses Modul kann direkt verwandt werden, um mit generischen TeX-Dokumenten umzugehen. Es wird Ihr Dokument in kleinere Blöcke (Absätze, »verbatim«-Blöcke oder sogar kleinere wie Titel oder Indices) teilen. Es gibt einige Optionen (die im nächsten Abschnitt beschrieben werden), die dieses Verhalten anpassen lassen. Falls dies nicht auf Ihr Dokumentenformat passt, ermutigen wir Sie, Ihr eigenes, von diesem Modul abgeleitetes Modul zu schreiben, um die Details Ihres Formats zu beschreiben. Lesen Sie den Abschnitt SCHREIBEN ABGELEITETER MODULE weiter unten für die Beschreibung des Prozesses. Dieses Modul kann auch durch Zeilen in der TeX-Datei, die mit »% po4a:« beginnen, angepasst werden. Diese Anpassungen werden im Abschnitt ANPASSUNGEN IM DOKUMENT beschrieben.VON DIESEM MODUL AKZEPTIERTE OPTIONEN¶
Dies sind die Modul-spezifischen Optionen:- debug
- Aktiviert Fehlersuchroutinen für einige interne Mechanismen dieses Moduls. Verwenden Sie den Quelltext, um zu sehen, welche Teile damit auf Fehler untersucht werden können.
- no_wrap
- durch Kommata getrennte Liste von Umgebungen, die nicht neu
umgebrochen werden sollen
- exclude_include
- durch Doppelpunkte getrennte Liste von Dateien, die nicht von \input und \include eingeschlossen werden sollten
- definitions
- Der Name der Datei, die die Definitionen für Po4a enthält, wie diese im Abschnitt ANPASSUNGEN IM DOKUMENT beschrieben sind. Sie können diese Option verwenden, falls es nicht möglich ist, die Definitionen in das zu übersetzende Dokument zu schreiben.
- verbatim
- durch Kommata getrennte Liste von Umgebungen, die
»verbatim« angenommen werden sollten
ANPASSUNGEN IM DOKUMENT¶
Das TeX-Modul kann durch Zeilen, die mit % po4a: beginnen, angepasst werden. Diese Zeilen werden vom Parser als Befehle interpretiert. Die folgenden Befehle werden erkannt:- % po4a: command Befehl1 alias Befehl2
- zeigt an, dass die Argumente des Befehls Befehl1 als Argumente des Befehls Befehl2 behandelt werden sollen
- % po4a: command Befehl1 Parameter
- Dies erlaubt es, die Parameter des Befehls Befehl1
im Detail zu beschreiben. Diese Information wird zur Überprüfung
der Anzahl der Argumente und ihrer Typen verwandt.
- einen Stern (*)
- Po4a wird diesen Befehl aus Absätzen herauslesen (falls er sich am Anfang oder Ende eines Absatzes befindet). Der Übersetzer muss dann die Parameter übersetzen, die als übersetzbar markiert sind.
- ein Plus (+)
- Wie bei einem Stern wird der Befehl herausgelesen, falls er
an den Endpunkten eines Blocks erscheint, aber die Parameter werden nicht
separat übersetzt. Der Übersetzer muss den Befehl,
zusammengesetzt mit allen seinen Parametern, übersetzen. Dies erlaubt
es, mehr Kontext zu erhalten und ist für Befehle nützlich, die
kleine Wörter in ihren Parametern enthalten, die mehrere Bedeutungen
(und Übersetzungen) haben können.
- ein Minus (-)
- In diesem Fall wird der Befehl aus keinem Block herausgelesen. Falls er aber alleine in einem Block erscheint, werden nur die als übersetzbar markierten Parameter dem Übersetzer angeboten. Dies ist für Schriftsatzbefehle nützlich. Diese Befehle sollten im Allgemeinen nicht von ihrem Absatz getrennt werden (um den Kontext zu erhalten), aber es gibt keinen Grund, den Übersetzer damit zu belästigen, falls die gesamte Zeichenkette in einem solchen Befehl eingeschlossen ist.
% po4a: command *chapter [_]{_}
% po4a: command -href {}{_}
- % po4a: environment Umgeb Parameter
- Dies erlaubt es, die von der Umgebung Umgeb
akzeptierten Parameter zu definieren. Diese Information wird später
zum Überprüfen der Anzahl der Argumente des \begin-Befehls
verwandt und erlaubt die Spezifizierung, welche davon übersetzt
werden müssen. Die Syntax ist die gleiche, wie sie für die
Befehle beschrieben ist. Der erste Parameter des Befehls \begin ist der
Name der Umgebung. Dieser Parameter darf nicht in der Liste der Parameter
spezifziert werden. Einige Beispiele:
% po4a: environment multicols {}
% po4a: environment equation
- % po4a: separator Umgeb "RegAus "
- zeigt an, dass die Umgebung entsprechend des
übergebenen regulären Ausdruckes aufgeteilt werden soll
- % po4a: verbatim environment Umgeb
- Zeigt an, dass Umgeb eine
»verbatim«-Umgebung ist. Kommentare und Befehle werden innerhalb
dieser Umgebung ignoriert.
SCHREIBEN ABGELEITETER MODULE¶
- pre_trans
- post_trans
- translate
- Wrapper um die Übersetzung von TransTractor, mit Vor-
und Nachverarbeitungsfiltern.
- get_leading_command($buffer)
- Diese Funktion liefert folgendes zurück:
- Einen Befehlsnamen
- Falls kein Befehl am Anfang des Puffers gefunden wird, wird diese Zeichenkette leer sein. Nur Befehle, die getrennt werden können, werden betrachtet. Der Hash %separated_command enthält eine Liste dieser Befehle.
- Eine Variante
- Dies zeigt an, ob eine Variante benutzt wurde. Beispielsweise kann ein Stern (*) am Ende eines »section«-Befehls verwendet werden, um anzugeben, dass diese nicht nummeriert werden sollen. In diesem Fall wird dieses Feld »*« enthalten. Falls es keine Variante gibt, enthält dieses Feld die leere Zeichenkette.
- Ein Feld von Tupeln (Argumenttyp, Argument)
- Der Typ des Arguments kann entweder »{« (für verpflichtende Argumente) oder »[« (für optionale Argumente) sein.
- Der verbleibende Puffer
- Der Rest des Puffers nach der Entfernung des führenden Befehls und seiner Argumente. Falls kein Befehl gefunden wird, wird der ursprüngliche Puffer nicht angerührt und in diesem Feld zurückgeliefert.
- get_trailing_command($buffer)
- identisch zu get_leading_command, allerdings für Befehle am Ende des Puffers
- translate_buffer
- rekursives Übersetzen eins Puffers durch Trennung von
führenden and abschließenden Befehlen (solche, die separat
übersetzt werden sollten) aus dem Puffer
- read
- überlädt Transtractors read
- read_file
- Liest rekursiv eine Datei und hängt eingebundene
Dateien, die nicht im Feld @exclude_include aufgeführt sind, an.
Eingebundene Dateien werden mittels des Befehls kpsewhich aus der
Bibliothek Kpathsea gesucht.
- parse_definition_file
- Subroutine zum Auswerten einer Datei mit Po4a-Direktiven (Definitionen für neue Befehle).
- parse_definition_line
- eine Definitionszeile der Form »% po4a: «
auswerten
- is_closed
- docheader
INTERNE FUNKTIONEN, die zum Schreiben abgeleiteter Parser verwendet werden¶
Befehls- und Umgebungsfunktionen erwarten die folgenden Argumente (zusätzlich zum Objekt $self):- Einen Befehlsnamen
- Eine Variante
- Ein Feld von (Typ, Argument)-Tupeln
- Die aktuelle Umgebung
% po4a: command Befehl Parameter generic_environment verwendet die durch register_generic_environment spezifizierte Information oder durch Hinzufügen von Definitionen zu der TeX-Datei:
% po4a: environment Umgeb Parameter Beide Funktionen werden nur die als übersetzbar (mit einem »_«) angegebenen Parameter übersetzen. generic_environment wird den Namen der Umgebung an den Umgebungsstapel anhängen und generic_command wird den Namen des Befehls gefolgt von einer Kennung des Parameters (wie{#7} oder [#2]) anhängen.
STATUS DIESES MODULS¶
Dieses Modul benötigt weitere Tests. Es wurde mit einem Buch und mit der Python-Dokumentation getestet.TODO-LISTE¶
- Automatische Erkennung neuer Befehle
- Das TeX-Modul könnte die »newcommand«-Argumente auswerten und versuchen, die Anzahl der Argumente, ihren Typ und ob (oder ob nicht) sie übersetzt werden sollten, zu raten.
- Übersetzung des Umgebungstrenners
- Wird \item als Trenner für Umgebungen verwandt, dann wird das Argument von »item« an die folgenden Zeichenkette angefügt.
- Einige Befehle sollten dem Umgebungsstapel hinzugefügt werden.
- Diese Befehle sollten paarweise angegeben werden. Dies könnte die Angabe von Befehlen ermöglichen, die eine wortgetreue Umgebung beginnen oder beenden.
- Weitere
- Verschiedene andere Punkte werden in der Quelle als TODO gekennzeichnet.
BEKANNTE FEHLER¶
Verschiedene Punkte werden in der Quelle als FIXME gekennzeichnet.SIEHE AUCH¶
Locale::Po4a::LaTeX(3pm), Locale::Po4a::TransTractor(3pm), po4a(7)AUTOREN¶
Nicolas François <nicolas.francois@centraliens.net>
URHEBERRECHT UND LIZENZ¶
Copyright 2004, 2005 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>. Dieses Programm ist freie Software; Sie können es unter den Bedingungen der GPL (siehe die Datei COPYING) vertreiben und/oder verändern.2012-05-17 | perl v5.14.2 |