NAAM¶

Locale::Po4a::AsciiDoc - AsciiDoc-documenten van/naar PO-bestanden converteren

BESCHRIJVING¶

Het doel van het project po4a (PO voor alles) is om de vertaalwerkzaamheden (en interessanter nog, het onderhoud van vertalingen) te vergemakkelijken met behulp van gettext-hulpmiddelen in domeinen waarin deze niet meteen verwacht worden, zoals documentatie.

Locale::Po4a::AsciiDoc is een module ter ondersteuning van de vertaling van documentatie in de AsciiDoc-indeling.

MOGELIJKE OPTIES BIJ DEZE MODULE¶

De volgende opties zijn specifiek voor deze module:

definitions

De naam van een bestand dat definities voor po4a bevat, zoals beschreven wordt in de sectie INBOUWAANPASSINGEN. U kunt deze optie gebruiken indien het niet mogelijk is om de definities te plaatsen in het document dat vertaald wordt.

In een bestand definitions mogen regels niet met twee slashes starten, maar moeten ze direct met po4a: beginnen.

entry

Door spaties gescheiden lijst met eigenschapselementen die u wilt vertalen. Standaard zijn eigenschapselementen niet vertaalbaar.

macro

Door spaties gescheiden lijst met macrodefinities.

style

Door spaties gescheiden lijst met stijldefinities.

forcewrap

Automatische regelafbreking in niet-letterlijke blokken aanzetten, ook al zou het resultaat fout geïnterpreteerd kunnen worden door AsciiDoc-bestandsopmaaktoepassingen.

Standaard zal po4a voor de geproduceerde AsciiDoc-bestanden geen regelafbreking toepassen, omdat een handmatig nazicht nodig is om er zeker van te zijn dat de afbreking de opmaak niet wijzigt. Neem bijvoorbeeld het volgende lijstitem:

 * een lange zin die eindigt op een cijfer 1. A is de eerste letter van het alfabet(tweede zin).
    

Indien het afbreken leidt tot de volgende voorstelling, creëert het afbreken van het item een genummerde sublijst. Wat het probleem nog ernstiger maakt is, dat enkel iemand die de voor de vertaling gebruikte taal spreekt, de situatie kan onderzoeken.

 * een lange zin eindigt op een cijfer
   1. A is de eerste letter van het alfabet (tweede zin).
    

Merk op dat geen regelafbreking toepassen bij de door po4a geproduceerde bestanden, geen probleem zou mogen vormen, omdat deze bestanden bedoeld zijn voor automatische verwerking. Deze zouden hoe dan ook niet mogen beschouwd worden als bronbestanden.

Met deze optie produceert po4a AsciiDoc-bestanden die er mooier uitzien, maar dit kan mogelijk wel leiden tot een foutief opgemaakte uitvoer.

noimagetargets

Standaard zijn de doelen van blokafbeeldingen vertaalbaar om de mogelijkheid te bieden om de inhoud naar vertaalde afbeeldingen te laten verwijzen.. Door deze optie in te stellen kan dit gestopt worden.

tablecells

Deze optie is een vlag die segmentering van subtabellen in celinhoud mogelijk maakt. De segmentering is beperkt tot celinhoud, zonder enige ontleding erin.

compat

Ontleedregels wisselen in functie van compatibiliteit met verschillende hulpmiddelen. Mogelijke opties zijn "asciidoc" en "asciidoctor". Asciidoctor gebruikt striktere ontleedregels, zoals gelijke lengte van de openende en sluitende blokafsluitingen.

nolinting

De berichten van de linter uitschakelen. Wanneer de broncode niet kan aangepast worden in functie van een duidelijkere documentstructuur, hebben deze berichten geen nut.

cleanspaces

Extra spaties verwijderen uit de bronsegmenten in de modus no-wrap. Dit is handig wanneer de vertaalhulpmiddelen gevoelig zijn voor het aantal spaties.

yfm_keys

Door komma's gescheiden lijst met sleutels die moeten worden verwerkt voor vertaling in de sectie YAML Front Matter. Alle andere sleutels worden overgeslagen. Sleutels worden hoofdlettergevoelig vergeleken. Als yfm_paths en yfm_keys samen worden gebruikt, worden waarden opgenomen als ze overeenkomen met minstens één van de opties. Arraywaarden worden altijd vertaald, tenzij de optie yfm_skip_array is opgegeven.

yfm_skip_array

Vertaal matrixwaarden niet in de sectie YAML Front Matter.

yfm_paths

Door komma's gescheiden lijst met hash-paden die voor extractie moeten worden verwerkt in de sectie YAML Front Matter. Alle andere paden worden overgeslagen. Paden worden hoofdlettergevoelig vergeleken. Als yfm_paths en yfm_keys samen worden gebruikt, worden waarden opgenomen als ze overeenkomen met minstens één van de opties. Arraywaarden worden altijd teruggegeven, tenzij de optie yfm_skip_array is opgegeven.

INBOUWAANPASSINGEN¶

De AsciiDoc-module kan aangepast worden met regels die beginnen met //po4a:. Deze regels worden geïnterpreteerd als commando's voor de ontleder. De volgende commando's worden herkend:

//po4a: macro naam[attributenlijst]

Dit beschrijft de parameters van een macro in detail; naam moet een geldige macro-naam zijn, en deze eindigt met een onderstrepingsteken als het doel vertaald moet worden.

Het argument attributenlijst is een door komma's gescheiden lijst welke informatie bevat over vertaalbare argumenten. Deze lijst bevat ofwel cijfers om positieparameters te definiëren, of benoemde kenmerken.

Indien de naam voorafgegaan wordt door een plusteken (+), worden de macro en zijn argumenten in hun geheel vertaald. In dat geval moet er geen attributenlijst gedefinieerd worden, maar haakjes moeten aanwezig zijn.

//po4a: style [attributenlijst]

Dit beschrijft in detail welke attributen van een stijl vertaald moeten worden.

Het argument attributenlijst is een door komma's gescheiden lijst welke informatie bevat over vertaalbare argumenten. Deze lijst bevat ofwel getallen om positieparameters te definiëren of benoemde attributen. Het eerste attribuut is de stijlnaam, welke niet vertaald zal worden.

Indien de stijlnaam voorafgegaan wordt door een plusteken, is de attributenlijst in zijn geheel vertaalbaar. Het is niet nodig om vertaalbare attributen te definiëren.

Indien de stijlnaam voorafgegaan wordt door een minteken (-), wordt dit attribuut niet vertaald.

//po4a: entry naam

Dit verklaart dat een attribuutvermelding vertaalbaar is. Ze worden standaard niet vertaald.

STATUS VAN DEZE MODULE¶

Met succes getest op eenvoudige AsciiDoc-bestanden.

AUTEURS¶

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

COPYRIGHT EN LICENTIE¶

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

Dit programma is vrije software; u kunt het verder verspreiden en/of aanpassen onder de bepalingen van de GPL v2.0 of recenter (zie het bestand COPYING).