Contrôle de la qualité du contenu dans l’éditeur web

Cet article donne un aperçu des possibilités de validation dans l’éditeur web des Guides d’AEM.
Par défaut, l’éditeur web de conception exploite la configuration du schéma DITA dans le système pour obliger les utilisateurs à créer du contenu compatible DITA. Ainsi, tout le contenu stocké dans le système est du contenu DITA structuré, réutilisable et valide.

Outre la prise en charge des règles DITA, l’éditeur web prend également en charge la validation du contenu basé sur "Schéma".

"Schéma" fait référence à un langage de validation basé sur des règles utilisé pour définir des tests pour un fichier XML. Vous pouvez importer les fichiers de schéma et les modifier dans l’éditeur web. À l’aide d’un fichier "Schéma", vous pouvez définir certaines règles, puis les valider pour une rubrique DITA ou un mappage. Les règles de schéma peuvent assurer la cohérence de la structure XML en imposant des restrictions définies comme règles. Ces restrictions sont motivées par les PME qui détiennent la qualité et la cohérence du contenu.

REMARQUE : l’éditeur web prend en charge le schéma ISO.

Fonctionnement de "Schéma" dans l’éditeur web

Configuration des règles de schéma

Reportez-vous à la section "Prise en charge des fichiers de schéma" dans Guide de l’utilisateur

Application des règles de validation à l’enregistrement du fichier

Les paramètres de l’éditeur Web permettent aux utilisateurs expérimentés de configurer des règles/fichiers de schéma qui seront exécutés chaque fois qu’un utilisateur met à jour le contenu. Pour plus d’informations, reportez-vous à la section "Validation" dans Guide de l’utilisateur

Définition de règles à partir des paramètres de l’éditeur web

Pouvez-vous exécuter la validation manuellement ?

Oui, en tant qu’auteur/utilisateur lors de la création de contenu, vous pouvez utiliser le panneau Schéma de l’éditeur de texte web pour charger un fichier de schéma et exécuter des validations sur le fichier ouvert dans l’éditeur.

Pour que cela fonctionne, l’administrateur de profil de dossier doit permettre à tous les utilisateurs d’ajouter des fichiers de schéma dans le panneau Validation. Voir Paramètres de l’éditeur (capture d’écran ci-dessus)

Choisir le fichier de schéma
Exécuter la validation

Règles prises en charge

La version actuelle des Guides d’AEM prend en charge la validation à l’aide de règles basées sur l’affirmation uniquement. (voir ressource/rapport) Les règles basées sur "Rapports" ne sont pas encore prises en charge.

Exemples et plus d’aide sur les règles de schéma

Exemples de cas d’utilisation

  • Vérifier si un lien est externe et s’il a une portée "externe"

    code language-none
    <sch:pattern>
        <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]">
            <sch:assert test="@scope = 'external' and @format = 'html'">
                All external xref links must be with scope='external' and format='html'
            </sch:assert>
        </sch:rule>
    </sch:pattern>
    
  • Vérifiez s’il existe au moins un "topicref" sur une carte ou au moins un "li" sous un "ul"

    code language-none
    <sch:pattern>
        <sch:rule context="map">
            <sch:assert test="count(topicref) > 0">
                There should be atleast one topicref in map
            </sch:assert>
        </sch:rule>
    
        <sch:rule context="ul">
            <sch:assert test="count(li) > 1" >
                A list must have more than one item.
            </sch:assert>
        </sch:rule>
    </sch:pattern>
    
  • L’élément "indexterm" doit toujours être présent dans un "prolog".

    code language-none
    <sch:pattern>
        <sch:rule context="*[contains(@class, ' topic/indexterm ')]">
            <sch:assert test="ancestor::node()/local-name() = 'prolog'">
                The indexterm element should be in a prolog.
            </sch:assert>
        </sch:rule>
    </sch:pattern>
    

Ressources

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178