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

OHW構成ファイル

Oracle Help for the Web(OHW)構成ファイルは、OHW構成を定義するXMLファイルです。構成は、OHWサーブレットのすべての調節可能な機能を制御します。このファイルの通常の名前はohwconfig.xmlですが、サーブレットのconfigFileName初期化パラメータの値に指定すれば、他の名前を付けることも可能です。(OHWデモ・バンドルは、ohwconfig.xmlを使用します。)

OHW構成ファイルは、次の要素およびその子要素で構成されています。

<helpConfiguration>要素

<helpConfiguration>要素は、構成ファイルのトップレベルの要素です。次に説明する構成の全要素は、<helpConfiguration>タグおよび</helpConfiguration>タグの間に出現します。

<branding>要素

<branding>要素は、タブ・バーの上に表示される製品ブランドについてのテキストや画像を指定します。<branding>要素には、次の表で説明されている要素のうち1つのみを含めることができます。両方が含まれている場合、<brandingImage>が使用され、<brandingText>は無視されます。ブランド情報が指定されていない場合、OHWはデフォルトのブランド・テキストを使用します。

要素 説明
<brandingText>

タブ・バーの上のテキストをレンダリングします。この要素では、次の属性がサポートされています。

text - レンダリングされるテキスト。

<brandingImage>

タブ・バーの上に画像を表示します。この要素では、次の属性がサポートされています。

source - 表示される画像。画像へのパスは、このファイルの位置に対して絶対的または相対的です。

shortDesc - 画像についての短い記述。このテキストは、HTMLでのALT属性の記述と同じように表示されます。たとえば、画像の上にマウスを移動すると表示されます。

次に例を示します。


<branding>
  <brandingText text="Oracle iSomething Help" />
</branding>
または

<branding>
  <brandingImage source="images/anImage.gif" shortDesc="Oracle iSomething Help branding image" />
</branding>

<localeSettings>要素

OHWは、Oracle Help制御ファイルでロケール依存の操作をするために、システムにデフォルトで設定されているJava LocaleおよびJava Localeのデフォルトのエンコーディングを自動的に使用します。<localeSettings>要素を使用してこの動作を無効にできます。トピック(HTML)ファイルのエンコーディングは、トピック・ファイルに直接指定されることに注意してください。

OHW構成ファイルでは、<localeSettings>要素は<books>要素の前に位置します。<localeSettings>要素には次の要素が含まれます。

要素 説明
<locale>

ロケール依存操作のためにJava Localeを構築する際に使用されるISO言語、国および改良コード(オプション)を指定します。この要素では、次の属性がサポートされています。

language - ISO-639で定義されている小文字2文字の言語コード(たとえば英語はen)。

country - ISO-3166で定義されている大文字2文字の国コード(たとえば米国はUS)。

variant - ブラウザまたはプラットフォーム固有ロケールに対するオプションの改良コード。

<controlFileEncoding>

Oracle Help制御ファイル(たとえばISO8859_1)のキャラクタ・セット・エンコーディングに使用される、Javaでサポートされるエンコーディング名。この要素では、次の属性がサポートされています。

encoding - Javaでサポートされるエンコーディング名。サポートされる一連のエンコーディングは、JDKのバージョンによって異なります。Sun社のJDK 1.3でサポートされるエンコーディングの一覧は、http://java.sun.com/j2se/1.3/docs/guide/intl/encoding.doc.htmlを参照してください。

次に例を示します。


<localeSettings>
  <locale language="en" country="US"  />
  <controlFileEncoding encoding="ISO8859_1" />
</localeSettings>

<books>要素

<books>要素はOHWで表示されるコンテンツを指定します。<books>要素には、任意の数のヘルプセット、HelpBook、または両方の組合せを含めることができます。 (ヘルプセットおよびHelpBookは、一般的にブックと呼ばれます。) マージの動作は次の属性の値で定義されます。

combineBooks - trueの場合、すべてのブックからのビューが1セットのナビゲータ(タブ)に表示されます。falseの場合、各ブックに情報を表示するナビゲータのセットがあります。

useLabelInfo - trueの場合、作成者定義のラベルがマージされたヘルプセット/HelpBookのナビゲータに使用されます。falseの場合、デフォルトのラベル、たとえば、「目次」「索引」および「検索」タブ・ラベルが使用されます。

combineBookstrueの場合、たとえば「索引」タブのように種類とラベルが同じナビゲータのみが同じナビゲータにマージされます。これは、useLabelInfotrueに設定されている場合、予期せぬ結果を導くことがあります。たとえば、1つのヘルプセットでデフォルトの「索引」ラベルを「キーワード索引」でオーバーライドし他のラベルはデフォルトのままの場合、索引は同じタブでマージされません。ラベルを同じに設定(たとえばヘルプセットに対するヘルプセット・ファイルのように)するか、OHW構成ファイルでuseLabelInfofalseに設定することで、これを変更できます。

<books>要素には、次の要素が含まれます。

要素 説明
<helpSet>

OHWのインスタンスに含めるヘルプセット。この要素には、次の属性があります。

jar - ヘルプセットがJAR(Java Archive)ファイルに格納されている場合のJARファイルの場所。この属性が使用されている場合、JARファイルでのヘルプセット・ファイルの場所を指定するためにlocation属性も使用する必要があります。

