Comment convertir le fichier xsd de lisible par l'homme de la documentation?

Nous avons un peu de XML basés sur des interfaces qui est très bien documenté dans les schémas XSD. Les interfaces sont maintenant accessibles au public et nous souhaitons créer une documentation de référence pour eux.

Est-il un outil qui peut convertir automatiquement les fichiers XSD dans certains format plus lisible?

InformationsquelleAutor Jonas Pegerfalk | 2008-10-26
  1. 18

    xs3p de pouvoir faire ce que vous voulez (voir aussi leur SourceForce page).

    • Wow, étonné de la voix, peut-être parce qu'il y a si peu de solutions de rechange, mais la sortie de x3sp est incroyablement laid et difficile à suivre - il suffit de lire la plaine de xsd est beaucoup plus facile. Et c'est quoi le "AusAddress" type au hasard ajouté à la fin?
    • La page du lien ne semble plus exister, et je ne trouve aucune trace d'un logiciel nommé x3sp au moins, avec une recherche rapide sur le web.
    • c'est parce que les lettres/chiffres sont dans le mauvais ordre
    • "AusAddress" fait partie de la légende, vous pouvez la désactiver dans les paramètres, voir printLegend dans le fichier xsl.
    InformationsquelleAutor Andrew Kennan
  2. 16

    Insérer en haut de la XSD

    <?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>

    Ensuite, vous pouvez directement consulter le fichier XSD à l'aide d'un navigateur web. Le navigateur web de la conversion en HTML à l'aide du spécifiée XSLT.

    Vous ne pas besoin d'un processeur XSL, mais les feuilles de style comme xs3p de ne pas générer des liens à l'aide de cette approche. J'utilise Firefox navigateur web, IE8 semble inutile pour cette.

    J'ai essayé les feuilles de style xsl:
    https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.zip/download
    http://crism.maden.org/consulting/pub/xsl/xsd2html.xsl

    Je pense que je préfère xs3p.

    • Pour clarifier: les navigateurs web modernes (comme Firefox) ont intégré dans le processeur XSLT permettant de transformation, de se produire, de sorte que la fiabilité de cette approche dépend de l'environnement d'exécution.
    • ne sais pas sur IE8 - mais IE11 fonctionne très bien avec un bémol, je n'arrive pas à le faire fonctionner en laissant tomber le fichier XSD sur elle. Toutefois, si le fichier est servi par un serveur web il fonctionne très bien... quand j'ai frappé à la IE bouton dans intellij IDEA pendant l'affichage de l'XSD, il envoie par le biais de localhost - de sorte qu'il s'affiche correctement.Me permet d'économiser les tracas de l'installation de firefox. Étant donné que chrome ne fonctionne pas pour moi.Mon rêve ultime serait de trouver quelque chose comme x3sp - mais ce n'est pas pêle-mêle la documentation tous ensemble... au contraire, le laisser dans la même position qu'il était dans le fichier XSD (en vertu de l'élément il a été placedafter)
    InformationsquelleAutor
  3. 6

    oxygène a de très jolies Schéma XSD outil de documentation qui permet une personnalisation facile, grâce à des options supplémentaires et des fichiers CSS.

    Je n'ai pas utilisé avant, mais FlexDoc/XML XML constitue un outil de documentation avec un XSD documentation composant appelé XSDDoc qui semble intéressant.

    Bien sûr, comme l'a souligné dans les autres réponses, XSD est juste un fichier XML de manière personnalisée XSLT peut être écrite pour générer une sortie de documentation vous le souhaitez.

    InformationsquelleAutor Mads Hansen
  4. 2

    Un script XSLT peut faire le travail.

    InformationsquelleAutor Ather
  5. 2

    Les chances sont très bonnes que vous ne souhaitez pas utiliser un outil générique pour la documentation de votre schéma. Schéma des outils de documentation (je suis plus familier avec l'un de XML Spy) sont conçus pour faire des schémas lisibles. À partir de votre description, il semble que ce n'est pas vraiment ce que vous voulez, ce que vous voulez est d'utiliser ces informations dans votre schéma de la base de la documentation du logiciel.

    Quand j'ai eu besoin pour ce faire, l'approche que j'ai adoptée a été de concevoir HTML qui ressemblaient à ce que j'avais besoin de la documentation à regarder, et puis trouver de l'information dans le schéma que j'avais besoin de saisir de la peupler. En s'en servant comme d'un modèle, il est assez simple d'extraire de l'information pertinente à partir du schéma à l'aide de XSLT.

    InformationsquelleAutor Robert Rossney
  6. 1

    J'ai documentation générée dans le passé à l'aide d'un outil que j'ai trouvé sur Freshmeat.net appelé xsddoc. Regardant tout à l'heure (pour obtenir le lien direct), je vois qu'il a été repris par ses développeurs avec un outil appelé xnsdoc. La plus récente est gratuit pour un usage par les projets open-source, mais si vous utilisez ce pour un produit commercial, vous pouvez avoir une licence. Si la dernière version publiée en vertu de la "xsddoc" bannière convient à vos besoins, alors vous pouvez simplement utiliser ce un.

    La documentation de ce produit a le look et la sensation de la Javadoc, et permet un certain degré de contrôle dans la feuille de style, etc.

    InformationsquelleAutor rjray
  7. 1

    Si vous êtes prêt à plonger dans les méandres de Château de sable, je recommande fortement Schéma XML Documentaliste qui est un plugin pour l'excellent Sandcastle Help File Builder.

    Sorties possibles sont les mêmes que château de sable: un site web, une Aide HTML (CHM) de fichiers, MS Help 2 contenu, MME la Visionneuse de l'Aide 1...

    InformationsquelleAutor Mac
  8. -3

    Il ne devrait pas être difficile de le convertir (ou d'écrire à l'avance) à docbook format.

    • Vous ne savez pas comment le référencement d'un livre vient de fermer pour répondre à cette question.
    • Docbook est pas un livre plutôt qu'un outil qui peut aider à convertir du XML en Html/word/pdf format. Pour ma compréhension, c'est beaucoup plus concret que juste se référant à la transformation XSLT.
    InformationsquelleAutor Ilya