NAAM¶

Locale::Po4a::Xml -XML-documenten en afgeleiden 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::Xml is een module ter ondersteuning van de vertaling van XML-documenten naar andere [menselijke] talen. Ze kan ook gebruikt worden als basis voor het bouwen van modules voor op XML gebaseerde documenten.

VERTALEN MET PO4A::XML¶

Deze module kan rechtstreeks gebruikt worden voor het verwerken van generieke XML documenten. Zij extraheert al de inhoud uit tags zonder de attributen, omdat daar in de meeste op XML gebaseerde documenten de tekst geschreven staat.

Er zijn bepaalde opties (die in het volgende gedeelte beschreven worden) die dit gedrag kunnen aanpassen. Indien deze module niet beantwoordt aan de indeling van uw document, wordt u aangemoedigd om op basis van deze module uw eigen module te schrijven, met de beschrijving van de details van uw indeling. Raadpleeg het gedeelte AFGELEIDE MODULES SCHRIJVEN, hieronder, voor de beschrijving van de werkwijze.

MOGELIJKE OPTIES BIJ DEZE MODULE¶

De algemene debug-optie doet deze module de uitgesloten tekstfragmenten weergeven, om zo te kunnen zien of ze niets belangrijk overslaat.

De volgende opties zijn specifiek voor deze module:

nostrip

Voorkomt het wegnemen van spaties rond de geëxtraheerde tekstfragmenten.

wrap

Canoniseert het te vertalen tekstfragment vanuit de veronderstelling dat witruimte niet belangrijk is, en past regelafbreking toe voor het vertaalde document. Deze optie kan overstegen worden door aangepaste tag-opties. Zie de optie translated hieronder.

unwrap_attributes

Bij attributen wordt standaard regelafbreking toegepast. Deze optie zet regelafbreking uit.

caseinsensitive

Het zorgt ervoor dat het zoeken naar tags en attributen niet hoofdlettergevoelig gebeurt. Indien dit gedefinieerd wordt zal het <BoeK>taAL en <BOEK>Taal behandelen als <boek>taal.

escapequotes

Aanhalingstekens in uitvoertekstfragmenten maskeren met een maskeerteken. Dit is bijvoorbeeld nodig om tekstfragmentbronmateriaal te creëren dat gebruikt zal worden door bouwgereedschap op Android .

Zie ook: https://developer.android.com/guide/topics/resources/string-resource.html

includeexternal

Als deze optie gedefinieerd werd, worden externe entiteiten meegenomen in het gegenereerde (vertaalde) document en voor het extraheren van tekstfragmenten. Indien ze niet gedefinieerd werd, zult u externe entiteiten afzonderlijk moeten vertalen als onafhankelijke documenten.

ontagerror

Deze optie definieert het gedrag van de module wanneer zij met een ongeldige XML-syntaxis geconfronteerd wordt (een afsluitende tag die niet overeenkomt met de laatste openende tag). Zij kan de volgende waarden hebben:

tagsonly

Opmerking: deze optie is verouderd.

Extraheert enkel die tags welke gespecificeerd werden in de optie "tags". Anders zal ze alle tags extraheren, behalve die welke gespecificeerd werden.

doctype

Tekenreeks waarmee naar een overeenkomst gezocht wordt met de eerste regel van het doctype van het document (voor zover gedefinieerd). Is dit niet succesvol, dan wordt de waarschuwing gegeven dat het document mogelijk van een slecht documenttype is.

addlang

Tekenreeks die het pad (bijv. <bbb><aaa>) aangeeft van een tag waaraan een attribuut lang="..." zal toegevoegd worden. De taal zal gedefinieerd worden als de basisnaam voor het PO-bestand zonder de extensie .po.

optionalclosingtag

Booleaanse operator die aangeeft of afsluitende tags facultatief zijn (zoals bij HTML). Standaard geeft het ontbreken van een afsluitende tag aanleiding tot een fout, die afgehandeld wordt volgens "ontagerror".

tags

Opmerking: deze optie is verouderd. In de plaats daarvan moet u de opties translated en untranslated gebruiken.

