Extraction de chaînes pour la traduction

Utilisez xgettext-maven-plugin pour extraire de votre code source les chaînes qui doivent être traduites. Le module externe Maven extrait les chaînes dans un fichier XLIFF que vous envoyez en traduction. Les chaînes sont extraites aux emplacements suivants :

  • Fichiers sources Java.
  • Fichiers sources JavaScript
  • Représentations XML de ressources SVN (nœuds JCR)

Configuration de l’extraction de chaînes

Configurez la manière dont l’outil xgettext-maven-plugin extrait des chaînes pour votre projet.

/filter { }
/parsers {
   /vaultxml { }
   /javascript { }
   /regexp {
      /files {
         /java { }
         /jsp { }
         /extjstemplate { }
      }
   }
}
/potentials { }
Section Description
/filter Identifie les fichiers analysés.
/parsers/vaultxml Configure l'analyse des fichiers Vault. Identifie les nœuds JCR contenant des indices de localisation et des chaînes externalisées. Identifie également les nœuds JCR à ignorer.
/parsers/javascript Identifie les fonctions JavaScript qui externalisent les chaînes. Il n’est pas nécessaire de modifier cette section.
/parsers/regexp Configure l’analyse des fichiers Java, JSP et modèle ExtJS. Il n’est pas nécessaire de modifier cette section.
/potentiels La formule de détection des chaînes à internationaliser.

Identification des fichiers à analyser

La section /filter du fichier i18n.any identifie les fichiers analysés par l’outil xgettext-maven-plugin. Ajoutez plusieurs règles d’inclusion et d’exclusion qui identifient les fichiers qui sont analysés et ignorés, respectivement. Vous devez inclure tous les fichiers, puis exclure ceux que vous ne souhaitez pas analyser. En règle générale, vous excluez les types de fichiers qui n’appartiennent pas à l’interface utilisateur ou ceux qui définissent l’interface utilisateur, mais qui ne sont pas traduits. Les règles d’inclusion et d’exclusion présentent le format suivant :

{ /include "pattern" }
{ /exclude "pattern" }

La partie « pattern » d’une règle est utilisée pour faire correspondre les noms des fichiers à inclure ou à exclure. Le préfixe de motif indique si vous effectuez une correspondance avec un nœud JCR (sa représentation dans Vault) ou le système de fichiers.

Préfixe Effet
/ Indique un chemin JCR. Par conséquent, ce préfixe correspond aux fichiers situés dans le répertoire jcr_root.
* Indique un fichier normal sur le système de fichiers.
none Aucun préfixe, ou modèle commençant par un nom de dossier ou de fichier, n’indique un fichier normal sur le système de fichiers.

Lorsqu'il est utilisé dans un modèle, le caractère / indique un sous-répertoire et * correspond à all. Le tableau suivant répertorie plusieurs exemples de règles.

Exemple de règle Effet
{ /include "*" } Incluez tous les fichiers.
{ /exclude "*.pdf" } Exclure tous les fichiers PDF.
{ /exclude "*/pom.xml" } Exclure les fichiers POM.
{ /exclude "/content/*?lang=fr" } { /include "/content/catalogs/geometrixx/templatepages?lang=fr" } { /include "/content/catalogs/geometrixx/templatepages/*?lang=fr" }

Exclure tous les fichiers situés sous le noeud /content.

Incluez le noeud /content/catalogs/geometrixx/modèles.

Incluez tous les noeuds enfants de /content/catalogs/geometrixx/modèles.

Extraction des chaînes

Aucun POM :

mvn -N com.adobe.granite.maven:xgettext-maven-plugin:1.2.2:extract  -Dxgettext.verbose=true -Dxgettext.target=out -Dxgettext.rules=i18n.any -Dxgettext.root=.

Avec un POM : ajoutez ceci au POM :

<build>
    <plugins>
        <plugin>
            <groupId>com.adobe.granite.maven</groupId>
            <artifactId>xgettext-maven-plugin</artifactId>
            <version>1.1</version>
            <configuration>
                <rules>i18n.any</rules>
                <root>jcr_root</root>
                <xliff>cq.xliff</xliff>
                <verbose>true</verbose>
            </configuration>
        </plugin>
    </plugins>
</build>

La commande :

mvn xgettext:extract

Fichiers de sortie

  • raw.xliff: chaînes extraites

  • warn.log: avertissements (le cas échéant), si CQ.I18n.getMessage() l’API est utilisée de manière incorrecte. Une correction est toujours nécessaire, suivie d’une nouvelle exécution.

  • parserwarn.log : avertissements de l’analyseur (le cas échéant) ; problèmes de l’analyseur js, par exemple

  • potentials.xliff : candidats « potentiels » qui ne sont pas extraits, mais il peut s’agir de chaînes lisibles qui doivent être traduites (peuvent être ignorées ; produisent toujours un grand nombre de faux positifs)

  • strings.xliff : fichier xliff aplati, à importer dans ALF

  • backrefs.txt : permet de rechercher rapidement une chaîne donnée dans des emplacements de code source

Sur cette page