198 lines
18 KiB
Plaintext
198 lines
18 KiB
Plaintext
<!-- $XConsortium: ch12.sgm /main/11 1996/09/08 19:41:02 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.Inst.div.1">
|
||
<title id="HRDC.Inst.mkr.1">インストール・パッケージの準備</title>
|
||
<para id="HRDC.Inst.mkr.2">この章では、アプリケーションのインストール・パッケージにあるヘルプ・ファイルについて説明します。また、アプリケーションがデスクトップに登録されるときにヘルプ・ファイルが処理される方法についても説明します。
|
||
</para>
|
||
<informaltable id="HRDC.Inst.itbl.1" frame="All">
|
||
<tgroup cols="1">
|
||
<colspec colname="1" colwidth="4.0 in">
|
||
<tbody>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Delivering Online Help244'--><xref
|
||
role="JumpText" linkend="HRDC.Inst.mkr.4"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Creating an Installation Package244'--><xref
|
||
role="JumpText" linkend="HRDC.Inst.mkr.5"></para></entry></row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Registering Your Application and
|
||
Its Help247'--><xref role="JumpText" linkend="HRDC.Inst.mkr.9"></para></entry>
|
||
</row>
|
||
<row rowsep="1">
|
||
<entry><para><!--Original XRef content: 'Product Preparation Checklists248'--><xref
|
||
role="JumpText" linkend="HRDC.Inst.mkr.12"></para></entry></row></tbody></tgroup>
|
||
</informaltable>
|
||
<sect1 id="HRDC.Inst.div.2">
|
||
<title id="HRDC.Inst.mkr.3">概要</title>
|
||
<para>最終的に製品を準備する段階になったら、すべてのヘルプ・ファイルが適切に作成され、インストールされていることを確認しなければなりません。製品パッケージには、
|
||
実行時のヘルプ・ファイル (<symbol>volume</symbol><filename>.sdl</filename>) およびそのグラフィック・ファイルの両方が入っています。さらに、フロントパネルのヘルプ・ビューアを使用してボリュームの表示を可能にするヘルプ・ファミリ・ファイルを作成することができます。
|
||
</para>
|
||
</sect1>
|
||
<sect1 id="HRDC.Inst.div.3">
|
||
<title id="HRDC.Inst.mkr.4">オンライン・ヘルプの配布</title>
|
||
<para>オンライン・ヘルプは、アプリケーションに完全に統合されるか、スタンドアロン・ヘルプ・ボリュームとして提供されます。完全に統合されたヘルプによって、[ヘルプ]メニューか[ヘルプ]キーを使用して、アプリケーションからヘルプ情報に直接アクセスできます。その一方、スタンドアロン・ヘルプは、デスクトップのヘルプ・ビューアを使用してのみ表示できます。
|
||
</para>
|
||
<para>システム管理者は、アプリケーションが統合されたヘルプを提供しない場合や、カスタマイズされた環境で補足的なヘルプ・ボリュームが作成されない場合に、スタンドアロン・ヘルプ・ボリュームをデスクトップに追加するように選択できます。デスクトップにスタンドアロン・ボリュームを追加する手順については、<xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.10"> を参照してください。
|
||
</para>
|
||
</sect1>
|
||
<sect1 id="HRDC.Inst.div.4">
|
||
<title id="HRDC.Inst.mkr.5">インストール・パッケージの作成</title>
|
||
<para>インストール・パッケージには、次のヘルプ・ファイルが入っています。
|
||
</para>
|
||
<itemizedlist><listitem><para>実行時のヘルプ・ファイル</para>
|
||
</listitem><listitem><para>グラフィック・ファイル</para>
|
||
</listitem><listitem><para>ヘルプ・ファミリ・ファイル (オプション)</para>
|
||
</listitem><listitem><para>アプリケーション・デフォルト・ファイル (オプション)</para>
|
||
</listitem></itemizedlist>
|
||
<para>オンライン・ヘルプで使用されている実行時のヘルプ・ファイルとグラフィック・ファイルは、インストール・パッケーシに入っています。ヘルプ・ファミリ・ファイルは、統合されたアプリケーション・ヘルプのオプションです。しかし、アプリケーション・ヘルプをデスクトップのヘルプ・ビューアを使用してブラウズ可能にしたい場合は、ファミリ・ファイルを作成しなければなりません。スタンドアロン・ヘルプ・ボリュームを配布する場合は、ヘルプ・ファミリ・ファイルを作成しなければなりません。<xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.11"> を参照してください。
|
||
</para>
|
||
<para>アプリケーションのヘルプ・ボリュームに実行リンクがある場合、設計者はアプリケーションのデフォルトのリソース・ファイルに実行別名を定義するようにしてください。このためには、実行別名でリンクを自動的に実行するヘルプ・システムのデフォルトの実行ポリシーを利用します。しかし、ヘルプ・ボリュームが、ヘルプ・ビューアのような別の情報ビューアを使用して独立したボリュームとして表示される場合、ヘルプ・システムは実行リンクが選択された時点で確認ダイアログボックスを表示します。
|
||
</para>
|
||
<para><xref role="Page" linkend="HRDC.Inst.mkr.6"> の <xref role="CodeOrFigureOrTable" linkend="HRDC.Inst.mkr.6"> は、アプリケーションとそのヘルプ・ファイルの典型的なインストール・パッケージを示しています。ヘルプ・ディレクトリは、デフォルトの言語ディレクトリ（C がデフォルトです）がある別の <filename>help</filename> サブディレクトリにグループ化されます。実行時のヘルプ・ファイル、ファミリ・ファイル、およびグラフィック・ファイルは、このディレクトリにあります。
|
||
</para>
|
||
<figure>
|
||
<title id="HRDC.Inst.mkr.6">アプリケーション・インストール・パッケージ</title>
|
||
<graphic id="HRDC.Inst.grph.1" entityref="HRDC.Inst.fig.1"></graphic>
|
||
</figure>
|
||
<para>アプリケーションが複数の言語でオンライン・ヘルプを提供する場合、各言語を格納するための <symbol role="Variable">language</symbol> サブディレクトリを作成してください（<symbol role="Variable">language</symbol> はユーザの <systemitem class="resource">LANG</systemitem> 環境変数と一致します）。たとえば、英語ユーザ・インタフェースとドイツ語ユーザ・インタフェースの両方を提供するアプリケーションは、英語には <filename>C</filename>、ドイツ語には <filename>german</filename>、というように２つのサブディレクトリに、それぞれ対応するオンライン・ヘルプを保存します。
|
||
</para>
|
||
<sect2 id="HRDC.Inst.div.5">
|
||
<title>実行時ヘルプ・ファイル</title>
|
||
<para>DocBook は単一の実行時のヘルプ・ファイル <symbol role="Variable">volume</symbol><filename>.sdl</filename> を作成します。ベース名 <symbol role="Variable">volume</symbol> は、<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルのベース名と同一です。ヘルプ・ビューアは、マスタ・ヘルプ・ファイルに保存されている情報を使用し、関連付けられたグラフィック・ファイルにもアクセスします。
|
||
</para>
|
||
<para>DocBook ソフトウェアによって作成された <symbol role="Variable">volume</symbol><filename>.sgm</filename> や追加のファイルを出荷する必要はありません。
|
||
</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Inst.div.6">
|
||
<title id="HRDC.Inst.mkr.7">グラフィック・ファイル</title>
|
||
<para>ヘルプ・ボリュームがグラフィックを使用している場合、通常、イメージ・ファイルは、便宜上別のディレクトリに保存されます。しかし、<symbol role="Variable">volume</symbol><command>.sgm</command> ファイルと同じ場所に保存するように選択することも可能です。
|
||
</para>
|
||
<para>実行時のヘルプ・ファイルには、実際のグラフィック・イメージは入っていません。その代わりに、各グラフィック・ファイルへの位置への「参照」が入っています。DocBook を実行すると、<command>dtdocbook</command> コンパイラは、グラフィックの相対パス名をヘルプ・ボリュームに組み込みます。
|
||
</para>
|
||
<para>ヘルプ・ファイルがインストールされると、グラフィック・ファイルは実行時のファイルが作成されたときと同じ相対位置に位置付けられます。そうでない場合は、ヘルプ・ボリュームはグラフィック・ファイルを位置付けることはできません。たとえば、グラフィック・ファイルが <symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルよりひとつ下のレベルにある <filename>graphics</filename> という名前のサブディレクトリにある場合、インストール・パッケージはその相対位置を確保しておかなければなりません。グラフィック・ファイルは、<symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルよりひとつ下のレベルにある <filename>graphics</filename> という名前のサブディレクトリに位置付けられなければなりません。
|
||
</para>
|
||
<figure>
|
||
<title>作成ディレクトリとインストール・パッケージの関係</title>
|
||
<graphic id="HRDC.Inst.grph.2" entityref="HRDC.Inst.fig.2"></graphic>
|
||
</figure>
|
||
</sect2>
|
||
<sect2 id="HRDC.Inst.div.7">
|
||
<title>ヘルプ・ファミリ・ファイル</title>
|
||
<para>ヘルプ・ファミリ・ファイル (<symbol>volume</symbol><filename>.hf</filename>) をオプションとして提供できます。ファミリ・ファイルにはヘルプ・ボリュームについての簡単な記述と著作権情報があります。また、このファイルは、ひとつ以上の関連のあるボリュームをひとつの製品のカテゴリにグループ化するときにも使用されます。
|
||
</para>
|
||
<para id="HRDC.Inst.mkr.8">デスクトップ・ブラウザ・ボリュームからヘルプ・ボリュームへアクセス可能にしたい場合、インストール・パッケージにファミリ・ファイルを作成しなければなりません。ファミリ・ファイルを作成するには、<xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.11"> を参照してください。
|
||
</para>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Inst.div.8">
|
||
<title id="HRDC.Inst.mkr.9">アプリケーションとそのヘルプの登録</title>
|
||
<para>デスクトップの統合ユーティリティ <command>dtappintegrate</command> は、インストールされたアプリケーション・ファイルと特定のデスクトップ・ディレクトリの間にシンボリック・リンクを作成することによって、アプリケーションとそのヘルプ・ファイルを登録します。アプリケーションの登録によって、ヘルプ・システムが使用するディレクトリ検索パスにヘルプ・ファイルを確実に位置付けることができます。
|
||
</para>
|
||
<para>登録によって、ヘルプ・システムの重要な２つの機能が使用可能になります。
|
||
</para>
|
||
<itemizedlist><listitem><para><emphasis>他のボリュームへのハイパーリンク</emphasis> ひとつのヘルプ・ボリュームにあるハイパーリンクは、ボリューム名とボリュームにあるIDだけを使用して、別のヘルプ・ボリュームを参照することができます。転送先ボリュームが登録されている場合、リンクはボリュームをファイル・システムのどこに保存するかを指定する必要はありません。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>ヘルプ・ファミリのブラウズ</emphasis>
|
||
「ヘルプ・ファミリ」も登録する場合、ヘルプ・ボリュームはヘルプ・ビューアを使用してブラウズ可能になります。
|
||
</para>
|
||
</listitem></itemizedlist>
|
||
<para>オンライン・ヘルプを登録すると、提供したヘルプにアクセスしやすくなります。設計者とプログラマにとっては、ボリュームの実際の位置を指定しなくても、ボリュームへの参照には、ボリューム名だけを使用すればよいため、より簡単です。
|
||
</para>
|
||
<para>ひとつ以上のヘルプ・ボリュームがあるヘルプ・ファミリを登録する場合、フロントパネルの[ヘルプ・ビューア]からの一般的なブラウズにヘルプを使用できるようにします。これによって、アプリケーションを使用せずに、アプリケーション固有のヘルプにアクセスすることができます。また、スタンドアロン・ヘルプを記述している場合は、この方法がヘルプにたどりつく唯一の方法です。
|
||
</para>
|
||
<sect2 id="HRDC.Inst.div.9">
|
||
<title id="HRDC.Inst.mkr.10">スタンドアロン・ヘルプ</title>
|
||
<para>アプリケーションのスタンドアロン・ヘルプ・ボリュームやカスタマイズされた環境は、ヘルプ・システムの開発者用キットを使用して作成できます。ヘルプ・ボリュームをデスクトップ・ブラウザ・ボリュームからアクセス可能にするには、システム管理者は実行時のヘルプ・ファイル、関連付けられたグラフィック、およびファミリ・ファイルを <filename>/etc/dt/appconfig/help/</filename><symbol role="Variable">language</symbol> ディレクトリにインストールしてください。
|
||
</para>
|
||
<para>実行時のヘルプ・ファイルとそのグラフィック・ファイルは、ヘルプ・ボリュームが作成されたときと同じ相対位置にインストールされなければならないことを忘れないでください。グラフィック・ファイルのインストールを見直すには、<xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.7"> を参照してください。
|
||
</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Inst.div.10">
|
||
<title>アプリケーションの登録時に発生すること</title>
|
||
<para>アプリケーションの登録により、<symbol>app_root</symbol>/<filename>dt/appconfig/help</filename><symbol>language</symbol> にある実行時のヘルプ・ファイルおよびファミリと <filename>/etc/dt/appconfig/help</filename>/<symbol>language</symbol> ディレクトリの間にシンボリック・リンクが作成されます。
|
||
</para>
|
||
<para>アプリケーションの登録手順の詳細については、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle> を参照してください。
|
||
</para>
|
||
</sect2>
|
||
<sect2 id="HRDC.Inst.div.11">
|
||
<title id="HRDC.Inst.mkr.11">ヘルプ・ボリュームの検索方法</title>
|
||
<para>ヘルプ・システムはデスクトップ検索パスを使用してヘルプ・ボリュームを位置付けます。ヘルプがアプリケーション内で要求されたり、ヘルプ・ボリュームがコマンド行に指定された場合、ヘルプ・ボリュームは検索パス・ディレクトリのセットをチェックすることによって検索されます。いくつかの環境変数を変更してヘルプ・ボリュームのディレクトリ検索パスをコントロールすることができます。検索パスの指定の詳細については、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle> を参照してください。
|
||
</para>
|
||
</sect2>
|
||
</sect1>
|
||
<sect1 id="HRDC.Inst.div.12">
|
||
<title id="HRDC.Inst.mkr.12">製品準備チェックリスト</title>
|
||
<para>次のチェックリストは、製品が適切に準備されていることを確認するのに役立ちます。もちろん、ユーザが行うように製品をテストするのがいちばんいい方法です。
|
||
</para>
|
||
<sect2 id="HRDC.Inst.div.13">
|
||
<title>設計者の場合</title>
|
||
<orderedlist><listitem><para><emphasis>最後のバージョンの実行時のヘルプ・ファイルが作成された。
|
||
</emphasis></para>
|
||
<para>次の例は、実行時のファイルの作成の際に推奨するコマンドです。
|
||
</para>
|
||
<para><command>dtdocbook -r</command> <symbol role="Variable">volume</symbol></para>
|
||
<para><command>dtdocbook</command> <symbol role="Variable">volume</symbol></para>
|
||
<para><command>-r</command> オプションは、上記の <command>dtdocbook</command> コマンドからファイルを削除します。パーサ・エラーが発生したヘルプ・ボリュームを配布してはいけません。パーサ・エラーが発生すると、dtdocbook はそれらを中間ファイル <symbol role="Variable">volume</symbol><filename>.log</filename> に出力します。</para>
|
||
</listitem><listitem><para><emphasis>すべてのハイパーリンクをテストした。</emphasis>
|
||
</para>
|
||
<para>各ハイパーリンクが適切なトピックを表示し、正しいアクションが実行されることを検証します。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>実行別名が実行リンクに定義された。</emphasis></para>
|
||
<para>実行別名は、アプリケーションのアプリケーション・デフォルト・ファイルにあるリソースとして定義されます。実行別名は、実行されるシェル・コマンドと名前とを関連付けます。ヘルプ・ボリュームで実行リンクを使用した場合は、アプリケーション開発者がこれらのリソースをアプリケーション・デフォルト・ファイルに追加するように調整してください。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>すべてのグラフィックが受け入れ可能である。</emphasis></para>
|
||
<para>グラフィックの表示を、さまざまな色、グレースケール、およびモノクロ・ディスプレイでテストしたことを確認してください。
|
||
</para>
|
||
</listitem></orderedlist>
|
||
</sect2>
|
||
<sect2 id="HRDC.Inst.div.14">
|
||
<title>製品のインテグレータの場合</title>
|
||
<orderedlist><listitem><para><emphasis>実行時のファイルがインストールされた。</emphasis></para>
|
||
</listitem><listitem><para><emphasis>すべてのグラフィックが適切な位置にインストールされた。</emphasis></para>
|
||
<para>各グラフィック・ファイルは、DocBook ソフトウェアが実行されたときに <filename>.sgm</filename> ファイルとは相対的な位置にあった <filename>.sdl</filename> ファイルに対しても、同じ相対的な位置にインストールされなければなりません。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>ヘルプ・ボリュームが登録された。</emphasis></para>
|
||
<para><command>dtappintegrate</command> スクリプトが、インストール・ディレクトリから登録ディレクトリにシンボリック・リンクを作成するために実行された。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>製品のファミリ・ファイルがインストールおよび登録された。</emphasis></para>
|
||
<para>ファミリ・ファイルは、他のヘルプ・ファイルとともにインストールされます。<command>dtappintegrate</command> を実行すると、ファミリ・ファイルのシンボリック・リンクを作成します。ヘルプ・ボリュームのためにファミリ・ファイルを登録するのは任意です。しかし、ファミリ・ファイルを登録しないと、ヘルプ・ボリュームはフロントパネルのヘルプ・ビューアからはアクセスできません。
|
||
</para>
|
||
</listitem></orderedlist>
|
||
</sect2>
|
||
<sect2 id="HRDC.Inst.div.15">
|
||
<title>プログラマの場合</title>
|
||
<orderedlist><listitem><para><emphasis>アプリケーションは次の必須リソースに対して正しい値を設定している。</emphasis></para>
|
||
<programlisting><symbol>App-class</symbol>*helpVolume: <symbol>volume</symbol>
|
||
<symbol>App-class</symbol>*helpOnHelpVolume: <symbol role="Variable">help-on-help-volume</symbol></programlisting>
|
||
<para><systemitem class="resource">helpVolume</systemitem> リソースは、アプリケーションのためのヘルプ・ボリュームを識別します。<systemitem class="resource">helpOnHelpVolume</systemitem> リソースは、ヘルプ・システムの使用に関するヘルプがあるヘルプ・ボリュームを識別します。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>実行別名はアプリケーションのデフォルトのリソース・ファイルにある。</emphasis></para>
|
||
<para>設計者は、アプリケーションのリソースとして実行別名を定義します。実行別名は、実行するシェル・コマンドと名前とを関連付けます。実行リンクがヘルプ・ボリュームで使用されていた場合は、追加する必要があるリソースを識別していることを設計者が確認するようにしてください。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>アプリケーションが次のオプションのリソースに対して希望する値を設定している。</emphasis></para>
|
||
<programlisting><symbol>App-class</symbol>*DtHelpDialogWidget*onHelpDialog*rows: <symbol>rows</symbol>
|
||
|
||
<symbol>App-class</symbol>*DtHelpDialogWidget*onHelpDialog*columns: <symbol role="Variable">columns</symbol>
|
||
|
||
<symbol>App-class</symbol>*DtHelpDialogWidget*definitionBox*rows: <symbol role="Variable">rows</symbol>
|
||
|
||
<symbol>App-class</symbol>*DtHelpDialogWidget*definitionBox*columns: <symbol role="Variable">columns</symbol>
|
||
</programlisting>
|
||
<para><systemitem class="resource">onHelpDialog</systemitem> リソースは、「ヘルプの使い方」を表示するために使用される簡易ヘルプ・ダイアログのサイズを制御します。<systemitem class="resource">definitionBox</systemitem> リソースは、定義リンクに使用される簡易ヘルプ・ダイアログのサイズを制御します。
|
||
</para>
|
||
</listitem><listitem><para><emphasis>アプリケーションはデフォルトのフォント・リソースを使用するかアプリケーションのデフォルトのリソース・ファイルにフォント・リソースを定義している。</emphasis></para>
|
||
<para>ほとんどの場合、アプリケーションはデフォルトのフォント・リソースを使用できます。しかし、カスタム・フォントが使用される場合、デフォルトのリソース・ファイルに定義されていなければなりません。サンプルのフォント・スキーマが <filename>/usr/dt/dthelp/fontschemes</filename> ディレクトリに用意されています。フォント・スキーマの詳細については、<xref role="ChapNumAndTitle" linkend="HRDC.Lang.mkr.1"> を参照してください。
|
||
</para>
|
||
</listitem></orderedlist>
|
||
</sect2>
|
||
</sect1>
|
||
</chapter>
|
||
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
|
||
<?Pub *0000023101>
|