Groche le 24 avril 2013 à 08:58

2013-04-24T08:58:09Z

← Version précédente		Version du 24 avril 2013 à 08:58
Ligne 131 :		Ligne 131 :

	<references/>		<references/>

	~~[[category:How To]]~~

Groche : Page créée avec « == Utiliser les traductions == On utilise la balise {{tag|i18n:text}} pour insérer une chaîne à traduire. Une chaîne traduite est constituée de : # une chaîne, qui ... »

2013-04-24T08:27:17Z

Page créée avec « == Utiliser les traductions == On utilise la balise {{tag|i18n:text}} pour insérer une chaîne à traduire. Une chaîne traduite est constituée de : # une chaîne, qui ... »

Nouvelle page

== Utiliser les traductions ==

On utilise la balise {{tag|i18n:text}} pour insérer une chaîne à traduire. Une chaîne traduite est constituée de :
# une chaîne, qui sera affichée ;
# une clé ({{attr|key}}), qui identifie de façon unique la chaîne que l'on souhaite affichée ;
# un catalogue ({{attr|catalogue}}), qui indique où l'on va chercher la clé. Si cet attribut n'est pas présent, on cherchera la clé dans le catalogue défini par défaut (cf. {{path|{{app}}/catalogues-i18n.xmap}}).

=== Définition d'une traduction ===

Dans notre catalogue, on ajouter un élément {{tag|message}} pour chaque chaîne :

<syntaxhighlight lang="xml">
<message key="edit.menu.monModule.intro">chaine affiché si tout marche correctement.</message>
</syntaxhighlight>

En indiquant à chaque fois :
* la clé : {{attr|key}} ;
* le contenu de la chaîne à afficher.

=== Utilisation d'une traduction ===

== L'espace de nom {{var|i18n}} ==

Dans la feuille XSL générant notre fichier de sortie, on ajoutera au moins le espace de nom ({{attr|xmlns}}) pour l'{{var|i18n}} :

<syntaxhighlight lang="xml">
<xsl:stylesheet version="2.0"
xmlns:i18n="http://apache.org/cocoon/i18n/2.1"
exclude-result-prefixes="i18n">
</syntaxhighlight>

== Affichage : {{tag|i18n:text}} ==

Puis on insérera notre chaîne de la façon suivante :

<syntaxhighlight lang="xml">
<i18n:text catalogue="module-monModule" key="edit.menu.monModule.intro">
chaîne affichée si le catalogue ou la clé pose problème.
</i18n:text>
</syntaxhighlight>

En précisant bien :
* la clé : {{attr|key}} ;
* le catalogue : {{attr|catalogue}}, si ce n'est pas celui par défault ;
* un contenu de secours si la traduction souhaitée manque.

== Contenu dynamique avec {{tag|i18n:translate}} ==

Cocoon permet l'utilisation de ''placeholder'' pouvant être dynamiquement substituer par des variables. Ceci est possible avec l'élément {{tag|i18n:translate}}.

Il faudra appeler la chaîne dynamique de la façon suivante
:
<syntaxhighlight lang="xml">
<i18n:translate>
<i18n:text catalogue="monCatalogue" key="maCleI18n" >monFallback</i18n:text>
<i18n:param><xsl:value-of select="$monParametre"/></i18n:param>
</i18n:translate>
</syntaxhighlight>

Et définir son contenu avec indiquant le numéro du paramètre en crochets {{value|{#}}} comme suit :

<syntaxhighlight lang="xml">
<message key="maCleI18n">blabla bla <span class="maClass"> ({0})</span></message>
</syntaxhighlight>

{{important|La substitution ne marche pas quand le ''placeholder'' est dans un attribut<ref>[https://issues.apache.org/jira/browse/COCOON-2057 ParamSaxBuffer doesn't substitute params within attribute values]</ref>.

<syntaxhighlight lang="xml">
<message key="maCleI18n">blabla bla <href="{0}/wrong.html" > ({0})</span></message>
</syntaxhighlight>

On se retrouvera donc avec {{value|{#}}} dans le document final et non la chaîne attendue}}

== Ajouter un catalogue ==

=== Catalogue des traductions ===

On commence par créer un nouveau fichier aussi appelé ''catalogue'', dans lequel on définira les clés et les chaînes associées. On place généralement les fichiers de traduction dans {{path|{{app}}/theme/i18n/local/}}. Par exemple on créera le fichier {{path|{{app}}/theme/i18n/local/module-monModule.xml}} avec le contenu minimum suivant :

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<catalogue xmlns:xhtml="http://www.w3.org/1999/xhtml">
<message key="monModule.maCle">La chaine à afficher</message>

</catalogue>
</syntaxhighlight>

=== Déclarer le catalogue à l'application ===

Ensuite, il faut déclarer à l'application la présence de notre nouveau catalogue, de façon à pouvoir trouver les traductions de nos clés. On surchargera le fichier {{path|{{app}}/catalogues-i18n.xmap}} de façon à indiquer à l'application le chemin vers les nouveaux fichiers de traductions.

==== Catalogues et transformeur ====

Le catalogue que vous rajouter doit être placer dans le {{tag|map:transformer}} dont l'attribut {{attr|name}} correspond à celui que vous appeler dans votre pipeline.
Ci-dessous un pipeline faisant appel au transformateur {{value|prefixI18n-normal}} :

<syntaxhighlight lang="xml">
<map:act type="locale">
<map:transform type="prefixI18n-normal">
<map:parameter name="locale" value="{locale}"/>
</map:transform>
</map:act>
</syntaxhighlight>

On déclarera donc notre catalogue dans le transformateur {{value|prefixI18n-normal}} du fichier {{path|{{app}}/catalogues-i18n.xmap}} :

<syntaxhighlight lang="xml">
<map:transformer name="prefixI18n-normal" logger="sitemap.transformer.prefixI18n" src="org.pleade.transformation.PrefixI18nTransformer">
...
</map:transformer>
</syntaxhighlight>

==== Ajout du catalogue ====

Une fois le bon tranformateur trouvé, on rajouter notre catalogue de la façon suivante :

<syntaxhighlight lang="xml">
<catalogue id="module-monModule" name="module-monModule">
<location>${pleade.theme-dir}/i18n/local</location>
<location>${pleade.theme-dir}/i18n</location>
</catalogue>
</syntaxhighlight>

== Voir aussi ==

* [https://cocoon.apache.org/2.1/userdocs/i18nTransformer.html I18n Transformer] (doc officiel)
* [https://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/transformation/I18nTransformer.html Class I18nTransformer] (spécification Java)

== Références ==

<references/>

[[category:How To]]

Cocoon i18n - Historique des versions

Groche le 24 avril 2013 à 08:58

Groche : Page créée avec « == Utiliser les traductions == On utilise la balise {{tag|i18n:text}} pour insérer une chaîne à traduire. Une chaîne traduite est constituée de : # une chaîne, qui ... »

Groche : Page créée avec « == Utiliser les traductions == On utilise la balise {{tag|i18n:text}} pour insérer une chaîne à traduire. Une chaîne traduite est constituée de : # une chaîne, qui ... »