ナビゲーション・ヘッダーをスキップ
Oracle Helpのファイル形式 Table of Contents
目次
Previous topic
前へ
Next topic
次へ

ヘルプセット・ファイル

ヘルプセット・ファイルは、ヘルプセットに関するプロジェクトレベルの情報を編成するXMLファイルです。たとえばヘルプセット・ファイルでは、マップ、目次、索引、関連リンクおよび検索などヘルプセットで使用される他の制御ファイルが参照されています。これらの参照を利用して、ユーザー・インタフェースを構築する際にOracle Helpで使用するナビゲーション表示のセットが定義されます。

(古いリリースのOHJでは、HelpBookファイルおよびHelpBookオブジェクトが使用されていました。HelpBookは現在のリリースのOHJでもサポートされていますが、現在のリリースではヘルプセット(ヘルプセット・ファイルおよびHelpSetオブジェクト)を使用することをお薦めします。 OHJをプログラミングする際のHelpBookとヘルプセットの違いの詳細は、「ヘルプ・データの追加」を参照してください。)

ヘルプセット・ファイルは、次の要素とその子要素で構成されます。

このトピックでは、サンプルのヘルプセット・ファイルも紹介しています。

<helpset>要素

ヘルプセット・ファイルの内容は、すべて1つの<helpset>要素内に記述されます。つまり、ヘルプセット・ファイルは<helpset>で始まり、</helpset>で終わる必要があります。1つのヘルプセット・ファイルで使用できるのは、1つの<helpset>要素のみです。

<title>要素

<title>要素は、ヘルプセットに名前を割り当てます。 次に例を示します。


  <title>API Reference</title>

状況により、このタイトルがヘルプセット名としてOracle Helpのユーザー・インタフェースに表示されます。たとえば、Oracle Helpが(ヘルプセットを連結するのではなく)マージされたヘルプセットのリストを表示するよう設定されている場合、タイトルはヘルプセットのドロップダウン・リストに表示されます。この機能の詳細は、次の項目を参照してください。

<maps>要素

<maps>要素は、トピックIDのトピック・ファイルへのマップに使用される1つ以上のマップ・ファイルを指定します。<maps>要素には、次の子要素があります。

要素 説明
<mapref>

このヘルプセットのためのマップ・ファイルの位置。複数のマップ・ファイルが指定されている場合にはマージされます。 <mapref>の各項目が順に検索され、マージしたマップが作成されます。 <mapref>要素には、次の属性があります。

location - ヘルプセットに対するマップ・ファイルの相対URL。

class - (オプション)その位置がマップ・ファイルのベース位置であるクラス。location属性に含まれるすべてのパス情報は、このベース位置に対する相対パスになります。

<homeID>

ヘルプセットのデフォルトのトピックとして使用される場合もあるトピックのID(マップ・ファイルに定義)。つまり、OHJの起動時にトピックが指定されていない場合には、デフォルトでこのトピックが表示されます。<homeID>要素は、次に示すOHJの実装でのみ機能します。

  • OHJ Documentation Viewer。(OHJ Documentation Viewerは、OHJのインストール時にインストールされます。)
  • OHJが実装されていて、ナビゲータ・ウィンドウおよびトピック・ウィンドウがデフォルトでドッキングされている場合。

<homeID>要素は、OHWでは使用できません。

例:


  <maps>
    <mapref location="main_map.xml"/>
    <mapref location="tutorial/tut_map.xml"/>
  </maps>

<wintype>要素

<wintype>要素は、サイズ、画面上の位置、文字色および背景色など、OHJでトピックの表示に使用する1つ以上のウィンドウの特徴を定義します。OHJのユーザー・インタフェースでの表示例は、「OHJのトピック・ウィンドウ」を参照してください。OHWではこの要素は無視されます。トピックがWebブラウザに直接表示される場合も、この情報は無視されます。

ヘルプセット・ファイルには、任意の数の<wintype>セクションを定義できますが、各ウィンドウ・タイプに対して定義できるのは1つです。<wintype>タグで有効な属性は次の1つのみです。

default - trueの場合で、トピック・ファイルにウィンドウ・タイプが指定されていない場合には、現在のウィンドウ・タイプがデフォルトのウィンドウ・タイプとして使用されます。false場合、このウィンドウ・タイプはデフォルトとならず、マップ・ファイルで明示的に指定されないかぎり使用されません。default属性を指定しない場合、その値はfalseとみなされます。

<wintype>要素には、次の子要素があります。

要素 説明

<name>

