NAME¶

Locale::Po4a::AsciiDoc - konvertiert AsciiDoc-Dokumente von/in PO-Dateien

BESCHREIBUNG¶

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::AsciiDoc ist ein Modul, um bei der Übersetzung von Dokumentation im AsciiDoc-Format zu helfen.

VON DIESEM MODUL AKZEPTIERTE OPTIONEN¶

Dies sind die Modul-spezifischen Optionen:

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.

In einer Definitionsdatei dürfen die Zeilen nicht mit zwei Schrägstrichen, sondern müssen direkt durch po4a: beginnen.

entry

leerzeichengetrennte Liste von Attributeinträgen, die Sie übersetzen möchten. Standardmäßig sind keine Attributeinträge übersetzbar.

macro

leerzeichengetrennte Liste von Makrodefinitionen

style

leerzeichengetrennte Liste von Stildefinitionen

forcewrap

Aktiviert automatischen Zeilenumbruch in wörtlichen Blöcken, selbst wenn das Ergebnis durch AsciiDoc-Formatierprogramme falsch interpretiert werden könnte.

Standardmäßig bricht Po4a die erstellten AsciiDoc-Dateien nicht um, da eine manuelle Überprüfung notwendig ist, um sicherzustellen, dass der Umbruch nicht die Formatierung ändert. Betrachten Sie beispielsweise die folgende Liste:

 * ein langer Satz, der auf eine Zahl 1 endet. Ein zweiter Satz.
    

Falls der Umbruch zu der folgenden Darstellung führt, dann wird der Eintrag in eine nummerierte Unterliste aufgeteilt. Um es noch schlimmer werden zu lassen, können nur die Leser der in der Übersetzung verwandten Sprache die Situation überprüfen.

 * eine langer Satz, der auf einer Zahl
   1 endet. Ein zweiter Satz.
    

Beachten Sie, dass es kein Problem ist, dass die von Po4a erstellten Dateien nicht umgebrochen werden, da diese Dateien für die automatische Verarbeitung gedacht sind. Sie sollten sowieso nicht als Eingabedatei verstanden werden.

Mit dieser Option wird Po4a besser aussehende Quelldateien erstellen, die zu möglicherweise falsch formatierten Ausgaben führen können.

noimagetargets

Standardmäßig können die Ziele von Blockbildern übersetzt werden, um die Möglichkeit zu schaffen, auf übersetzte Inhalte zu verweisen. Dies kann durch Setzen dieser Option gestoppt werden.

tablecells

Diese Option ist ein Schalter, der Innerzell-Abtrennung in Zellinhalten ermöglicht. Die Abtrennung ist auf Zellinhalte begrenzt, ohne das Innere auszuwerten.

compat

Schaltet die Auswertregeln auf Kompatibilität zu verschiedenen Werkzeugen um. Verfügbare Optionen sind »asciidoc« und »asciidoctor«. Asciidoctor hat strengere Auswertregeln, wie die Gleichheit der Längen von öffnenden und schließenden Blockbegrenzungen.

yfm_keys

Kommata-getrennte Liste von Schlüsseln, die für Übersetzungen in dem Yaml-Front-Matter-Abschnitt verarbeitet werden sollen. Alle anderen Schlüssel werden übersprungen. Schlüssel werden unabhängig von der Groß-/Kleinschreibung verglichen. Feldwerte werden immer übersetzt, außer die Option yfm_skip_array wird bereitgestellt.

yfm_skip_array

Keine Feldwerte in dem Abschnitt »YAML Front Matter« übersetzen.

ANPASSUNGEN IM DOKUMENT¶

Das AsciiDoc-Modul kann durch Zeilen, die mit % po4a: beginnen, angepasst werden. Diese Zeilen werden vom Parser als Befehle interpretiert. Die folgenden Befehle werden erkannt:

//po4a: macro Name[Attributliste]

Dies erlaubt es, die Parameter eines Macro im Detail zu beschreiben. Name muss ein gültiger Makroname sein und er endet in einem Unterstrich, falls das Ziel übersetzt werden muss.

Das Argument Attributliste ist eine kommatagetrennte Liste, die Informationen über übersetzbare Argumente enthält. Diese Liste enthält entweder Zahlen, um Positionsparameter zu definieren, oder benannte Attribute.

Falls Name ein Pluszeichen (+) vorangestellt wird, dann wird das Makro und seine Argumente als ganzes übersetzt. In diesem Fall ist es nicht notwendig, die Attributliste zu definieren, aber die Klammern müssen vorhanden sein.

//po4a: style [Attributliste]

Dies erlaubt es im Detail zu beschreiben, welche Atrribute eines Stils übersetzt werden müssen.

Das Argument Attributliste ist eine kommatagetrennte Liste, die Informationen über übersetzbare Argumente enthält. Diese Liste enthält entweder Zahlen, um Positionsparameter zu definieren, oder benannte Attribute. Das erste Attribut ist der Name des Stils, er wird nicht übersetzt.

Falls dem Stilnamen ein Pluszeichen (+) vorangestellt wird, dann wird die Attributliste als ganzes übersetzt. Es ist nicht notwendig, übersetzbare Attribute festzulegen.

Falls dem Stilnamen ein Minuszeichen (-) vorangestellt wird, dann wird dieses Attribut nicht übersetzt.

//po4a: entry Name

Dies erklärt einen Attributeintrag als übersetzbar. Standardmäßig sind sie nicht übersetzbar.

STATUS DIESES MODULS¶

Erfolgreich bei einigen einfachen AsciiDoc-Dateien getestet.

AUTOREN¶

 Nicolas François <nicolas.francois@centraliens.net>
 Denis Barbier <barbier@linuxfr.org>

URHEBERRECHT UND LIZENZ¶

 Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
 Copyright © 2012 Denis BARBIER <barbier@linuxfr.org>.
 Copyright © 2017 Martin Quinson <mquinson#debian.org>.

Dieses Programm ist freie Software; Sie können es unter den Bedingungen der GPL (siehe die Datei COPYING) vertreiben und/oder verändern.