location - ヘルプセット・ファイルの場所。ヘルプセットがJARファイル化されていない場合、これはヘルプセット・ファイルの名前になり、適切なパス情報が付随します。パスは、OHW構成ファイルの位置に対して絶対的または相対的です。この属性がjar属性とともに使用されている場合、locationはJARファイルでのヘルプセット・ファイルの場所です。

<helpBook>

OHWのインスタンスに含めるHelpBook。この要素には、次の属性があります。

basename - ファイル名の拡張子を除いた、ディレクトリにある制御ファイルの名前。たとえば、制御ファイルがmyproject.hhc、myproject.hhk、myproject.idxなどの場合、basenameはmyprojectです。

location - HelpBookファイルの場所。パスは、OHW構成ファイルの位置に対して絶対的または相対的です。

title - HelpBook/ヘルプセットがマージされ、マージされたブック・リストにHelpBookがOHWユーザー・インタフェースで表示される際に使用されるタイトル。(これとは対照的に、ヘルプセット・ファイルの<title>要素では、このタイトルはヘルプセットに対して設定されています。)

次に例を示します。


<books combineBooks="true" useLabelInfo="true">
 <helpSet location="shakespeare/shakespeare.hs" />
 <helpSet location="myProduct/myProductHelp.hs" />
 <helpSet jar="myJar.jar" location="myHelpset.hs" />
 <helpBook baseName="discoverer" location="discoverer/" title="Discoverer Help" />
</books>

ヘルプ・トピック・ファイルが、Oracle Helpによって予定されていた場所以外に格納された場合、<helpBook>要素および<helpSet>要素には0個以上の<contentLocation>要素を含めることができます。 後述の<contentLocation>要素を参照してください。

注意: HelpBookファイルおよびhelpBook要素は、OHJの旧リリースで使用されています。現在のリリースではヘルプセットの使用をお薦めしますが、Oracle Helpは引き続きHelpBookをサポートしています。 OHJでのHelpBookとヘルプセットの違いの詳細は、「ヘルプ・データの追加」を参照してください。

<contentLocation>要素

デフォルトでは、ヘルプセット(.hs)ファイルまたはHelpBookのベース・ディレクトリと同じ場所にあるヘルプ・トピック(HTML)ファイルはOHWによって自動的に処理されます。

ヘルプセットの場合、OHWは次のようにヘルプ・トピックHTMLファイルを処理します。

HelpBookの場合、OHWは次のようにヘルプ・トピックHTMLファイルを処理します。

ヘルプ・トピック・ファイルを他の場所に配置している場合、<contentLocation>要素を使用してその場所を指定する必要があります。<contentLocation>要素には、次の属性があります。

baseURI - ヘルプ・コンテンツのセットのルート位置を示す絶対URI。

<contentLocation>要素は<helpBook>または<helpSet>の子にできます(前述のとおり、この2つの要素自体は<books>の子です)。 <helpBook>および<helpSet>には、0個以上の<contentLocation>要素を含めることができます。

通常のHTMLファイルとは異なり、Oracle Helpのヘルプ・トピック・ファイルが表示されるにはOHWサーブレットによって処理される必要があるため、この要素は必須です。したがって、参照されるヘルプ・トピック・ファイルがデフォルトの場所にない場合、HelpBookまたはヘルプセットに配置されている場所を明示的に列挙する必要があります。(他の場所や他のWebサーバーにあるサブヘルプセットがヘルプセットに含まれる場合、または同じサーバーや別のサーバーのどこかに配置されているヘルプ・トピック・ファイルへの参照が状況依存マップ・ファイルに含まれる場合、この状況は発生します。)

たとえば、他のサーバーにあるサブヘルプセットhttp://www.myCompany.com/help/remoteHelpSet.hsを参照するローカルのヘルプセットmyHelpSet.hsでOHWが構成されている場合、構成ファイルには次のものが含まれます。


<books combineBooks="true" useLabelInfo="true">
  <helpSet location="myHelpSet.hs">
    <contentLocation baseURI="http://www.myCompany.com/help/" />
  </helpSet>
</books>

この構成により、ローカルのmyHelpSet.hsファイルが、たとえばhttp://www.myCompany.com/help/remoteHelpSet.hsなどのサーバーにあるヘルプ・コンテンツを参照していることがOHWに認識されます。したがってOHWはmyHelpSet.hsおよびそのリモート位置の両方でヘルプ・トピック・ファイルを処理します。

<parameters>要素

<parameters>要素はその他の各種OHWパラメータの値を指定します。この要素には、次の要素が含まれます。

要素 説明
<maxSearchThreads>

検索ナビゲータによって要求される、検索の際に生成されるスレッドの最大数。OHWが実行できる同時検索の最大数になります。この値は、サーブレットで予想されるロードに対応するように、慎重に設定する必要があります。

<defaultHomeID>

ユーザーが特定のトピックに移動した場合ではなく、OHWヘルプ・システムのURLに直接移動した場合にデフォルトで表示されるトピックの(マップ・ファイルに設定されている)トピックID。

次に例を示します。


<parameters>
  <maxSearchThreads>10</maxSearchThreads>
  <defaultHomeID>myTopicID</defaultHomeID>
</parameters>