test

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

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

この章では、ヘルプ・システムの概要を述べ、ユーザ・インタフェースを簡単に説明します。ここではヘルプ情報の構成を示し、ヘルプ・モジュールの作成および処理の方法を概説し、アプリケーション・ヘルプの設計および作成における設計者と開発者の役割を説明します。

ヘルプ・システムの概要

ヘルプ・システムは、アプリケーション・ソフトウェアのオンライン・ヘルプを開発するための一連のツールを提供します。これにより設計者は、グラフィックとテキストを書式化し、ハイパーリンクやアプリケーションとの通信などをオンライン・ヘルプに書き込むことができます。

また、オンライン・ヘルプをアプリケーションに統合するためのプログラマのツールキットも提供します。ヘルプ・システムのアプリケーション・プログラム・インタフェースは、2 つの特殊なヘルプ・ダイアログと、オンライン・ヘルプ・モジュールの表示、ナビゲート、検索、および印刷に使用するサポート・ルーチンを提供します。

開発者のツールキット

ヘルプ・システム開発者のツールキットには、オンライン・ヘルプを記述、処理、表示するためのツールと、アプリケーション・プログラム用のライブラリが含まれています。

設計者用ツールキット

オンライン・ヘルプの作成および処理の詳細は、第 2 章「ヘルプ・ボリュームの構成および記述」を参照してください。

アプリケーション開発者用ツール

アプリケーション・プログラム用のライブラリについては、第 9 章「ヘルプ・ダイアログ・ボックスの作成と管理 」から第 13 章「インストール・パッケージの準備」 で説明します。

オンライン・ヘルプの概要

コンピュータのハードウェアおよびソフトウェアの機能をすべて覚えることは不可能です。多くのコンピュータ・ユーザは、何度かヘルプを必要とすることがあるはずです。

オンライン・ヘルプは印刷されたマニュアルと異なり、その場ですぐ参照できる点で優れています。最も重要なのは、ユーザの現在の「コンテキスト」の情報に適応できるようにするという点です。コンテキスト・ヘルプはユーザが行なっている作業に対応するヘルプを提供します。オンライン・ヘルプを開発するときは、ユーザがその場の状況に応じてあらゆるヘルプを必要とすることに注意してください。ユーザの疑問を予測することによって、論理的かつ直観的に応答するアプリケーション・ヘルプを設計できます。

ヘルプ情報モデル

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

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

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

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

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

ヘルプの種類

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

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

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

[ヘルプ] キー

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

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

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

[ヘルプ] メニュー

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

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

Graphic

[ヘルプ] ボタン

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

ヘルプ・ユーザ・インタフェース

この節では、ヘルプ・システムが提供するグラフィカル・インタフェースの概要を説明します。ヘルプの機能の詳細は、『Solaris 共通デスクトップ環境 ユーザーズ・ガイド』を参照してください。対応するオンライン・ヘルプを表示するには、デスクトップのフロントパネルの [ヘルプ・ビューア] (「ブラウザ・ボリュームを表示するには」を参照してください) を開きます。それから [デスクトップの紹介] および [ヘルプの使い方] を選択します。

アプリケーションの使用中、[ヘルプ] キーを押すかアプリケーションの [ヘルプ] メニューを選択することにより、ユーザはヘルプを要求できます。また、ヘルプ・システムを統合したアプリケーションをインストールできるので、デスクトップの [ヘルプ・ビューア] からそれぞれのヘルプ・モジュールにアクセスできます。これにより、複数のアプリケーションが提供するヘルプ情報をブラウズする場合でも、各アプリケーションを実行せずに行うことができます。

ヘルプ・ウィンドウ

ユーザがヘルプを要求すると、ヘルプ・システムはヘルプ・ウィンドウを表示します。ヘルプ・ウィンドウには、一般ヘルプと簡易ヘルプの 2 種類あります。一般ヘルプ・ウィンドウはメニュー・バー、トピック・ツリー、およびトピック表示領域から構成されます。トピック・ツリーはユーザが選択できるヘルプ・トピックの一覧です。ウィンドウの下部 (トピック表示領域) には選択されたトピックが表示されます。

簡易ヘルプ・ウィンドウはむだを省いたヘルプ・ウィンドウです。トピック表示領域と 1 つ以上のダイアログ・ボタンしか表示されません。このウィンドウは、定義などの短い組み込み情報の表示によく使用されます。

