Linux 上的 GNOME 2.2 桌面系统管理指南

提高帮助的性能

帮助的源文件是 XML 文件。 XML 文件被转换成 HTML,然后在 Yelp 帮助浏览器中显示该 HTML 文件。 HTML 可以预生成,就是说,可以在使用帮助之前将 XML 转换成 HTML。

或者,在用户调用帮助文件时自动进行这种转换。 如果在用户调用帮助文件时进行转换,转换对帮助文档的显示速度会有明显的影响。

为避免出现帮助性能问题,请预生成 HTML,避免帮助浏览器进行转换。 使用 yelp-pregenerate 命令可以预生成帮助文档。 yelp-pregenerate 命令的语法如下:

yelp-pregenerate [-a| [-f filename]] [locale]

下面的表格中给出了 yelp-pregenerate 命令的选项和参数:

选项或参数  

说明 

-a

预生成 ScrollKeeper 数据库中已经注册的所有 XML 文件。 这是默认选项。

-f

仅预生成您在命令中指定的 XML 文件。 

filename

您要预生成的一个或多个 XML 文件的名称。 

locale

您要预生成的 XML 文件的语言设置。 默认语言设置是 C 或英语。 

例如,要预生成文件系统中所有 XML 文件的英语版本,请运行以下命令:

# yelp-pregenerate -a

在这个示例中,您无需指定语言设置,因为默认语言设置就是 C。 要预生成 gedit 手册的西班牙语版本,请运行以下命令:

# yelp-pregenerate -f gedit.xml es

当用户打开帮助文件时,帮助浏览器将执行以下操作:

  1. 帮助浏览器搜索相应的 HTML 文件。 如果浏览器找到了 HTML 文件,帮助浏览器将该 HTML 文件的修改日期与相应的 XML 文件进行对比。 如果 HTML 文件比 XML 文件新,则显示 HTML 文件。

  2. 如果 HTML 文件比 XML 文件旧,则将 XML 文件转换成 HTML。

  3. 如果帮助浏览器找不到某个帮助文档的 HTML 文件,则将 XML 文件转换成 HTML。

换句话说,如果有预生成的 HTML 文件,帮助浏览器将显示这个 HTML 文件。 如果没有预生成的 HTML 文件,帮助浏览器会将 XML 文件转换成 HTML。


注意:

您可能希望为添加到 GNOME 桌面的所有新应用程序预生成帮助文档。 如果您的环境中有严格的空间限制,则可以选择不预生成帮助。