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

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

ホーム >  ユーザーマニュアル > メニューコマンド > WSDL メニュー > ドキュメンテーションの生成 >

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

WSDL | ドキュメンテーションの生成」コマンドにより、WSDL ドキュメンテーションダイアログが表示され、ドキュメンテーションに関するオプションを選択することができます(以下のスクリーンショットを参照)。

 

ダイアログのドキュメンテーションデザインペインでは、ドキュメンテーションの生成に XMLSpy の固定デザインを使用するのか、 StyleVision SPS により作成されたカスタマイズデザインを使用するのか選択することができます。使用するオプションを選択してください。PDF 出力は、 StyleVision SPS により生成されたドキュメンテーションでしか利用することはできず、固定デザインを使ったドキュメンテーションの生成では利用できないということに注意してください。ユーザー定義デザインの使用方法については、 ユーザー定義デザインのセクションを参照ください。

WSDLDocGen

WSDL ダイアログにあるその他のオプションに関する説明を以下に記述します。アクティブなドキュメントが WSDL 1.1 か WSDL 2.0 で、ダイアログ内にある含める対象 ならびに詳細 ペインの表示内容が変化します。上に示されるスクリーンショットは、WSDL 1.1 ドキュメントに対するドキュメンテーションダイアログを示しています。

 

目的のフォーマットを出力形式ペインにて選択します。HTML、Microsoft Word、RTF、または PDF から選択を行うことができます(PDF 出力フォーマットは、StyleVision SPS を使ったドキュメンテーションの生成でのみ選択可能になります)。OK をクリックすると、出力ファイルが保存される場所と名前を指定するよう促されます。
Microsoft Word ドキュメントは、固定デザインを使用した際には .doc 拡張子を持ったファイルが生成され、StyleVision SPS を使用した生成では、 .docx ファイル拡張子が使用されます。
ドキュメンテーションの生成は、単一のファイルに対して行える他、複数のファイルに分割して行うこともできます。複数のファイルが生成された場合、各ファイルが個々のコンポーネントに対応します。出力に含まれるコンポーネントは、含める対象ペインにあるチェックボックスにより指定することができます。固定デザインの場合、複数ドキュメント間を結ぶリンクが自動的に作成されます。
HTML 出力の場合、CSS スタイル定義を、独立した CSS ファイルに収めるか、HTML ファイル(の <head> 要素)内部に収めるか指定することができます。独立した CSS ファイルが作成される場合、HTML ファイルと同じ名前で、 .css 拡張子を持ったファイルが作成されます。必要に応じて HTML に CSS を埋め込む オプションにチェックを入れてください。
Microsoft Word、RTF、PDF オプションでは、図を埋め込む オプションが有効になります。このオプションが有効になっている場合、PNG 形式でダイアグラムが結果ファイル内部に埋めこまれます。オプションが無効になっている場合、ダイアグラムは PNG ファイルとして作成され、オブジェクトリンクにより結果ファイルにて表示されます。
出力ファイルが HTML の場合、全てのダイアグラムはドキュメントから独立した PNG ファイルとして作成されます。図のフォルダーを作成 チェックボックスにチェックを入れることで、HTML ファイルと同じ場所にフォルダーが作成され、その中に PNG ファイルが保存されます。このフォルダーは HTMLファイル名_diagrams という名前になります。図のフォルダーを作成 チェックボックスにチェックが入っていない場合、HTML ファイルと同じ場所に PNG ファイルが保存されます。
含める対象ペインでは、ドキュメンテーションに含めるアイテムを選択することができます。概要オプションを選択することで、全てのコンポーネントがコンポーネントの種類ごとにファイルの上部に表示されます。インポートされたファイル(WSDL 1.1) またはインポート/インクルードされたファイル (WSDL 2.0) オプションにチェックが入れられた場合、インポートされたファイル(WSDL 2.0 の場合は更にインクルードされたファイル)がスキーマのドキュメンテーションに加えられます。
スキーマペインでは、ファイル内部にあるスキーマもドキュメンテーションに含まれるか選択することができます。スキーマを含めるよう選択した場合、(i) スキーマのドキュメンテーションが独立したファイルとして生成されるのか、またはメインドキュメンテーションファイル内部に加えるのか、(ii) スキーマ全体をドキュメンテーションの生成対象とするのか、またはグローバル要素、単純型、そして複合型だけを含めるのか選択することができます。
詳細ペインでは各コンポーネントに含めることのできるアイテムの詳細が表示されます。ドキュメンテーションに含めるアイテムを選択してください。全てチェックならびに全てクリアボタンにより、ペインにある全てのオプションを全て選択、または選択解除することができます。
生成後にファイルを表示 オプションは、全ての出力オプションに対して有効になります。このオプションが有効になっていると、生成されたファイルが(HTML 出力の場合は)ブラウザービュー、(MS Word 出力の場合は)MS Word、(RTF ならびに PDF 出力の場合は) .rtf ならびに .pdf ファイルのデフォルトアプリケーションにて表示されます。

 

 

パラメーター値

StyleVision SPS に複数のパラメーター定義が含まれる場合、OK をクリックした後に SPS にて定義されている全てのパラメーターがダイアログにて表示されます。このダイアログでパラメーター値を入力することで、SPS に割り当てられたデフォルトのパラメーター値をオーバーライドすることができます。

 


(C) 2019 Altova GmbH