図 1-2 一般ヘルプ・ウィンドウと簡易ヘルプ・ウィンドウ

GraphicGraphic

ハイパーリンク

ヘルプ・トピックには、関連するヘルプ情報へ「ジャンプ」するハイパーリンクがしばしば含まれています。テキストとグラフィックの両方をハイパーリンクとして使用できます。図 1-3 は、ハイパーリンクの識別に使用されるスタイルのフォーマットを示しています。

実線の下線または破線の下線は、ハイパーリンクである話または句を示します。実線の下線、つまり標準ハイパーリンクが最も一般的です。ハイパーリンクを選択すると、関連するトピックが表示されます。ハイパーリンク・トピックを現在のヘルプ・ウィンドウと新規ウィンドウのどちらに表示するかは、設計者が指定します。破線の下線は定義リンクを示します。これを選択すると、関連するトピックが簡易ヘルプ・ウィンドウに表示されます。グレーの隅の開いている枠 (破線または実線の線) は、グラフィック・ハイパーリンクを示します。

図 1-3 グラフィック・ハイパーリンクとテキスト・ハイパーリンクの形式

Graphic

ヘルプ・ナビゲーション

図 1-4 のトピック・ツリーは、現在のヘルプ・ボリュームのトピックのリストです。リスト最上部にある最初のトピックはホーム・トピックで、ヘルプ・ボリュームの先頭です。矢印 (->) は現在のトピックを指し、ヘルプ・ボリュームにおけるユーザの位置を示します。

図 1-4 一般ヘルプ・ダイアログ・ボックスのトピック・ツリー

Graphic

ヘルプ・トピックを表示するには、トピック・ツリーのタイトルか、トピック表示領域のハイパーリンクを選択します。表示をスクロールして任意のトピックを選択することにより、トピックの概要をブラウズできます。ナビゲーション・コマンドにより、前のトピックまたはヘルプ・ボリュームの先頭に戻ることができます。

ヘルプ・ナビゲーション・ボタン

一般ヘルプ・ダイアログには、[前のトピックへ]、[ヒストリ]、 [索引] の 3 つのダイアログ・ボタンがあります。これらの機能は、メニュー項目の選択にも使用できます。

デスクトップのフロントパネルから [ヘルプ・ビューア] を使用する場合、一般ヘルプ・ダイアログに [トップレベル] という追加ダイアログ・ボタンがあります。別のヘルプ・ボリュームを参照した後、このボタンを選択してデスクトップ・ブラウザ・ヘルプ・ボリュームのトップレベルに戻ることができます。

ヘルプ・メニュー

一般ヘルプ・ダイアログのメニュー・バーには、[ファイル]、[編集]、[検索]、[ナビゲート]、[ヘルプ] の 5 つのメニューが表示されます。[検索] メニューと [ナビゲート] メニューには、前記した [索引] ボタンとナビゲーション・ボタンで使用するコマンドがあります。また、[ナビゲート] メニューには、ヘルプ・ボリュームの先頭に戻るための [ホーム・トピック] コマンドがあります。その他のメニューは次の機能を提供します。

ヘルプ索引

ヘルプ・ボリュームには、ユーザがサブジェクトのヘルプ・トピックを検索できるように重要な語句の索引が入っています。ユーザは現在のボリューム、選択したボリューム、またはシステムで使用できるすべてのヘルプ・ボリュームの索引をブラウズまたは検索できます。* (アスタリスク) および ? (クエスチョン・マーク) などの正規表現もトピックの検索に使用できます。対応するヘルプ・トピックを表示するには、索引エントリを選択します。

図 1-5 [索引検索] ダイアログ・ボックス

Graphic

[ヘルプ索引] は一度に表示するには多すぎる場合があるので、表示されていない索引エントリがまだあったり、全部が表示されている場合もあります。+ (プラス) または - (マイナス) の符号は表示されていない索引エントリがまだあるのかないのかを示します。マイナス符号はエントリのすべてが表示されていることを示し、プラス符号はまだ表示されていないエントリがあり、索引エントリを表示できることを示します。

図 1-6 の -9 は、9 個の索引エントリが表示されていることを意味しています。+2 の符号は表示されていないエントリがまだあることを示します。表示されていないエントリを選択するとリストが展開され、+ 符号が - 符号に変わります。この図の最後の索引エントリはこのようにして表示されたエントリです。

