CN101887364B

CN101887364B - 帮助文档的生成方法和装置

Info

Publication number: CN101887364B
Application number: CN2010101591710A
Authority: CN
Inventors: 薛征枫
Original assignee: Beijing Star Net Ruijie Networks Co Ltd
Current assignee: Beijing Star Net Ruijie Networks Co Ltd
Priority date: 2010-04-28
Filing date: 2010-04-28
Publication date: 2013-06-19
Anticipated expiration: 2030-04-28
Also published as: CN101887364A

Abstract

本发明公开了一种帮助文档的生成方法和装置。该方法包括：根据组件生成可扩展标记语言XML元文件，所述XML元文件包括组件，所述组件包括用于标识所述组件的组件标识；根据指定的组件标识，从所述XML元文件中获取指定组件，所述指定组件为包括所述指定的组件标识的组件；根据所述指定组件生成第一帮助文档。采用本实施例提供的方法和装置对帮助文档进行修改，无需对帮助系统进行调整，也无需对包括修改后的组件的所有帮助文档一一进行修改，从而降低了对帮助文档进行维护的复杂度。

Description

帮助文档的生成方法和装置

技术领域

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

背景技术

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

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

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

发明内容

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

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

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

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

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

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

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

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

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

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

附图说明

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

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

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

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

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

具体实施方式

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

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

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

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

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

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

<para>Mod1Content</para>

“mod2_title”/>

<para>other content</para>

</figure>

</module>

例如：组件mod2结构可如下所示：

<para>Mod2Content</para>

</module>

例如：组件mod3结构可如下所示：

<para>Mod3Content</para>

</module>

其中，组件mod1的标签为“module”，组件mod1的组件标识id为“mod1”。组件mod1包括组件link1，组件link1的标签为“link”，组件link1的组件标识为“link1”。组件link1引用了组件mod2。组件mod2的标签为“module”，组件mod2的组件标识id为“mod2”。组件mod3的标签为“module”，组件mod3的组件标识id为“mod3”。组件mod1、mod2和mod3中还包括标题title。组件mod1的标题为“mod1_title”，组件mod2的标题为“mod2_title”，组件mod3的标题为“mod3_title”。“para”用于描述组件内容。

例如：生成的XML元文件的结构可如下所示：

<help>

<para>Mod1Content</para>

<para>other content</para>

</figure>

</module>

<para>Mod2Content</para>

</module>

<para>Mod3Content</para>

</module>

</help>

上述XML元文件包括组件mod1、组件mod2和组件mod3。

本实施例中，帮助文档的生成装置可通过“ENTITY”声明的方式生成XML元文件。具体地，帮助文档的生成装置将预先生成的声明文件引用的组件写入到该声明文件中，以生成该XML元文件。其中，声明文件可以由人工编译生成或者由帮助文档的生成装置生成。

例如：声明文件的结构可如下所示：

<？xml version＝“1.0”encoding＝“UTF-8”？>

<！DOCTYPE help SYSTEM“../../docbook.xml/docbookx.dtd”[

<！ENTITY mod1SYSTEM“module1/module1.xml”>

<！ENTITY mod2 SYSTEM“module2/module2.xml”>

<！ENTITY mod3 SYSTEM“module3/module3.xml”>

]>

<help>

&mod1；

&mod2；

&mod3；

</help>

该声明文件引用了组件mod1、组件mod2和组件mod 3。具体地，该声明文件通过“<！ENTITY mod1 SYSTEM“module1/module1.xm”>”引用了组件mod1，通过“<！ENTITY mod2SYSTEM“module2/module2.xml“>”引用了组件mod2，通过<！ENTITY mod3SYSTEM“module 3/module3.xml”>引用了组件mod3。帮助文档的生成装置将组件mod1、组件mod2和组件mod3写入到声明文件中，从而生成XML元文件。

步骤102、根据指定的组件标识，从XML元文件中获取指定组件，该指定组件为包括该指定的组件标识的组件。

本实施例中，指定的组件标识可以由用户直接选择或者由用户通过组件树选择。

当指定的组件标识由用户通过组件树指定时，本实施例中步骤102之前还包括：帮助文档的生成装置将XML元文件解析为组件树，该组件树包括节点，节点对应于XML元文件中的组件，节点的标识为与该节点对应的组件的标题，该组件的标题与组件标识对应。则用户通过组件树选择组件标识具体包括：用户从组件树的节点的标识中选择出指定的组件的标题，并获得该指定的组件的标题对应的指定的组件标识。以实现选择出指定的组件标识。

