Ajout d’un paramètre régional pour Forms adaptatif basé sur les composants principaux supporting-new-locales-for-adaptive-forms-localization

Version
Lien de l’article
Composants de base
Cliquez ici
Composants principaux
Cet article

La fonctionnalité de prise en charge de la langue de droite à gauche est disponible dans le programme des premiers adopteurs. Vous pouvez écrire à aem-forms-ea@adobe.com à partir de votre adresse e-mail officielle pour rejoindre le programme d’adoption précoce et demander l’accès à la fonctionnalité.

AEM Forms fournit une prise en charge immédiate des paramètres régionaux en anglais (en), espagnol (es), français (fr), italien (it), allemand (de), japonais (ja), portugais du Brésil (pt-BR), chinois (zh-CN), chinois taïwanais (zh-TW) et coréen (ko-KR). Vous pouvez également ajouter la prise en charge d’autres paramètres régionaux, comme Hindi(hi_IN). Vous pouvez également présenter Adaptive Forms dans une langue de droite à gauche (RTL) telle que l’arabe, le persan et l’ourdou en ajoutant ces paramètres régionaux.

Comment AEM Forms détermine-t-il les paramètres régionaux d’un formulaire adaptatif ?

Pour une localisation correcte, il est essentiel de comprendre comment AEM Forms sélectionne les paramètres régionaux du rendu d’un formulaire adaptatif. Voici une répartition du processus de sélection :

Sélection des paramètres régionaux en fonction de la priorité

AEM Forms donne la priorité aux méthodes suivantes pour déterminer les paramètres régionaux d’un formulaire adaptatif :

  1. Sélecteur de paramètres régionaux de l’URL ([locale]) :

    Le système donne la priorité aux paramètres régionaux spécifiés dans l’URL à l’aide du sélecteur [locale] . Ce format permet la mise en cache pour de meilleures performances.

    Format : l’URL suit ce format : http:/[URL du serveur AEM Forms]/content/forms/af/[afName].[locale].html?wcmmode=disabled.

    Exemple : https://[server]/content/forms/af/contact-us.hi.html effectue le rendu du formulaire en hindi.

  2. Paramètre de requête afAcceptLang :

    Pour remplacer les paramètres régionaux du navigateur de l’utilisateur, vous pouvez utiliser le paramètre afAcceptLang dans l’URL.

    Exemple : https://[server]/forms/af/survey.ca-fr.html?afAcceptLang=ca-fr force le rendu du formulaire en français canadien.

  3. Paramètre régional du navigateur de l’utilisateur (en-tête Accept-Language) :

    Si aucun autre paramètre régional n’est spécifié, AEM Forms prend en compte le paramètre régional du navigateur de l’utilisateur envoyé à l’aide de l’en-tête Accept-Language.

Mécanisme de secours :

  • Si une bibliothèque cliente (processus d’ajout d’un nouveau paramètre régional, comme expliqué plus loin dans ce document) pour le paramètre régional requis n’est pas disponible, AEM Forms recherche une bibliothèque en fonction du code de langue dans le paramètre régional.

    Exemple : si en_ZA (anglais d’Afrique du Sud) est demandé et qu’il n’existe pas de bibliothèque en_ZA, il utilise en (anglais) s’il est disponible.

    Si aucune bibliothèque cliente appropriée n’est trouvée, le dictionnaire par défaut (principalement en) pour le langage de création du formulaire est utilisé.

    En l’absence d’informations sur les paramètres régionaux, le formulaire adaptatif s’affiche dans la langue d’origine utilisée lors du développement.

Conditions préalables pour l’ajout d’un paramètre régional

Avant de commencer à ajouter un nouveau paramètre régional pour votre Forms adaptatif, vérifiez que vous disposez des éléments suivants :

Logiciel :

  • Éditeur de texte brut (IDE) : bien que tout éditeur de texte brut puisse fonctionner, un environnement de développement intégré (IDE) comme Microsoft Visual Studio Code offre des fonctionnalités avancées pour faciliter la modification.

  • Git : ce système de contrôle de version est nécessaire pour gérer les modifications de code. Si vous ne l'avez pas installé, téléchargez-le depuis https://git-scm.com.