図 1-6 索引エントリ符号

Graphic

ヘルプからの印刷

ユーザは、個々のヘルプ・トピック、目次、索引、あるいはヘルプ・ボリューム全体を印刷できます。出力はテキストのみ印刷されます。用紙サイズ、部数、出力先プリンタなどのオプションも、[印刷] ダイアログ・ボックスで設定できます。

図 1-7 [印刷] ダイアログ・ボックス

Graphic

ヘルプ・トピックの構成

設計者はヘルプ情報を論理フレームワークで構成します。例外はありますが、トピックの概略または階層を示す形式がほとんどです。図 1-8 に示すトピックの階層は、メイン・レベル、3 つのセクション、およびそれに従属するトピックから構成されています。[ヘルプ] は階層から成る情報に最適化されていますが、必要に応じて任意の構成にできます。

図 1-8 トピックの階層

Graphic

ヘルプ・トピック

ヘルプ・トピックは固有の ID で識別される情報の単位です。ヘルプ・システムが提供する一連のタグは、ヘルプ・トピックをマークし、構造的なフレームワークを作成するために使用されます。ヘルプ・ビューアはヘルプ・システムの一部で、ヘルプ・トピックに直接アクセスし表示させることができます。

ヘルプ・ボリューム

ヘルプ・ボリュームは、アプリケーションまたは特定のサブジェクトを記述するトピックの集まりです。アプリケーションのヘルプを開発する場合、一般にはアプリケーションごとに 1 つのヘルプ・ボリュームがあります。ただし、複雑なアプリケーション、または関連するアプリケーションの集まりについては、複数のヘルプ・ボリュームを使用することもあります。

ヘルプ・ファミリ

ソフトウェアは、プロダクト・ファミリとして認識される一連の関連アプリケーションとして使用できます。たとえばオフィスで使用されるアプリケーションにはワードプロセッサ、スプレッドシート、描画プログラムなどがあります。各アプリケーションには独自のヘルプ・ボリュームがあるので、関連するヘルプ・ボリュームをヘルプ・ファミリとしてグループ化するようになっています。ヘルプ・ファミリには単一のヘルプ・ボリュームまたは複数のボリュームが入っています。

ヘルプ・ボリュームをヘルプ・ファミリにまとめるかどうかは任意です。フロントパネルの [ヘルプ・ビューア] などのヘルプ・ブラウザでヘルプをブラウズできるようにする場合にのみ必要です。

ヘルプ・ファミリ・ファイルとその使い方については、「ヘルプ・ファミリを作成するには」を参照してください。

ヘルプ・ブラウザ・ボリューム

デスクトップは、システムにインストールされたヘルプを表示するブラウザ・ボリュームと呼ばれる特殊なヘルプ・ボリュームを提供します。フロントパネルの [ヘルプ・ビューア] をクリックすると、図 1-9 に示すブラウザ・ボリュームが表示されます。

これは、ヘルプ・ファミリ (下線の付いた名前) とヘルプ・ファミリのメンバである任意のボリュームを表示します。

図 1-9 ヘルプ・ブラウザ・ボリューム

Graphic

ブラウザ・ボリュームにより、アプリケーションを使用せずにアプリケーション固有のヘルプにアクセスできます。またスタンドアロン・ヘルプを書く場合は、ヘルプを使用するための唯一の手段がこのブラウザ・ボリュームを使用する方法です。ヘルプ・ボリュームが 1 つしかない場合は、[ヘルプ・ビューア] でブラウズできるヘルプ・ファミリに属していなければなりません。

「ブラウザ・ボリュームへのヘルプの追加」では、ファミリ・ファイルの作成方法と、ブラウザ・ボリュームからヘルプ・ボリュームにアクセスできるようにするためにユーザが行うべき作業について説明しています。

設計者が行う作業

オンライン・ヘルプの記述は印刷マニュアルを記述するのとは違うので、対象ユーザ、情報へのアクセスの方法、アプリケーションと情報との合致という点に留意することが重要です。

オンライン・ヘルプの目的

良質のオンライン・ヘルプの設計には、次の 2 つの重要な目的があります。

これらに目標を置けば、最適なヘルプは何か、必要な情報は何かを判断するのに役立ちます。

対象となるユーザ