このウィンドウ・タイプの名前。トピックとウィンドウ・タイプを関連付ける際に使用されます。ヘルプセットに複数のウィンドウが定義されている場合、各ウィンドウ名は一意である必要があります。
<height> このウィンドウの高さ。数値は、ピクセル単位の距離を示します。数値の後にパーセント記号(%)が続く場合は、表示画面に対する割合を示します。
<width> このウィンドウの幅。数値は、ピクセル単位の距離を示します。数値の後にパーセント記号(%)が続く場合は、表示画面に対する割合を示します。
<x> このウィンドウの水平方向の位置。数値は、ピクセル単位の距離を示します。値が負の場合は、ウィンドウの右端と画面の右端との間の距離を表します。数値の後にパーセント記号(%)が続く場合は、表示画面に対する割合を示します。
<y> このウィンドウの垂直方向の位置。数値は、ピクセル単位の距離を示します。値が負の場合は、ウィンドウの下端と画面の下端との間の距離を表します。数値の後にパーセント記号(%)が続く場合は、表示画面に対する割合を示します。
<textfg> ウィンドウ内のテキストの文字色を表す、6桁の16進数によるRGB値。値の先頭に#を付けることは可能ですが、無視されます。各トピックについて、HTMLトピック・ファイルまたはCSSファイルで文字色が指定されている場合、この値より優先されます。
<linkfg> ウィンドウ内のリンクの文字色を表す、6桁の16進数によるRGB値。値の先頭に#を付けることは可能ですが、無視されます。各トピックについて、HTMLトピック・ファイルまたはCSSファイルでリンク色が指定されている場合、この値より優先されます。
<bg> ウィンドウ内の背景色を表す、6桁の16進数によるRGB値。値の先頭に#を付けることは可能ですが、無視されます。各トピックについて、HTMLトピック・ファイルまたはCSSファイルで背景色が指定されている場合、この値より優先されます。
<title> ウィンドウのタイトル・バーに表示されるテキスト。 このテキストより、HTMLトピック・ファイルの<title>タグが優先されます。
<toolbar> ウィンドウのツールバーに表示されるボタンの定義。次のうちの1つまたは複数の値の和である、5桁の16進数値です。

00004    ツールバー上のデフォルトのボタンをオフにします。
00040    URLアドレスのテキスト・フィールドを追加し、現在のURLを表示します。
00400    ナビゲーション用ボタンを追加します。
02000    「トピックの印刷」ボタンを追加します。
04000    「戻る」および「進む」ボタンを追加します。
08000    「検索」ボタンを追加します。
10000    「ドッキング」および「ドッキング解除」ボタンを追加します。

値の先頭に#を付けることは可能ですが、無視されます。

HTMLトピック・ファイルで属性が指定されている場合は、<wintype>セクションで指定された属性より常に優先されることに注意してください。

次の<wintype>要素では、チュートリアルのトピックで使用されるウィンドウを定義しています。


  <wintype default=false>
    <name>Tutorial</name>
    <height>50%</height>
    <width>200</width>
    <x>10</x>
    <y>10</y>
    <textfg>000000</textfg>
    <linkfg>0000cc</linkfg>
    <bg>ffffff</bg>
    <title>Tutorial</title>
    <toolbar>06004</toolbar>
  </wintype>

この例では、「Tutorial」という名前のウィンドウ・タイプを定義しており、デフォルトの高さは画面の50%、デフォルトの幅は200ピクセルです。このウィンドウは、画面の上端と左端からそれぞれ10ピクセルの位置に表示されます。ウィンドウの背景色は白、文字色は黒、リンク色は青です。このウィンドウのタイトル・バーには、「Tutorial」と表示されます。ツールバーには「トピックの印刷」「戻る」および「進む」ボタンが表示されます。

<links>要素

<links>要素は、複数のターゲットをリンクIDと関連付けるために使用される、1つ以上のリンク・ファイルを指定します。<links>要素には、次の子要素があります。

要素 説明
<linkref>

このヘルプセットのためのマップ・ファイルの位置。複数のマップ・ファイルが指定されている場合にはマージされます。 <linkref>の各項目が順に検索され、マージされたリンク・データベースが作成されます。 <linkref>要素には、次の属性があります。

location - ヘルプセットに対するリンク・ファイルの相対URL。

class - (オプション)その位置がマップ・ファイルのベース位置であるクラス。location属性に含まれるすべてのパス情報は、このベース位置に対する相対パスになります。

次に例を示します。


  <links>
    <linkref location="linkfile1.xml"/>
    <linkref location="linkfile2.xml"/>
  </links>

<view>要素

<view>要素は、Oracle Helpでのナビゲーション表示のレンダリング方法を指定します。ナビゲーション表示とは、ナビゲーション制御ファイル(目次、索引、検索など)のデータ、およびそれらを介して移動するためのユーザー・インタフェース・コントロールの表示形式を指します。Oracle Helpには、標準タイプの表示をレンダリングするJavaクラスが含まれています。各typeの表示は、それぞれのタブに表示されます。デフォルトでは、「目次」タブ、「索引」タブおよび「検索」タブです。