步骤103、根据指定组件生成第一帮助文档。

本实施例中，帮助文档的生成装置可根据获取的指定组件生成第一帮助文档。

本实施例中，生成的第一帮助文档可包括标签和属性内容。

本实施例中，由于指定组件的格式是XML格式的，因此生成的第一帮助文档的格式也是XML格式的。由于对于用户来说，XML格式的第一帮助文档可读性较差，因此本实施例中还可以将XML格式的第一帮助文档转换为可读性强的帮助文档。则进一步地，本实施例还可以包括：帮助文档的生成装置根据预先定义的文档转换规则，将第一帮助文档转换为第二帮助文档。文档转换规则可以根据需要进行定义，文档转换规则为将XML格式的文档转换为设定格式的文档，例如：设定格式包括超文本标记语言(HyperText Mark-upLanguage，以下简称：HTML)格式或者可移植文档格式(Portable DocumentFormat，以下简称：PDF)格式等，此处不一一列举。

其中，文档转换规则可包括至少一个标签转换规则和至少一个属性内容转换规则。每个标签转换规则与一个XML格式的标签匹配，标签转换规则为将XML格式的标签转换为设定格式的标签。每个属性内容转换规则与一个XML格式的属性内容匹配，属性内容转换规则为将XML格式的属性内容转换为设定格式的标签。则根据预先定义的文档转换规则，将第一帮助文档转换为第二帮助文档具体包括：根据文档转换规则中与第一帮助文档中的标签匹配的标签转换规则，将该第一帮助文档中的标签进行转换得出转换后的标签；以及根据文档转换规则中与第一帮助文档中的属性内容匹配的属性内容转换规则，将该第一帮助文档中的属性内容进行转换得出转换后的属性内容，以生成第二帮助文档，该第二帮助文档包括转换后的标签和转换后的属性内容。

例如：文档转换规则为将XML格式的文档转换为HTML格式的文档。其中，标签转换规则为将XML格式的标签转换为HTML格式的标签，属性内容转换规则为将XML格式的属性内容转换为HTML格式的属性内容。第一帮助文档为：

例一(Ex1)：<link refid＝“mod2”>组件2</link>

例二(Ex2)：<link refid＝“mod3”term＝“mod3_title”/>

则第二帮助文档可以为：

Ex1：<a href＝“mod2.html”>组件2</a>

Ex2：<a href＝“mod3.html”>组件3</a>

上述第一帮助文档为XML格式的文档，第二帮助文档为HTML格式的文档。

对于Ex1：标签为<link>，属性内容包括refid＝“mod2”和组件2。帮助文档的生成装置根据与<link>匹配的标签转换规则，将<link>进行转换，得出转换后的标签<a></a>；帮助文档的生成装置根据与refid＝“mod2”匹配的属性转换规则将refid＝“mod2”进行转换得出转换后的属性内容href＝“mod2.html”，以及根据与组件2匹配的属性内容转换规则将组件2进行转换得出转换后的属性内容组件2，；以生成第二帮助文档<a href＝“mod2.html”>组件2</a>。其中，需要说明的是：由于组件2是文本，则该组件2既符合XML格式又符合HTML格式，因此将组件2进行转换后得出的转换后的属性内容仍然是组件2。

对于Ex2：标签为<link>，属性内容包括refid＝″mod3″和term＝″mod3_title″。帮助文档的生成装置根据与<link>匹配的标签转换规则，对<link>进行转换得出转换后的标签<a></a>；根据与refid＝“mod3”匹配的属性内容转换规则将refid＝“mod3”进行转换得出转换后的属性内容href＝“mod3.html”，以及根据与term＝“mod3_title”匹配的属性内容转换规则将term＝“mod3_title”进行转换得出转换后的属性内容组件3；以生成第二帮助文档，该第二帮助文档包括<a href＝“mod3.html”>组件3</a>。

本实施例中，HTML格式的第二帮助文档的展示结果如下：

Ex1：组件2

Ex2：组件3

本实施例的方法可应用于首次生成帮助文档的过程。则步骤101之前还包括：帮助文档的生成装置为组件设置组件标识，以使组件包括组件标识。

本实施例中的方法还可以应用于对帮助文档进行修改的过程。具体地，可由帮助文档的生成装置对修改后的组件执行本实施例中的方法流程。特别需要说明的是，对组件进行修改时不会对该组件的组件标识进行修改。