何を書く場合でも、対象となるユーザとそのユーザが必要としている情報を理解することが大切です。特にオンライン・ヘルプでは、ユーザが行おうとしている作業と、起こりうる問題について認識しておくことが重要です。

ヘルプへのアクセス方法

ユーザを正しく認識するのと同時に、ユーザがどのようにヘルプにアクセスするのかを理解することが重要です。

アプリケーションのヘルプ

アプリケーションのヘルプを記述する場合は、ブラウズできるトピックと、コンテキスト・ヘルプとしてアプリケーションから使用できるトピックをそれぞれ決めることが必要です。トピックをナビゲートできる場合は、トピック・ツリーまたはハイパーリンクを使用してトピックをブラウズできます。排他的なコンテキスト・ヘルプに指定されているトピックは、アプリケーションの特定のコンテキストからしかトピックを表示できないため、ブラウズできません。

アプリケーションのヘルプボリュームを登録するかどうかも決める必要があります。登録されたヘルプ・ボリュームは他のアプリケーション (ヘルプ・ビューアなど) によっても表示でき、より広範囲な情報へのアクセスが可能になります。ヘルプ・ボリュームにあるトピックへの別のヘルプ・ボリュームからのハイパーリンクが含まれている場合は、そのヘルプ・ボリュームを登録してください。

アプリケーションのインストールと登録の詳細は、「アプリケーションとそのヘルプの登録」を参照してください。

スタンドアロン・ヘルプ・ボリューム

スタンドアロン・ヘルプ・ボリューム (アプリケーションに対応付けられていないヘルプ・ボリューム) を記述する場合は、別の方法で実行できます。

まず、記述したすべてのトピックをユーザが使用できるようパスを設定しなければなりません。つまり、すべてのトピックが、少なくとも 1 つのハイパーリンクによってブラウズできなければなりません。また、ヘルプに対応付けられているアプリケーションがないため、ヘルプ・ボリュームの表示はヘルプ・ビューアに依存しなければなりません。

ヘルプの表示方法の評価

アプリケーションは種類が異なるヘルプを取り入れることができます。この場合、アプリケーションに最適なヘルプの種類がどれかを判断することが重要になります。たとえば同じヘルプ情報でも様々な方法で表示されることがあります。その選択には、主要な機能、チュートリアル、例、作業指示、ショートカット、トラブルシューティング、リファレンス情報、用語集、ハード・コピーまたはその他のオンライン・マニュアルがあります。ヘルプ・ボリュームは異なる表示を組み合わせることもあります。

アプリケーション・プログラマとの協力

アプリケーションのヘルプを記述する場合は、アプリケーション・プログラマと密に連絡をとるようにしてください。ヘルプ・システムをどの程度アプリケーションに統合するかは設計仕様によります。

アプリケーションとそのヘルプの結び付きが弱い場合には、アプリケーションが直接表示できるトピックはほんの一握りです。しかし簡単に実装できます。

反対に、アプリケーションのあらゆる状況に対応する特定のヘルプを提供できるアプリケーションもあります。これには多くの作業を必要としますが、それさえできれば、ユーザにとっては非常に便利です。

ヘルプの統合レベルを決定するのは、あなた自身とそのプロジェクト・チームです。

設計者のワークフロー

ヘルプの設計が終わったら、ヘルプ・ボリュームを作成するためのヘルプ・トピックを作成し、処理します。必要な作業は次のとおりです。

ヘルプタグによるヘルプ・トピックの記述

オンライン・ヘルプは通常のテキスト・ファイルで記述されます。情報の「要素」をマークアップするには特殊コード、すなわち「タグ」を使用します。タグは、ヘルプタグと呼ばれるマークアップ言語を形成します。

ヘルプタグ・マークアップ言語は、章、セクション、サブセクションなどハイレベルの要素と、段落、リスト、強調語などローレベルの要素とを判別する、要素の階層を定義します。

「一般的なマークアップのガイドライン」では、マークアップの使い方について簡単に示しています。各要素の詳細は、第 5 章「ヘルプタグ・マークアップのリファレンス」を参照してください。

簡易マークアップ

タグセットは、実行時のヘルプ・ファイルを作成するため、簡易マークアップ、および正規マークアップの 2 種類の方法で使用できます。前者は、標準テキスト・エディタを使用して情報を「hand−tag」(タグ付け) する設計者にとって最適です。すなわち、実際のヘルプ・トピック・テキストに加えて、設計者がタグを入力する場合です。手動によるタグ入力の影響を小さくするため、簡易マークアップではいくつかの省略方法を取り込んでいます。最初に、必要な開始タグと終了タグの数を減らします。また、マークアップやスタイルを変更するときに適宜使用する簡単な文字の組み合わせも提供されています。

正規マークアップ

正規マークアップとは、設計者が使用できる SGML (Standard Generalized Markup Language) によって、完全に SGML に準拠したヘルプ・トピックを作成することです。この場合はすべての要素の最初と最後にタグを付けなければなりません。また、各要素の構造にも明示的にタグを付けなければなりません。したがって、正規マークアップを使用するとタグの数が非常に多くなります。標準エディタで正規マークアップを入力することもできますが、構造化エディタを使用することをお勧めします。

構造化エディタ

構造化エディタと呼ばれる新しいツールが、SGML マークアップを効率よく作成するために使用できるようになりつつあります。典型的には、構造化エディタではコンテキスト・メニューを提供します。つまり、メニューに表示される要素が、ドキュメントのカーソルの位置に基づいて動的に変更されます。

たとえばリストを入力する場合は、メニューにはリスト要素のコンテキストで有効な要素だけが含まれます。この組み込み「知能」によって、設計者は簡単にマークできます。

設計者が、セクション、ヘッダ、リストなどの要素を選択すると、エディタはそれに対応する開始、終了、および任意の中間構造タグを生成します。たとえば設計者が章という要素を選択すると、この要素が必要とする中間タグをエディタが自動的に挿入します。編集者は単に章のタイトルを入力すればよいのです。生成されたタグの表示は任意で、設計者はタグを表示しないようにできます。

注 -

簡易マークアップ、正規マークアップのいずれの場合も、コンパイルおよび表示の時には同じオンライン情報を生成します。どちらの方法を使用するかは、ヘルプ情報および有効な設計ツールが使えるかどうかに依存します。

正規マークアップの使い方

正規マークアップを使う場合は、最初にパート II 「設計者が行う作業」を読んでヘルプタグ要素の設定を理解してください。簡易マークアップと正規マークアップは同じタグセットを共有しますが、重要な相違点がいくつかあります。

第 8 章「ヘルプタグ文書型定義の読み方」では、文書型定義 (DTD) の主要なコンポーネントを説明し、正規マークアップの方法を示します。完全なヘルプタグ文書型定義は、付録 A「ヘルプタグ 1.3 DTD」にあります。

注 -

開発者キットには、ヘルプタグ文書型定義が入っています。ファイルは /usr/dt/dthelp/dthelptag/dtd ディレクトリにあり、helptag.dtd という名前です。

関連項目

形式ではなく構造を考える

他のパブリッシング・システムに精通している場合は、情報を好きな形式にすることに慣れているはずです。ヘルプタグを用いて設計するときは、形式ではなく構造と内容を考慮することが必要です。

記述するときは、ある種の情報をマークするのにタグを使います。マークする時には情報が何であるかを識別しますが、それをどうフォーマットすべきかは識別しません。

たとえば次のようなマークアップ行を含む本のタイトルを参照するとします。

<book>System Administrator's Reference Guide</book>

ここでは、構造と内容が形式とは関係ないので、異なるシステムが同じ情報を違う形式で使用できるようになります。たとえば、ヘルプは本のタイトルをイタリックで表示します。しかしシステムによっては、イタリックは使えず、本のタイトルにはアンダーラインが引かれます。

実行時のヘルプ・ファイルの作成

実行時のヘルプ・ファイルを作成するには、記述したテキスト・ファイルをヘルプタグ・ソフトウェアで「コンパイル」しなければなりません。それはユーザがヘルプを要求したときにアクセスする実行時のヘルプ・ファイルとなります。実行時のファイルは、 Semantic Delivery Language (SDL) 形式を使用します。この言語は、オンライン情報のデリバリ専用に設計された SGML 文書型定義に基づいています。

ヘルプ・システムは、デスクトップの動作と、ヘルプ固有のファイルのデータ型を定義します。これによりヘルプ・ソース・ファイルのアイコンを選択し、ファイルを処理するメニュー・コマンドを選択する事により、デスクトップから簡単に実行時のファイルを作成できます。実行時のヘルプ・ファイルの識別には、.sdl という拡張子を使用します。処理中にエラーが発生すると、エラー・ファイル (volume.err) に通知されます。