ヘルプセットには、各typeの表示を複数含めることができます。つまり、複数の「目次」タブや「索引」タブなどをユーザー・インタフェースに表示できます。また、Oracle Helpでは同じtypeの表示をマージできます。これは、同じlabelを持つ、同じtypeの表示をすべてマージすることで実現されます。(次の表内の<type>要素および<label>要素の説明を参照してください。)typeおよびlabelが同じ表示は、次のようにマージされます。

<view>要素には、次の子要素があります。

要素 説明
<label> ユーザー・インタフェースのナビゲータのタブに表示されるラベル。このラベルはオプションです。ラベルを指定しない場合、Oracle Helpでは「目次」、「索引」および「検索」がそれぞれ適切なタブに使用されます。<label>要素では、次の属性がサポートされています。

image - (オプション)画像ファイルと関連付けられたマップ・ファイルのID。imageは、ナビゲータのタブでラベル・テキストの隣に表示されます。

<title> 表示のタイトル。タイトルは、ナビゲーション表示ごとに異なる場所に表示されます。
  • 「目次」では、タイトルは最上位ノードのタイトルとして表示されます。目次ファイル(または、マージされている場合は複数の目次ファイル)のすべての最上位ノードは、このタイトル・ノードの下位に置かれます。「目次」にタイトルを指定しない場合、「目次」の定義に含まれるすべての最上位ノードが、そのまま最上位ノードとして「目次」に表示されます。

  • 「検索」および「索引」では、タイトルは、検索結果または索引項目の選択の結果としてリスト表示される任意のトピックのソースの場所として表示されます。「検索」または「索引」にタイトルを指定しない場合、ソースの場所は空欄になります。

<title>要素では、次の属性をサポートしています。

image - (オプション)画像ファイルと関連付けられたマップ・ファイルのID。「目次」に指定されている場合、imageは最上位ノードのテキストの隣に表示されます。「索引」または「検索」に指定されている場合、imageは無視されます。

<type> この表示のユーザー・インタフェースとして使用されるJavaクラスの名前。デフォルトの実装では、次のタイプが用意されています。

oracle.help.navigator.tocNavigator.TOCNavigator
oracle.help.navigator.keywordNavigator.KeywordNavigator
oracle.help.navigator.searchNavigator.SearchNavigator

(JavaHelpのタイプが指定されている場合、Oracle Helpではそれらを該当するOracle Helpのタイプにマップします。)

<data> この表示で使用されるデータへのパス。つまり、目次ファイル、索引ファイルまたは検索ファイルなどの関連するナビゲーション表示の制御ファイルへのパス。この要素のコンテンツは、ファイル名またはURLです。<data>要素では、次の属性がサポートされています。

class - (オプション)その位置がデータ・ファイルのベース位置であるクラス。HTMLファイルへの参照も含め、すべてのパス情報は、このベース位置に対する相対パスになります。

engine - データ・ファイルを処理するJavaクラスの名前。(JavaHelpの形式に基づいた)Oracle HelpのXML形式、Microsoft HTMLHelpのHHC/HHKのファイル形式および初期リリースのOHJでサポートされていたTOC/TOK形式を含み、Oracle Helpでサポートされているファイル・タイプごとに異なるengineが必要です。表示の各typeで有効なengine値を、次の表に示します。

タイプ oracle.help.navigator.tocNavigator.TOCNavigator:

engine 説明
oracle.help.engine.XMLTOCEngine(デフォルト) Oracle HelpのXML形式の目次(JavaHelpの目次の拡張)
oracle.help.engine.HHCEngine Microsoft HTMLHelp 1.xの目次
oracle.help.engine.TOCEngine 旧リリースのOHJの目次

タイプ oracle.help.navigator.keywordNavigator.KeywordNavigator:

engine 説明
oracle.help.engine.XMLIndexEngine(デフォルト) Oracle HelpのXML形式の索引(JavaHelpの索引の拡張)
oracle.help.engine.HHKEngine Microsoft HTMLHelpの索引
oracle.help.engine.TOKEngine 旧リリースのOHJの索引

タイプ oracle.help.navigator.searchNavigator.SearchNavigator:

engine 説明
oracle.help.engine.SearchEngine(デフォルト) Oracle Helpのテキスト検索データベース

次の例では、2つの「目次」タブが作成され、1つはUser's Guide、もう1つはReferenceというラベルが付いています。どちらのタブも、(<data>要素に指定されている)目次にはXMLのファイル形式が使用されていますが、<label>要素には異なる値が指定されています。labelが同じ場合には、目次ファイルであるug_toc.xmlおよびref_toc.xmlは単一の目次に結合され、1つのタブに表示されます。


  <view>
    <label>User's Guide</label>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.XMLTOCEngine">ug_toc.xml</data>
  </view>

  <view>
    <label>Reference</label>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.XMLTOCEngine">ref_toc.xml</data>
  </view>

