Oracle Help for Javaのファイル形式 Previous topic
前へ
Next topic
次へ

ヘルプセット・ファイル(.hs)

[origin:JH, OHJ]

ヘルプセット・ファイル名の末尾には、ファイル拡張子 .hsを使用します。

ヘルプセット・ファイルは、1組のマップ・ファイルを指定し、関連付けられた1組のナビゲーション表示(目次、索引および検索)を定義します。新バージョンのOHJで、OHJ HelpBookという従来の概念はヘルプセットに変わりました。

ヘルプセット・ファイルの形式には、World Wide Web ConsortiumのeXtensible Markup Language(XML)が使用され、ファイルはタグによって次のセクションに分けられます。

OHJのヘルプセット・ファイルは、JavaHelp 1.0の仕様で記述され、JavaHelp 1.0 Referenceで実装されているヘルプセット・ファイルの拡張実装です。OHJにより実装された拡張は、次のとおりです。

<helpset>タグ

[origin:JH]

ヘルプセット・ファイルの最上位レベルのタグは、<helpset>タグです。1つのヘルプセット・ファイルでは、1つの<helpset>タグのみ使用できます。

JavaHelpの標準で指定される<helpset>タグでは、xml:langversionの2つの属性がサポートされています。OHJでは、versionのみがサポートされます。この仕様で説明しているヘルプセット定義は、バージョン1.1です。(OHJでは、現在のデフォルト・ロケールのデフォルトのキャラクタ・セットで制御ファイルがエンコードされていると想定しています。)

<title>セクション

[origin:JH]

ヘルプセットの最初のセクションである<title>セクションでは、ヘルプセットの名前を指定します。次に例を示します。

  <title>Developer Help</title>

この例では、ヘルプセットに「Developer Help」というタイトルが付けられます。

Helpオブジェクトを構築する際、プログラマはヘルプセットを結合するか、またはナビゲータのツールバー上のドロップダウン・リストに各ヘルプセットが表示されるようにするかを選択します。後者の場合ユーザーは、ドロップダウン・リストから選択することによって、各ヘルプセットの表示を切り替えることができます。ドロップダウン・リストに表示されるテキストが、<title>タグの内容です。この例では、「Developer Help」がリストに表示されます。

<maps>セクション

[origin:JH]

<maps>セクションは、<maps>タグにより定義されます。このセクションには、トピックIDとURL(HTMLファイルへのパス)とのマッピング方法に関する情報が含まれます。OHJでは、次のタグを含むJavaHelp 1.0の仕様で指定されたマップ・ファイルを使用します。

タグ 説明
<mapref> このヘルプセットのためのトピック・マップ・ファイルの位置。このタグに含まれるlocation属性で、マップ・ファイルの相対URLが指定されます。1つの<maps>セクション内で、複数のマップ・ファイルを指定できます。これらのマップ・ファイルはマージされます。<mapref>の各項目が順に検索され、マージしたマップが作成されます。OHJでは、オプションでclass属性を追加できます。このクラスの位置が、マップ・ファイルのベース位置です。location属性に含まれるすべてのパス情報は、このベース位置に対する相対パスになります。マップ・ファイル内でのHTMLファイルへの参照は、マップ・ファイルの位置に対する相対パスであることに注意してください。

<maps>セクションの簡単な例を示します。

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

<wintype>セクション

[origin:OHJ]

ウィンドウ・タイプは、<wintype>タグを使用して、<wintype>セクションで定義されます。

ウィンドウ・タイプでは、ヘルプのコンテンツ・ウィンドウの外観(サイズ、画面上の位置、文字色、背景色など)を定義します。OHJのヘルプ・システムにおける各トピックには、トピックのコンテンツの表示に使用するウィンドウ・タイプを指定するMETAタグが含まれる場合があります。(詳細は、このドキュメントの「トピック・ファイル」を参照してください。)ヘルプ・システムがWebブラウザ(Netscape Navigatorなど)を使用してヘルプ・トピックを表示している場合、ウィンドウ・タイプは無視されます。

<wintype>セクションは、各ウィンドウ・タイプに1つずつ、一意の名前を付ければ(<name>タグにより指定)、いくつでも指定できます。<wintype>タグで有効な属性は、defaultの1つのみです。default属性がtrueの場合、現在のウィンドウ・タイプがデフォルトのウィンドウ・タイプとなり、HTMLコンテンツ・ファイルでウィンドウ・タイプを指定しないかぎり、それが使用されます。default属性がfalseの場合、このウィンドウ・タイプはデフォルトとならず、HTMLコンテンツ・ファイルで明示的に指定されないかぎり使用されません。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>セクション

[origin:OHJ]