Référentiel de code :

Cloner le référentiel des composants principaux de Forms adaptatif : vous avez besoin d’une bibliothèque cliente à partir de ce référentiel pour ajouter un paramètre régional. Pour cloner le référentiel :

  1. Ouvrez la ligne de commande ou la fenêtre de terminal.

  2. Accédez à l’emplacement souhaité sur votre ordinateur où stocker le référentiel (par exemple, /adaptive-forms-core-components).

  3. Exécutez la commande suivante pour cloner le référentiel :

    code language-none
    git clone https://github.com/adobe/aem-core-forms-components.git
    

    Cette commande télécharge le référentiel et crée un dossier nommé aem-core-forms-components sur votre ordinateur. Dans ce guide, nous nous référons à ce dossier en tant que [Adaptive Forms Core Components repository]

Ajouter un paramètre régional add-localization-support-for-non-supported-locales

Pour ajouter la prise en charge de nouveaux paramètres régionaux à un formulaire adaptatif en fonction des composants principaux, procédez comme suit :

Clonage de votre référentiel Git AEM as a Cloud Service

  1. Ouvrez la ligne de commande et choisissez un répertoire pour stocker votre référentiel AEM as a Cloud Service, tel que /cloud-service-repository/.

  2. Exécutez la commande ci-dessous pour cloner le référentiel :

    code language-shell
    git clone https://git.cloudmanager.adobe.com/<organization-name>/<program id>/
    

    Pour cloner votre référentiel Git, vous avez besoin d’informations :

    • Nom de l’organisation : cela identifie votre équipe ou votre projet dans Adobe Experience Manager as a Cloud Service (AEM as a Cloud Service).

    • ID de programme : indique le programme associé à votre référentiel.

    • Credentials : vous avez besoin d’un nom d’utilisateur et d’un mot de passe (ou d’un jeton d’accès personnel) pour accéder au référentiel en toute sécurité.

    Où trouver ces informations ?

    Pour obtenir des instructions détaillées sur la localisation de ces détails, reportez-vous à l’article de Adobe Experience League "Accès à Git".

    Votre projet est prêt !

    Une fois la commande terminée, un nouveau dossier est créé dans votre répertoire local. Ce dossier porte le nom de votre programme (par exemple, program-id). Ce dossier contient tous les fichiers et le code téléchargés à partir de votre référentiel Git AEM as a Cloud Service.

    Dans ce guide, nous nous référons à ce dossier sous le nom de [AEMaaCS project directory].