Door spaties gescheiden lijst met tags die u wilt vertalen of overslaan. Standaard worden de opgegeven tags uitgesloten, maar indien u de optie "tagsonly" gebruikt, zullen de gespecificeerde tags de enige zijn die opgenomen worden. De tags moeten de vorm <aaa> hebben, maar u kunt er samenvoegen (<bbb><aaa>) om aan te geven dat de inhoud van de tag <aaa> enkel vertaald zal worden wanneer deze zich binnenin tag <bbb> bevindt.

U kunt ook tag-opties opgeven door bepaalde tekens te plaatsen vooraan aan de tag-hiërarchie. U kunt er bijvoorbeeld 'w' (wrap - regelafbreking) of 'W' (don't wrap - geen regelafbreking) plaatsen om het standaardgedrag te overstijgen dat door de globale optie "wrap" gespecificeerd wordt.

Bijvoorbeeld: W<chapter><title>

attributes

Door spaties gescheiden lijst met tagattributen die u wilt vertalen. U kunt het attribuut opgeven bij zijn naam (bijvoorbeeld "lang"), maar u kunt het laten voorafgaan door een tag-hiërarchie, om aan te geven dat dit attribuut enkel vertaald zal worden wanneer het zich binnen de opgegeven tag bevindt. Bijvoorbeeld: <bbb><aaa>lang specificeert dat het attribuut lang (taal) enkel vertaald zal worden als het zich binnen een tag <aaa> binnenin tag <bbb> bevindt.

foldattributes

Geen attributen vertalen die binnenin de in de tekst geïntegreerde tags (inline tags) staan. In de plaats daarvan alle attributen van een tag vervangen door po4a-id=<id>.

Dit is nuttig wanneer attributen niet vertaald moeten worden, omdat dit de tekstfragmenten voor vertalers eenvoudiger maakt en typefouten vermijdt.

customtag

Door spaties gescheiden lijst met tags die niet als tags mogen worden behandeld. Deze tags worden behandeld als geïntegreerd in de tekst (inline tags) en moeten niet gesloten worden.

break

Door spaties gescheiden lijst met tags die het tekstfragment afbreken. Standaard breken alle tags het fragment af.

De tags moeten de vorm <aaa> hebben, maar u kunt er enkele samenvoegen (<bbb><aaa>), indien enkel rekening gehouden moet worden met een tag wanneer deze zich binnen een andere tag (<bbb>) bevindt.

Merk op dat een tag slechts vermeld mag worden bij één van de volgende instellingsreeksen: break, inline placeholder of customtag.

inline

Door spaties gescheiden lijst met tags die behandeld moeten worden als geïntegreerd in de tekst (inline tag). Standaard sluit elke tag een tekstfragment af.

De tags moeten de vorm <aaa> hebben, maar u kunt er enkele samenvoegen (<bbb><aaa>), indien enkel rekening gehouden moet worden met een tag wanneer deze zich binnen een andere tag (<bbb>) bevindt.

placeholder

Door spaties gescheiden lijst met tags die als tijdelijke aanduiding (placeholder) moeten worden behandeld. Tijdelijke aanduidingen sluiten geen tekstfragment af, maar de inhoud van tijdelijke aanduidingen wordt apart vertaald.

De plaats van de tijdelijke aanduiding (placeholder) in zijn tekstblok wordt gemarkeerd met een tekenreeks die vergelijkbaar is met:

  <placeholder type=\"footnote\" id=\"0\"/>
    

De tags moeten de vorm <aaa> hebben, maar u kunt er enkele samenvoegen (<bbb><aaa>), indien enkel rekening gehouden moet worden met een tag wanneer deze zich binnen een andere tag (<bbb>) bevindt.

break-pi

Standaard worden verwerkingsinstructies (d.w.z. tags in de vorm van "<? ... ?">) behandeld als in de tekst geïntegreerde tags (inline tags). Geef deze optie mee als u wilt dat verwerkingsinstructies behandeld worden als tags die een tekstfragment afsluiten. Merk op dat onverwerkte PHP-tags door de ontleder behandeld worden als verwerkingsinstructies.

nodefault

Door spaties gescheiden lijst met tags die de module niet standaard in een categorie zou moeten proberen te plaatsen.

Als u een tag heeft die door de subklasse van deze module zijn standaardinstelling krijgt, maar u een alternatieve instelling wilt instellen, moet u die tag vermelden als onderdeel van de instellingsreeks nodefault.

cpp

C-preprocessorinstructies ondersteunen. Indien deze optie ingesteld is, zal po4a preprocessorinstructies beschouwen als alinea-afbrekers. Dit is belangrijk wanneer het XML-bestand moet voorbewerkt worden, omdat deze instructies anders geplaatst zouden kunnen worden in het midden van een regel mocht po4a ze beschouwen als behorend tot de huidige alinea, waardoor ze niet herkend zouden worden door de preprocessor. Merk op dat de preprocessorinstructies enkel tussen tags mogen staan (zij mogen geen tag verbreken).

translated

Door spaties gescheiden lijst met tags die u wilt vertalen.

De tags moeten de vorm <aaa> hebben, maar u kunt er enkele samenvoegen (<bbb><aaa>), indien enkel rekening gehouden moet worden met een tag wanneer deze zich binnen een andere tag (<bbb>) bevindt.

U kunt ook een aantal tag-opties opgeven door bepaalde tekens te plaatsen vóór de tag-hiërarchie. Dit overstijgt het standaardgedrag dat gespecificeerd wordt door de algemene opties wrap en defaulttranslateoption.

  * Tags vermeld in B<break> worden ingesteld op I<w> of I<W> afhankelijk van de optie <wrap>.
  * Tags vermeld in B<inline> worden ingesteld op I<i>.
  * Tags vermeld in B<placeholder> worden ingesteld op I<p>.
  * Tags vermeld in B<untranslated> worden op geen van deze opties ingesteld.

untranslated

Door spaties gescheiden lijst met tags die u niet wilt vertalen.

De tags moeten de vorm <aaa> hebben, maar u kunt er enkele samenvoegen (<bbb><aaa>), indien enkel rekening gehouden moet worden met een tag wanneer deze zich binnen een andere tag (<bbb>) bevindt.

Merk op dat een in de tekst geïntegreerde (inline) vertaalbare tag binnenin een niet-vertaalde tag, behandeld wordt als een vertaalbare tag die een tekstfragment afsluit; de instelling i wordt verwijderd en w of W wordt ingesteld, afhankelijk van de optie <wrap>.

defaulttranslateoption

De standaardcategorieën voor tags die niet behoren tot een van deze categorieën: translated, untranslated, break, inline, en placeholder.

Dit is een reeks letters, zoals in translated gedefinieerd, en deze instelling is alleen geldig voor vertaalbare tags.

AFGELEIDE MODULES SCHRIJVEN¶

  $self->{options}{'new_option'}='';
  $self->SUPER::initialize(%options);
  $self->{options}{'_default_translated'}.=' <p> <head><title>';
  $self->{options}{'attributes'}.=' <p>lang id';
  $self->{options}{'_default_inline'}.=' <br>';
  $self->treat_options;

  sub found_string {
    my ($self,$text,$ref,$options)=@_;
    $text = $self->translate($text,$ref,"type ".$options->{'type'},
      'wrap'=>$self->{options}{'wrap'});
    return $text;
  }

INTERNE FUNCTIES welke gebruikt worden voor het schrijven van afgeleide ontleders¶

STATUS VAN DEZE MODULE¶

Deze module kan tags en attributen vertalen.

TO-DOLIJST¶

DOCTYPE (ENTITEITEN)

De vertaling van entiteiten wordt minimaal ondersteund. Entiteiten worden in hun geheel vertaald en met tags wordt geen rekening gehouden. Entiteiten die meerdere regels beslaan worden niet ondersteund en tijdens de vertaling wordt steeds regelafbreking toegepast.

TAG-TYPES UIT OVERGEËRFDE MODULES WIJZIGEN ( de structuur tag_type binnen de hash $self verplaatsen?)

ZIE OOK¶

Locale::Po4a::TransTractor(3pm), po4a(7)

AUTEURS¶

 Jordi Vilalta <jvprat@gmail.com>
 Nicolas François <nicolas.francois@centraliens.net>

COPYRIGHT EN LICENTIE¶

 Copyright © 2004 Jordi Vilalta  <jvprat@gmail.com>
 Copyright © 2008-2009 Nicolas François <nicolas.francois@centraliens.net>

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