OHJのヘルプセット・ファイルの<links>セクションは、<links>タグにより定義され、関連リンクに使用されるリンク・ファイルの相対的な位置が含まれます。<links>セクションの<linkref>の各項目が順に検索され、マージされたリンク・データベースが作成されます。<linkref>項目では、オプションでclass属性もサポートされています。このクラスの位置が、リンク・ファイルのベース位置です。location属性に含まれるすべてのパス情報は、このベース位置に対する相対パスになります。

次に例を示します。

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

この例では、linkfile1.xmlおよびlinkfile2.xmlというファイルに、関連項目へのリンクのリストを表示する際に使用されるリンク項目およびエントリが含まれます。詳細は、「リンク・ファイル(.xml)」を参照してください。

<view>セクション

[origin:JH, OHJ]

このセクションにはヘルプセットで定義されるナビゲーション表示、すなわち目次、索引および検索の各表示に関する情報が含まれます。

JavaHelpの仕様で定義されているように、ヘルプセットには各タイプの表示を複数含めることができます。OHJでは、typeおよびlabelが同じすべての表示をマージします。つまり、typeおよびlabelが同じ目次は1つに連結され、typeおよびlabelが同じ索引はソートしマージされます。また、typeおよびlabelが同じ検索は順序を問わずマージされます(検索結果はOHJのユーザー・インタフェースによりソートされるため、順序は無関係です)。

OHJでは、JavaHelp 1.0の仕様で指定されているナビゲーション表示セクションのすべてのタグが解釈されます。

タグ 説明
<name> [origin:JH]  表示の名前。OHJでは、このタグおよびその内容は無視されます。
<label> [origin:JH, OHJ]  ナビゲータのタブに表示されるラベル。ラベルはオプションです。ラベルを指定しない場合、OHJでは「目次」、「索引」および「検索」の各タブのラベルとして、それぞれ「目次」、「索引」および「検索」が使用されます。ラベルおよび表示タイプの同じ表示は、OHJによりマージされます。<label>タグでは、オプションでimage属性がサポートされます。これは、ナビゲータのタブでラベル・テキストの隣に表示させる画像のマップ・ファイルIDに設定されます。
<title> [origin:OHJ]  表示のタイトル。タイトルは、「目次」における最上位のノードとして表示されます。このとき、「目次」の定義に含まれるすべての最上位ノードは、閉じられてタイトル・ノードの下位に置かれます。「目次」にタイトルを指定しない場合、「目次」の定義に含まれるすべての最上位ノードが、そのまま最上位ノードとして「目次」に表示されます。「検索」では、検索結果に表示される特定の全文検索インデックス・ファイルの位置を示すために使用されます。「検索」にタイトルを指定しない場合、検索結果におけるファイルの位置は空欄になります。「索引」では、タイトルは現在使用されません。<title>タグでは、オプションでimage属性がサポートされます。これは、画像のマップ・ファイルIDに設定されます。「目次」でimageを設定した場合、最上位ノードの目次アイコンとして使用されます。「索引」または「検索」に指定した場合、imageは無視されます。
<type> [origin:JH, OHJ]  この表示のユーザー・インタフェースとして使用されるJavaクラスの名前。デフォルトの実装では、次のタイプが用意されています。

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

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

<data> [origin:JH, OHJ]  表示の各タイプが使用するデータへのパスを指定します。ファイル名またはURLを使用できます。

OHJでは、オプションでclass属性を追加できます。このクラスの位置が、データ・ファイルのベース位置です。すべてのパス情報は、このベース位置に対する相対パスになります。表示のデータとして使用されるHTMLファイル名への参照は、このベース位置に対する相対パスであることに注意してください。

OHJでは、サポートされている他のファイル形式を指定するために、engine属性の使用を拡張しています。この属性では、指定したナビゲーション表示の内容を示すためにデータ・ファイルを処理するクラスの名前を指定します。このタグは、JavaHelp形式と、旧リリースのOHJでサポートされていたhhc/hhkのファイル形式の両方をサポートするために使用されます。表示の各typeで有効なengine値を、次の表に示します。

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

engine 説明
oracle.help.engine.XMLTOCEngine(デフォルト) OHJのXML形式の目次(JavaHelpの目次の拡張)
oracle.help.engine.HHCEngine Microsoft HTMLHelpの目次
oracle.help.engine.TOCEngine OHJの目次

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

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

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

engine 説明
oracle.help.engine.SearchEngine(デフォルト) OHJの全文検索データベース

<subhelpset>セクション

[origin:JH]

OHJでは、ヘルプセットを他のヘルプセットに含めることが可能です。サブヘルプセット内の、typeおよびlabelが同じ表示はマージされることに注意してください。<subhelpset>セクションでは、マージするヘルプセットのURLを指定するlocation属性がサポートされます。OHJでは、オプションでclass属性を追加できます。このクラスの位置が、サブヘルプセット・ファイルのベース位置です。すべてのパス情報は、このベース位置に対する相対パスになります。

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

次に、前述したすべてのセクションを含むヘルプセット・ファイルの例を示します。<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>


  Previous topic
前へ
Next topic
次へ