RngDoc, documenter un schéma XML (Relax-NG)

RngDoc est un outil pour extraire et produire la documentation d’un schéma XML/Relax-NG. Il a été initié, développé et maintenu par Frédéric Glorieux depuis 2005. L’OBVIL utilise cet outil pour regénérer régulièrement la documentation du schéma Teibook, que consulte ses éditeurs XML. Relativement à des outils de documentation similaire, comme par exemple la fonctionnalité de documentation de schéma du logiciel commercial Oxygen, il ne s’agit pas d’un document noyant le lecteur dans des schémas dessinant les imbrications entre les éléments. En effet, l’édition de textes induit des structures de contenu complexes, produisant des schémas qui ne sont pas du tout éclairants. L’approche consiste plutôt à concevoir un schéma dans l’esprit de la “programmation lettrée” (literate programming) de Donald Knuth. Le schéma est articulé est rédigé comme un texte suivi. Cet outil est aussi utilisé par l’OBVIL pour le schéma EAD dont il héberge une traduction française (EAD est utilisé paar le Labex pour les inventaires de fonds d’auteurs, par exemple Francis Ponge).

Partager cet article