Empressがインストールされたディレクトリ以下にあるhelpディレクトリ ($EMPRESSPATH/rdbms/help) は、 Empressのオンラインヘルプ機能によってアクセスされるヘルプファイルが 格納されています。
※v862 日本語版では$EMPRESSPATH/rdbms/help/japaneseの下にヘルプファイルが置かれています。
ヘルプファイルとして、あなたが作成したヘルプファイルを追加することができます。 Empressからアクセス可能な新しいヘルプファイルを追加するには、 help ディレクトリにヘルプファイルを置き、ヘルプファイルディレクトリ中の _dictファイルに登録します。 _dictファイルは以下のフォームのエントリを含みます。
ヘルプファイル {, <タブ>} トピック
where:
| ヘルプファイル | オンラインヘルプにおいて、キーワードが入力されたときに 表示するファイル名で、１つのファイルはいくつかのキーワードと関連付けることができます。 |
| <タブ> | タブ文字はセパレータです。 |
| トピック | トピックではパターンマッチのためのアスタリスク("*")を記述することができます。、 アスタリスク("*")はそれが出現する位置のすべての文字（文字がない場合を含め）とマッチします。 例えば、"edit *ed*"と登録した場合、"help edit", "help ed", "help editor"の 入力で、 editファイルを見つけることができます。 クエスション"?"は、Empress クエリー言語のパターンマッチと同様に すべての１文字とマッチするために利用することができます。 また、キーワード中にブランクを含むことはできません。 |
ヘルプのトピックが、Empress(empsql)中でタイプされると _dict ファイルのキーワードリストの中に 一致したトピックが見つけるまで直線的に検索されます。 パターンマッチングを使用しないキーワードは、 マッチングする必要要件が、より特定されており、 あまり特定されていない要求がヘルプファイルを 見つけるためには、 パターンマッチングを使用するキーワードより、 リストにおいて前に記述すべきです。 例えば、このリストは
database database datatype datatype database *data*
適切な順序になりますが、以下のリストにおいては、 datatypeは決して一致することはありません。
database database database *data* datatype datatype
例として、 "データベース管理者ガイドを参照してください。"を含む errorsと呼ばれるファイルを作成し、 エラーメッセージについてのヘルプファイルを追加する場合、 ヘルプファイルとしてこれをインストールします。 helpディレクトリ中にerrorsファイルを移動し、 _dictへ以下の行を追加します。
errors <タブ> *error*
この追加により、ユーザーはトピックに"error"という単語を含む ヘルプのリクエストを入力すると"error"の内容を出力します。 また、以下のコマンドにより"error"ファイルを出力するには
help message
次の行を_dictに追加します。
errors <タブ> *message*