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

ヘルプ情報モデル

オンライン・ヘルプには次の 2 つの形式があります。

アプリケーションのオンライン・ヘルプを開発する場合、情報をアプリケーションでだけアクセスできるように構成できます。あるいはスタンドアロン・ヘルプのように、アプリケーションの外からでも情報をブラウズできるように設定できます。

アプリケーションとの統合

このヘルプ機能により、アプリケーションとそのオンライン・ヘルプを高度に統合できます。ユーザの見地から見れば、ヘルプはアプリケーションの一部ということになります。これによって、ユーザとユーザが参照するヘルプとの間にあるアプリケーションの「距離」が縮められます。

アプリケーションの近くにあるということは、オンライン・ヘルプが使いやすく、要求に迅速に対応できるということです。

ヘルプの種類

オンライン・ヘルプは次の 3 種類に分類されます。

ユーザがヘルプを獲得する方法

ユーザはいくつかの方法でヘルプを要求できます。多くのアプリケーションが [ヘルプ] メニュー、[ヘルプ] キー、およびダイアログ・ボックスの [ヘルプ] ボタンを提供しています。

[ヘルプ] キー

多くのアプリケーションでユーザがまず使用するのは [ヘルプ] キーを押す方法です。最近では、多くのワークステーションおよびパーソナル・コンピュータにおいて、[F1] ファンクション・キーが事実上の標準ヘルプ・キーとなっています。

共通デスクトップ環境 スタイル・ガイド』では、ヘルプ・キーとして [F1] キーを使用することと、OSF/Motif アプリケーションでのヘルプ・キーの使用を容易にするような内部処理を提供する OSF/Motif プログラマ・ツールキットを使用することを勧めています。

一部のコンピュータは、キーボード上に [ヘルプ] キーを備えています。

[ヘルプ] メニュー

[ヘルプ] メニューはヘルプ情報にアクセスするための一般的な方法です。OSF/Motif アプリケーションは [ヘルプ] メニューを提供しており、メニュー・バーの右端に表示されます。『共通デスクトップ環境 スタイル・ガイド』では、[ヘルプ] メニューに含めるコマンドについて推薦しています。

図 1-1 アプリケーションの [ヘルプ] メニュー

Graphic

[ヘルプ] ボタン

ほとんどのダイアログ・ボックスに、ダイアログでヘルプを表示するための [ヘルプ] ボタンがあります。『共通デスクトップ環境 スタイル・ガイド』では、ダイアログ・ボックスで [ヘルプ] ボタンを選択することはそのダイアログ・ボックスを使用中に [ヘルプ] キーを押すのと同じであると述べています。ただし、複雑なダイアログ、すなわちダイアログ・ボックス内で個々のコントロールがヘルプを持つような場合は例外です。