本实施例提供的帮助文档的生成方法，根据组件生成XML元文件，该组件包括组件标识，根据指定的组件标识从XML元文件中获取指定组件，并根据指定组件生成第一帮助文档，当采用本实施例提供的方法实现对帮助文档的修改时，根据修改后的组件生成XML元文件，并根据XML元文件生成第一帮助文档，以实现对帮助文档的修改。采用本实施例提供的方法对帮助文档进行修改，无需对帮助系统进行调整，也无需对包括修改后的组件的所有帮助文档一一进行修改，从而降低了对帮助文档进行维护的复杂度。本实施例中，根据指定的组件标识从XML元文件中获取指定组件，并根据指定组件生成第一帮助文档，从而实现了生成的帮助文档的差异化。本实施例还可根据文档转换规则进一步将第一帮助文档转换成可读性强的第二帮助文档，从而提高了帮助文档的可读性，便于对帮助文档进行展示。本实施例提供的帮助文档的生成方法，可根据指定组件生成第一帮助文档，生成的第一帮助文档可直接运行，从而提高了帮助文档的运行效率。本实施例提供的方法中，根据组件生成XML元文件的过程可由文档开发者完成，从XML元文件中获取指定组件的过程可由产品开发者完成，根据指定组件生成第一帮助文档可由系统开发者完成，从而实现了分工协作，提高了生产效率。

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

步骤201、帮助文档的生成装置根据组件生成XML元文件，该XML元文件包括组件，该组件包括用于标识该组件的组件标识。

对步骤201的具体描述可参见上述实施例一中的步骤101。

步骤202、帮助文档的生成装置遍历XML元文件中的组件标识，判断XML元文件是否包括指定的组件标识，如果是，则执行步骤203，如果否则流程结束。

步骤203、帮助文档的生成装置根据指定的组件标识，从XML元文件中获取指定组件，该指定组件为包括该指定的组件标识的组件。

对步骤203的具体描述可参见上述实施例一中的步骤102。

步骤204、帮助文档的生成装置根据指定组件生成第一帮助文档。

对步骤204的具体描述可参见上述实施例一中的步骤103。

步骤205、帮助文档的生成装置判断预先定义的文档转换规则中是否包括与第一帮助文档中的标签匹配的标签转换规则，如果是，则执行步骤206，如果否，则流程结束。

本实施例中，当第一帮助文档中的标签为多个时，帮助文档的生成装置需要判断文档转换规则中是否包括与第一帮助文档中的每个标签匹配的标签转换规则，当帮助文档的生成装置判断出文档转换规则中包括与每个标签匹配的标签转换规则时，执行步骤206；当帮助文档的生成装置判断出文档转换规则中未包括至少一个与标签匹配的标签转换规则时，流程结束。

步骤206、帮助文档的生成装置根据与第一帮助文档中的标签匹配的标签转换规则，将第一帮助文档中的标签进行转换得出转换后的标签。

本实施例中，当第一帮助文档中的标签为多个时，帮助文档的生成装置依次将第一帮助文档中的每个标签进行转换。

步骤207、帮助文档的生成装置判断预先定义的文档转换规则中是否包括与第一帮助文档中的属性内容匹配的属性内容转换规则，如果是，则执行步骤208，如果否，则流程结束。

本实施例中，当第一帮助文档中的属性内容为多个时，帮助文档的生成装置需要判断文档转换规则中是否包括与第一帮助文档中的每个属性内容匹配的属性内容转换规则，当帮助文档的生成装置判断出文档转换规则中包括与每个属性内容匹配的属性内容转换规则时，执行步骤208；当帮助文档的生成装置判断出文档转换规则中未包括至少一个与属性内容匹配的属性内容转换规则时，流程结束。

步骤208、帮助文档的生成装置将第一帮助文档中与属性内容对应的属性内容进行转换得出转换后的属性内容，以生成第二帮助文档，该第二帮助文档包括转换后的标签和转换后的属性内容。

本实施例中，当第一帮助文档中的属性内容为多个时，帮助文档的生成装置依次将第一帮助文档中的每个属性内容进行转换。

本实施例提供的帮助文档的生成方法，当判断出XML元文件中包括指定的组件标识时从XML元中获取指定组件并根据指定组件生成第一帮助文档，否则不生成第一帮助文档；当判断出文档转换规则中包括与第一帮助文档中的标签匹配的标签转换规则以及当判断出文档转换规则中包括与第一帮助文档中的属性内容匹配的属性内容转换规则时生成第二帮助文档，否则不生成第二帮助文档。从而保证了生成帮助文档的成功率和准确性。