実行時のヘルプ・ファイルの作成の詳細は、「実行時のヘルプ・ファイルの作成」を参照してください。デスクトップの動作とデータ型に関する一般的な情報については、『Solaris 共通デスクトップ環境 上級ユーザ及びシステム管理者ガイド』を参照してください。

ユーザを想定したヘルプのレビュー

設計中に、ヘルプを表示させて読者と同じように対話する必要が生じることがあります。その場合デスクトップからヘルプ・ボリュームを表示させるには、実行時のヘルプ・ボリューム (volume.sdl) のアイコンをダブルクリックします。あるいは、dthelpview コマンドを使用して任意のトピックを表示することもできます。第 4 章「ヘルプ・ボリュームの処理と表示」で両方の方法を説明します。

アプリケーション・ヘルプを書いていて、ヘルプ・システムがアプリケーションに統合されている場合は、アプリケーションを実行してユーザと同じ方法でヘルプを要求することにより、ヘルプを表示できます。

プログラマが行う作業

プログラマは、ユーザがコンテキスト・ヘルプを要求したときに、その時のアプリケーションの動作に関連するヘルプ情報が表示されるようにアプリケーションにコードを追加します。

注 -

/usr/dt/share/examples/dthelp ディレクトリには、dthelpdemo というプログラム例のソースコードが入っています。OSF/Motif アプリケーションへのヘルプ・ダイアログを追加する方法を示すものです。

ヘルプへのアクセス方法

ユーザに役立つ情報を提供するには、次のことを考慮することが必要です。

ヘルプの設計者との協力

オンライン・ヘルプの設計者は各コンテキスト・トピックを表示する方法を知りたがっており、プログラマは各コンテキスト・トピックの内容を知りたがっているので、プログラマは設計者と密に連絡をとることが必要です。双方の協力がないと、情報は不適切で、曖昧で、誤りのあるものとなります。

こうした協力により、プログラマはアプリケーションを理解し、設計者は情報をユーザへどのように伝えたらよいかを理解できます。

ヘルプのエントリ・ポイントの識別

ヘルプのエントリ・ポイントを設定することにより、アプリケーションでオンライン・ヘルプが使えるようになります。エントリ・ポイントはアプリケーションで定義され、特定のヘルプ・トピックに対応付けられます。ユーザが [ヘルプ] キー、[ヘルプ] ボタン、[ヘルプ] メニューのいずれの方法によってヘルプを要求してもエントリ・ポイントが表示されます。たとえば [ヘルプ] ボタンを備えた印刷ダイアログ・ボックスを想定します。設計者はダイアログ・ボックスの内容を説明するヘルプ・トピックを記述し、トピックの ID を提供します。そこでユーザはコールバック・ルーチンを使用し、[ヘルプ] ボタンでヘルプ・トピックの ID を指定できます。

ヘルプ・ダイアログの作成と管理

ヘルプ・システムのアプリケーション・プログラム・インタフェースは、特に OSF/Motif アプリケーションで使用するように設計されています。特にこのヘルプでは、次の 2 つの新しいウィジェット・クラス (およびこれらを処理するために便利な機能を加えたもの) を提供することにより、OSF/Motif ウィジェット・セットを拡張しています。

アプリケーションでは上記のいずれか、または両方を使用できます。アプリケーションを (ヘルプ・ライブラリといっしょに) コンパイルすると、ヘルプ・ウィンドウがアプリケーションの一部になります。

第 9 章「ヘルプ・ダイアログ・ボックスの作成と管理 」で、一般ヘルプ・ダイアログ・ボックスと簡易ヘルプ・ダイアログ・ボックスを説明します。

パッケージとヘルプの割り当て

プロダクト・パッケージには実行時のヘルプ・ファイル (volume.sdl) とグラフィック・ファイルが入っています。また、フロント・パネルの [ヘルプ・ビューア] でボリュームを表示できるようにするヘルプ・ファミリ・ファイルも作成できます。

ヘルプ・ボリュームが実行リンクを使用する場合、適切な実行リンク・リソースをアプリケーションのデフォルト・リソース・ファイルに入れるよう設計者と協力しなければなりません。第 13 章「インストール・パッケージの準備」で、アプリケーションにどのヘルプ・ファイルが割り当てられるかを説明します。