Mamy kilka interfejsów opartych na XML, które są dość dobrze udokumentowane w schematach XSD. Interfejsy będą teraz publicznie dostępne i chcielibyśmy utworzyć dla nich dokumentację referencyjną.Jak przekonwertować xsd do czytelnej dla ludzi dokumentacji?
Czy istnieje narzędzie, które może automatycznie konwertować pliki XSD do jakiegoś bardziej czytelnym formacie?
To nie powinno być trudne do zagospodarowania (lub napisać wcześniej) do formatu docbook.
XSLT skrypt może wykonać pracę.
oXygen ma bardzo ładne XSD schema documentation tool, który pozwala na łatwe dostosowanie poprzez opcje i dodatkowe pliki CSS.
Nie użyłem tego wcześniej, ale DocFlex/XML to narzędzie dokumentacji XML z komponentem dokumentacji XSD o nazwie XSD Doc, który wygląda interesująco.
couse, jak wskazano w sprawie innych odpowiedzi, XSD jest tylko plik XML tak zwyczaj XSLT mogą być zapisywane generuje wyjście dokumentacji chcesz.
Szanse są całkiem dobre, że nie chcesz używać rodzajowe narzędzie do dokumentowania schematu. Narzędzia do tworzenia schematów schematów (jestem najbardziej znany z tego w Spy XML) są zaprojektowane tak, aby schematy były czytelne. Z twojego opisu wynika, że to nie jest to, czego chcesz; to, czego chcesz, to wykorzystanie informacji zawartych w twoim schemacie jako podstawy dokumentacji oprogramowania.
Kiedy musiałem to zrobić, podejście, które podjąłem, polegało na zaprojektowaniu kodu HTML, który wyglądał tak, jak potrzebowałem dokumentacji do obejrzenia, a następnie ustaleniu, jakie informacje w schemacie muszę pobrać, aby go wypełnić. . Używając tego jako szablonu, wystarczy pobrać odpowiednie informacje ze schematu za pomocą XSLT.
mam generowane dokumentację w przeszłości za pomocą narzędzia znalazłem na freshmeat.net nazywa xsddoc. Poszukując go już teraz (aby uzyskać bezpośredni link), widzę, że został on zastąpiony przez programistów za pomocą narzędzia o nazwie xnsdoc. Ten nowszy jest darmowy do użytku przez projekty open-source, ale jeśli używasz tego dla komercyjnego produktu, możesz potrzebować jego licencji. Jeśli ostatnia wersja wydana pod banerem "xsddoc" pasuje do twoich celów, możesz po prostu użyć tej.
Dokumentacja produkuje ma wygląd i Javadoc i pozwala na pewien stopień kontroli w arkuszu stylów, itp
x3sp może robić to, co chcesz: http://xml.fiforms.org/xs3p/
Wow, zdumiony głosowaniem, może dlatego, że jest tak mało alternatyw, ale wyniki z x3sp są niesamowicie brzydkie i trudne do naśladowania - samo czytanie zwykłego xsd jest znacznie łatwiejsze. A co z typem "AusAddress" losowo dołączonym do końca? –
Strona, do której prowadzi link, wydaje się już nie istnieć i nie mogę znaleźć żadnych śladów oprogramowania o nazwie * x3sp * przynajmniej z szybkim wyszukiwaniem w Internecie. –
wstawić ten na górze z XSD
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
Następnie można bezpośrednio przeglądać plik XSD za pomocą przeglądarki internetowej. Przeglądarka internetowa dokonuje konwersji do HTML za pomocą określonego XSLT.
Nie musisz potrzebujesz procesora XSL, ale arkusze stylów takie jak xs3p nie będą generować linków za pomocą tego podejścia. Używam przeglądarki internetowej Firefox, IE8 wydaje się bezużyteczna.
Próbowałem te arkusze stylów XSL: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.zip/download http://crism.maden.org/consulting/pub/xsl/xsd2html.xsl
Chyba wolę xs3p.
Wyjaśnienie: nowoczesne przeglądarki internetowe (takie jak Firefox) mają wbudowany procesor XSLT, który pozwala na taką transformację, więc niezawodność tego podejścia zależy od środowiska wykonawczego. – jevon
nie wiem o IE8 - ale IE11 działa dobrze z jednym zastrzeżeniem, nie mogę sprawić, żeby działał, upuszczając na niego plik XSD. Jednakże, jeśli plik jest obsługiwany przez serwer WWW, działa dobrze ... po naciśnięciu przycisku IE w intellij IDEA podczas przeglądania XSD, wysyła go przez localhost - więc renderuje się poprawnie. Oszczędza mi kłopotów z instalacją firefox. Skoro chrom nie zadziała dla mnie. Moim marzeniem byłoby znalezienie czegoś takiego jak x3sp - ale to nie zignoruje całej dokumentacji ... raczej zostaw to w tej samej pozycji, w jakiej znajdowało się w XSD (pod element został umieszczony po) – ycomp
Jeśli jesteś gotowy, aby zagłębić się w zawiłościach Sandcastle, bardzo polecam XML Schema Documenter, który jest wtyczką do doskonałego Sandcastle Help File Builder.
Możliwe wyjścia są takie same jak Sandcastle: witryna, Pomoc HTML plik (CHM), MS Help 2 treść, MS Help Viewer 1 ...
Gdybym nie był 2 lata późno, powiedziałbym, „blisko”, ponieważ jest to duplikat http://stackoverflow.com/questions/202049/formatting-xsd-scheme-for-peer-review – f3lix