DITA XML schema : DTD, XSD et RELAX NG, quelles différences

En DITA, le DITA XML schema désigne l’ensemble des fichiers de grammaire qui disent quels éléments et quels attributs un topic ou une map peut contenir. La norme accepte trois formats de grammaire, DTD, XSD et RELAX NG, et le comité OASIS écrit ses fichiers de référence en RELAX NG pour DITA 1.3. C’est ce schéma qui permet de valider les contenus avant publication et de les échanger d’un outil à l’autre.

Ce que recouvre le schéma XML dans DITA

Le schéma définit le vocabulaire : la liste des éléments, leurs attributs et les règles d’imbrication. Il s’applique à chaque type de document, qu’il s’agisse d’un topic (concept, tâche, référence) ou d’une map.

Dans une chaîne documentaire, il joue le rôle de garde-fou. Un auteur ne peut pas placer un élément là où la grammaire ne le prévoit pas, et l’éditeur signale l’erreur avant que le contenu n’atteigne la publication. C’est la base de tout CCMS conforme à la norme DITA, qui s’appuie sur ces règles pour contrôler les contenus qu’il stocke.

DTD, XSD et RELAX NG : trois grammaires pour un même modèle

Le modèle de contenu DITA est le même quel que soit le format. Ce qui change, c’est la façon de l’écrire et ce que le langage permet d’exprimer.

  • La DTD est le format historique d’XML. Sa syntaxe n’est pas du XML, elle est compacte et très répandue dans les outils.
  • Le XML Schema (XSD) s’écrit en XML et gère mieux les types de données, mais sa mécanique de redéfinition pose des limites pour la spécialisation.
  • Le RELAX NG s’écrit lui aussi en XML, avec une syntaxe que la spécification juge la plus simple à utiliser et celle qui exprime les contraintes les plus précises.

Le comité OASIS utilise la syntaxe XML de RELAX NG pour les versions normatives des fichiers de grammaire de DITA 1.3. Les versions DTD et XSD livrées sont générées à partir de ces fichiers, et les grammaires OASIS évitent toute fonction de RELAX NG qui ne se traduirait pas en DTD ou en XSD. En pratique, les trois formats décrivent donc la même chose.

Modules et document-type shells : comment les fichiers s’assemblent

Une grammaire DITA n’est pas un fichier unique. Elle se compose de modules : un module par type de topic ou de map, des modules de domaine qui ajoutent des éléments et attributs thématiques (surlignage, indexation), et des modules de contrainte qui resserrent les règles d’un type existant.

Le document-type shell assemble ces briques. En XSD, il inclut ou redéfinit les groupes d’éléments communs, de déclaration de métadonnées et de modèle de tableau, inclut chaque domaine retenu, puis le module du type structurel visé. Si ce type est contraint, c’est le module de contrainte qui remplace le module de base. Ajouter ou retirer un domaine se fait donc dans le shell, sans sortir de la norme. Cette logique modulaire n’a rien à voir avec celle d’un CMS pour un site web, où l’on empile des extensions sans grammaire commune.

Spécialiser un schéma : ce que permet chaque format

La spécialisation consiste à créer ses propres éléments dérivés des éléments de base, pour qu’ils portent le vocabulaire métier d’une entreprise tout en restant lisibles par les outils DITA.

En XSD, elle passe par xs:redefine, qui inclut le fichier redéfini et porte la redéfinition. Cette fonction ne permet pas de contraindre directement les groupes de séquence. Il faut parfois refactoriser les modèles de contenu en groupes nommés, ce que l’OASIS n’a fait que pour le corps de tâche strict et la tâche de l’industrie mécanique.

Blocs de bois de formes différentes en cours d'assemblage sur un bureau

RELAX NG n’a pas cette contrainte, ce qui explique en partie que le comité en ait fait son format de référence. Les équipes qui spécialisent beaucoup gagnent à partir de ces fichiers plutôt que de refaire l’exercice en XSD.

Valider ses topics : le catalogue XML et les erreurs courantes

Pour valider un topic, l’éditeur ou le processeur doit retrouver la bonne grammaire à partir de l’identifiant déclaré dans le document. Cette résolution passe par un catalogue XML, qui associe chaque identifiant à un fichier local.

Les erreurs viennent presque toujours d’un décalage entre le document et le catalogue : shell introuvable, domaine déclaré mais absent de la grammaire, ou grammaires de versions différentes mélangées dans un même projet. Un contrôle de la gouvernance des données documentaires évite ces dérives, en fixant qui maintient le catalogue et à quel moment les grammaires évoluent.

Quel format retenir pour son projet documentaire

Le choix dépend d’abord de l’outillage en place : l’éditeur XML, le CCMS et la chaîne de publication ne prennent pas tous en charge les trois formats avec le même confort. Partir du format que ces outils exploitent le mieux évite des conversions inutiles.

Le deuxième critère est le besoin de spécialisation. Sans éléments sur mesure, les grammaires livrées avec DITA suffisent, quel que soit leur format. Avec une spécialisation poussée, RELAX NG est le plus à l’aise, alors qu’en XSD il faut composer avec les limites de la redéfinition.

Équipe réunie autour d'une table de travail avec des schémas imprimés

Reste le facteur humain : les compétences de l’équipe et la compatibilité avec l’existant pèsent autant que la technique. Une migration de grammaire est un projet à part entière, et le rôle d’un PMO dans un projet de ce type est de cadrer le calendrier et les validations.

Quel que soit le format choisi, le modèle de contenu reste celui de DITA, et le DITA XML schema décrit la même structure dans les trois cas. Mieux vaut donc fixer le format une fois, dans les shells du projet, et le documenter pour les auteurs.

Articles populaires