識別子を作成して割り当てる
プロジェクトのために文脈依存型ヘルプ (CSH)の開発にあたる最初の手段はヘッダー ファイルとエイリアス ファイルを追加することです。その後、ヘッダー ファイルの識別子を編集しなければなりません:
- もしあなたが文脈依存型ヘルプにおけるヘッダー ファイルを作成する責任をもっていることが決定されたら、識別子の作成も割り当ても両方エイリアス エディタで行わなければなりません。
- もしソフト開発者が文脈依存型ヘルプにおけるヘッダー ファイルを作成する責任をもっていることが決定されたら、識別子(開発者が提供してくれるヘッダー ファイルに既に含まれているはず)の割り当てをだけ行う必要があります。
識別子を作成して割り当てることというのは:
- トピック ID と含めたい CSH ヘルプのいろいろなトピックに相当するユニーク数値を作成 たとえば、あなたが書いているドキュメンテーションの対象ソフトアプリケーションが「Properties Dialog」というダイアログを含むならば、それのための「Using the Properties Dialog」というトピックを書いたでしょう。本物のダイアログをトピックとつなげるために、エイリアス エディタの中でトピック ID を作成して、「Properties_Dialog」と名称を付けることができます。なお、それ以外の 157 個のトピックやダイアログ用の似たトピック ID が既に作成してあると例えましょう。それぞれのトピック ID に 1 から 157 の間のユニーク数値を与えました。よって、「Properties_Dialog」には 158 を割り当てます。それで以下のようなとピック ID と数値で終わります: Properties_Dialog 158。
- 作成したトピック ID にトピック(ブックマーク内トピックでも)を割り当てる たとえば、"Properties_Dialog" というトピック ID を作成した場合、ユーザがそのダイアログのヘルプボタンをクリックする際に見てほしいトピックと何となくリンクをつけなければなりません。そのトピック ID を「Using the Properties Dialog」というトピックとリンクを付けたいとしましょう。よって、エイリアス エディタでそのトピック ID を選択して、トピックを選択して、そして「割り当て」ボタンをクリックするとよいのです。これがトピック ID を指定トピックと「結びます」。
- 作成したトピック ID にスキンを割り当てる たとえば、ヘルプ システムのほとんどのトピックを幅12センチ、高さ17センチ(などの特性を持つ)というウィンドウで開くようにしたいと仮定しましょう。だから、以上の仕様を含むスキンをつくって、「Main」という名称をつけます。しかし、ある独特のウィンドウかダイアログから開かれる CSH トピックに対しては、幅10センチ、高さ15センチ(などの違う特性を持つ)というヘルプウィンドウにしたいのです。それでこの別の使用を含むもう一つのスキンをつくって、その名を「Dialogs」にします。エイリアス エディタでは、識別子を作成してから、それぞれに「Dialogs」スキンを割り当てることができます。
以下の手段は同時に識別子を作成してトピックに割り当てる、識別子を作成するだけ、トピックとスキンに識別子を割り当てるだけ、の方法を指導します。以下の手順は識別子の作成と同時にトピックに割り当てる、識別子を作成するだけ、トピックとスキンに識別子を割り当てるだけといったことを指導します。状況に一番適切な手順を利用します。
識別子を同時に作成して割り当てる方法
- 作成したエイリアス ファイルを開きます。
- プロジェクトにヘッダー文書が複数あれば、エイリアス エディタの左上側にある下矢印をクリックして作成する識別子の対象ヘッダー ファイルを選択します。または、フィールドに "(すべての識別子)" をそのままに置いても結構です。
- エイリアス エディタの右側で、新規識別子に割り当てるトピックを選択します。もしトピックをコンテンツ エクスプローラの別々のファイルに整理したなら、上部の下矢印をクリックして適切なフォルダを選択することでエイリアス エディタの右側に表示されるトピックを制限できます。識別子をトピック内の特定のブックマークに「結ぶ」には、エイリアス エディタの最下部のブックマークの表示チェックボックスをクリックして、それからその上のトピック リストからブックマークを選択します。
- 新規を割り当てるボタンをクリックします。 新規識別子割り当てダイアログが開きます。
- 新規識別子の名称フィールドに、ソフトウェア アプリケーションのあるダイアログまたはウィンドウを代表するために自動的に与えられた名称をそのままにするか、自分のを打ちます(例: Properties_Dialog)。(単語間には空白が許可されていないから必ずアンダースコアを利用します。)
- 識別子の値フィールドに、自動的に与えられた数値をそのままにするか、任意のお好みの数値(同値の識別子がない限り)に変更します。
- OKをクリックします。新規の行が新しい識別子の名称、割り当てられたトピック名、ユニーク数値をもってエディタの左側に追加されます。
- 特定のスキンを識別子に割り当てるには、下記のスキン一覧からスキンを選択します。
- 識別子を選択し続けたまま、割り当てるボタンをクリックします。スキン名がエイリアス エディタの左側にある識別子行に追加されます。
- 追加する各識別子の(それぞれソフトウェア アプリケーションでの別のダイアログかウィンドウを代表する)ために上記の手順を繰り返します。
-
をクリックして変更を保存します。アステリスクがエイリアス エディタにあるファイル名から取り除かれます。
識別子を作成する方法
- 作成したエイリアス ファイルを開きます。
- プロジェクトにヘッダー文書が複数あれば、エイリアス エディタの左上側にある下矢印をクリックして作成する識別子の対象ヘッダー ファイルを選択します。または、フィールドに "(すべての識別子)" をそのままに置いても結構です。
- エイリアス エディタの下部にある新規識別子ボタンをクリックします。新規の行が一時的な識別子名称とユニークな数値とをもってエディタの左側に追加されます。
- 識別子セルの中をクリックしてソフトウェア アプリケーションのあるダイアログまたはウィンドウを代表するように変更します(例: Properties_Dialog)。(単語間には空白が許可されていないから必ずアンダースコアを利用します。)自動的に与えられた数値をそのままにするか、値セルの中をクリックして任意のお好みの数値(同値の識別子がない限り)に変更できます。エイリアス エディタのトップのファイル名の隣にアステリスク(*)が現れます。このアステリスクはエイリアス ファイルに未保存変更があることを指示します。
- 追加する各識別子の(それぞれソフトウェア アプリケーションでの別のダイアログかウィンドウを代表する)ために上記の二手段を繰り返します。
-
をクリックして変更を保存します。アステリスクがエイリアス エディタにあるファイル名から取り除かれます。
トピックとスキンに識別子を割り当てる方法
- 作成したエイリアス ファイルを開きます。
- エイリアス エディタの左側で、トピックまたはスキンに割り当てる識別子を選択します。
- エイリアス エディタの右側で、前の手段で選択した識別子を割り当てるトピックを選択します。もしトピックをコンテンツ エクスプローラの別々のファイルに整理したなら、上部の下矢印をクリックして適切なフォルダを選択することでエイリアス エディタの右側に表示されるトピックを制限できます。識別子をトピック内の特定のブックマークに「結ぶ」には、エイリアス エディタの最下部のブックマークの表示チェックボックスをクリックして、それからその上のトピック リストからブックマークを選択します。
- 割り当てるボタンをクリックします。トピック名がエイリアス エディタの左側にある識別子行に追加されます。
- 特定のスキンを識別子に割り当てるには、下記のスキン一覧からスキンを選択します。
- 識別子を選択し続けたまま、割り当てるボタンをクリックします。スキン名がエイリアス エディタの左側にある識別子行に追加されます。
-
をクリックして変更を保存します。アステリスクがエイリアス エディタにあるファイル名から取り除かれます。
次は?
識別子を作成して割り当ててから、(プロジェクトにエイリアス文書が複数あれば)エイリアス ファイルをビルドするターゲットに関連づけなければなりません。それから、(もしあなたがヘッダー ファイル作成責任を持っていれば)開発者にヘッダー ファイルのコピーを提供、ターゲットの出力をビルド、開発者に出力ファイルのコピーを供給、そしてCSH をテストといった以上のことをしなければなりません。
追加参照