test

GNOME 2.2 システム管理 (Linux 版)

第 8 章 ヘルプシステム

この章では、GNOME デスクトップのヘルプシステムについて説明します。

概要

GNOME デスクトップは、Yelp ヘルプブラウザにヘルプを表示します。ヘルプのソース文書は XML ファイルです。XML ファイルは、DocBook XML Version 4.1.2 DTD (Document Type Definition) に書き込まれます。DocBook XML ファイルは HTML に変換され、この HTML がヘルプブラウザに表示されます。DocBook XML については、以下の URL を参照してください。 

http://www.oasis-open.org/docbook/xml

ヘルプシステムは、OMF (Open Source Metadata Framework) およびカタログ作成システムを使用します。次の節では、OMF ファイルとカタログ作成システムについて説明します。

OMF ファイル

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

アプリケーションをインストールすると、インストールプロセスが、OMF ファイルを OMF ファイル用のディレクトリにインストールします。OMF ファイルディレクトリ内にヘルプ文書の関連 OMF ファイルがある場合は、ヘルプ文書がヘルプブラウザに表示されます。

OMF ファイルには、ヘルプ文書に関する以下のような情報が含まれています。

ScrollKeeper カタログ作成システム

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

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

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

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

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

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

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

注 –

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