web-dev-qa-db-ja.com

xsdを人間が読めるドキュメントに変換する方法は?

XSDスキーマで非常によく文書化されたXMLベースのインターフェイスがいくつかあります。インターフェイスは現在公開されており、それらのリファレンスドキュメントを作成したいと思います。

XSDファイルをより読みやすい形式に自動的に変換できるツールはありますか?

43
Jonas Pegerfalk

xs3p は、あなたが望むことをするかもしれません( SourceForceページ もご覧ください)。

18
Andrew Kennan

これをXSDの上部に挿入します

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

その後、Webブラウザを使用してXSDファイルを直接表示できます。 Webブラウザーは、指定されたXSLTを使用してHTMLへの変換を行います。

あなたはXSLプロセッサを必要としませんが、xs3pのようなスタイルシートはこのアプローチを使用してリンクを生成しません。私はFirefox Webブラウザを使用していますが、IE8はこれには役に立たないようです。

これらのxslスタイルシートを試しました: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.Zip/downloadhttp://crism.maden。 org/consulting/pub/xsl/xsd2html.xsl

私はxs3pを好むと思います。

16
user263486

oXygen には非常に素晴らしい XSDスキーマドキュメントツール があり、オプションや追加のCSSファイルを使用して簡単にカスタマイズできます。

以前は使用していませんでしたが、 FlexDoc/XMLXSDDoc と呼ばれるXSDドキュメントコンポーネントを備えたXMLドキュメントツールです。

もちろん、他の回答で指摘したように、XSDは単なるXMLファイルであるため、カスタムXSLTを記述して任意のドキュメント出力を生成できます。

6
Mads Hansen

XSLTスクリプトがジョブを実行できます。

2
Ather

スキーマを文書化するための汎用ツールを使用したくないというのはかなり良いことです。スキーマドキュメントツール(私はXML Spyのツールに最も精通しています)は、スキーマを読みやすくするように設計されています。あなたの説明から、それは本当にあなたが望むものではないように聞こえます。必要なのは、スキーマ内の情報をソフトウェアのドキュメントの基礎として使用することです。

これを行う必要があったとき、私が取ったアプローチは、ドキュメントの外観に必要な方法に見えるHTMLを設計し、それを取り込むために取得する必要があるスキーマ内の情報を把握することでした。これをテンプレートとして使用すると、XSLTを使用してスキーマから関連情報を取り込むのは非常に簡単です。

2
Robert Rossney

Sandcastle の複雑さを掘り下げる準備ができている場合、 Sandcastle Help File Builder のプラグインである XML Schema Documenter を強くお勧めします。

可能な出力はサンドキャッスルと同じです:Webサイト、HTMLヘルプ(CHM)ファイル、 MSヘルプ2 コンテンツ、 MSヘルプビューアー1 ...

1
Mac

xsddoc というFreshmeat.netで見つけたツールを使用して、過去にドキュメントを生成しました。今すぐ調べて(直接リンクを取得するため)、開発者が xnsdoc と呼ばれるツールを使用して取って代わったことがわかります。新しいものはオープンソースプロジェクトで無料で使用できますが、これを商用製品に使用している場合は、ライセンスを取得する必要があります。 「xsddoc」バナーの下でリリースされた最後のバージョンが目的に合っている場合は、それを使用できます。

それが生成するドキュメントは、Javadocのルックアンドフィールを持ち、スタイルシートなどである程度の制御を可能にします。

1
rjray