Yelp ブラウザ

Yelp ブラウザは、OMF (Open Source Metadata Framework) およびカタログ作成システムを使用します。

OMF ファイル

各マニュアルの XML ファイルには、OMF ファイルが関連付けられています。OMF ファイルには、Yelp ブラウザが使用するマニュアルについての情報が含まれています。OMF ファイルの拡張子は、.omf です。

アプリケーションをインストールすると、OMF ファイルが OMF ファイル用のディレクトリにインストールされます。OMF ファイルディレクトリ内にヘルプドキュメントの関連 OMF ファイルがある場合は、Yelp ブラウザからヘルプドキュメントにアクセスできます。

OMF ファイルには、ヘルプドキュメントに関する以下のような情報が含まれています。

• ヘルプドキュメントの XML ファイルがある場所

• ヘルプドキュメントの題名

• ヘルプドキュメントが属しているサブジェクトカテゴリ

ScrollKeeper カタログ作成システム

ScrollKeeper は、ドキュメント用カタログシステムです。Yelp ヘルプブラウザは、ScrollKeeper を使用してシステム上にマニュアルのカタログを作成します。ScrollKeeper は、Yelp ヘルプブラウザのために OMF ファイル内の情報を管理します。

ScrollKeeper が OMF ファイル内の情報を使用することで、Yelp ヘルプブラウザはシステム上のヘルプドキュメントを検索できます。アプリケーションをインストールすると、OMF ファイルが OMF ファイル用のディレクトリにインストールされます。

ScrollKeeper は、OMF ファイルが関連付けられた各ヘルプドキュメントの目次を作成します。ScrollKeeper は、OMF ファイル内に指定された XML ファイルから目次を作成します。ヘルプドキュメントの目次は Yelp ヘルプブラウザウィンドウの左区画に表示されます。ユーザーは、目次を使って左区画に表示されたヘルプドキュメントに移動できます。OMF ファイルのドキュメントの題名も Yelp ヘルプブラウザウィンドウの左区画に表示されます。

ScrollKeeper には、ヘルプドキュメントが属しているサブジェクトカテゴリの階層が含まれています。ヘルプドキュメントは、Yelp ヘルプブラウザウィンドウの左区画のサブジェクトカテゴリ階層に整理されています。OMF ファイル内のドキュメントのサブジェクトカテゴリは、階層内のドキュメントの位置を決定します。サブジェクトカテゴリの階層は、以下のファイルで定義されます。

/usr/share/scrollkeeper/Templates/C/scrollkeeper_cl.xml

ドキュメントのサブジェクトカテゴリは、以下のファイルのサブジェクトカテゴリに対応していなければなりません。

/usr/share/scrollkeeper/Templates/C/scrollkeeper_cl.xml

ヘルプドキュメントの XML ファイルを新しい場所に移動した場合、OMF ファイル内の場所情報も更新しなければならない場合があります。