WSDL ドキュメンテーションの作成

www.altova.com このトピックを印刷 前のページ 1つ上のレベル 次のページ

ホーム >  ユーザーマニュアル > WSDL と SOAP > WSDL チュートリアル >

WSDL ドキュメンテーションの作成

「WSDL | ドキュメンテーションの生成」 オプションを使えば、現在の WSDL ドキュメントに関する詳細なドキュメンテーションを生成することができます。生成されるドキュメンテーションは HTML、Microsoft Word、または RTF の形式から選択し、またドキュメンテーションに含まれるコンポーネントも選択することができます。関連する WSDL 要素同士は生成されたドキュメンテーション内でハイパーリンク化され、ナビゲーションを簡単に行うことができます。

 

注意Microsoft Word の形式でドキュメンテーションを生成するには、Microsoft Word (バージョン 2000 以降)がインストールされている必要があります。

 

WSDL ファイルのドキュメンテーションを生成するには:

 

1.timeservice.wsdl をアクティブなドキュメントにします。
2.WSDL ビューに切り替えます。
3.メニューオプションから 「WSDL | ドキュメンテーションの生成」 を選択します。
この操作により(以下のスクリーンショットにある) WSDL ドキュメントダイアログが起動します。
4.HTML、Microsoft Word、RTF から生成したい出力ファイルの形式を選択します。
5.ドキュメンテーションに含めたい WSDL コンポーネントを選択し、その他のオプションを指定します(以下の WSDL ドキュメンテーションオプションを参照ください)

WSDLDocGen

 

6.「OK」 をクリックして、名前を付けて保存ダイアログボックスにて WSDL ドキュメンテーションファイルの名前を入力します。

 

WSDL ドキュメンテーションオプション

以下のドキュメンテーションオプションを指定することができます:

 

ドキュメンテーションの形式は出力書式ペインにより指定されます。ドキュメンテーションは単一のファイル、または複数のファイルに分割して生成することができます。複数のファイルが生成された場合、各ファイルが各コンポーネントに対応します。ドキュメンテーションに含まれるコンポーネントの種類は、含める対象ペインにより指定されます。
図を書き込むオプションは Microsoft Word ならびに RTF 出力オプションに対して有効になります。このオプションにチェックを入れると、ダイアグラムファイルは PNG または EMF ファイルとして出力ファイル内に埋め込まれます。チェックが入れられていない場合、ダイアグラムは PNG または EMF ファイルとして作成され、オブジェクトリンクにより出力ファイルから参照されます。出力形式が HTML の場合、全てのダイアグラムは PNG ファイルとして作成され、ドキュメントから参照されます。
含める対象ペインでは、ドキュメンテーションに含めるアイテムを選択します。概要オプションにより、ファイルの最初に全てのコンポーネントがその種類ごとに表示されます。インポートされたファイルオプションにチェックが入っている場合、インポートされたファイル内にあるコンポーネントがスキーマドキュメンテーションに含められます。
スキーマペインでは、ファイル内にあるスキーマのレポートを生成するか選択することができます。スキーマのレポートを生成するよう選択した場合、更に (i) スキーマのドキュメンテーションを独立したファイルとして生成するか、またはメインドキュメンテーションファイル内部に含めるか、そして (ii) スキーマ全体のレポートを生成するのか、グローバル要素、単純型、複合型だけを生成するのか選択することができます。
詳細ペインでは、各コンポーネントに含める対象が表示されます。ドキュメンテーションに加えたい項目を選択してください。
「生成時にファイルを表示」 オプションにより、(HTML 出力の場合は)ブラウザービュー、(Microsoft Word の場合は)Microsoft Word、(RTF ファイルの場合は).rtf ファイルに割り当てられたデフォルトアプリケーションで出力ファイルが開かれます。

 


(C) 2018 Altova GmbH