共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

このマニュアルの構成

このマニュアルは 4 つのパートから構成されています。パート I 「概要」では、アプリケーション・ヘルプの設計段階で必要な設計者と開発者の協力と役割について述べます。パート II 「設計者が行う作業」では、オンライン・ヘルプを構成し記述する設計者に必要な情報を提供します。パート III 「プログラマが行う作業」では、ヘルプ・システムのアプリケーション・プログラマのツールキットを説明します。パート IV 「国際化対応」では、多言語環境でオンライン・ヘルプを使用する場合に設計者とプログラマの両方に必要な情報を提供します。

このマニュアルは次の章から構成されています。

パート I 「概要」

第 1 章「ヘルプ・システムの概要」

オンライン・ヘルプの作成にあたり、設計者と開発者の協力的な役割について説明します。

パート II 「設計者が行う作業」

第 2 章「ヘルプ・ボリュームの構成および記述」

ヘルプ・ボリュームの構成に必要な要素を説明します。

第 3 章「ヘルプ・トピックの記述」

ヘルプ・システム・マークアップ言語を概説し、さまざまなタイプの情報をフォーマットするのに使用する要素の例を示します。グラフィックを入れる方法とハイパーリンクの作成についても説明します。

第 4 章「ヘルプ・ボリュームの処理と表示」

1 つまたは複数のマークアップ・ファイルを処理して、オンライン表示を行うための実行時のファイルを生成する方法を説明します。

第 5 章「ヘルプタグ・マークアップのリファレンス」

ヘルプタグ・マークアップ言語要素を、各要素の例と共にアルファベット順に説明します。

第 6 章「特殊文字エンティティの概要」

特殊文字をヘルプ・トピックのテキストに入力するのに使用する文字と、それに対応するエンティティ名のリストを示します。

第 7 章「コマンドの要約」

端末エミュレータ・ウィンドウにコマンドを入力して、ヘルプ・ボリュームを処理および表示する方法を要約します。

第 8 章「ヘルプタグ文書型定義の読み方」

ヘルプタグ DTD (文書型定義) の概要と、それを使用して完全に SGML (Standard Generalized Markup Language) に準拠するヘルプ・ファイルを作成する方法を説明します。

パート III 「プログラマが行う作業」

第 9 章「ヘルプ・ダイアログ・ボックスの作成と管理 」

ヘルプ・ダイアログ・ウィジェットの概要と使い方を説明します。

第 10 章「ヘルプ要求への応答」

さまざまなヘルプにアクセスするためにエントリ・ポイントを提供する方法を説明します。

第 11 章「ヘルプ・ダイアログのイベント処理」

コールバック構造を使用してハイパーリンク・イベントを処理する方法を示します。

第 12 章「「ヘルプの使い方」の作成」

ユーザにヘルプ・システムの使い方を示すヘルプ・モジュールの作成方法を説明します。

第 13 章「インストール・パッケージの準備」

アプリケーションでオンライン・ヘルプを提供するために、インストール・パッケージに含まれているものについて説明します。

パート IV 「国際化対応」

第 14 章「母国語のサポート」

ヘルプ・システムで使用する言語依存ファイルを示します。

「用語集」

このマニュアルに出てくる語句とその定義のリストです。