Comment convertir xsd en documentation lisible par l'homme?
Nous avons quelques interfaces basées sur XML qui sont assez bien documentées dans les schémas XSD. Les interfaces vont maintenant être accessibles au public et nous aimerions créer une documentation de référence pour elles.
Existe-t-il un outil qui peut convertir automatiquement les fichiers XSD dans un format plus lisible?
xs3p pourrait faire ce que vous voulez (voir aussi leur page SourceForce ).
Insérez-le en haut du XSD
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
Ensuite, vous pouvez afficher directement le fichier XSD à l'aide d'un navigateur Web. Le navigateur Web effectue la conversion au format HTML à l'aide du XSLT spécifié.
Vous n'avez pas besoin d'un processeur XSL, mais les feuilles de style comme xs3p ne généreront pas de liens en utilisant cette approche. J'utilise le navigateur web Firefox, IE8 semble inutile pour cela.
J'ai essayé ces feuilles de style xsl: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.Zip/downloadhttp: //crism.maden. org/consulting/pub/xsl/xsd2html.xsl
Je pense que je préfère xs3p.
oXygen a très Nice outil de documentation de schéma XSD qui permet une personnalisation facile grâce à des options et des fichiers CSS supplémentaires.
Je ne l'ai pas utilisé auparavant, mais FlexDoc/XML est un outil de documentation XML avec un composant de documentation XSD appelé XSDDoc qui semble intéressant.
Bien sûr, comme indiqué dans l'une des autres réponses, XSD est juste un fichier XML afin qu'un XSLT personnalisé puisse être écrit pour générer n'importe quelle sortie de documentation que vous aimez.
Un script XSLT peut faire le travail.
Les chances sont bonnes que vous ne souhaitiez pas utiliser un outil générique pour documenter votre schéma. Les outils de documentation de schéma (je connais le mieux celui de XML Spy) sont conçus pour rendre les schémas lisibles. D'après votre description, il semble que ce ne soit pas vraiment ce que vous voulez; ce que vous voulez, c'est utiliser les informations de votre schéma comme base de la documentation du logiciel.
Lorsque j'ai eu besoin de le faire, l'approche que j'ai adoptée a été de concevoir du code HTML qui ressemblerait à la documentation dont j'avais besoin, puis de déterminer les informations du schéma que je devrais saisir pour le remplir. En utilisant cela comme modèle, il est assez simple d'extraire des informations pertinentes du schéma à l'aide de XSLT.
Si vous êtes prêt à vous plonger dans les subtilités de Sandcastle , je recommande fortement XML Schema Documenter qui est un plugin pour l'excellent Sandcastle Help File Builder .
Les sorties possibles sont les mêmes que Sandcastle: un site Web, un fichier HTML Help (CHM), MS Help 2 content, MS Help Viewer 1 ...
J'ai généré de la documentation dans le passé en utilisant un outil que j'ai trouvé sur Freshmeat.net appelé xsddoc . En le cherchant tout à l'heure (pour obtenir le lien direct), je vois qu'il a été remplacé par ses développeurs avec un outil appelé xnsdoc . Le plus récent est gratuit pour les projets open-source, mais si vous l'utilisez pour un produit commercial, vous devrez peut-être le concéder sous licence. Si la dernière version publiée sous la bannière "xsddoc" convient à vos besoins, alors vous pouvez simplement l'utiliser.
La documentation qu'elle produit a l'apparence de Javadoc et permet un certain degré de contrôle dans la feuille de style, etc.