次の例では、2つの表示に異なるファイル形式(XMLとHHC)および異なるデータ・エンジンが使用されていますが、作成される「目次」タブは1つのみです。これは、labelおよびtypeが同じためです。この機能の利点は、タブの表示方法を損わずに、古い形式を使用したヘルプ・システムを、新しい形式を使用したヘルプ・システムでマージできることです。


  <view>
    <label>Table of Contents</label>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.XMLTOCEngine">new_toc.xml</data>
  </view>

  <view>
    <label>Table of Contents</label>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.HHCEngine"old_toc.hhc</data>
  </view>

次の例では、目次、索引および検索がそれぞれ1つの表示に表示されます。labelが指定されていないため、Oracle Helpでは「目次」「索引」および「検索」のデフォルトのラベルを使用して3つのタブを作成します。各表示には、User's Guideという値の<title>要素が含まれています。結果は次のようになります。

この機能は、複数のヘルプセットをマージする際に便利です。目次の最上位ノードの数を減らしたり、索引および検索の使用時に検出されたトピックのソースを表示するなど、ユーザー指向を維持できます。



  <view>
    <title>User's Guide</title>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.XMLTOCEngine">ug_toc.xml</data>
  </view>

  <view>
    <title>User's Guide</title>
    <type>oracle.help.navigator.keywordNavigator.KeywordNavigator</type>
    <data engine="oracle.help.engine.XMLIndexEngine">ugindex.xml</data>
  </view>


  <view>
    <title>User's Guide</title>
    <type>oracle.help.navigator.searchNavigator.SearchNavigator</type>
    <data engine="oracle.help.engine.SearchEngine">search.idx</data>
  </view>

<subhelpset>要素

<subhelpset>要素は、このヘルプセット・ファイルで定義されているヘルプセット・ファイルに別のヘルプセットを含めるために使用されます。結合されたサブヘルプセットの表示は、複数の表示が単一のヘルプセットにマージされるのと同じ方法でマージされます。つまり、<type>および<label>が同じサブヘルプセットの表示がマージされます。 詳細は、前述の「<view>要素」を参照してください。

<subhelpset>要素では、次の属性がサポートされています。

location - マージするヘルプセットのURLを指定。

class - (オプション)その位置がサブヘルプセット・ファイルのベース位置であるクラス。location属性に含まれるすべてのパス情報は、このベース位置に対する相対パスになります。

ヘルプセット・ファイルの例

次に、前述したすべてのセクションを含むヘルプセット・ファイルの例を示します。<view>セクションには2つの目次、2つの索引および1つのテキスト検索があります。


  <?xml version='1.0'?>
  <helpset version="1.1">

  <maps>
    <mapref location="topics.xml"/>
  </maps>

  <wintype>
    <name>Tutorial</name>
    <height>50%</height>
    <width>200</width>
    <x>10</x>
    <y>10</y>
    <title>Tutorial</title>
    <toolbar>06004</toolbar>
  </wintype>

  <links>
    <linkref location="linkfile1.xml"/>
    <linkref location="linkfile2.xml"/>
  </links>

  <view>
    <label image="tocgif">Table of Contents</label>
    <title image="uggif">Forms User's Guide</title>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.XMLTOCEngine">ugcontents.xml</data>
  </view>

  <view>
    <label>Keyword Index</label>
    <type>oracle.help.navigator.keywordNavigator.KeywordNavigator</type>
    <data engine="oracle.help.engine.XMLIndexEngine">ugindex.xml</data>
  </view>

  <view>
    <label image="tocgif">Table of Contents</label>
    <title image="dggif">Forms Developer's Guide</title>
    <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
    <data engine="oracle.help.engine.HHCEngine"
      class="oracle.forms.documentation.dev">
      dgcontents.hhc
    </data>
  </view>

  <view>
    <label>Keyword Index</label>
    <type>oracle.help.navigator.keywordNavigator.KeywordNavigator</type>
    <data engine="oracle.help.engine.HHKEngine"
      class="oracle.forms.documentation.dev">
      dgindex.hhk</data>
  </view>

  <view>
    <label>Search</label>
    <title>Forms Documentation</title>
    <type>oracle.help.navigator.searchNavigator.SearchNavigator</type>
    <data engine="oracle.help.engine.SearchEngine"
      class="oracle.forms.documentation.dev">
      search.idx</data>
  </view>

  <subhelpset location="prodsup.hs"/>
  <subhelpset location="advanced.hs"/>
  </helpset>