图3为本发明实施例三提供的一种帮助文档的生成装置的结构示意图，如图3所示，该装置包括：文件生成模块1、文件处理模块2和第一文档生成模块3。

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

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

第一文档生成模块3用于根据该指定组件生成第一帮助文档。

进一步地，文件生成模块1可将预先生成的声明文件引用的该组件写入到该声明文件中，以生成该XML元文件。

本实施例提供的帮助文档的生成装置可用于执行上述实施例一提供的帮助文档的生成方法。

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

图4为本发明实施例四提供的一种帮助文档的生成装置的结构示意图，如图4所示，本实施例在上述实施例三的基础上还包括：与文件生成模块1和文件处理模块2连接的文件解析模块4。该文件解析模块4可用于将文件生成模块1生成的XML元文件解析为组件树，该组件树包括节点，该节点对应于XML元文件中的组件，节点的标识为与该节点对应的组件的标题，组件的标题与组件的组件标识对应，以供用户从组件树的节点的标识中选择出指定的组件的标题，根据用户选择出的指定的组件的标题获得指定的组件的标题对应的指定的组件标识，并将指定的组件标识输出给文件处理模块2。

进一步地，本实施例中的装置还可以包括：与第一文档生成模块3连接的第二文档生成模块5。第二文档生成模块5可用于根据预先定义的文档转换规则，将第一文档生成模块3生成的第一帮助文档转换为第二帮助文档，文档转换规则包括将XML格式的文档转换为设定格式的文档。例如：设定格式包括HTML格式、PDF格式或者F0格式等，此处不一一列举。文档转换规则可包括至少一个标签转换规则和至少一个属性内容转换规则，每个标签转换规则与一个XML格式的标签匹配，标签转换规则包括将XML格式的标签转换为设定格式的标签，每个属性内容转换规则与一个XML格式的属性内容匹配，该属性内容转换规则包括将XML格式的属性内容转换为设定格式的属性内容。则第二文档生成模块5可用于根据文档转换规则中与第一帮助文档中的标签匹配的标签转换规则将第一帮助文档中的标签进行转换得出转换后的标签，根据所述文档转换规则中与所述第一帮助文档中的属性内容匹配的属性内容转换规则将所述第一帮助文档中的属性内容进行转换得出转换后的属性内容，以生成第二帮助文档，所述第二帮助文档包括转换后的标签和转换后的属性内容。

进一步地，本实施例中的装置还包括与第二文档生成模块5和第一文档生成模块3连接的第一判断模块6。第一判断模块6可用于判断文档转换规则中是否包括与第一帮助文档中的标签匹配的标签转换规则，当第一判断模块6判断出文档转换规则中包括与所述第一帮助文档中的标签匹配的标签转换规则时，将判断出的文档转换规则中包括与所述第一帮助文档中的标签匹配的标签转换规则的判断结果输出给第二文档生成模块5，由第二文档生成模块5执行所述根据所述文档转换规则中与所述第一帮助文档中的标签匹配的标签转换规则，将所述第一帮助文档中的标签进行转换得出转换后的标签的步骤；当第一判断模块6判断出文档转换规则中未包括至少一个与所述第一帮助文档中的标签匹配的标签转换规则时，将判断出的文档转换规则中未包括至少一个与所述第一帮助文档中的标签匹配的标签转换规则的判断结果输出给第二文档生成模块5，第二文档生成模块5不执行所述根据所述文档转换规则中与所述第一帮助文档中的标签匹配的标签转换规则，将所述第一帮助文档中的标签进行转换得出转换后的标签的步骤，即不执行后续流程。进一步地，本实施例中的装置还可以包括：与第二文档生成模块5和第一文档生成模块3连接的第二判断模块7，第二判断模块7可用于判断文档转换规则中是否包括与第一帮助文档中的属性内容匹配的属性内容转换规则，当第二判断模块7判断出文档转换规则中包括与所述第一帮助文档中的属性内容匹配的属性内容转换规则时，将判断出的文档转换规则中包括与所述第一帮助文档中的属性内容匹配的属性内容转换规则的判断结果输出给第二文档生成模块5，由第二文档生成模块5执行所述根据所述文档转换规则中与所述第一帮助文档中的属性内容匹配的属性内容转换规则，将所述第一帮助文档中的属性内容进行转换得出转换后的属性内容的步骤；当第二判断模块7判断出文档转换规则中未包括至少一个与所述第一帮助文档中的属性内容匹配的属性内容转换规则时，将判断出的文档转换规则中未包括至少一个与所述第一帮助文档中的属性内容匹配的属性内容转换规则输出给第二文档生成模块5，第二文档生成模块5不执行所述根据所述文档转换规则中与所述第一帮助文档中的属性内容匹配的标签转换规则，将所述第一帮助文档中的属性内容进行转换得出转换后的属性内容的步骤，即不执行后续流程。