Ajouter le nouveau paramètre régional au Guide Localization Service

  1. Ouvrez le dossier du référentiel dans un éditeur.

    Dossier Référentiel dans un éditeur

  2. Recherchez le fichier Guide Localization Service.cfg.json. Ce fichier contrôle les paramètres régionaux pris en charge par votre application AEM Forms. Vous pouvez modifier ce fichier pour ajouter un nouveau paramètre régional.

    • Fichier existant : si le fichier existe déjà, localisez-le dans votre répertoire de projet AEM Forms. L’emplacement type est :

      code language-shell
      [AEMaaCS project directory]/ui.config/src/main/content/jcr_root/apps/<appid>/osgiconfig/config`.
      

      Remplacez <appid> par l’ID d’application spécifique à votre projet. Vous pouvez trouver <appid> pour votre projet AEM dans le fichier archetype.properties .

      Propriétés de l’archétype

    • Nouveau fichier : si le fichier n’existe pas, vous devez le créer au même emplacement que celui mentionné ci-dessus. Ne copiez pas le nom du fichier à partir de ce document, mais saisissez-le manuellement. Le nom de fichier Guide Localization Service.cfg.json comprend des espaces. Il s’agit d’une faute intentionnelle et non d’une faute de frappe dans la documentation.

      Voici un exemple de fichier avec la liste des paramètres régionaux OOTB pris en charge :

      code language-none
          {
              "supportedLocales":[
              "en",
              "fr",
              "de",
              "ja",
              "pt-br",
              "zh-cn",
              "zh-tw",
              "ko-kr",
              "it",
              "es"
              ]
          }
      
  3. Ajoutez le code de paramètres régionaux correspondant à la langue souhaitée au fichier.

    1. Utilisez la Liste des codes ISO 639-1 pour trouver le code à deux lettres représentant la langue souhaitée.

    2. Insérez le code de paramètres régionaux dans le fichier Guide Localization Service.cfg.json. Voici quelques exemples :

      • Langues écrites de gauche à droite :

        • Anglais (Etats-Unis) : en-US
        • Espagnol (Espagne) : es-ES
        • Français (France) : fr-FR
      • Langues écrites de droite à gauche :

        • Arabe (Emirats arabes unis) : ar-ae
        • Hébreu : he (ou iw pour référence historique)
        • Farsi : fa
  4. Après avoir apporté des modifications, assurez-vous que le fichier Guide Localization Service.cfg.json est correctement formaté en tant que fichier JSON valide. Des erreurs de mise en forme JSON peuvent l’empêcher de fonctionner correctement. Enregistrez le fichier.

Utilisation de l’exemple de bibliothèque cliente pour faciliter l’ajout de paramètres régionaux

AEM Forms fournit un exemple de bibliothèque cliente utile, clientlib-it-custom-locale, pour simplifier l’ajout de nouveaux paramètres régionaux. Cette bibliothèque fait partie du référentiel des composants principaux de Forms adaptatif, disponible sur GitHub.

Avant de commencer, assurez-vous d’avoir une copie locale du [référentiel des composants principaux de Forms adaptatif]. Sinon, vous pouvez facilement le cloner à l’aide de Git avec la commande suivante :

git clone https://github.com/adobe/aem-core-forms-components.git

Cette commande télécharge l’ensemble du référentiel, y compris la bibliothèque clientlib-it-custom-locale, dans un répertoire nommé aem-core-forms-components sur votre ordinateur.

Répertoire du référentiel des composants principaux de Forms adaptatif sur l’ordinateur local

Intégration de l’exemple de bibliothèque cliente

Maintenant, incorporons la bibliothèque clientlib-it-custom-locale dans votre répertoire de projet AEM as a Cloud Service, [AEMaaCS project directory] :

  1. Recherchez l’exemple de bibliothèque cliente :

    Dans votre copie locale du [référentiel des composants principaux de Forms adaptatif], accédez au chemin suivant :

    code language-none
        /aem-core-forms-components/it/apps/src/main/content/jcr_root/apps/forms-core-components-it/clientlibs
    
  2. Copiez et collez la bibliothèque :

    1. Copiez le dossier clientlib-it-custom-locale.

      Copie de clientlib-it-custom-locale

    2. Accédez au répertoire suivant dans votre [ répertoire de projet AEMaaCS ] :

      code language-none
      /ui.apps/src/main/content/jcr_root/apps/<app-id>/clientlib
      

      Important : remplacez <app-id> par l’identifiant réel de votre application.

    3. Collez le dossier clientlib-it-custom-locale copié dans ce répertoire.

      Collage de clientlib-it-custom-locale

Créez un fichier pour vos nouveaux paramètres régionaux :

  1. Accédez au répertoire de paramètres régionaux :

    Dans votre [AEMaaCS project directory], accédez au chemin suivant :

    code language-none
        /ui.apps/src/main/content/jcr_root/apps/<program-id>/clientlibs/clientlib-it-custom-locale/resources/i18n/
    

    Important : remplacez <program-id> par votre ID d’application réel.

  2. Recherchez l’exemple de fichier en anglais :

    AEM Forms fournit un exemple de fichier de paramètres régionaux anglais (.json) sur GitHub.

    Le fichier en anglais comprend l’ensemble de chaînes par défaut à titre de référence. Votre fichier spécifique au paramètre régional doit imiter la structure du fichier en anglais.

    Pour les langues comme l'arabe, l'hébreu et le farsi, le texte se lit de droite à gauche (RTL) au lieu de gauche à droite (LTR) comme l'anglais. Pour vous assurer que vos formulaires s’affichent correctement dans ces langues, nous vous recommandons d’utiliser nos exemples de fichiers de paramètres régionaux comme guide. Ces fichiers fournissent une référence pour la mise en forme du texte, des dates et d’autres éléments pour les langues RTL. Vous trouverez des exemples de fichiers de paramètres régionaux pour :

    En exploitant ces fichiers d’exemple, vous pouvez vous assurer que vos formulaires offrent une expérience transparente aux utilisateurs travaillant dans des langues RTL.

  3. Créez votre fichier de paramètres régionaux :

    1. Créez un fichier .json dans le répertoire i18n.
    2. Nommez le fichier à l’aide du code de paramètres régionaux correspondant à la langue souhaitée (par exemple, fr-FR.json pour le français et ar-ae.json pour l’arabe). La structure de ce fichier doit refléter le fichier de paramètres régionaux anglais.
  4. Structure et traduction :

    1. Ouvrez le fichier nouvellement créé dans un éditeur de texte.

    2. Remplacez les valeurs anglaises par les traductions correspondantes pour votre langue cible.

    3. Une fois la traduction des chaînes terminée, enregistrez le fichier.

Ajout de la prise en charge des paramètres régionaux au dictionnaire

Cette étape s’applique uniquement aux langues autres que les suivantes couramment prises en charge : anglais (en), allemand (de), espagnol (es), français (fr), italien (it), portugais brésilien (pt-br), chinois (simplifié - zh_cn), chinois (traditionnel - zh_tw), japonais (ja) et coréen (ko_kr).

  1. Recherchez le dossier de configuration :

    Accédez au répertoire suivant dans votre [répertoire de projet AEMaaCS] :

    code language-none
    /ui.content/src/main/content/jcr_root/etc
    
  2. Créez les dossiers nécessaires (le cas échéant) :

    Si le dossier etc n’existe pas dans le dossier jcr_root, créez-le. Dans etc, créez un autre dossier nommé languages s'il manque.

  3. Créez le fichier de configuration des paramètres régionaux :

    Dans le dossier languages, créez un fichier nommé .content.xml. Ne copiez pas le nom du fichier à partir de ce document, mais saisissez-le manuellement.

    créez un nouveau fichier nommé

    Ouvrez ce fichier et collez le contenu suivant, en remplaçant [LOCALE_CODE] par le code de paramètres régionaux réel (par exemple, ar-ae pour l’arabe).

    code language-xml
    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
          jcr:primaryType="nt:unstructured"
          languages="[de,es,fr,it,pt-br,zh-cn,zh-tw,ja,ko-kr,hi]"/>
    

    AVERTISSEMENT : ne remplacez pas la liste existante. Ajoutez plutôt votre nouveau code de paramètres régionaux entre crochets, séparés par des virgules, comme illustré ci-dessous (à l’aide de ar-ae comme exemple) :

    code language-xml
    languages="[de,es,fr,it,pt-br,zh-cn,zh-tw,ja,ko-kr,hi,ar-ae]"
    
  4. Incluez les nouveaux dossiers dans filter.xml :

    Accédez au fichier /ui.content/src/main/content/meta-inf/vault/filter.xml dans votre [ répertoire de projet AEMaaCS].

    Ouvrez le fichier et ajoutez la ligne suivante à la fin :

    code language-none
    <filter root="/etc/languages"/>
    

    Ajoutez les dossiers créés dans le sous

  5. Enregistrez le fichier.

Déployer les paramètres régionaux nouvellement créés dans votre environnement AEM

Vous êtes maintenant prêt à utiliser le nouveau paramètre régional avec votre Forms adaptatif. Vous pouvez

  • Déployez le [répertoire de projet AEMaaCS] d’AEM as a Cloud Service dans votre environnement de développement local pour essayer la nouvelle configuration des paramètres régionaux sur votre ordinateur local. Pour effectuer un déploiement sur votre environnement de développement local :

    1. Assurez-vous que votre environnement de développement local est opérationnel. Si vous n’avez pas encore configuré d’environnement de développement local, reportez-vous au guide sur la configuration de l’environnement de développement local pour AEM Forms.

    2. Ouvrez la fenêtre de terminal ou l’invite de commande.

    3. Accédez au [ répertoire du projet AEMaaCS]

    4. Exécutez la commande suivante :

      code language-none
      mvn -PautoInstallPackage clean install
      
  • Déployez le [répertoire de projet AEMaaCS] d’AEM as a Cloud Service dans votre environnement de Cloud Service. Pour effectuer un déploiement sur votre environnement de Cloud Service :

    1. Validez vos modifications :

      Après avoir ajouté la nouvelle configuration de paramètres régionaux, validez vos modifications avec un message Git clair décrivant l’ajout de paramètres régionaux (par exemple, "Ajout de la prise en charge de [Nom de paramètre régional]").

    2. Déployer le code mis à jour :

      Déclenchez un déploiement de votre code par le biais du pipeline de pile complète existant. Cette opération génère et déploie automatiquement le code mis à jour avec la nouvelle prise en charge des paramètres régionaux.

      Si vous n’avez pas encore configuré de pipeline, reportez-vous au guide sur la configuration d’un pipeline pour AEM Forms as a Cloud Service🔗.

Aperçu d’un formulaire adaptatif avec les paramètres régionaux nouvellement ajoutés

Ces étapes vous guident tout au long de l’aperçu d’un formulaire adaptatif avec les paramètres régionaux nouvellement ajoutés :

  1. Connectez-vous à votre instance AEM Forms as a Cloud Service.
  2. Accédez à Formulaires > Formulaires et documents.
  3. Sélectionnez un formulaire adaptatif, puis cliquez sur Ajouter un dictionnaire. L’assistant Ajouter un dictionnaire au projet de traduction s’affiche.
  4. Spécifiez le Titre du projet et sélectionnez les Langues cibles dans le menu déroulant de l’assistant Ajouter un dictionnaire au projet de traduction.
  5. Cliquez sur Terminé et exécutez le projet de traduction créé.
  6. Accédez à Formulaires > Formulaires et documents.
  7. Sélectionnez le formulaire adaptatif et choisissez l’option Aperçu en tant qu’HTML .
  8. Ajoutez &afAcceptLang=<locale-name> à l’URL de prévisualisation et appuyez sur la touche Entrée. Remplacez <locale-name> par votre code de paramètres régionaux réel. Le formulaire adaptatif s’affiche dans les paramètres régionaux spécifiés.

Bonnes pratiques pour la prise en charge d’une nouvelle localisation best-practices

  • Adobe recommande de créer un projet de traduction après la création d’un formulaire adaptatif. Cela simplifie le processus de localisation.

  • Lorsque les composants Zone numérique et Sélecteur de date sont traduits dans un paramètre régional spécifique, des problèmes de mise en forme peuvent se produire. Pour atténuer ce problème, une option Langue a été incorporée dans la boîte de dialogue de configuration de composant Sélecteur de date et composant Zone numérique.

  • Gestion des nouveaux champs :

    • Traduction automatique : si vous utilisez la traduction automatique, vous devez recréer le dictionnaire et exécuter à nouveau le projet de traduction🔗 après avoir ajouté de nouveaux champs à un formulaire adaptatif existant. Les nouveaux champs ajoutés après le projet de traduction initial restent non traduits.

    • Traduction humaine : pour les processus de traduction humaine, exportez le dictionnaire à l’aide de l’interface utilisateur à l’adresse [AEM Forms Server]/libs/cq/i18n/gui/translator.html. Mettez à jour le dictionnaire des nouveaux champs et téléchargez la version révisée.

Voir également see-also

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab