Java Desktop System 发行版 3 管理指南

Yelp 浏览器

Yelp 浏览器使用开放源元数据框架 (OMF) 文件和一个类目系统。

OMF 文件

每本手册的 XML 文件都有一个相关联的 OMF 文件。OMF 文件包含关于 Yelp 浏览器所用手册的信息。OMF 文件的扩展名是 .omf

安装应用程序时,安装过程将把一个 OMF 文件安装到 OMF 文件的目录。如果帮助文档在 OMF 文件目录中有关联的 OMF 文件,用户就可以从 Yelp 浏览器访问该帮助文档。

OMF 文件包含了与帮助文档有关的如下信息:

ScrollKeeper 类目系统

ScrollKeeper 是一个用于文档记录的类目系统。Yelp 浏览器使用 ScrollKeeper 将系统中的手册归类。ScrollKeeper 在 OMF 文件中为 Yelp 浏览器管理信息。

ScrollKeeper 使用 OMF 文件中的信息,以使 Yelp 帮助浏览器能找到系统中的帮助文档。安装应用程序时,安装过程将把一个 OMF 文件安装到 OMF 文件的目录。

ScrollKeeper 会为有相关联的 OMF 文件的每个帮助文档建立目录。ScrollKeeper 利用 OMF 文件中指定的 XML 文件建立目录。帮助文档的目录在 Yelp 帮助浏览器窗口的左侧窗格中显示,以便用户能在左侧窗格中对帮助文档进行导航。Yelp 帮助浏览器窗口的左侧窗格中还会显示 OMF 文件中的文档标题。

ScrollKeeper 包含了每个帮助文档所属的主题类别的层级结构。帮助文档根据这个主题类别层级结构在 Yelp 帮助浏览器窗口的左侧窗格中进行组织。OMF 文件中的文档主题类别决定了文档在层级结构中的位置。主题类别层级结构是在以下文件中定义的:

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

文档的主题类别必须与以下文件中的主题类别相对应:

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


注意 –

如果将帮助文档 XML 文件移动到新位置,则需要在 OMF 文件中更新该位置。