| Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発 12c(12.1.2) E48092-01 |
|
 前 |
 次 |
この章では、Oracle Helpシステムのオーサリング・ユーティリティとプロセスについて説明します。
この項の構成は、次のとおりです。
Oracle Helpにフル機能のオーサリング環境はありません。オーサリング・ツールを使用しないでヘルプ・システムをオーサリングすることは難しくありませんが、Oracle Helpを直接サポートするAdobe RoboHelp、Quadralay WebWorks、AuthorIT Software CorporationのAuthorITなどのツールを使用する方が簡単です。
Oracle Helpのファイル形式はJavaHelpファイル形式に基づいているため、JavaHelpシステムを作成するオーサリング・ツールも使用できます。ただし、Oracle Help固有の機能は手動で追加する必要があります。Oracle HelpはMicrosoft社のHTML Helpの制御ファイル形式もサポートしているため、HTML Helpをサポートするオーサリング・ツールも使用できます。ただしこの場合も、Oracle Help固有の機能は手動で追加する必要があります。
OHJおよびOHWでは同じファイル形式を使用するため、作成したヘルプ・システムは変更なしで表示できます。
Oracle Helpヘルプ・システムの基本的なオーサリング手順は次のとおりです。
ヘルプ・システムのトピックを構成するHTMLページを記述します。
ヘルプセット・ファイルを作成します。このXMLファイルは、ヘルプ・システムを識別し、ユーザー・インタフェースの様々な側面を始めとする数多くのプロパティを指定します。たとえば、表示するナビゲータ(通常はタブとして表示される)はこのファイルに指定します。標準のナビゲータは「目次」、「索引」および「検索」です。このファイルはOracle Helpのメイン制御ファイルであり、必須です。
マップ・ファイルを作成します。このXMLファイルは、トピックIDをHTMLページにマップします。トピックIDは、状況依存コールのためのAPI、目次ファイル、索引ファイル、リンク・ファイルおよびトピック・ファイル内のトピックIDリンクで使用されます。このファイルは必須です。
索引ファイルを作成します。このXMLファイルは、「索引」タブに表示されるキーワードの索引を定義します。ヘルプ・システムで索引を使用しない場合、このファイルは不要です。ただし、索引を使用しない場合は、ヘルプセット・ファイルに「索引」タブを定義しないでください。
目次ファイルを作成します。このXMLファイルは、「目次」タブに表示される目次を定義します。ヘルプ・システムで目次を使用しない場合、このファイルは不要です。ただし、目次を使用しない場合は、ヘルプセット・ファイルに「目次」タブを定義しないでください。
検索索引を生成します。このファイルには、ユーザーが「検索」タブで単語または句を検索するときに使用されるデータが含まれます。このファイルはオプションです。ただし、検索索引を使用しない場合は、ヘルプセット・ファイルに「検索」タブを定義しないでください。ヘルプ・システムの作成にオーサリング・ツールを使用していない場合は、Oracle Helpに付属の索引作成ツールを使用できます。「テキスト検索インデクサの使用方法」を参照してください。
関連リンクを使用する場合は、リンク・ファイルを作成します。このXMLファイルは、トピックを関連リンク・キーワードに関連付けます。このファイルはオプションです。
Oracle Help for Javaには2つのオーサリング・ユーティリティが付属しています。Oracle Helpをサポートするオーサリング・ツールがない場合は、Oracle Helpシステムのオーサリングにこの2つのユーティリティを使用できます。それぞれの詳細は、該当するリンクを参照してください。
ヘルプセット・オーサリング・ウィザード: このウィザードは、特定の互換性のないヘルプ・コンテンツおよび制御ファイルをOracle Helpで使用できるファイルに変換します。たとえば、このウィザードを使用すると、RoboHelp 2000 for Microsoft HTML Helpで生成されたファイルからOracle Helpシステムを作成できます。
テキスト検索インデクサ: このユーティリティは、ユーザーが「検索」タブで単語または句を検索するときにOracle Helpで使用される検索索引ファイルを生成します。
OHWの埋込みヘルプ機能の一部として、アプリケーションの各コンポーネントに複数のレベルのヘルプを関連付け、各レベルが特定のユーザー動作によってトリガーされるようにできます。ヘルプのレベルは次のとおりです。
定義テキスト
方法テキスト
フル・ヘルプ
どのレベルとも、どのようなHTMLコンテンツでもかまいません。定義テキストおよび方法テキストは、集合的に埋込みヘルプ・コンテンツと呼ばれます。フル・ヘルプ・コンテンツは、ヘルプのウィンドウに単独のトピックとして表示されるコンテンツです。
定義テキストは、ハードコード化されたスタイル・クラス名definitionを使用して<div>内で指定されます。title属性がある場合は、定義テキストのトピックIDを表します。ここではプレーン・テキストのみを入力でき、この<div>タグではHTMLコンテンツは処理されないことに注意してください。例:
<div title="topicId" class="definition"> Any plain text </div>
方法テキストは、ハードコードされたスタイル・クラス名instructionsを使用して<div>内に指定されます。title属性がある場合は、方法テキストのトピックIDを表します。次に例を示します。
<div title="topicId" class="instructions"> Any HTML content </div>
トピックの定義テキストおよび方法テキストは、一般的なHTMLを使用してトピック・ファイルに次のように指定します。
定義テキストと指示テキストの<div>タグは、HTML本文内に表示されます。いずれのレベルのHelpのコンテンツも同じファイルで指定する必要があります。いずれかのレベルが同じファイルで使用できない場合、コンテンツは未定義と見なされます。
1つのトピックIDに対する定義テキストおよび方法テキストのコンテンツは、既存のトピックHTMLファイルに指定します。topic1.htmlという名前のサンプル・トピックを次に示します。
<html> <body> <div title="topic1" class="definition"> This is Definition Text help content. </div> ... <div title="topic1" class="instructions"> This is <b>Instructions Text</b> help content. </div> ... This is the regular Full Help content. ... </body> </html>
|
注意:
|
