417 lines
44 KiB
Plaintext
417 lines
44 KiB
Plaintext
<!-- $XConsortium: ch01.sgm /main/12 1996/10/22 12:20:04 rws $ -->
|
||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||
<!-- (c) Copyright 1995 Hitachi. -->
|
||
<chapter id="HRDC.Intro.div.1">
|
||
<title id="HRDC.Intro.mkr.1">ヘルプ・システムの概要</title>
|
||
<para>この章では、ヘルプ・システムの概要を述べ、ユーザ・インタフェースを簡単に説明します。ここでは、ヘルプ情報の構成を示し、ヘルプ・モジュールの作成および処理の方法を解説し、アプリケーション・ヘルプの設計およぴ作成における設計者と開発者の役割を説明します。</para>
|
||
<informaltable id="HRDC.Intro.itbl.1" frame="All">
|
||
<tgroup cols="1">
|
||
<colspec colname="1" colwidth="4.0 in">
|
||
<tbody>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Developer's Toolkit2'--><xref role="JumpText"
|
||
linkend="HRDC.Intro.mkr.3"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Overview of Online Help2'--><xref
|
||
role="JumpText" linkend="HRDC.Intro.mkr.4"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Help Information Model3'--><xref
|
||
role="JumpText" linkend="HRDC.Intro.mkr.5"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Help User Interface5'--><xref role="JumpText"
|
||
linkend="HRDC.Intro.mkr.7"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Help Topic Organization11'--><xref
|
||
role="JumpText" linkend="HRDC.Intro.mkr.14"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'The Author's Job14'--><xref role="JumpText"
|
||
linkend="HRDC.Intro.mkr.18"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Programmer's Job19'--><xref role="JumpText"
|
||
linkend="HRDC.Intro.mkr.27"></para></entry></row></tbody></tgroup></informaltable>
|
||
<para><indexterm><primary>ヘルプ・システムの概要</primary></indexterm><indexterm>
|
||
<primary>共通デスクトップ環境ヘルプ・システム, 概要</primary></indexterm></para>
|
||
<sect1 id="HRDC.Intro.div.2">
|
||
<title id="HRDC.Intro.mkr.2">ヘルプ・システムの概要</title>
|
||
<para>ヘルプ・システムは、アプリケーション・ソフトウェアのオンライン・ヘルプを開発するための一連のツールを提供します。これにより設計者は、グラフィックとテキストの書式化、ハイパーリンク、およびアプリケーションとの通信を含むヘルプ・システムを作成することができます。 </para>
|
||
<para>また、オンライン・ヘルプをアプリケーションに統合するためのプログラマのツールキットも提供します。ヘルプ・システムのアプリケーション・プログラム・インタフェースは、２つの特別なヘルプ・ダイアログ、およびオンライン・ヘルプ・モジュールの表示、ナビゲート、検索、および印刷に使用するサポート・ルーチンを提供します。</para>
|
||
<sect2 id="HRDC.Intro.div.3">
|
||
<title id="HRDC.Intro.mkr.3">開発者のツールキット</title>
|
||
<para>ヘルプ・システム開発者のツールキットには、オンライン・ヘルプの記述、処理、および表示を行うためのツールと、アプリケーション・プログラム用のライブラリが含まれています。</para>
|
||
<sect3 id="HRDC.Intro.div.4">
|
||
<title>設計者用ツールキット</title>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>DocBook マークアップ言語</emphasis> オンライン・ヘルプの構成と内容をマークするためにテキストファイルで使用するタグのセット</para>
|
||
</listitem><listitem><para><emphasis>DocBook ソフトウェア</emphasis> 作成したDocBookファイルを変換して、実行時のヘルプ・ファイルに書き込むためのソフトウェア・ツールのセット</para>
|
||
</listitem><listitem><para><emphasis>ヘルプ表示アプリケーション</emphasis> オンライン・ヘルプを表示して、ユーザと同じようにそれを読んだり対話したりできるようにするビューア・プログラム</para>
|
||
</listitem></itemizedlist>
|
||
<para>オンライン・ヘルプの作成および処理の詳細については、<!--Original XRef content: 'Chapter 2, “Organizing and Writing a Help Volume'--><xref role="ChapNumAndTitle" linkend="HRDC.OrgH.mkr.1">を参照してください。</para>
|
||
<sect4 id="HRDC.Intro.div.5">
|
||
<title>アプリケーション開発者用ツール</title>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>DtHelp プログラミング・ライブラリ</emphasis> ヘルプ・ウィンドウをユーザのアプリケーションへ統合するためのアプリケーション・プログラム・インタフェース (API)</para>
|
||
</listitem><listitem><para><emphasis>プログラム例</emphasis> ヘルプ・システムを Motif アプリケーションへ統合する方法を示す単純な例
|
||
(<!--Original XRef content: 'page 19'--><xref role="PageNum" linkend="HRDC.Intro.mkr.28">を参照してください)
|
||
</para>
|
||
</listitem></itemizedlist>
|
||
<para>アプリケーションのプログラミング・ライブラリについては、第8章から第12章で説明します。</para>
|
||
</sect4>
|
||
</sect3>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.6">
|
||
<title id="HRDC.Intro.mkr.4">オンライン・ヘルプの概要</title>
|
||
<para>コンピュータのハードウェアおよびソフトウェアの機能を<emphasis>すべて</emphasis>覚えることは不可能です。多くのコンピュータ・ユーザは、何度かヘルプを必要とすることがあるはずです。</para>
|
||
<para>オンライン・ヘルプは印刷されたマニュアルと異なり、その場ですぐ参照できる点で優れています。もっとも重要なのは、ユーザの現在のコンテキストの情報に適応できるようにするという点です。<emphasis>コンテキスト依存</emphasis>ヘルプは、ユーザが行っている作業に対応するヘルプを提供します。 オンライン・ヘルプを開発するときは、ユーザがその場の状況に応じてあらゆるヘルプを必要とすることに注意してください。
|
||
ユーザの疑問を予測することによって、論理的かつ直観的に応答するアプリケーション・ヘルプを設計することができます。</para>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.7">
|
||
<title id="HRDC.Intro.mkr.5">ヘルプ・インフォメーション・モデル<indexterm><primary>インフォメーション・モデル、ヘルプ</primary></indexterm><indexterm><primary>モデル、ヘルプ・インフォメーション</primary></indexterm></title>
|
||
<para>オンライン・ヘルプには次の２つの形式があります。</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>アプリケーション・ヘルプ</emphasis> Motifアプリケーションに統合されたヘルプの一部として機能します。
|
||
<indexterm><primary>Motif</primary></indexterm><indexterm><primary>Motif</primary></indexterm></para>
|
||
</listitem><listitem><para><emphasis>スタンドアロン・ヘルプ</emphasis> あらゆるアプリケーション・ソフトウェアに依存せずに、タスク、リファレンス、チュートリアル情報にオンラインでアクセスできるようにします。<indexterm><primary>スタンドアロン・ヘルプ</primary></indexterm></para>
|
||
</listitem></itemizedlist>
|
||
<para>アプリケーションのオンライン・ヘルプを開発する場合、情報をアプリケーションでのみアクセスできるように構成できます。あるいはスタンドアロン・ヘルプのように、アプリケーションの外からでも情報をブラウズできるように設定できます。</para>
|
||
<sect2 id="HRDC.Intro.div.8">
|
||
<title>アプリケーションの一部</title>
|
||
<para>ヘルプ機能により、アプリケーションとそのオンライン・ヘルプを高度に統合できます。ユーザの見地からみれば、ヘルプはアプリケーションの一部ということになります。これによって、ユーザとユーザが参照するヘルプとの間にあるアプリケーションの「距離」が縮まります。</para>
|
||
<para>アプリケーションの近くにあるということは、オンライン・ヘルプが使いやすく、要求に迅速に対応できるということです。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.9">
|
||
<title id="HRDC.Intro.mkr.6">ヘルプの種類<indexterm><primary>ヘルプの獲得</primary></indexterm><indexterm><primary>ヘルプ、ユーザによる獲得方法</primary></indexterm></title>
|
||
<para>オンライン・ヘルプは、次の３種類に分類されます。</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>自動ヘルプ</emphasis> ヘルプが必要なとき、および表示する内容をアプリケーションが決定します。システム起動ヘルプとも呼ばれます。</para>
|
||
</listitem><listitem><para><emphasis>半自動ヘルプ</emphasis> ヘルプが必要かどうかはユーザが判断しますが、表示する内容はシステムが決定します。このヘルプはユーザの操作または[F1]キーを押すなどのヘルプ要求によって起動されます。どの情報を表示するかはユーザの現在のコンテキストによって決められるため、こうしたシステムの応答はコンテキスト・ヘルプと呼ばれます。</para>
|
||
</listitem><listitem><para><emphasis>自動ヘルプ</emphasis> ヘルプ・メニューなどからユーザが特定の情報を要求します。</para>
|
||
</listitem></itemizedlist>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.10">
|
||
<title>ユーザがヘルプを獲得する方法</title>
|
||
<para>ユーザはいくつかの方法でヘルプを要求できます。多くのアプリケーションが、ヘルプ・メニュー、ヘルプ・キー、およびダイアログ・ボックスのヘルプ・ボタンを提供しています。</para>
|
||
<sect3 id="HRDC.Intro.div.11">
|
||
<title>ヘルプ・キー</title>
|
||
<para>多くのアプリケーションでユーザがまず使用するのは、<emphasis>ヘルプ・キー</emphasis>を押す方法です。最近では、多くのワークステーションおよびパーソナル・コンピュータにおいて、[F1]ファンクション・キーが事実上の標準ヘルプ・キーとなっています。</para>
|
||
<para>『CDE/Motif スタイル・ガイドおよび認証チェックリスト』では、ヘルプ・キーとして[F1]キーを使用することと、Motif アプリケーションでのヘルプ・キーの使用を容易にするような内部処理を提供する Motif プログラマ・ツールキットを使用することを推奨しています。
|
||
</para>
|
||
<para>一部のコンピュータは、キーボード上にヘルプ・キーを備えています。</para>
|
||
</sect3>
|
||
<sect3 id="HRDC.Intro.div.12">
|
||
<title>ヘルプ・メニュー</title>
|
||
<para>ヘルプ・メニューはヘルプ情報にアクセスするための一般的な方法です。Motif アプリケーションは、ヘルプ・メニューを提供しており、メニュー・バーの右端に表示されます。<citetitle>CDE/Motif スタイル・ガイドおよび認証チェックリスト</citetitle>では、ヘルプ・メニューに含めるコマンドについて推奨しています。</para>
|
||
<figure>
|
||
<title>アプリケーションのヘルプ・メニュー</title>
|
||
<graphic id="HRDC.Intro.grph.1" entityref="HRDC.Intro.fig.1"></graphic>
|
||
</figure>
|
||
</sect3>
|
||
<sect3 id="HRDC.Intro.div.13">
|
||
<title>ヘルプ・ボタン</title>
|
||
<para>ほとんどのダイアログ・ボックスに、ダイアログでヘルプを表示するためのヘルプ・ボタンがあります。<citetitle>CDE/Motif スタイル・ガイドおよび認証チェックリスト</citetitle>では、ダイアログ・ボックスでヘルプ・ボタンを選択することは、そのダイアログ・ボックスを使用中にヘルプ・キーを押すのと同じであると述べています。ただし、複雑なダイアログ、すなわちダイアログ・ボックス内で個々のコントロールがヘルプを持つような場合は例外です。
|
||
</para>
|
||
</sect3>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.14">
|
||
<title id="HRDC.Intro.mkr.7">ヘルプ・ユーザ・インタフェース<indexterm><primary>概要</primary><secondary>ヘルプ・グラフィカル・ユーザ・インタフェース</secondary></indexterm></title>
|
||
<para>この節では、ヘルプ・システムが提供するグラフィカル・インタフェースの概要を説明します。ヘルプの機能の詳細については、<citetitle>共通デスクトップ環境 ユーザーズ・ガイド</citetitle>を参照してください。対応するオンライン・ヘルプを表示するには、デスクトップのフロントパネルのヘルプ・ビューア (<!--Original XRef content: '“To Display the Help Index Volume&rdquo--><!--r; on page 97'--><xref role="SecTitleAndPageNum" linkend="hrdc.crhv.mkr.12">を参照してください) を開きます。それから、[デスクトップの紹介]および[ヘルプの使い方]を選択します。</para>
|
||
<para>アプリケーションの使用中、ヘルプ・キーを押すかアプリケーションのヘルプ・メニューを選択することにより、ユーザはヘルプを要求できます。また、ヘルプ・システムを統合したアプリケーションをインストールできるので、デスクトップのヘルプ・ビューアからそれぞれのヘルプ・モジュールにアクセスできます。これにより、複数のアプリケーションが提供するヘルプ情報をブラウズする場合でも、各アプリケーションを実行せずに行うことができます。</para>
|
||
<sect2 id="HRDC.Intro.div.15">
|
||
<title>ヘルプ・ウィンドウ</title>
|
||
<para>ユーザが要求すると、ヘルプ・システムはヘルプ・ウィンドウを表示します。ヘルプ・ウィンドウには、一般ヘルプと簡易ヘルプの２種類があります。一般ヘルプ・ウィンドウは、メニュー・バー、トピック・ツリー、およびトピック表示領域から構成されます。トピック・ツリーはユーザが選択できるヘルプ・トピックの一覧です。ウィンドウの下部（トピック表示領域）には選択されたトピックが表示されます。</para>
|
||
<para>簡易ヘルプ・ウィンドウは無駄を省いたヘルプ・ウィンドウです。トピック表示領域とひとつ以上のダイアログ・ボタンしか表示されません。このウィンドウは、定義などの短い組み込み情報の表示によく利用されます。</para>
|
||
<figure>
|
||
<title>一般ヘルプ・ウィンドウと簡易ヘルプ・ウィンドウ</title>
|
||
<graphic id="HRDC.Intro.grph.2" entityref="HRDC.Intro.fig.2"></graphic>
|
||
</figure>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.16">
|
||
<title>ハイパーリンク</title>
|
||
<para>ヘルプ・トピックには、関連するヘルプ情報へ「ジャンプ」するハイパーリンクがしばしば含まれています。テキストとグラフィックの両方をハイパーリンクとして使用できます。
|
||
<!--Original XRef content: 'Figure 1‐3 on page 7'--><xref role="CodeOrFigOrTabAndPNum" linkend="HRDC.Intro.mkr.8">は、ハイパーリンクの識別に使用されるスタイルのフォーマットを示しています。</para>
|
||
<para><indexterm><primary>ハイパーリンク</primary><secondary>表示形式</secondary></indexterm>
|
||
実線の下線または破線の下線は、ハイパーリンクである語または句を示します。実線の下線、つまり標準ハイパーリンクがもっとも一般的です。ハイパーリンクを選択すると、関連するトピックが表示されます。ハイパーリンク・トピックを現在のヘルプ・ウィンドウと新規ウィンドウのどちらに表示するかは、設計者が指定します。破線の下線は定義リンクを示します。これを選択すると、関連するトピックが簡易ヘルプ・ウィンドウに表示されます。グレーの隅の開いている枠（破線または実線の枠）は、グラフィック・ハイパーリンクを示します。</para>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.8">グラフィック・ハイパーリンクとテキスト・ハイパーリンクの形式</title>
|
||
<graphic id="HRDC.Intro.grph.3" entityref="HRDC.Intro.fig.3"></graphic>
|
||
</figure>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.17">
|
||
<title>ヘルプ・ナビゲーション<indexterm><primary>トピック・ツリー</primary><secondary>トピックの選択</secondary></indexterm></title>
|
||
<para><!--Original XRef content: 'Figure 1‐4'--><xref role="CodeOrFigureOrTable" linkend="HRDC.Intro.mkr.9">のトピック・ツリー<indexterm><primary>トピック・ツリー</primary><secondary>一般ヘルプ・ダイアログ</secondary></indexterm>は、現在のヘルプ・ボリュームのトピックのリストです。リスト最上部にある最初のトピックは、<emphasis>ホーム・トピック</emphasis>で、ヘルプ・ボリュームの先頭です。矢印（→）は現在のトピックを指し、ヘルプ・ボリュームにおけるユーザの位置を示します。</para>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.9">一般ヘルプ・ダイアログ・ボックスのトピック・ツリー</title>
|
||
<graphic id="HRDC.Intro.grph.4" entityref="HRDC.Intro.fig.4"></graphic>
|
||
</figure>
|
||
<para>ヘルプ・トピックを表示するには、トピック・ツリーのタイトルか、トピック表示位置のハイパーリンクを選択します。表示をスクロールして任意のトピックを選択することにより、トピックの概要をブラウズできます。ナビゲーション・コマンドにより、前のトピックまたはヘルプ・ボリュームの先頭に戻ることができます。</para>
|
||
<sect3 id="HRDC.Intro.div.18">
|
||
<title>ヘルプ・ナビゲーション・ボタン<indexterm><primary>ナビゲーション、ヘルプ・ボタン</primary></indexterm></title>
|
||
<para><indexterm><primary>ボタン、ナビゲーション</primary></indexterm>一般ヘルプ・ダイアログには、[前のトピックへ]、[ヒストリ]、[索引]の３つのダイアログ・ボタンがあります。これらの機能は、メニュー項目の選択にも使用できます。</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>[前のトピックへ]</emphasis> 前のトピックに戻ります。先に参照したトピックに戻るには、希望のトピックが表示されるまで[前のトピック]ボタンを繰り返し押します。</para>
|
||
</listitem><listitem><para><emphasis>[ヒストリ]</emphasis> <emphasis>[ヒストリ]</emphasis>ダイアログ・ボックスを表示します。これはヘルプ・ボリュームとすでに参照したトピックをリストします。リストにある任意のトピックに戻るには、そのタイトルを選択します。 </para>
|
||
</listitem><listitem><para><emphasis>[索引]</emphasis> <emphasis>[索引検索]</emphasis>ダイアログ・ボックスを表示します。これは設計者が索引エントリとしてマークした語句をすべてリストします。索引エントリを選択し、表示されたトピックのいずれかを選択すると、一般ヘルプ・ダイアログにそのトピックが表示されます。
|
||
<!--Original XRef content: ''--><xref role="CodeOrFigureOrTable"
|
||
linkend="HRDC.Intro.mkr.10"></para>
|
||
</listitem></itemizedlist>
|
||
<para>デスクトップのフロントパネルからヘルプ・ビューアを使用する場合、一般ヘルプ・ダイアログに[トップレベル]という追加ダイアログ・ボタンがあります。別のヘルプ・ボリュームを参照した後、このボタンを選択してデスクトップ・ブラウザ・ヘルプ・ボリュームのトップレベルに戻ることができます。</para>
|
||
</sect3>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.19">
|
||
<title>ヘルプ・メニュー</title>
|
||
<para><indexterm><primary>ホーム・トピック</primary><secondary>メニュー・コマンド</secondary>
|
||
</indexterm>一般ヘルプ・ダイアログのメニュー・バーには、[ファイル]、[編集]、[検索]、[ナビゲート]、[ヘルプ]の5つのメニューが表示されます。[検索]メニューと[ナビゲート]メニューには、前記した[索引]ボタンとナビゲーション・ボタンで使用するコマンドがあります。また、[ナビゲート]メニューには、ヘルプ・ボリュームの先頭に戻るための[ホーム・トピック]コマンドがあります。その他のメニューは次の機能を提供します。</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>[ファイル]メニュー</emphasis> ヘルプ・ウィンドウの複製、ヘルプ・トピックまたは現在のヘルプ・ボリュームの印刷、ヘルプ・ウィンドウのクローズ</para>
|
||
<indexterm><primary>メニュー</primary><secondary>[ファイル]</secondary></indexterm>
|
||
<indexterm><primary>メニュー</primary><secondary>[編集]</secondary></indexterm>
|
||
<indexterm><primary>メニュー</primary><secondary>[ヘルプ]</secondary></indexterm>
|
||
<indexterm><primary>メニュー</primary><secondary>[ナビゲート]</secondary></indexterm>
|
||
</listitem><listitem><para><emphasis>[編集]メニュー</emphasis> ヘルプ・ウィンドウから他のアプリケーションへのテキストのコピー</para>
|
||
</listitem><listitem><para><emphasis>[ヘルプ]メニュー</emphasis> ヘルプ・ダイアログの機能とその使い方に関するヘルプ情報の提供</para>
|
||
</listitem></itemizedlist>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.20">
|
||
<title id="HRDC.Intro.mkr.10">ヘルプ索引</title>
|
||
<para><indexterm><primary>索引</primary><secondary>[索引検索]ダイアログ索引</secondary></indexterm>ヘルプ・ボリュームには、ユーザがサブジェクトのヘルプ・トピックを検索できるように、重要な語句の索引が入っています。ユーザは現在のボリューム、選択したボリューム、またはシステムで使用できるすべてのヘルプ・ボリュームの索引をブラウズまたは検索できます。*（アスタリスク）および ?（疑問符）などの正規表現もトピックの検索に使用できます。対応するヘルプ・トピックを表示するには、索引エントリを選択します。</para>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.11">[索引検索]ダイアログ・ボックス</title>
|
||
<graphic id="HRDC.Intro.grph.5" entityref="HRDC.Intro.fig.5"></graphic>
|
||
</figure>
|
||
<para>[ヘルプ索引]は一度に表示するには多すぎるる場合があるので、表示されていない索引エントリがまだあったり、全部が表示されている場合もあります。+（プラス）または -（マイナス）の符号は表示されていない索引エントリがまだあるのかないのかを示します。マイナス符号はエントリのすべてが表示されていることを示し、プラス符号はまだ表示されていないエントリがあり、索引エントリを表示できることを示します。</para>
|
||
<para>図<!--Original XRef content: 'Figure 1‐6 on page 10'--><xref role="CodeOrFigOrTabAndPNum" linkend="HRDC.Intro.mkr.12">において、-36の符号は、36個の索引エントリが表示されていることを意味しています。+3の符号は、表示されていないエントリがまだあることを示します。表示されていないエントリを選択するとリストが展開され、+ 符号が - 符号に変わります。この図の最後の索引エントリは、このようにして表示されたエントリです。</para>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.12">索引エントリ符号</title>
|
||
<graphic id="HRDC.Intro.grph.6" entityref="HRDC.Intro.fig.6"></graphic>
|
||
</figure>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.21">
|
||
<title>ヘルプからの印刷<indexterm><primary>印刷</primary><secondary>ヘルプ情報</secondary></indexterm></title>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.13">[印刷]ダイアログ・ボックス</title>
|
||
<graphic id="HRDC.Intro.grph.7" entityref="HRDC.Intro.fig.7"></graphic>
|
||
</figure>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.22">
|
||
<title id="HRDC.Intro.mkr.14">ヘルプ・トピックの構成<indexterm><primary>ヘルプ</primary><secondary>トピックの構成</secondary></indexterm></title>
|
||
<para>設計者は、ヘルプ情報を論理フレームワークで構成します。例外はありますが、トピックの概略または階層を示す形式がほとんどです。
|
||
<!--Original XRef content: 'Figure 1‐8'--><xref role="CodeOrFigureOrTable" linkend="HRDC.Intro.mkr.15">に示すトピックの階層は、メイン・レベル、３つのセクション、およびそれに従属するトピックから構成されています。 [ヘルプ]は、階層から成る情報に最適化されていますが、必要に応じて任意の構成にすることができます。</para>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.15">トピックの階層</title>
|
||
<graphic id="HRDC.Intro.grph.8" entityref="HRDC.Intro.fig.8"></graphic>
|
||
</figure>
|
||
<sect2 id="HRDC.Intro.div.23">
|
||
<title>ヘルプ・トピック<indexterm><primary>トピック</primary><secondary>定義された</secondary>
|
||
</indexterm><indexterm><primary>ヘルプ・トピック</primary><secondary>定義された</secondary></indexterm></title>
|
||
<para id="HRDC.Intro.mkr.16"><emphasis>ヘルプ・トピック</emphasis>は固有のIDで識別される情報の単位です。ヘルプ・システムが提供する一連のタグは、ヘルプ・トピックをマークし、構造的なフレームワークを作成するために使用されます。ヘルプ・ビューアは、ヘルプ・システムの一部で、ヘルプ・トピックに直接アクセスし、それを表示することができます。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.24">
|
||
<title><indexterm><primary>ヘルプ・ボリューム</primary><secondary>定義された</secondary>
|
||
</indexterm><indexterm><primary>ボリューム</primary><secondary>定義された</secondary>
|
||
</indexterm>ヘルプ・ボリューム<indexterm><primary>ボリューム</primary><secondary>トピックの集まりとしての</secondary></indexterm><indexterm><primary>トピック</primary><secondary>～の集まりとしてのボリューム</secondary></indexterm></title>
|
||
<para><emphasis>ヘルプ・ボリューム</emphasis>は、アプリケーションまたは特定のサブジェクトを記述するトピックの集まりです。アプリケーションのヘルプを開発する場合、一般にはアプリケーションごとにひとつのヘルプ・ボリュームがあります。ただし、複雑なアプリケーション、または関連するアプリケーションの集まりについては、複数のヘルプ・ボリュームを使用することもあります。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.25">
|
||
<title><indexterm><primary>ヘルプ・ファミリ</primary><secondary>定義された</secondary></indexterm>ヘルプ・ファミリ<indexterm><primary>ファミリ</primary><secondary>～の定義</secondary></indexterm><indexterm><primary>関連するボリュームのグループ、～としてのファミリ</primary></indexterm><indexterm><primary>関連するボリューム、～のグループとしてのファミリ</primary></indexterm><indexterm><primary>ボリューム</primary><secondary>ボリュームのファミリ</secondary></indexterm></title>
|
||
<para>ソフトウェアは、<emphasis>プロダクト・ファミリ</emphasis>として認識される一連の関連アプリケーションとして使用できます。たとえば、オフィスで使用されるアプリケーションには、ワードプロセッサ、スプレッドシート、描画プログラムなどがあります。各アプリケーションには独自のヘルプ・ボリュームがあるので、関連するヘルプ・ボリュームを<emphasis>ヘルプ・ファミリ</emphasis>としてグループ化するようになっています。ヘルプ・ファミリには、単一のヘルプ・ボリュームまたは複数のボリュームが入っています。</para>
|
||
<para>ヘルプ・ボリュームをヘルプ・ファミリにまとめるかどうかは任意です。フロントパネルのヘルプ・ビューアなどの<emphasis>ヘルプ・ブラウザ</emphasis>でヘルプをブラウズできるようにする場合にのみ必要です。</para>
|
||
<para>ヘルプ・ファミリ・ファイルとその使い方については、<!--Original XRef content: '“To Create a Help Family” on page 95'--><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.11">を参照してください。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.26">
|
||
<title>ヘルプ索引ボリューム<indexterm><primary>ボリューム</primary><secondary>デスクトップ索引ボリューム</secondary></indexterm><indexterm><primary>ヘルプ索引</primary>
|
||
</indexterm><indexterm><primary>ヘルプ索引ボリューム</primary><secondary>定義された</secondary></indexterm></title>
|
||
<para>デスクトップは、システムにインストールされたヘルプを表示する<emphasis>検索</emphasis>ボリュームと呼ばれる特別なヘルプ・ボリュームを提供します。フロントパネルのヘルプ・ビューアをクリックすると、
|
||
<!--Original XRef content: 'page 13'--><xref role="PageNum" linkend="HRDC.Intro.mkr.17">の
|
||
<!--Original XRef content: 'Figure 1‐9'--><xref role="CodeOrFigureOrTable" linkend="HRDC.Intro.mkr.17">に示す検索ボリュームが表示されます。</para>
|
||
<para>これは、ヘルプ・ファミリ（下線の付いた名前）とヘルプ・ファミリのメンバである任意のボリュームを表示します。</para>
|
||
<figure>
|
||
<title id="HRDC.Intro.mkr.17">索引ヘルプ・ボリューム</title>
|
||
<graphic id="HRDC.Intro.grph.9" entityref="HRDC.Intro.fig.9"></graphic>
|
||
</figure>
|
||
<para>索引ボリュームにより、アプリケーションを使用せずにアプリケーション固有のヘルプにアクセスできます。また、スタンドアロン・ヘルプを書く場合は、ヘルプを使用するための唯一の手段がこの索引ボリュームを使用する方法です。ヘルプ・ボリュームがひとつしかない場合は、ヘルプ・ビューアでブラウズできるヘルプ・ファミリに属していなければなりません。</para>
|
||
<para><!--Original XRef content: '“Adding Your Help to the Browser
|
||
Volume” on page 94'--><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.8">では、ファミリ・ファイルの作成方法と、索引ボリュームからヘルプ・ボリュームにアクセスできるようにするためにユーザが行うべき作業について説明しています。</para>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.27">
|
||
<title id="HRDC.Intro.mkr.18">設計者が行う作業<indexterm><primary>設計者</primary><secondary>責任</secondary></indexterm><indexterm>
|
||
<primary>設計者が行う作業</primary></indexterm><indexterm><primary>責任</primary><secondary>設計者</secondary></indexterm></title>
|
||
<para>オンライン・ヘルプの記述は紙のマニュアルの記述とは異なるため、対象ユーザ、情報へのアクセス方法、アプリケーションと情報との合致という点に留意することが重要です。</para>
|
||
<sect2 id="HRDC.Intro.div.28">
|
||
<title>オンライン・ヘルプの目的<indexterm><primary>オンライン・ヘルプの目標</primary></indexterm><indexterm><primary>オンライン・ヘルプ</primary><secondary>目的</secondary></indexterm></title>
|
||
<para>良質のオンライン・ヘルプの設計には、次の２つの重要な目的があります。</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>ユーザができるだけ早く、かつ正常に作業に戻ることができるようにすること。</emphasis></para>
|
||
</listitem><listitem><para><emphasis>ユーザがいずれヘルプなしでも作業できるように教育すること。</emphasis></para>
|
||
</listitem></itemizedlist>
|
||
<para>これらに目標を置けば、最適なヘルプは何か、必要な情報は何かを判断するのに役立ちます。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.29">
|
||
<title id="HRDC.Intro.mkr.19">対象となるユーザ<indexterm><primary>ユーザ</primary><secondary>対象となる</secondary></indexterm></title>
|
||
<para>何を書く場合でも、対象となるユーザとそのユーザが必要としている情報を理解することが大切です。特に、オンライン・ヘルプでは、ユーザが行おうとしている作業と、起こりうる問題について認識しておくことが重要です。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.30">
|
||
<title id="HRDC.Intro.mkr.20">ヘルプへのアクセス方法<indexterm>
|
||
<primary>ヘルプ</primary><secondary>アクセスのタイプ</secondary></indexterm><indexterm>
|
||
<primary>アプリケーションのヘルプ</primary></indexterm></title>
|
||
<para>ユーザを正しく認識するのと同時に、ユーザがどのようにヘルプにアクセスするのかを理解することが重要です。</para>
|
||
<sect3 id="HRDC.Intro.div.31">
|
||
<title>アプリケーションのヘルプ</title>
|
||
<para>アプリケーションのヘルプを記述する場合は、ブラウズできるトピックと、<emphasis>コンテキスト・ヘルプ</emphasis>としてアプリケーションから使用できるトピックをそれぞれ決めることが必要です。トピックをナビゲートできる場合は、トピック・ツリーまたはハイパーリンクを使用してトピックをブラウズできます。排他的なコンテキスト・ヘルプに指定されているトピックは、アプリケーションの特定のコンテキストからしかトピックを表示できないため、ブラウズできません。</para>
|
||
<para>アプリケーションのヘルプ・ボリュームを<emphasis>登録する</emphasis>かどうかも決める必要があります。登録されたヘルプ・ボリュームは、他のアプリケーション（ヘルプ・ビューアなど）によっても表示でき、より広範囲な情報へのアクセスが可能になります。ヘルプ・ボリュームにあるトピックへの別のヘルプ・ボリュームからのハイパーリンクが含まれている場合は、そのヘルプ・ボリュームを登録してください。</para>
|
||
<para>アプリケーションのインストールと登録の詳細については、<!--Original XRef content: '“Registering Your Application and Its Help” on page 247'--><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9">を参照してください。</para>
|
||
</sect3>
|
||
<sect3 id="HRDC.Intro.div.32">
|
||
<title>スタンドアロン・ヘルプ・ボリューム<indexterm><primary>スタンドアロン・ヘルプ</primary>
|
||
</indexterm><indexterm><primary>ボリューム</primary><secondary>スタンドアロン・ヘルプ</secondary></indexterm></title>
|
||
<para>スタンドアロン・ヘルプ・ボリューム（アプリケーションに対応付けられていないヘルプ・ボリューム）を記述する場合は、別の方法で行うことができます。</para>
|
||
<para>まず記述したすべてのトピックをユーザが使用できるようパスを設定しなければなりません。つまり、すべてのトピックが、少くともひとつのハイパーリンクによってブラウズできなければなりません。また、ヘルプに対応付けられているアプリケーションがないため、ヘルプ・ボリュームの表示は、（[ヘルプ・ビューア]のような）ヘルプ・ビューアに依存しなければなりません。</para>
|
||
</sect3>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.33">
|
||
<title>ヘルプの表示方法の評価</title>
|
||
<para>アプリケーションは種類が異なるヘルプを取り入れることができます。この場合、アプリケーションに最適なヘルプの種類がどれかを判断することが重要になります。たとえば、同じヘルプ情報でもさまざまな方法で表示されることがあります。その選択には、主要な機能、チュートリアル、例、作業指示、ショートカット、トラブルシューティング、リファレンス情報、用語集、ハード・コピーの参照、またはその他のオンライン・マニュアルがあります。ヘルプ・ボリュームは、異なる表示を組み合わせることもあります。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.34">
|
||
<title id="HRDC.Intro.mkr.21">アプリケーション・プログラマとの協力<indexterm>
|
||
<primary>設計者</primary><secondary>アプリケーション・プログラマとの協力</secondary></indexterm><indexterm><primary>アプリケーション・プログラマ、～との協力</primary></indexterm><indexterm><primary>プログラマ、アプリケーション</primary>
|
||
<secondary>との協力</secondary></indexterm></title>
|
||
<para>アプリケーションのヘルプを記述する場合は、アプリケーション・プログラマと密に連絡をとるべきです。ヘルプ・システムをどの程度アプリケーションに統合するかは設計仕様によります。</para>
|
||
<para>アプリケーションとそのヘルプの結び付きが弱い場合には、アプリケーションが直接表示できるトピックはほんの一握りです。しかし、簡単に実装できます。</para>
|
||
<para>対照的に、アプリケーションのあらゆる状況に対応する特定のヘルプを提供できるアプリケーションもあります。これには多くの作業を必要としますが、それさえできればユーザにとっては非常に便利です。</para>
|
||
<para>ヘルプの結合レベルを決定するのは、設計者とそのプロジェクト・チームです。</para>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.35">
|
||
<title id="HRDC.Intro.mkr.22">設計者のワークフロー<indexterm><primary>設計者</primary><secondary>ワークフロー</secondary></indexterm></title>
|
||
<para>ヘルプの設計が終わったなら、ヘルプ・ボリュームを作成するためのヘルプ・トピックを作成し、処理します。必要な作業は、次のとおりです。</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para>ヘルプ・トピックの記述</para>
|
||
</listitem><listitem><para>実行時のヘルプ・ファイルの作成</para>
|
||
</listitem><listitem><para>ヘルプ・ボリュームの表示</para>
|
||
</listitem></itemizedlist>
|
||
<sect2 id="HRDC.Intro.div.36">
|
||
<title id="HRDC.Intro.mkr.23">DocBook によるヘルプ・トピックの記述</title>
|
||
<para>オンライン・ヘルプは通常のテキスト・ファイルで記述されます。情報の<symbol role="Variable">要素</symbol>をマークアップするには、特別なコード、すなわち<symbol role="Variable">タグ</symbol>を使用します。タグは、DocBook と呼ばれるマークアップ言語を形成します。</para>
|
||
<para>DocBook マークアップ言語は、章、セクション、サブセクションなどハイレベルの<symbol role="Variable">要素</symbol>と、段落、リスト、強調語などロウレベルの要素とを判別する、要素の階層を定義します。</para>
|
||
<para><!--Original XRef content: '“General Markup Guidelines”
|
||
on page 28'--><xref role="SecTitleAndPageNum" linkend="HRDC.OrgH.mkr.4">
|
||
では、マークアップの使い方について簡単に示しています。</para>
|
||
<sect3 id="HRDC.Intro.div.38">
|
||
<title id="HRDC.Intro.mkr.24">正規マークアップ<indexterm><primary>正規マークアップ</primary><secondary>定義された</secondary></indexterm><indexterm><primary>マークアップ</primary><secondary>正規 (SGML)</secondary></indexterm><indexterm>
|
||
<primary>構造化エディタ</primary></indexterm><indexterm><primary>エディタ、構造化</primary></indexterm></title>
|
||
<para><emphasis><indexterm><primary>マークアップ言語</primary><secondary>正規マークアップ、SGML準拠</secondary></indexterm>正規マークアップ</emphasis>とは、設計者が使用できる SGML (Standard Generalized Markup Language) によって、完全に SGML に準拠したヘルプ・トピックを作成することです。この場合は、<emphasis>すべての</emphasis>要素の最初と最後にタグを付けなければなりません。また、各要素の構造にも明示的にタグを付けなければなりません。したがって、正規マークアップを使用するとタグの数が非常に多くなります。標準エディタで正規マークアップを入力することもできますが、構造化エディタの使用を推奨します。</para>
|
||
<sect4 id="HRDC.Intro.div.39">
|
||
<title>構造化エディタ</title>
|
||
<para>構造化エディタと呼ばれる新しいツールが、SGML マークアップを効率よく作成するために使用できるようになりつつあります。典型的には、構造化エディタではコンテキスト・メニューを提供します。つまり、メニューに表示される要素が、ドキュメントのカーソルの位置に基づいて動的に変更されます。</para>
|
||
<para>たとえば、リストを入力する場合は、メニューにはリスト要素のコンテキストで有効な要素だけが含まれます。この組み込み「知能」によって、設計者は簡単にマークすることができます。</para>
|
||
<para>設計者が、セクション、ヘッダ、リストなどの要素を選択すると、エディタはそれに対応する開始、終了、および任意の中間構造タグを生成します。たとえば、設計者が章という要素を選択すると、この要素が必要とする中間タグをエディタが自動的に挿入します。編集者は、単に章のタイトルを入力すればよいのです。生成されたタグの表示は任意であり、設計者はタグを表示しないようにすることもできます。</para>
|
||
</sect4>
|
||
<sect4 id="HRDC.Intro.div.40">
|
||
<title>正規マークアップの使い方</title>
|
||
<para>正規マークアップを使う場合は、最初に<citetitle>第２部 設計者が行う作業</citetitle>を読んで、DocBook 要素の設定を理解してください。</para>
|
||
<para><!--Original XRef content: ''--><xref role="Blank" linkend="HRDC.Sgml.mkr.1"> <!--Original XRef content: 'Chapter 8, “Reading the DocBook Document Type Definition'--><xref role="ChapNumAndTitle" linkend="HRDC.Sgml.mkr.1">では、文書型定義 (DTD) の主要なコンポーネントを説明し、正規マークアップの作成方法を示します。完全な DocBook 文書型定義 (DTD) は、<citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle>にあります。</para>
|
||
<note>
|
||
<para>開発者キットには、DocBook 文書型定義 (DTD) が入っています。ファイルは、<filename>/usr/dt/dthelp/dtdocbook/SGML/docbook.dtd</filename>ディレクトリにあり、<filename>DocBook.dtd</filename>という名前です。</para>
|
||
</note>
|
||
</sect4>
|
||
</sect3>
|
||
<sect3 id="HRDC.Intro.div.41">
|
||
<title>関連項目</title>
|
||
<itemizedlist><listitem><para><citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle>は、主要なタグの詳細な説明を、アルファベット順で示しています。</para>
|
||
</listitem><listitem><para><!--Original XRef content: 'Chapter 8, “Reading the DocBook Document Type Definition'--><xref role="ChapNumAndTitle" linkend="HRDC.Sgml.mkr.1">は、正規マークアップについて説明しています。</para>
|
||
</listitem>
|
||
<listitem><para><filename moreinfo="RefEntry">docbook.dtd(4)</filename> マニュアル・ページ</para>
|
||
</listitem></itemizedlist>
|
||
</sect3>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.42">
|
||
<title>形式ではなく構造を考える</title>
|
||
<para>他のパブリッシング・システムに精通している場合は、情報を好きな形式にすることに慣れているはずです。DocBook を用いて設計するときは、形式ではなく構造と内容を考慮することが重要です。</para>
|
||
<para>記述するときは、ある種の情報をマークするのにタグを使います。マークするときには、<emphasis>どのような</emphasis>情報であるかを識別しますが、それをどうフォーマットすべきかは識別しません。</para>
|
||
<para>たとえば、次のようなマークアップ行を含む本のタイトルを参照するとします。</para>
|
||
<programlisting><CiteTitle>System Administrator's Reference Guide</CiteTitle>
|
||
</programlisting>
|
||
<para>ここでは、構造と内容が形式とは関係ないので、異なるシステムが同じ情報を異なる形式で使用できるようになります。たとえば、ヘルプは本のタイトルをイタリック体で表示します。しかし、システムによっては、イタリック体は使えず、本のタイトルにはアンダーラインが引かれます。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.43">
|
||
<title id="HRDC.Intro.mkr.25">実行時のヘルプ・ファイルの作成<indexterm><primary>作成</primary><secondary>実行時のヘルプ・ファイル</secondary></indexterm><indexterm>
|
||
<primary>実行時のファイル</primary><secondary>作成</secondary></indexterm><indexterm>
|
||
<primary>ファイル、実行時のヘルプ</primary><secondary>作成</secondary></indexterm></title>
|
||
<para><emphasis>実行時のヘルプ・ファイル</emphasis>を作成するには、記述したテキスト・ファイルを DocBook ソフトウェアで「コンパイル」しなければなりません。それは、ユーザがヘルプを要求したときにアクセスする実行時のヘルプ・ファイルとなります。実行時のファイルは、Semantic Delivery Language (SDL) 形式を使用します。この言語は、オンライン情報のデリバリ専用に設計された SGML 文書型定義に基づいています。
|
||
<indexterm><primary>Semantic Delivery Language (SDL)</primary></indexterm><indexterm>
|
||
<primary>SDL (Semantic Delivery Language)</primary></indexterm></para>
|
||
<para>ヘルプ・システムは、デスクトップの動作と、ヘルプ固有のファイルのデータ型を定義します。これにより、ヘルプ・ソース・ファイルのアイコンを選択し、ファイルを処理するメニュー・コマンドを選択することにより、デズクトップから簡単に実行時のファイルを作成できます。実行時のヘルプ・ファイルの識別には、
|
||
<indexterm><primary>ヘルプ</primary><secondary>アクション</secondary>
|
||
</indexterm><indexterm><primary>アクション、ヘルプ</primary></indexterm><indexterm><primary>ヘルプ</primary><secondary>データ型</secondary></indexterm><indexterm><primary>データ型、ヘルプ</primary></indexterm><filename>.sdl</filename> という拡張子を使用します。処理中にエラーが発生すると、エラー・ファイル (<symbol role="Variable">volume</symbol><filename>.log</filename>) に通知されます。</para>
|
||
<para>実行時のヘルプ・ファイルの作成の詳細については、<!--Original XRef content: '“Creating Run-Time Help Files” on page 89'--><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.2">を参照してください。デスクトップの動作とデータ型に関する一般的な情報については、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle>を参照してください。</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.44">
|
||
<title id="HRDC.Intro.mkr.26">ユーザを想定したヘルプのレビュー<indexterm>
|
||
<primary>レビュー</primary><secondary>ユーザを想定したヘルプ</secondary>
|
||
</indexterm><indexterm><primary>ユーザの</primary></indexterm><indexterm><primary>ユーザの視点、～からヘルプをみる</primary></indexterm><indexterm><primary>視点、ユーザを想定したヘルプ</primary></indexterm><indexterm><primary>σ</primary></indexterm></title>
|
||
<para>設計中に、ヘルプを表示させて読者と同じように対話する必要が生じることがあります。その場合、デスクトップからヘルプ・ボリュームを表示させるには、実行時のヘルプ・ボリューム (<symbol role="variable">volume</symbol>.<filename>sdl</filename>) のアイコンをダブルクリックします。あるいは、<command>dthelpview</command> コマンドを使用して任意のトピックを表示することもできます。
|
||
<!--Original XRef content: 'Chapter 4, “Processing and Displaying
|
||
a Help Volume'--><xref role="ChapNumAndTitle" linkend="HRDC.CrHV.mkr.1">で、両方の方法を説明します。</para>
|
||
<para>アプリケーション・ヘルプを書いていて、ヘルプ・システムがアプリケーションに統合されている場合は、アプリケーションを実行して、ユーザと同じ方法でヘルプを要求することにより、ヘルプを表示することができます。</para>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Intro.div.45">
|
||
<title id="HRDC.Intro.mkr.27">プログラマが行う作業<indexterm><primary>プログラマ、アプリケーション</primary><secondary>責任</secondary></indexterm><indexterm>
|
||
<primary>責任</primary><secondary>プログラマ</secondary></indexterm></title>
|
||
<para>プログラマは、ユーザがコンテキスト・ヘルプを要求したときに、そのときのアプリケーションの動作に関するヘルプ情報が表示されるように、アプリケーションにコードを追加します。</para>
|
||
<note>
|
||
<para id="HRDC.Intro.mkr.28"><filename>/usr/dt/share/examples/dthelp</filename> ディレクトリには、<command>dthelpdemo</command> というプログラム例のソースコードがあります。Motif アプリケーションへのヘルプ・ダイアログを追加する方法を示すものです。
|
||
<indexterm>
|
||
<primary>アプリケーション例、統合されたヘルプ</primary></indexterm></para>
|
||
</note>
|
||
<sect2 id="HRDC.Intro.div.46">
|
||
<title id="HRDC.Intro.mkr.29">ヘルプのアクセス方法</title>
|
||
<para>ユーザに役立つ情報を提供するには、次のことを考慮することが必要です。
|
||
</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para>一般に起こりうる混乱状況は何か。このような状況で、有効なヘルプを提供すれば、ユーザは時間を浪費せずに済みます。
|
||
</para>
|
||
</listitem><listitem><para>後でも先でもなく今、ユーザがヘルプを必要としているのはなぜか。実行するステップが複数あり、ユーザがその最初のステップにない場合は、そのステップに固有のヘルプ情報へ分岐しなければなりません。こうしたほうが、各ステップごとに同じヘルプ情報を表示するよりずっと役立ちます。ユーザが最初のステップにある場合は、最初のステップの詳細な情報も、全ステップの概要もわかるようにしなければなりません。
|
||
</para>
|
||
</listitem><listitem><para>ユーザはコンテキスト・ヘルプを要求しているのか、それとも単にヘルプ情報をブラウズしているだけなのか。コンテキスト・ヘルプを要求している場合は、現在行われている作業に関連した情報を提供しなければなりません。
|
||
</para>
|
||
</listitem></itemizedlist>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.47">
|
||
<title id="HRDC.Intro.mkr.30">ヘルプの設計者との協力</title>
|
||
<para>オンライン・ヘルプの設計者は、各コンテキスト・トピックを表示する方法を知りたがっており、プログラマは各コンテキスト・トピックの内容を知りたがっているので、プログラマは設計者と密に連絡をとることが必要です。双方の協力がないと、情報は不適切で、曖昧で、誤りのあるものとなります。
|
||
</para>
|
||
<para>こうした協力により、プログラマはアプリケーションを理解し、設計者は情報をユーザへどのように伝えたらよいかを理解できます。
|
||
</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.48">
|
||
<title>ヘルプのエントリ・ポイントの識別</title>
|
||
<para>ヘルプの<emphasis>エントリ・ポイント</emphasis>を設定することにより、アプリケーションでオンライン・ヘルプが使えるようになります。エントリ・ポイントは、アプリケーションで定義され、特定のヘルプ・トピックに対応付けられています。ユーザが、[ヘルプ]キー、[ヘルプ]ボタン、[ヘルプ]メニューのいずれの方法によってヘルプを要求しても、エントリ・ポイントが表示されます。たとえば、[ヘルプ]ボタンを備えた印刷ダイアログ・ボックスを想定します。設計者は、ダイアログ・ボックスの内容を説明するヘルプ・トピックを記述し、トピックのIDを提供します。そこで、ユーザはコールバック・ルーチンを使用して、[ヘルプ]ボタンでヘルプ・トピックのIDを指定できます。
|
||
</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.49">
|
||
<title id="HRDC.Intro.mkr.31">ヘルプ・ダイアログの作成と管理</title>
|
||
<para>ヘルプ・システムのアプリケーション・プログラム・インタフェースは、特に、Motif アプリケーションで使用するように設計されています。特に、このヘルプでは、次の２つの新しいウィジェット・クラス（およびこれらを処理するために便利な機能を加えたもの）を提供することにより、Motif ウィジェット・セットを拡張しています。
|
||
</para>
|
||
<itemizedlist remap="Bullet1"><listitem><para><emphasis>一般ヘルプ・ダイアログ</emphasis>メニュー・バー、トピック・ツリー、ヘルプ・トピック表示領域を備えたヘルプ・ウィンドウを提供します。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>簡易ヘルプ・ダイアログ</emphasis>トピック表示領域といくつかのダイアログ・ボタンを備えた簡素なヘルプ・ウィンドウを提供します。
|
||
</para>
|
||
</listitem></itemizedlist>
|
||
<para>アプリケーションでは、上記のいずれか、または両方を使用できます。アプリケーションを（ヘルプ・ライブラリとともに）コンパイルすると、ヘルプ・ウィンドウがアプリケーションの一部になります。
|
||
</para>
|
||
<para><!--Original XRef content: 'Chapter 9, “Creating and Managing Help Dialog Boxes'--><xref role="ChapNumAndTitle" linkend="HRDC.CrDia.mkr.1">で、一般ヘルプ・ダイアログ・ボックスと簡易ヘルプ・ダイアログ・ボックスを説明します。
|
||
</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Intro.div.50">
|
||
<title>パッケージとヘルプの割り当て</title>
|
||
<para>プロダクト・パッケージには実行時のヘルプ・ファイル (<symbol role="variable">volume</symbol>.<filename>sdl</filename>) とグラフィック・ファイルが入っています。また、フロントパネルのヘルプ・ビューアでボリュームを表示できるようにするヘルプ・ファミリ・ファイルも作成できます。
|
||
</para>
|
||
<para>ヘルプ・ボリュームが実行リンクを使用する場合、適切な実行リンク・リソースをアプリケーションのデフォルト・リソース・ファイルに入れるよう設計者と協力しなければなりません。
|
||
<!--Original XRef content: 'Chapter 13, “Preparing an Installation Package'--><xref role="ChapNumAndTitle" linkend="HRDC.Inst.mkr.1">で、アプリケーションに、どのヘルプ・ファイルが割り当てられるかを説明します。
|
||
</para>
|
||
</sect2>
|
||
</sect1>
|
||
</chapter>
|
||
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
|
||
<?Pub *0000050603>
|