NOM¶

Locale::Po4a::AsciiDoc - Convertir les documents AsciiDoc depuis ou vers des fichiers PO

DESCRIPTION¶

L’objectif du projet po4a [PO for anything — PO pour tout] est de simplifier la traduction (et de façon plus intéressante, la maintenance des traductions) en utilisant les outils gettext dans des domaines pour lesquels ils n’étaient pas destinés, comme la documentation.

Locale::Po4a::AsciiDoc est un module qui permet d’aider la traduction de documentations au format AsciiDoc.

OPTIONS ACCEPTÉES PAR CE MODULE¶

Voici les options particulières à ce module :

definitions

Le nom d’un fichier contenant des définitions pour po4a, telles qu’elles sont décrites dans la section PERSONNALISATION EN LIGNE. Vous pouvez utiliser cette option s’il n’est pas possible de placer les définitions dans le document à traduire.

Dans un fichier de définitions, les lignes ne doivent pas commencer par deux barres obliques, mais directement par po4a:.

entry

Liste d’entrées d’attribut, séparées par des espaces, que vous souhaitez traduire. Par défaut, aucune entrée d’attribut ne peut être traduite.

macro

Liste de définitions de macro, séparées par des espaces.

style

Liste de définitions de style, séparées par des espaces.

forcewrap

Activer le retour à la ligne automatique dans les blocs non textuels, même si le résultat peut être mal interprété par les convertisseurs AsciiDoc.

Par défaut, po4a n'ajoutera pas de retour à la ligne dans les fichiers AsciiDoc produits car une inspection manuelle est requise pour s'assurer que ceci ne modifie pas le formatage. Considérez par exemple l'élément de liste suivant :

 * une longue phrase qui finit par un nombre 1. Une deuxième phrase.
    

Si l'habillage mène à la présentation suivante, l'élément est divisé en une sous-liste numérotée. Pour aggraver les choses, seuls les locuteurs de la langue utilisée dans la traduction peuvent inspecter la situation.

 * une longue phrase qui finit par un nombre
   1. Une deuxième phrase.
    

Notez que ne pas rajouter de retour à la ligne dans les fichiers produits par po4a ne devrait pas être un problème puisque ces fichiers sont destinés à être traités automatiquement. Ils ne doivent de toute façon pas être considérés comme des fichiers source.

Avec cette option, po4a produira des fichiers AsciiDoc plus lisibles, mais ceci peut conduire éventuellement à des sorties formatées erronées.

noimagetargets

Par défaut, les cibles de blocs images sont traduisibles pour donner la possibilité de faire pointer le contenu vers des images traduites. Ceci peut être empêché en définissant cette option.

tablecells

Cette option est un indicateur qui active la segmentation des sous-tableaux en contenu de cellule. La segmentation est limitée au contenu de la cellule, sans aucune analyse à l'intérieur de celle-ci.

compat

Bascule les règles d'analyse sur la compatibilité avec différents outils. Les options disponibles sont "asciidoc" ou "asciidoctor". Asciidoctor a des règles d'analyse plus strictes, telles que l'égalité de longueur des marques d'ouverture et de fermeture des blocs de code.

nolinting

Désactiver les messages de vérification. Lorsque le code source ne peut pas être corrigé pour une structure de document plus claire, ces messages sont inutiles.

cleanspaces

Supprime les espaces supplémentaires des segments source en mode "no-wrap". Ceci est utile lorsque les outils de traduction sont sensibles au nombre d'espaces.

yfm_keys

Liste des clés à traiter, séparées par des virgules, pour la traduction de la section d'en-tête YAML. Toutes les autres clés sont ignorées. Les clés sont associées avec une correspondance sensible à la casse. Si yfm_paths et yfm_keys sont utilisées ensemble, les valeurs sont incluses si elles correspondent à au moins une des options. Les valeurs du tableau sont toujours traduites, sauf si l'option yfm_skip_array est fournie.

yfm_skip_array

Ne pas traduire les valeurs des tableaux dans la section préliminaire de YAML.

yfm_paths

Liste des chemins de hachage à traiter, séparées par des virgules, pour l'extraction de la section d'en-tête YAML. Tous les autres chemins sont ignorés. Les chemins sont associés avec une correspondance sensible à la casse. Si yfm_paths et yfm_keys sont utilisées ensemble, les valeurs sont incluses si elles correspondent à au moins une des options. Les valeurs des tableaux sont toujours retournées, sauf si l'option yfm_skip_array est fournie.

PERSONNALISATION EN LIGNE¶

Le module AsciiDoc peut être personnalisé à l’aide de lignes commençant par //po4a:. Ces lignes sont interprétées comme des commandes pour l’analyseur. Les commandes suivantes sont reconnues :

//po4a: macro nom[liste d’attributs]

Ceci décrit en détail les paramètres d’une macro. Le nom doit être un nom de macro existant, et se termine par un tiret bas si la cible doit être traduite.

L’argument liste d’attributs est une liste, séparées par des virgules, qui contient des renseignements sur les argument traduisibles. Cette liste contient soit des nombres, pour définir des paramètres positionnels, soit des attributs nommés.

Si un signe plus (+) précède le nom, alors la macro et ses arguments sont traduits comme un ensemble. Il n’est pas nécessaire de définir de liste d’attributs dans ce cas, mais les crochets doivent être présents.

//po4a: style [liste d’attributs]

Ceci décrit en détail quels attributs d'un style doivent être traduits.

L’argument liste d’attributs est une liste, séparées par des virgules, qui contient des informations sur les argument traduisibles. Cette liste contient soit des nombres, pour définir des paramètres positionnels, soit des attributs nommés. Le premier attribut est le nom du style, il ne sera pas traduit.

Si un signe plus (+) précède le nom du style, alors la liste d’attributs est traduite comme un ensemble. Il n’est pas nécessaire de définir les attributs à traduire dans ce cas.

Si un signe moins (-) précède le nom du style, alors cet attribut n’est pas traduit.

//po4a: entry nom

Cela déclare une entrée d’attribut à traduire. Par défaut, elles ne sont pas traduites.

ÉTAT DE CE MODULE¶

Testé avec succès sur des fichiers AsciiDoc simples.

AUTEURS¶

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

TRADUCTION¶

 Martin Quinson (mquinson#debian.org)

COPYRIGHT ET LICENCE¶

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

Ce programme est un logiciel libre ; vous pouvez le copier et / ou le modifier sous les termes de la GPL v2.0 ou suivante (voir le fichier COPYING).