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

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

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

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

スキーマデザイン | ドキュメンテーションの生成 コマンドは、アクティブなスキーマの詳細なドキュメントを生成します: XML スキーマ または JSON スキーマ。 このセクションでは、 XML スキーマドキュメンテーションの生成について説明されています。  スキーマドキュメンテーションの生成の過程に類似しています。 JSON スキーマドキュメンテーションの生成と、ドキュメント生成設定の詳細に関しては、以下のセクションを参照してください: JSON スキーマドキュメンテーションの生成.

 

スキーマドキュメンテーションの生成

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

 

 

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

schema-doc-ge4ndbox

以下にスキーマドキュメンテーションダイアログにて設定することにできるオプションについて記します:

 

出力書式ペインにて、HTML、Microsoft Word、RTF、または PDF から目的のフォーマットを指定します(PDF 出力書式は StyleVision SPS を使ったドキュメンテーションの生成でしか使用できません)。OK をクリックすると、出力ファイルの名前と場所を入力するよう求められます。
固定デザインを使用した場合、.doc ファイル拡張子の Microsoft Word ドキュメントが生成され、StyleVision SPS を使った生成を行うと、.docx ファイル拡張子のドキュメントが生成されます。
ドキュメンテーションは単一のファイルとして生成することも、複数のファイルに分割して生成することもできます。複数のファイルが生成される場合、各ファイルが個々のコンポーネントに対応します。出力ファイルに含められるコンポーネントは、含める対象 ペインにて指定することができます。固定デザインを使用する場合、ドキュメント間には自動的にリンクが作成されます。
HTML 出力では、CSS のスタイル定義を、外部 CSS ファイル内に保存するか、HTML ファイル内(<head> 要素の内部)に保存するか選択することができます。外部 CSS ファイルを作成する場合、.css という拡張子を持った HTML ファイルと同名のファイルが作成されます。HTML に CSS を埋めこむ オプションにより、オプションの指定を行うことができます。
図を埋めこむ オプションは MS Word、RTF、PDF 出力に対して有効になります。このオプションが有効になっていると、ダイアグラムが PNG または EMP 形式でファイルの中に埋めこまれます。このオプションが指定されていない場合、PNG ならびに EMP ファイルが作成され、オブジェクトリンクを使ってファイルの中に表示されます。
HTML 形式の出力が指定された場合、全てのダイアグラムは外部の PNG ファイルとして作成されます。図のフォルダーを作成 チェックボックスにチェックが入っている場合、HTML ファイルと同じ場所にフォルダーが作成され、PNG ファイルがそのフォルダー内部に保存されます。このフォルダーの名前は、HTMLFilename_diagrams になります。図のフォルダーを作成 チェックボックスにチェックが入っていない場合、PNG ファイルは HTML ファイルと同じ場所(フォルダー)に保存されます。
ダイアグラムのイメージや外部 CSS ファイルといったローカルファイルへのリンクは、相対パスか絶対パスか指定することができます。ローカルファイルにリンクを作成 ペインにて、適切なラジオボタンを選択してください。
含める対象 ペインでは、ドキュメンテーションに含めるアイテムを選択します。インデックスオプションにより、関係する全てのスキーマが、グローバルコンポーネントとともにファイル上部に表示されます。全てチェック全てクリアボタンにより、ペインにある全てのオプションを選択または選択解除することができます。含むオプションは、視覚的な定義内のアイテムの表示に影響を与えません。 スキーマ表示の構成 ダイアログにより視覚的な定義内のアイテムは管理されています。 スキーマアイテムのグラフィカルな表示内の属性の表示を無効化する場合、スキーマ表示の構成 ダイアログ内の属性オプションのチェックを解除してください。
詳細 ペインでは、各コンポーネントに含める詳細情報を指定します。ドキュメンテーションに含める項目を選択してください。全てチェック全てクリアボタンにより、ペインにある全てのオプションを選択または選択解除することがで
生成後にファイルを表示 オプションは全ての出力書式に対して使用することができます。このオプションにチェックが入っていると、生成されたファイルがブラウザビュー(HTML 出力)、MS Word(MS Word 出力)、.rtf ファイルや .pdf ファイルの(それぞれ RTF 出力と PDF 出力)デフォルトアプリケーションにて表示されます。ドキュメンテーション内のリンクを相対パスにするか、絶対パスにするか選択することもできます。

 

パラメーター値

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

 


(C) 2019 Altova GmbH