NAMN¶

Locale::Po4a::AsciiDoc – konvertera AsciiDoc-dokument från/till PO-filer

BESKRIVNING¶

Målet med po4a-projektet (PO för allt) är att underlätta översättningar (och, ännu mer intressant, underhållet av översättningar) med hjälp av gettext-verktyg på områden där de inte förväntades användas, såsom dokumentation.

Locale::Po4a::AsciiDoc är ett modul som hjälper till med översättning av dokumentation i AsciiDoc-format.

FLAGGOR SOM ACCEPTERAS AV DENNA MODUL¶

Detta är modulens specifika flaggor:

definitions

Namnet på en fil som innehåller definitioner för po4a, enligt definitionen i avsnittet INLINE CUSTOMIZATION. Du kan använda denna flagga om det inte är möjligt att placera definitionerna i det dokument som översätts.

I en definitionsfil får rader inte börja med två snedstreck, utan direkt med po4a:.

entry

En lista med attributposter som du vill översätta, separerade med mellanslag. Som standard är inga attributposter översättningsbara.

macro

Mellanslagsavgränsad lista över makrodefinitioner.

style

Lista med stildefinitioner separerade med mellanslag.

forcewrap

Aktivera automatisk radbrytning i icke-verbatim-block, även om resultatet kan misstolkas av AsciiDoc-formaterare.

Som standard kommer po4a inte att bryta de producerade AsciiDoc-filerna eftersom en manuell kontroll krävs för att säkerställa att brytningen inte ändrar formateringen. Tänk till exempel på följande listpunkt:

 * en lång mening som slutar med siffran 1. En andra mening.
    

Om omslaget leder till följande presentation delas artikeln upp i en numrerad underlista. För att göra saken ännu värre är det bara de som talar det språk som används i översättningen som kan granska situationen.

 * en lång mening som slutar med siffran
   1. En andra mening.
    

Observera att det inte bör vara något problem att inte packa in filerna som skapas av po4a, eftersom dessa filer är avsedda att bearbetas automatiskt. De bör ändå inte betraktas som källfiler.

Med denna flagga kommer po4a att producera snyggare AsciiDoc-filer, men det kan leda till eventuellt felaktigt formaterade utdata.

noimagetargets

Som standard är målen för blockbilder översättningsbara för att ge möjlighet att peka innehållet mot översatta bilder. Detta kan stoppas genom att ställa in denna flagga.

tablecells

Den här flaggan är en flagga som aktiverar segmentering av undertabeller i cellinnehåll. Segmenteringen är begränsad till cellinnehåll, utan någon analys inuti det.

compat

Ändra parsningsreglerna för kompatibilitet med olika verktyg. Tillgängliga flaggor är "asciidoc" eller "asciidoctor". Asciidoctor har strängare tolkningsregler, såsom att längden på öppnande och stängande blockfences måste vara lika.

nolinting

Inaktivera linting-meddelanden. När källkoden inte kan korrigeras för en tydligare dokumentstruktur är dessa meddelanden meningslösa.

cleanspaces

Ta bort extra mellanslag från källsegmenten i läget utan radbrytning. Detta är användbart när översättningsverktygen är känsliga för antalet mellanslag.

yfm_keys

Kommaseparerad lista över nycklar som ska bearbetas för översättning i YAML Front Matter-sektionen. Alla andra nycklar hoppas över. Nycklar matchas med en skiftlägeskänslig matchning. Om yfm_paths och yfm_keys används tillsammans inkluderas värden om de matchas av minst en av flaggorna. Arrayvärden översätts alltid, såvida inte flaggan yfm_skip_array anges.

yfm_skip_array

Översätt inte arrayvärden i YAML Front Matter-sektionen.

yfm_paths

Kommaseparerad lista över hashvägar som ska bearbetas för extrahering i YAML Front Matter-sektionen, alla andra vägar hoppas över. Vägar matchas med en skiftlägeskänslig matchning. Om yfm_paths och yfm_keys används tillsammans inkluderas värden om de matchas av minst en av flaggorna. Arrayvärden returneras alltid om inte flaggan yfm_skip_array anges.

INLINE-ANPASSNING¶

AsciiDoc-modulen kan anpassas med rader som börjar med //po4a:. Dessa rader tolkas som kommandon till parsern. Följande kommandon känns igen:

//po4a: macro name[attribute list]

Här beskrivs i detalj parametrarna för en B-<macro>; name måste vara ett giltigt makronamn och avslutas med ett understreck om målet måste översättas.

Argumentet i<attribute list> är en kommaseparerad lista som innehåller information om översättningsbara argument. Denna lista innehåller antingen siffror, för att definiera positionsparametrar, eller namngivna attribut.

Om ett plustecken (+) placeras framför name, översätts makrot och dess argument som en helhet. I detta fall behöver ingen attributlista definieras, men parenteser måste finnas med.

//po4a: style [attribute list]

Här beskrivs i detalj vilka attribut i en stil som måste översättas.

Argumentet i<attribute list> är en kommaseparerad lista som innehåller information om översättningsbara argument. Denna lista innehåller antingen siffror, för att definiera positionsparametrar, eller namngivna attribut. Det första attributet är stilnamnet, det kommer inte att översättas.

Om ett plustecken (+) placeras framför stilnamnet översätts attributlistan i sin helhet. Det finns inget behov av att definiera översättningsbara attribut.

Om ett minustecken (-) läggs till före stilnamnet, översätts inte detta attribut.

Om ett procenttecken (%) läggs till stilnamnet behandlas stilen som ordagrant. Raderna i stycket eller blocket med sådan stil bevaras i po-filerna och motsvarande poster markeras som no-wrap.

//po4a: entry name

Detta deklarerar en attributpost som översättningsbar. Som standard översätts de inte.

STATUS FÖR DENNA MODUL¶

Testat med framgång på enkla AsciiDoc-filer.

UPPHOVSPERSONER¶

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

UPPHOVSRÄTT OCH LICENS¶

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

Detta program är fri programvara; du får distribuera och/eller modifiera det enligt villkoren i GPL v2.0 eller senare (se filen COPYING).