进一步地，本实施例中的装置还包括：与文件生成模块1和文件处理模块2连接的第三判断模块8。第三判断模块8可用于遍历文件生成模块1生成的XML元文件中的组件标识，判断XML元文件中是否包括指定的组件标识，当第三判断模块8判断出XML元文件中的组件标识包括指定的组件标识时，将判断出的XML元文件中的组件标识包括指定的组件标识的判断结果输出给文件处理模块2，由文件处理模块2执行所述根据指定的组件标识，从所述XML元文件中获取指定组件的步骤；当第三判断模块8判断出文件生成模块生成的XML元文件中的组件标识未包括指定的组件标识时，将判断出的XML元文件中的组件标识未包括指定的组件标识的判断结果输出给文件处理模块2，文件处理模块2不执行所述根据指定的组件标识，从所述XML元文件中获取指定组件的步骤，即不执行后续流程。

进一步地，本实施例中的装置还可以包括：与文件生成模块1连接的设置模块9。当帮助文档的生成装置应用于首次生成帮助文档的过程时，设置模块9可用于为组件设置所述组件标识，以使组件包括该组件标识。

本实施例提供的帮助文档的生成装置可用于执行上述实施例二提供的帮助文档的生成方法。

本实施例提供的帮助文档的生成装置，根据组件生成XML元文件，该组件包括组件标识，根据指定的组件标识从XML元文件中获取指定组件，并根据指定组件生成第一帮助文档，当采用本实施例提供的装置实现对帮助文档的修改时，根据修改后的组件生成XML元文件，并根据XML元文件生成第一帮助文档，以实现对帮助文档的修改。采用本实施例提供的装置对帮助文档进行修改，无需对帮助系统进行调整，也无需对包括修改后的组件的所有帮助文档一一进行修改，从而降低了对帮助文档进行维护的复杂度。本实施例中，根据指定的组件标识从XML元文件中获取指定组件，并根据指定组件生成第一帮助文档，从而实现了生成的帮助文档的差异化。本实施例还可根据文档转换规则进一步将第一帮助文档转换成可读性强的第二帮助文档，从而提高了帮助文档的可读性，便于对帮助文档进行展示。本实施例提供的帮助文档的生成装置，可根据指定组件生成第一帮助文档，生成的第一帮助文档可直接运行，从而提高了帮助文档的运行效率。本实施例提供的装置中，文档开发者可通过文件生成模块实现根据组件生成XML元文件，产品开发者可通过文件处理模块实现从XML元文件中获取指定组件，系统开发者可通过文档生成模块实现根据指定组件生成第一帮助文档，从而实现了分工协作，提高了生产效率。本实施例提供的帮助文档的生成装置，当判断出XML元文件中包括指定的组件标识时从XML元中获取指定组件并根据指定组件生成第一帮助文档，否则不生成第一帮助文档；当判断出文档转换规则中包括与第一帮助文档中的标签匹配的标签转换规则以及当判断出文档转换规则中包括与第一帮助文档中的属性内容匹配的属性内容转换规则时生成第二帮助文档，否则不生成第二帮助文档。从而保证了生成帮助文档的成功率和准确性。

本领域普通技术人员可以理解：实现上述方法实施例的全部或部分步骤可以通过程序指令相关的硬件来完成，前述的程序可以存储于一计算机可读取存储介质中，该程序在执行时，执行包括上述方法实施例的步骤；而前述的存储介质包括：ROM、RAM、磁碟或者光盘等各种可以存储程序代码的介质。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims

1.一种帮助文档的生成方法，其特征在于，包括：

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

根据预先定义的文档转换规则，将所述第一帮助文档转换为第二帮助文档，所述文档转换规则包括将XML格式的文档转换为设定格式的文档；所述文档转换规则包括至少一个标签转换规则和至少一个属性内容转换规则，每个所述标签转换规则与一个XML格式的标签匹配，所述标签转换规则包括将XML格式的标签转换为设定格式的标签，每个所述属性内容转换规则与一个XML格式的属性内容匹配，所述属性内容转换规则包括将XML格式的属性内容转换为设定格式的属性内容；

