Prise en charge des fichiers Schematron

« 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. L’éditeur prend en charge les fichiers Schematron. Vous pouvez importer les fichiers Schematron et les modifier également dans l'éditeur. À l'aide d'un fichier Schematron, vous pouvez définir certaines règles, puis les valider pour une rubrique DITA ou une carte.

Importer des fichiers Schematron

Pour importer les fichiers Schematron, procédez comme suit :

Validation d'une rubrique ou d'un mappage DITA avec Schematron

Après avoir importé les fichiers Schematron, vous pouvez les modifier dans l'éditeur. Vous pouvez utiliser les fichiers Schematron pour valider les rubriques ou un plan DITA. Par exemple, vous pouvez créer les règles suivantes pour un plan ou une rubrique DITA :

Lorsque vous ouvrez une rubrique dans l’éditeur, un panneau Validation du schéma s’affiche à droite. Effectuez les étapes suivantes pour ajouter et valider une rubrique ou un mappage avec un fichier Schematron :

{width="350"}

La prise en charge de Schematron dans l’éditeur vous aide à valider les fichiers par rapport à un ensemble de règles, tout en préservant la cohérence et l’exactitude des rubriques.

Présentation des résultats de validation et des niveaux de gravité

Les résultats de la validation s’affichent en fonction de l’attribut de rôle défini dans le fichier Schematron. Les événements sont classés en Fatal, Error, Warn ou Info, avec un nombre visible pour chaque catégorie dans le panneau Validation.

{width="350"}

Pour déterminer la gravité d’un problème, la valeur sensible à la casse de l’attribut de rôle défini dans le fichier Schematron correspondant est évaluée.

Le fragment suivant présente les valeurs d’attribut de rôle prises en charge définies dans une règle de schéma :

Si l’attribut de rôle n’est pas spécifié ou si une valeur non prise en charge est utilisée, le problème est classé comme Error dans le panneau Validation . Ce comportement s’applique également aux fichiers Schematron existants qui ne définissent pas d’attribut de rôle. Dans ce cas, tous les problèmes sont regroupés sous Error.

Scénarios d’enregistrement de fichier

L’enregistrement d’un fichier dépend du paramètre Exécuter la vérification de validation avant d’enregistrer le fichier dans les paramètres Workspace :

Utilisez des instructions d’assertion et de rapport pour rechercher des règles schematron-assert-report

Experience Manager Guides prend également en charge les instructions d’assertion et de rapport dans Schematron. Ces instructions vous aident à valider vos rubriques DITA.

Instruction Assert

Une instruction d’assertion génère un message lorsqu’une instruction de test est évaluée sur false. Par exemple, si vous souhaitez que votre titre apparaisse en gras, vous pouvez définir une instruction d’assertion pour celui-ci.

<sch:rule context="title">
    <sch:assert test = "b"> Title should be bold </sch:assert>
  </sch:rule>

Lorsque vous validez vos rubriques DITA avec le Schematron, vous obtenez un message pour les rubriques dont le titre n'est pas en gras.

Instruction du rapport

Une instruction de rapport génère un message lorsqu’une instruction de test est évaluée comme vraie. Par exemple, si vous souhaitez que la description courte comporte moins de 150 caractères ou qu’elle soit égale à 1, vous pouvez définir une instruction de rapport pour vérifier les rubriques dont la description courte comporte plus de 150 caractères.
Lorsque vous validez vos rubriques DITA avec le schéma, vous obtenez un rapport complet des règles où l'instruction du rapport est vraie. Ainsi, vous obtenez un message pour les sujets dont la description courte dépasse 150 caractères.

<sch:rule context="shortdesc">
        <sch:let name="characters" value="string-length(.)"/>
        <sch:report test="$characters &gt; 150">
        The short description has <sch:value-of select="$characters"/> characters. It should contain more than 150 characters.
        </sch:report>
    </sch:rule>

Utilisation d’expressions Regex schematron-regex-espressions

Vous pouvez également utiliser des expressions Regex pour définir une règle avec la fonction matches() , puis effectuer la validation à l’aide du fichier Schematron.

Par exemple, vous pouvez l’utiliser pour afficher un message si le titre ne contient qu’un seul mot.

<assert test="not(matches(.,'^\w+$'))">
No one word titles.
</assert>

Définition de modèles abstraits schematron-abstract-patterns

Experience Manager Guides prend également en charge les modèles abstraits dans Schematron. Vous pouvez définir des modèles abstraits génériques et les réutiliser. Vous pouvez créer des paramètres d’espace réservé qui spécifient le modèle réel.

L’utilisation de modèles abstraits peut simplifier votre schéma Schematron en réduisant la duplication des règles et en facilitant la gestion et la mise à jour de votre logique de validation. Cela peut également faciliter la compréhension de votre schéma, dans la mesure où vous pouvez définir une logique de validation complexe dans un modèle abstrait unique qui peut être réutilisé dans l’ensemble du schéma.

Par exemple, le code XML suivant crée un modèle abstrait, puis le modèle réel y fait référence à l’aide de l’identifiant .

<sch:pattern abstract="true" id="LimitNoOfWords">

<sch:rule context="$parentElement">

<sch:let name="words" value="string-length(.)"/>

<sch:assert test="$words &lt; $maxWords">

You have <sch:value-of select="$words"/> letters. This should be lesser than <sch:value-of select="$maxWords"/>.

</sch:assert>

<sch:assert test="$words &gt; $minWords">

You have <sch:value-of select="$words"/> letters. This should be greater than <sch:value-of select="$minWords"/>.

</sch:assert>

</sch:rule>

</sch:pattern>

<sch:pattern is-a="LimitNoOfWords" id="extend-LimitNoOfWords">

<sch:param name="parentElement" value="title"/>

<param name="minWords" value="1"/>

<param name="maxWords" value="8"/>

</sch:pattern>