Wir haben einige XML-basierte Schnittstellen, die in XSD-Schemata recht gut dokumentiert sind. Die Schnittstellen werden nun öffentlich verfügbar sein und wir möchten Referenzdokumente für sie erstellen.Wie konvertiert man xsd in eine lesbare Dokumentation?
Gibt es ein Tool, das XSD-Dateien automatisch in ein besser lesbares Format konvertieren kann?
Es sollte nicht zu schwer sein, es zu konvertieren (oder im Voraus zu schreiben) in docbook Format.
Ein XSLT-Skript kann die Aufgabe erledigen.
oXygen hat sehr schöne XSD schema documentation tool, die für die einfache Anpassung durch Optionen und zusätzliche CSS-Dateien ermöglicht.
Ich habe es nicht zuvor verwendet, aber DocFlex/XML ist ein XML-Dokumentationstool mit einer XSD-Dokumentationskomponente namens XSD Doc, die interessant aussieht.
Natürlich, XSD ist nur eine XML-Datei, so dass eine benutzerdefinierte XSLT geschrieben werden könnte, um jede Dokumentationsausgabe zu erzeugen, die Sie mögen.
Die Chancen stehen gut, dass Sie kein generisches Tool zur Dokumentation Ihres Schemas verwenden möchten. Schema-Dokumentationstools (ich bin am vertrautesten mit dem in XML Spy) sind entworfen, um Schemas lesbar zu machen. Aus Ihrer Beschreibung klingt das, als ob das nicht wirklich das ist, was Sie wollen; Sie möchten die Informationen in Ihrem Schema als Grundlage für die Softwaredokumentation verwenden.
Wenn ich dies tun musste, war der Ansatz, HTML zu entwerfen, die so aussah, wie ich die Dokumentation suchen musste, und dann herauszufinden, welche Informationen im Schema ich erfassen müsste, um sie zu füllen . Wenn Sie das als Vorlage verwenden, können Sie relevante Informationen aus dem Schema mithilfe von XSLT abrufen.
Ich habe in der Vergangenheit Dokumentation mit einem Tool erstellt, das ich auf Freshmeat.net xsddoc gefunden habe. Wenn ich es gerade jetzt ansehe (um den direkten Link zu bekommen), sehe ich, dass es von seinen Entwicklern mit einem Tool namens xnsdoc ersetzt wurde. Der neuere ist frei für die Verwendung von Open-Source-Projekten, aber wenn Sie dies für ein kommerzielles Produkt verwenden, müssen Sie es möglicherweise lizenzieren. Wenn die letzte Version, die unter dem Banner "xsddoc" veröffentlicht wurde, Ihren Zwecken entspricht, können Sie diese einfach verwenden.
Die Dokumentation es produziert hat das Aussehen und das Gefühl von Javadoc und ermöglicht ein gewisses Maß an Kontrolle im Stylesheet usw.
x3sp könnte tun, was Sie wollen: http://xml.fiforms.org/xs3p/
Wow, erstaunt über die Stimmen, vielleicht weil es so wenige Alternativen gibt, aber die Ausgabe von x3sp ist unglaublich hässlich und schwer zu folgen - nur das Lesen der Ebene xsd ist viel einfacher. Und was ist mit dem "AusAddress" Typ zufällig an das Ende angehängt? –
Die verlinkte Seite scheint nicht mehr zu existieren, und ich finde keine Spuren einer Software namens * x3sp * zumindest mit einer schnellen Websuche. –
Legen Sie diese an der Spitze der XSD
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
Dann können Sie die XSD-Datei direkt über einen Webbrowser anzeigen. Der Webbrowser führt die Konvertierung in HTML mit dem angegebenen XSLT durch.
Sie nicht brauchen einen XSL-Prozessor, aber Stylesheets wie xs3p werden keine Links mit diesem Ansatz generieren. Ich benutze den Firefox Web-Browser, IE8 scheint dafür nutzlos.
Ich habe dieses XSL-Stylesheets versucht: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.zip/download http://crism.maden.org/consulting/pub/xsl/xsd2html.xsl
Ich glaube, ich ziehe xs3p.
Zur Klarstellung: moderne Webbrowser (wie Firefox) haben einen eingebauten XSLT-Prozessor, der diese Transformation ermöglicht, so dass die Zuverlässigkeit dieses Ansatzes von der Laufzeitumgebung abhängt. – jevon
weiß nicht über IE8 - aber IE11 funktioniert gut mit einem Vorbehalt, ich kann nicht scheinen, um es zu arbeiten, indem Sie die XSD-Datei darauf fallen lassen. Allerdings, wenn die Datei über einen Webserver bedient wird, funktioniert es gut ... wenn ich die IE-Taste in Intellij IDEA während der Anzeige der XSD drücken, sendet es es über localhost - so wird es richtig gerendert.Speichert mir den Aufwand der Installation von Firefox. Da Chrome nicht für mich arbeiten wird. Mein ultimativer Traum wäre, etwas wie x3sp zu finden - aber das durchwühlt die Dokumentation nicht alle zusammen ... eher, lassen Sie es in der gleichen Position, die es in der XSD war (unter der Element wurde nachher platziert) – ycomp
Wenn Sie bereit sind, in die Feinheiten von Sandcastle einzutauchen, empfehle ich XML Schema Documenter das ist ein Plugin für die ausgezeichnete Sandcastle Help File Builder.
Mögliche Ausgänge sind die gleichen wie Sandcastle: eine Website, eine HTML-Hilfe (CHM-Datei), MS Help 2 Inhalt, MS Help Viewer 1 ...
Wenn ich spät nicht mehr als 2 Jahren, würde ich sagen, ‚schließen‘, weil es ein Duplikat von http://stackoverflow.com/questions/202049/formatting-xsd-scheme-for-peer-review – f3lix