则所述根据预先定义的文档转换规则，将所述第一帮助文档转换为第二帮助文档包括：

根据所述文档转换规则中与所述第一帮助文档中的标签匹配的标签转换规则将所述第一帮助文档中的标签进行转换得出转换后的标签，根据所述文档转换规则中与所述第一帮助文档中的属性内容匹配的属性内容转换规则将所述第一帮助文档中的属性内容进行转换得出转换后的属性内容，以生成第二帮助文档，所述第二帮助文档包括转换后的标签和转换后的属性内容。

2.根据权利要求1所述的方法，其特征在于，所述根据组件生成XML元文件包括：

将预先生成的声明文件引用的所述组件写入到所述声明文件中，以生成所述XML元文件。

3.根据权利要求1所述的方法，其特征在于，所述根据指定的组件标识，从所述XML元文件中获取指定组件之前包括：

将所述XML元文件解析为组件树，所述组件树包括节点，所述节点对应于所述XML元文件中的组件，所述节点的标识为与所述节点对应的组件的标题，所述组件的标题与所述组件的组件标识对应，以供用户从所述组件树的节点的标识中选择出指定的组件的标题，并获得所述指定的组件的标题对应的指定的组件标识。

4.根据权利要求1至3任一所述的方法，其特征在于，所述根据指定的组件标识，从所述XML元文件中获取指定组件之前包括：

遍历所述XML元文件中的组件标识，判断所述XML元文件是否包括所述指定的组件标识；

当判断出所述XML元文件中的组件标识包括所述指定的组件标识时，执行所述根据指定的组件标识，从所述XML元文件中获取指定组件。

5.根据权利要求1至3任一所述的方法，其特征在于，所述根据组件生成可扩展标记语言XML元文件之前包括：

为所述组件设置所述组件标识，以使所述组件包括所述组件标识。

6.一种帮助文档的生成装置，其特征在于，包括：

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

第二文档生成模块，与所述第一文档生成模块连接，用于根据预先定义的文档转换规则，将所述第一文档生成模块生成的第一帮助文档转换为第二帮助文档，所述文档转换规则包括将XML格式的文档转换为设定格式的文档；所述文档转换规则包括至少一个标签转换规则和至少一个属性内容转换规则，每个所述标签转换规则与一个XML格式的标签匹配，所述标签转换规则包括将XML格式的标签转换为设定格式的标签，每个所述属性内容转换规则与一个XML格式的属性内容匹配，所述属性内容转换规则包括将XML格式的属性内容转换为设定格式的属性内容；

所述第二文档生成模块用于根据所述文档转换规则中与所述第一帮助文档中的标签匹配的标签转换规则将所述第一帮助文档中的标签进行转换得出转换后的标签，根据所述文档转换规则中与所述第一帮助文档中的属性内容匹配的属性内容转换规则将所述第一帮助文档中的属性内容进行转换得出转换后的属性内容，以生成第二帮助文档，所述第二帮助文档包括转换后的标签和转换后的属性内容。

7.根据权利要求6所述的装置，其特征在于，还包括：与所述文件生成模块和所述文件处理模块连接的文件解析模块；

所述文件解析模块，用于将所述文件生成模块生成的XML元文件解析为组件树，所述组件树包括节点，所述节点对应于所述XML元文件中的组件，所述节点的标识为与所述节点对应的组件的标题，所述组件的标题与所述组件的组件标识对应，以供用户从所述组件树的节点的标识中选择出指定的组件的标题，根据用户选择出的指定的组件的标题获得所述指定的组件的标题对应的指定的组件标识，并将所述指定的组件标识输出给所述文件处理模块。

8.根据权利要求6或7所述的装置，其特征在于，还包括：与所述文件生成模块和所述文件处理模块连接的第三判断模块；

所述第三判断模块，用于遍历所述文件生成模块生成的XML元文件中的组件标识，判断所述XML元文件中是否包括所述指定的组件标识，当判断出所述XML元文件中的组件标识包括所述指定的组件标识时，将判断出的XML元文件中的组件标识包括所述指定的组件标识的判断结果输出给所述文件处理模块，由所述文件处理模块执行所述根据指定的组件标识，从所述XML元文件中获取指定组件。

9.根据权利要求6或7任一所述的装置，其特征在于，还包括：

设置模块，用于为所述组件设置所述组件标识，以使所述组件包括所述组件标识。