マッピングドキュメントの生成とカスタム化

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

ホーム >  マップのカスタム化 >

マッピングドキュメントの生成とカスタム化

ドキュメンテーションの生成コマンドにより、マッピングに関する詳細なドキュメンテーションを HTML、MS Word、RTF、または PDF 形式で生成することができます。このコマンドにより生成されたドキュメンテーションは Altova からの許可を得ること無く自由に改変、使用することができます。

 

ドキュメンテーションは、ドキュメンテーションの生成ダイアログボックスにて選択したコンポーネントに対して生成されます。固定デザインまたは StyleVision の SPS ファイルをデザインとして使用することができます。StyleVision SPS を使用することで、生成されるドキュメンテーションのデザインをカスタマイズすることができます。カスタマイズの方法については ( ユーザー定義デザインのセクションを参照ください)。

 

メモ:SPS ファイルによりマッピングドキュメンテーションを生成するには、お使いのコンピューターに StyleVision がインストールされている必要があります。画面への出力では、関連する要素が通常ハイパーリンクされており、コンポーネント間のナビゲーションを行うことができます。

 

MS Word フォーマットにてドキュメンテーションの生成を行うには、MS Word (バージョン 2000 以降)がインストールされている必要があります

 

以下のスクリーンショットでは、..\MapForceExamples フォルダー以下の Lookup-standard.mfd ファイルが示されます。

 

document-mapping03

 

 

マッピングファイル(例: Lookup-standard.mfd)が開かれている状態で以下の操作を行います:

メニューオプションから「ファイル | ドキュメントの生成」を選択します。

この操作によりドキュメントの生成ダイアログボックスが表示されます。デフォルトのダイアログボックス設定を以下のスクリーンショットに示します。

 

document-mapping02

 

ドキュメンテーションデザイン

「固定デザインを使用」を選択することで、内蔵のドキュメンテーションテンプレートを使用します。

 

「ユーザー定義デザインを使用」を選択することで、StyleVision により作成された StyleVision Power Stylesheet を使用します。"...\My Documents\Altova\MapForce2013\Documentation\MapForce\" 以下に収められている SPS ファイルを選択することができます。

 

「参照」ボタンをクリックして定義済みの SPS ファイルを選択することができます。

 

「編集」ボタンをクリックすると StyleVision が起動し、選択された SPS が StyleVision ウィンドウにて開かれます。

 

 

以下にある定義済み SPS スタイルシートが ..MapForce2019\Documentation\MapForce フォルダーに収められています:

 

FunctionCallGraph.sps - メインマッピングの呼び出しグラフならびにユーザー定義関数が表示されます。

 

FunctionsUsedBy.sps - マッピングにて、どの関数が直接または間接的に使用されているか表示します。

 

ImpactAnalysis.sps - 全てのソースならびにターゲットノードを、ターゲットノードまでのルートとともに表示します。

 

OverallDocumentation.sps -  全てのノード、接続、関数、そしてターゲットノードを表示します。このオプションは最も詳細で、内蔵の「固定デザイン」出力を使った出力と同一の出力を得ることができます。

 

 

出力書式

出力フォーマットを HTML、Microsoft Word、RTF、または PDF から選択します。

固定デザインを使用すると、Microsoft Word ドキュメントは .doc ファイル拡張子で作成され、StyleVision SPS を使った生成では .docx ファイル拡張子にてファイルが作成されます。PDF 出力フォーマットは、 StyleVision SPS を使ったドキュメンテーションの生成でのみ有効になります

「出力を複数のファイルに分割」オプションを選択すると、入力、出力、定数コンポーネント、ライブラリから得られるユーザー定義関数のドキュメンテーションが分割されます。固定デザインでは、複数のドキュメント間においてリンクが自動的に作成されます。
「生成時にファイルを表示」オプションは全ての出力オプションに対して選択可能です。有効になっている場合、生成されたファイルがデフォルトのブラウザー(HTML 出力)、MS Word (MS Word 出力)、.rtf ファイルのデフォルトアプリケーション(RTF 出力)にて開かれます。

 

パスの長さの制限

アイテムに表示される「パス」の最大長さを指定することができます。

例えば、 ..\ShortPO\LineItems\LineItem は、デフォルトで設定されている最大長さ 3 となります。

 

含める対象

ドキュメンテーションに表示されるコンポーネントを指定することができます。

 

詳細

ドキュメンテーションに表示される詳細情報を指定することができます。

ライブラリ名を選択することで、関数に「core」プレフィックスが挿入されます。
接続されたノードならびに接続されていないノードの両方をドキュメンテーションに含めることができます。

 

メモ:
全てチェック/全てクリアボタンにより、そのグループにある全てのチェックボックスにチェックを入れる/チェックを外すことができます。

 

上の示されているデフォルトの設定にて 「OK」をクリックすると、出力ファイルの保存先とその名前を選択するよう促されます。固定デザインにより生成されたドキュメンテーションの一部を以下に示します。これは単一の出力ファイルであることに留意してください。

 

 

このテーブルではソースコンポーネントからターゲットコンポーネントへの接続が示されます。

 

document-mapping01

 

コンポーネントがドキュメント化される順番は、入力、出力、定数、ユーザー定義関数、そしてライブラリ関数となります。

 

例: 入力コンポーネント ShortPO:

最初の 2 つのアイテムである ShortPO と ShortPO/CustomerNr はターゲット内にあるどのアイテムにも接続されておらず、カラムが空となっています。
ShortPO/LineItems はターゲットの CompletePO/LineItems へ直接接続されています。
/LineItems/LineItem/ArticleNr には 2 つの接続が行われています:

 

ターゲットの /LineItem/Article/Number へ直接接続されています。
入力パラメーターとなる LookupArticle という名前のユーザー定義関数へ ArticleNr が接続されており、Name という名前の出力パラメーターがターゲットへ接続されています。

 

ユーザー定義関数の内容を以下に示します。

 

document-userdef

 

 

出力コンポーネントの CompletePO : このテーブルではソースコンポーネントからターゲットコンポーネントへの接続が表示されます

 

document-outpcmp

 

最初の 2 つのアイテムである CompletePO と CompletePO/Customer はソースコンポーネントにあるどのアイテムにも接続されておらず、カラムが空となっています。
CompletePO/LineItems はソースコンポーネントの ShortPO/LineItems へ直接接続されています。
LineItem/Article/Name は LineItems/LineItem/ArticleNr をソースアイテムとするユーザー定義関数の LookupArticle へ接続されています。

 

 

document-userfunc


(C) 2019 Altova GmbH