ナビゲーション・ヘッダーをスキップ
Oracle Helpシステムのオーサリング Table of Contents
目次
Previous topic
前へ
Next topic
次へ

Oracle Helpシステムのオーサリング

Oracle Helpには、完全なオーサリング環境は含まれていません。オーサリング・ツールを使用しないヘルプ・システムのオーサリングは非常に簡単ですが、eHelp社のRoboHelpやAuthorIT Software社のAuthorITなど、Oracle Helpを直接サポートするツールを使用する方がよい場合もあります。

Oracle Helpのファイル形式はSun社のJavaHelpのファイル形式に基づいているため、任意のオーサリング・ツールでJavaHelpシステムの作成を開始することも可能です。ただし、Oracle Help固有の機能を手動で追加する必要があります。Oracle HelpはSun社のHTML Help 1.xの制御ファイル形式もサポートしているため、HTML Helpをサポートしているヘルプ・オーサリング・ツールで開始することもできます。この場合も、Oracle Help固有の機能すべてを手動で追加する必要があります。

Oracle Help for Java(OHJ)およびOracle Help for the Web(OHW)では同じファイル形式が使用されているため、ヘルプ・システムを一度オーサリングすれば、変更を加えることなくOHJおよびOHWのどちらでも表示できます。

このトピックでは、次の項目について説明します。

オーサリングの概要

Oracle Helpのヘルプ・システムをオーサリングする基本的な手順は、次のとおりです。説明されているファイルの詳細は、このガイドのファイル形式のセクションへのリンクをたどってください。

  1. ヘルプ・システムのトピックで構成されるHTMLページを記述します。

  2. ヘルプセット・ファイルを作成します。このXMLファイルによりヘルプ・システムが識別され、特定のユーザー・インタフェースを含み、多くのプロパティが指定されます。たとえば、どのナビゲータ(通常タブとして表示される)を表示するかをこのファイルに指定します。標準のナビゲータは、目次、索引および検索です。これは、Oracle Helpの主要な制御ファイルで、必須です。

  3. マップ・ファイルを作成します。このXMLファイルにより、トピックIDがHTMLページにマップされます。これらのIDは、状況依存ヘルプのAPI、目次ファイル、索引ファイルおよびリンク・ファイル、また、トピック・ファイルのトピックIDリンクなどでも使用されます。このファイルは必須です。

  4. 索引ファイルを作成します。このXMLファイルにより、「索引」タブに表示される索引が定義されます。ヘルプ・システムに索引がない場合、このファイルは不要です。索引がない場合は、ヘルプセット・ファイルに「索引」タブを定義しないでください。

  5. 目次ファイルを作成します。このXMLファイルにより、「目次」タブに表示される目次が定義されます。ヘルプ・システムに目次がない場合、このファイルは不要です。目次がない場合は、ヘルプセット・ファイルに「目次」タブを定義しないでください。

  6. 検索インデックスを生成します。このファイルには、ユーザーが「検索」タブで語句を検索する際に使用されるデータが含まれます。このファイルはオプションです。検索インデックスがない場合は、ヘルプセット・ファイルに検索タブを定義しないでください。ヘルプ・システムの作成にオーサリング・ツールを使用していない場合は、Oracle Helpに含まれている索引ツールを使用できます。「検索インデックス作成機能の使用方法」を参照してください。

  7. 関連リンクを使用する場合は、リンク・ファイルを作成します。このXMLファイルにより、トピックと関連リンクのキーワードが関連付けられます。このファイルはオプションです。

Oracle Help for Javaに含まれるオーサリング・ユーティリティ

Oracle Help for Javaには、2つのオーサリング・ユーティリティが含まれています。Oracle Helpをサポートしているオーサリング・ツールがない場合は、これらのツールを使用してOracle Helpシステムをオーサリングできます。各ツールの詳細は、次のリンクをたどってください。