情報セットの作成

コンテンツ・ファイルからトピックを定義したので、情報セットを作成します。 情報セット (infoset) は、ドキュメンテーション Web またはブックです。 プラットフォームは、任意の数の情報セットを表示することができます。

情報セットには、1 つまたは複数の情報ビューを含めることができます。 情報ビューは、情報セット内の高レベルの意味上のグループを提供します。 情報ビューを使用すると、文書 Web 上に複数のビューを作成することができます。たとえば、情報ビューを使用して、 多くのコンポーネントが提供するドキュメンテーションの組み込みビューを作成することができます。  また、情報ビューを使用して、各種ヘルプ・トピック用の個別のビューを作成することもできます。  あるいは、この後で行いますが、ヘルプ・トピックをすべて表示する 1 つの情報ビューを作成することができます。 情報ビューという用語は、プラットフォームのユーザー・インターフェースにおけるビューという用語との衝突 あるいは混同を避けるために使用されます。

各情報ビューには、トピックのコレクションが含まれます。より高いレベルのコンポーネント・チームまたは製品チームが、 他の多数のコンポーネント・チームから提供されたドキュメンテーションおよびトピックを 1 つにまとめることもあります。 今回、ここで取り上げているプラグインは、トピックと、そのトピックを統合するブックの両方を提供するものと想定します。

以下の情報セットは、infoset_SampleGuide という ID を持ち、 view_Contents という ID を持つ 1 つの情報ビューを宣言しています。 最初に、情報ビューの高レベルの構造でワイヤリングし、最終的には、前に定義したトピック内でワイヤリングするので、 情報ビューの ID が重要になります。

infoset_SampleGuide.xml

<infoset id="infoset_SampleGuide" label="Online Help Sample" href="doc/splash.html">

 <infoview label="Content" id="view_Contents" />

</infoset>

ユーザーが「オンライン・ヘルプのサンプル (Online Help Sample)」というブックを選択すると、 「目次 (Content)」という 1 つの想定し得る情報ビューが表示されます。 splash.html に含まれているスプラッシュ・ページも表示されます。

トップレベルのワイヤリング

次に、「目次 (Contents)」情報ビュー内に表示されるトップレベルの構造を定義する必要があります。 最初に、トップレベルのトピック用に以下のトピック・ファイルを作成します。

topics_view_Contents.xml

<topics id="topics_view_Contents">

 <topic id="conceptsRoot" label="Concepts" />

 <topic id="tasksRoot" label="Tasks" />

 <topic id="funRoot" label="Fun Things" />

 <topic id="refRoot" label="Reference" />

</topics>

これらのトピックを「目次 (Contents)」情報ビューに「ワイヤリング」する必要があります。 それが終了した後、続けて上記のトップレベルのトピックの下の、他のトピックをすべてワイヤリングします。 最初に、以下のアクション・ファイルを使用してトップレベルのトピックをワイヤリングします。

actions_view_Contents.xml

<actions infoview="com.example.helpexample.view_Contents">

 <insert

 from="com.example.helpexample.topics_view_Contents"

 to="com.example.helpexample.view_Contents"

 as="child"/>

</actions>

上記のトピック・ファイル内のトピック・エレメント "topics_view_Contents" の 完全修飾トピック ID は、com.example.helpexample.topics_view_Contents です。 上記のアクション・ファイルで、このトピック・エレメントを取り出し、 それを ID com.example.helpexample.view_Contents を持つ情報ビューにワイヤリングします。 

以下の図に、これらトップレベルのトピックをワイヤリングした結果、 情報ビュー (Online Help Sample) がどのようになるかを示します。 情報セットのタイトル (ラベル) は、複数の情報セットがある場合にのみコンボ・ボックスに表示されます。