test

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

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

ヘルプタグを実行すると、volume.htg ファイル、volume.ctg ファイル、エンティティを使って指定された追加のソース・ファイルを読み取ります。また、使用するグラフィック・ファイルが存在するかどうかも確認します。

検索パスに /usr/dt/bin/dthelptag コマンドがあることを確認してください (確認の仕方がわからない場合は、システム管理者に問い合わせてください)。

実行時のヘルプ・ボリュームを作成するには

  1. ファイル・マネージャを開き、ディレクトリを volume.htg ファイルのあるディレクトリに変更します。

    Graphic

  2. ファイル・アイコンを選択します。

  3. ファイル・マネージャの [選択] メニューで [コンパイル] を選択します。

    volume.htg ファイルが処理され、volume.sdl ファイルと volume.err ファイルが作成されます。

ヘルプタグの出力

ヘルプタグの出力先は実行時のヘルプ・ボリュームで、名前は volume.sdl です。処理中に何らかのエラーが発生すると、エラー・ファイル (volume.err) に報告されます。エラーがない場合は、volume.err ファイルには著作権情報といくつかのステータス行が入ります。

helptag.opt ファイルに onerror=go オプションを設定すると、パーサはエラーを検出した後でも (可能であれば) 処理を続行します。onerror=go オプションを設定しないと、パーサは最初のエラーが検出されたところで停止します。volume.sdl ファイルは、ソース・ファイルにエラーがなくなるまでは作成されません。

ヘルプ・トピックを表示するために、volume.sdl ファイルとグラフィック・ファイルがヘルプ・システムに読み取られます。実行時のヘルプ・ファイルは、volume.htg ファイルと同じベース名を持ちます。たとえば、volume.htg ファイル名が Librarian.htg の場合、ヘルプ・ボリューム名は Librarian.sdl です。

注意 - 注意 -

ヘルプタグ実行後は、実行時のヘルプ・ファイルまたはグラフィック・ファイル名を変更しないでください。volume.sdl ファイルに格納される情報は元の名前に基づいています。volume.htg ファイル名を変更する場合は、ヘルプタグを再実行してください。

手動で dthelptag コマンドを実行するには

    dthelptag コマンドを次のように実行します。

       dthelptag  command-options  volume  parser-options

    command-options は volume 名の前に入力するオプションで、parser-options は volume 名の後に入力するオプションです。使用できるオプションは、「ヘルプタグ・ファイルの処理 (dthelptag)」にリストされています。

例: コマンド

次のコマンドは、MyVolume という名前のヘルプ・ボリュームを処理します。

dthelptag MyVolume

-verbose オプションを指定すると、処理の進み具合が画面に表示されます。

dthelptag -verbose MyVolume

検索パスを追加すると、ヘルプタグは graphics という名前の (現在のディレクトリの) サブディレクトリに格納されているファイルを検索できます。

dthelptag -verbose MyVolume search=graphics

例: helptag.opt ファイル

次の例は、オプションが 1 つずつ別の行にあるサンプル helptag.opt ファイルです。これは、ボリュームのドラフト版を作成するのに適した方法です。

memo
onerror=go 
search=graphics/
search=entityFiles/

ヘルプ・ボリュームの最終版を作成する前に、memo と onerror=go の行を削除してください。

関連項目

パーサ・エラーをレビューおよび修正するには

    ヘルプタグ実行後、volume.err ファイルの中身を見てください (volume は volume.htg ファイルのベース名です)。

volume.err ファイルにリストされている各エラーは、アスタリスクの文字列 (*****) で始まっています。たとえば、actions ファイルの 54 行目で次のエラーが検出されました。

*****
Line 54 of actions,
Missing end tag for LIST:
...the execution host becomes the current working directory.

<s2 id=EverythingYouNeedToKnow> E...
Current element is LIST begun on Line 28 of actions.

エラーの状況がわかるように、ファイルの内容が数行表示されています。また、その要素は同じファイルの 28 行目から始まる LIST だというヒントがあります。<s2> はリスト内では許可されないので、設計者が <¥list> 終了タグを入力し忘れたようです。

1 つの単純なエラーがいくつかのエラー・メッセージを生成することがあります。これは、最初のエラーによってパーサが意図していたコンテキストを見失い、その後のマークアップを正しく解釈できなくなったためです。

一般的なエラー

処理エラーのほとんどは、以下の一般的なミスによるものです。

要素に終了タグを付け忘れるのはよくあるミスです。リスト、図、注、注意、警告などの要素を作成するときには、必ず終了タグを付けてください。特に、リスト中の図のように、ある要素を他の要素の中にネストした場合は、マークアップを丁寧にチェックしてください。

間違ったエンティティ名を使用するエラーもよく起こります。ほとんどの場合は単なるつづりの間違いです。その他は、エンティティ名が変更されたのに元の名前への相互参照が見落とされた場合です。エンティティ名を変更するときには、ソース・ファイルでそのエンティティ名のすべてのインスタンスを忘れずに検索してください。

同じように、要素に関連付けられた ID を変更すると、そのトピックへの相互参照やリンクに影響します。