[发明专利]帮助文档的生成方法和装置

说明书

技术领域

本发明实施例涉及在线帮助系统技术领域，特别涉及一种帮助文档的生成方法和装置。

背景技术

目前，随着信息技术的发展，在企业应用的各种软件产品中通常会内置帮助系统，该帮助系统中的帮助文档可用于向软件产品提供帮助。

现有技术中，帮助系统可包括动态帮助系统和静态帮助系统。动态帮助系统适用于帮助文档变化较频繁的情况，静态帮助系统适用于帮助文档变化不频繁的情况。

当帮助文档内容发生变化时，需要对帮助文档内容进行修改并重新生成帮助文档。对于动态帮助系统中的帮助文档，由于该动态帮助系统和帮助文档是不可分离的，因此对帮助文档进行修改并重新生成帮助文档的过程中，还需要相应地对动态帮助系统进行调整，从而极大地增加了对帮助文档进行维护的复杂度。对于静态帮助系统，当生成帮助文档的某一组件发生变化时，需要对所有包括该组件的帮助文档一一进行修改，从而极大地增加了对帮助文档进行维护的复杂度。

发明内容

本发明实施例提供一种帮助文档的生成方法和装置，用以降低对帮助文档进行维护的复杂度。

本发明实施例提供一种帮助文档的生成方法，包括：

根据组件生成可扩展标记语言XML元文件，所述XML元文件包括组件，所述组件包括用于标识所述组件的组件标识；

根据指定的组件标识，从所述XML元文件中获取指定组件，所述指定组件为包括所述指定的组件标识的组件；

根据所述指定组件生成第一帮助文档。

本发明实施例提供一种帮助文档的生成装置，包括：

文件生成模块，用于根据组件生成可扩展标记语言XML元文件，所述XML元文件包括组件，所述组件包括用于标识所述组件的组件标识；

文件处理模块，用于根据指定的组件标识，从所述XML元文件中获取指定组件，所述指定组件为包括所述指定的组件标识的组件；

第一文档生成模块，用于根据所述指定组件生成第一帮助文档。

本实施例提供的帮助文档的生成方法和装置，根据组件生成XML元文件，该组件包括组件标识，根据指定的组件标识从XML元文件中获取指定组件，并根据指定组件生成第一帮助文档，当采用本实施例提供的方法和装置实现对帮助文档的修改时，根据修改后的组件生成XML元文件，并根据XML元文件生成第一帮助文档，以实现对帮助文档的修改。采用本实施例提供的方法和装置对帮助文档进行修改，无需对帮助系统进行调整，也无需对包括修改后的组件的所有帮助文档一一进行修改，从而降低了对帮助文档进行维护的复杂度。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作一简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1为本发明实施例一提供的一种帮助文档的生成方法的流程图；

图2为本发明实施例二提供的一种帮助文档的生成方法的流程图；

图3为本发明实施例三提供的一种帮助文档的生成装置的结构示意图；

图4为本发明实施例四提供的一种帮助文档的生成装置的结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

图1为本发明实施例一提供的一种帮助文档的生成方法的流程图，如图1所示，该方法包括：

步骤101、根据组件生成可扩展标记语言(eXtensible Markup Language，以下简称：XML)元文件，该XML元文件包括组件，该组件包括用于标识该组件的组件标识。

本实施例中各步骤可以由帮助文档的生成装置执行。

本实施例中，组件可以包括有序/无序列表、段落、链接、图片或表格等。组件的格式可以为XML格式。本实施例中，每个组件均包括一个组件标识，该组件标识是组件的唯一标识。每个组件还包括一个标签。由于一个组件可引用其它组件，因此根据需要组件之间可以采用多级嵌套的方式。

例如：组件mod1的结构可如下所示：

<module id＝“mod1”>