セクション

セクションとは、属性、パラメータ、テンプレート、コントロールからなる、XSLで記述されたドキュメントのブロックです。セクションの目次には、Title (タイトル)、Body (本文)、subordinate (下位)情報が含まれます。次の例は、簡単な編集モードで表示したIdentity Manager Systemの［Section Properties (セクションのプロパティ)］ページを示しています。

図 16-3 ［Section Properties (セクションのプロパティ)］ページ

［Identity Manager System］セクションには、セクションのタイトルと多数のタブ(属性)である［Document Properties (ドキュメントのプロパティ)］、［Client Properties (クライアントのプロパティ)］、［Header (見出し)］、［Font Settings (フォントの設定)］、［Other (その他)］があります。各タブには、編集可能なフィールドがあります。例えば、セクションのタイトルの名前は変更できます。［Advanced Editing (高度な編集)］アイコンをクリックすると、［Identity Manager System (Identity Managerシステム)］セクションの見出しの下に、1つのテンプレート、および複数の属性、コントロール、パラメータが含まれていることが分かります。

図 16-4 高度な編集モード

セクションのプロパティの表示と編集

［Style Editor (スタイルエディタ)］内で特定のセクションをクリックして［Properties (プロパティ)］ビュー(デフォルトではDesignerの左下隅)を見ると、選択したセクションに関連付けられた値を確認できます(デフォルトで［Properties (プロパティ)］ビューが表示されない場合は、セクションを右クリックして［Show Properties(プロパティの表示)］をクリックします)。

図 16-5 「Appendix B: Schema (付録B: スキーマ)」の［Properties (プロパティ)］ビュー

これらの値は［Properties (プロパティ)］ビューで編集できます。セクションには、［Enabled (有効)］、［Id (ID)］、［Numbered (番号)］、［Source (ソース)］、［Title (タイトル)］、［Titled (タイトル付き)］の各値があります。

テンプレート

テンプレートとは、生成されるページ全体のレイアウトを定義するXMLソースです。例えば、タイトルページには、多くの他の見出しだに加えて、テンプレートが含まれています。次の図は、Executive Summary (エグゼクティブサマリー)テンプレートの一部です。テンプレートの詳細については、操作チュートリアルを参照してください。

図 16-6 Executive Summary (エグゼクティブサマリー)テンプレートの一部

属性

属性はセクションの子要素です。例えば、セクションのタイトルIdentity Manager Systemを選択した状態で［Advanced Editor (高度なエディタ)］モードをクリックすると、次の属性は赤(グローバル)、緑(ローカル)、グレー(未使用)で表示されます。

図 16-7 属性

コントロールとパラメータ

パラメータを追加すると、各要素の表示方法を制御できます。［Advanced Editing (高度な編集)］モードでは、Short (abbreviated) Solution Name (簡略型ソリューション名)エントリの構造が、コントロールとラベルを含むグローバルな属性になります。次の例では、コントロールのタイプは、生成されるドキュメントの名前を誰でも入力できるテキストボックスです。コントロールを編集するには［プロパティ］ビューを使用します。

Designerでサポートされているコントロールのパラメータまたは値は次のとおりです。

新規セクションの作成

Style Editor (スタイルエディタ)に新しいセクションを挿入するには:

属性の追加

［Properties (プロパティ)］ビューには次の属性値が表示されます(属性はコントロールとパラメータによって定義されます)。

別のコントロールタイプの属性を表示することもできます。次の例では、まずコントロールを作成し、次にコントロールタイプをチェックボックス(デフォルト)から別のもの(テキストエリアなど)に変更しています。

追加内容をドキュメントに認識させる

生成されるドキュメントに、追加した属性の情報が取り込まれるようにするには、次のいずれかの操作を実行する必要があります。

方法2: カスタムレイアウト用のテンプレートを追加する

次のタスクを実行します。

• テンプレートの作成
• 別のセクションとテンプレートの作成

テンプレートの作成

1. 新しく作成したセクションを右クリックします。

2. ［新規］>[テンプレート］を選択します。

   

テンプレートには大半がコメントからなるデフォルトのコンテンツが含まれています。これらのコンテンツは初めてテンプレートを使用する際に役立ちます。この方法については次のタスクで説明します。ここでは、このテンプレート内のコメントを次のXSLコマンドで置換します。

	<xsl:param name="MyAttribute"/>	<xsl:template name="Section.Body"> MyAttribute:<xsl:call-template name="Format.OutputTextArea">		                 	                    <xsl:with-param name="value" select="$MyAttribute"/>		 	           </xsl:call-template> </xsl:template>

メモ: XSL内にFormat.OutputTextAreaの呼び出しがありますが、これはDocGen Core Support (DocGen コアサポート)テンプレートに含まれているヘルパー関数です。テキストエリアにはHTMLコードを使用できますが、Format.OutputTextAreaの呼び出しによりHTMLコードが正しく解釈およびエスケープされます。ドキュメント生成用の主要なXSLライブラリコールについては、セクション C.0, ドキュメントジェネレータのコアサポートテンプレートを参照してください。

テンプレートは次のようになるはずです。

このセクションのドキュメントを生成すると、次のような結果が得られます。

別のセクションとテンプレートの作成

1. 新しく作成したセクションを右クリックして、［New (新規)］>［Section (セクション)］の順に選択します。［Section Name (セクション名)］ウィンドウで、新しいセクションに「Table of Contents (目次)」と名前を付けます。

2. この新規作成したセクションを右クリックして、［New (新規)］>［Template (テンプレート)］の順に選択します。このテンプレートのコメントは慎重に目を通してください。これらの詳細は重要です。

カスタムのセクションを作成する際には、ドキュメントになんらかの情報を挿入することになります。コメントにも記載されているとおり、開発者は通常、次のいずれかのテンプレート関数を上書きします。

• セクションの本文 (最も一般的)
• セクションのコンテンツ
• セクションのタイトル

次の図は、定義されるセクションを示しています。スタイルの開発者は、このテンプレートを書いて関心のある領域を上書きします。

図 16-8 テンプレートの拡張ポイント

この例では、Section.Bodyを上書きします。Titleのデフォルトの動作を変更する必要も、他のセクションとこのセクションの関係を変更する必要もないためです(そうした変更は、ここで上書きしなくても、階層ビューを使用して、デフォルトのテンプレートで制御できます)。それには、デフォルトのテンプレートに出てくるサンプル関数のコメントを外します。次に上書き後の結果を示します。

図 16-9 テンプレートの上書き

この時点でドキュメントを生成しても、Table of Contents (目次)に内容は取り込まれません(周りのテキストを除く)。これは、スタイルソースがこのセクションに対して指定されていると、テンプレート側では想定するためです。ソースを指定するには:

1. Table of Contents (目次)セクションをクリックします。

2. ［Properties (プロパティ)］ビューで、ソースに［style (スタイル)］を設定します。

3. ［MySection］を右クリックして、［Generate Doc for this Section (このセクションのドキュメントを生成する)］を選択します。

   

ソースの表示

ドキュメントを生成すると、［Output XML Source Files (XMLソースファイルを出力)］というオプションがあります。このオプションの横にあるチェックボックスをクリックしてオンにしてください。ドキュメントを生成するとき、.xmlソースファイルが表示されるようになります。これらのソースファイルは、ソースを(例えば「style (スタイル)」などに)設定するときテンプレート内で使用されるXMLデータです。Designer 1.1以降では、次のソースが用意されています。