# はじめに

このマニュアルでは、共通デスクトップ環境アプリケーション・ソフトウェアのオンライン・ヘルプの開発方法について説明します。ヘルプ・トピックの作成方法や、オンライン・ヘルプを Motif™アプリケーションに統合する方法についても説明します。

## 対象読者

このマニュアルの対象読者は、次のとおりです。

- オンライン・ヘルプ情報を設計、作成、検証する設計者

- 完全なヘルプ機能を備えたソフトウェア・アプリケーションの作成を目的としている開発者

## このマニュアルの構成

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

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

第１部「概要」

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

第２部「設計者が行う作業」

`` HRDC.OrgH.mkr.1 は、ヘルプ・ボリュームの構成に必要な要素を説明します。

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

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

共通デスクトップ環境 DocBook 文書型定義ガイドは、アルファベット順にDocBookマークアップ言語の要素を列挙し、それらの使用方法について説明しています。

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

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

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

第３部「プログラマが行う作業」

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

HRDC.HReq.mkr.1, explains how an application provides entry points to access different types of help.

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

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

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

第４部「国際化対応」

HRDC.Lang.mkr.1は、ヘルプ・システムで使用する言語依存ファイルを示します。

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

## 関連文書

関連する「共通デスクトップ環境」の文書を、以下に示します。

- 共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド

- 共通デスクトップ環境 国際化対応プログラマーズ・ガイド

- CDE/Motif スタイル・ガイドおよび認証チェックリスト

- 共通デスクトップ環境 ユーザーズ・ガイド

- 共通デスクトップ環境 DocBook 文書型定義ガイド

SGML (Standard Generalized Markup Language) の技術的な説明については、次の文書を参照してください。

- The SGML Handbook by Charles F. Goldfarb, Oxford University Press (ISBN 0-19-853737-9).

## 表記上の規則

次の表に、このマニュアルで使用する表記上の規則を示します。

## 表記上の規則

`文字または記号` | `意味` | `使用例`
`AaBbCc123` | コマンド、ファイル、ディレクトリの名前、画面の出力表示 | `.login`ファイルを編集します。 `ls -a`を使用してすべてのファイルをリストします。 `system%` `You have mail.`
AaBbCc123 | 変数を示します。 実際に使用する特定の名前または値で置き換えます。 | ファイルを削除するには、`rm` `` filenameを入力します。
AaBbCc123 | 文書名、新規の語句または用語、および強調すべき語句を示します。 | 共通デスクトップ環境 ユーザーズ・ガイド ``を参照してください。 これらは、classオプションと呼ばれます。 これを行うには、rootでなければなりません。