一种基于VBScript的帮助文档生成方法及装置与流程

本申请涉及帮助系统领域，尤其涉及一种基于vbscript的帮助文档生成方法及装置。

背景技术：

随着开发技术越来越成熟，各类软件或者基于web的业务系统、尤其是一些规模大，功能多的业务系统成功开发出来，通过提供用户界面，用户能够与应用交互，极大地方便用户。然而，对于一个新的软件或者业务系统，使用者在不熟悉该软件或业务系统的情况下，往往都需要在不同程度上依赖该软件或业务系统的帮助系统，帮助系统中的帮助文档可用来向用户提供关于软件产品的帮助。

但是，有些帮助文档直接链接到网页，这种帮助文档不便于离线使用，例如在工厂无网络的情况下；还有一些帮助文档存储为pdf格式，需要用户在电脑上安装相应的可以查看pdf格式文件的软件，操作繁复。为了解决上述问题，帮助文档采用chm格式的文件，既无需安装其他软件，也无需链接网络。

现有技术中，chm帮助文件的生成通常是使用htmlhelpworkshop软件来制作，用户需要创建格式为.hhp的工程，将需要用到的htm文件手动添加进来，制作过程繁琐。同时由于添加的文档必须是htm格式的文件，而很多帮助文档在最开始是用word编写的doc或docx格式文件，需要手动转换为htm格式的文件；在有大量的doc或docx格式的帮助文档的情况下，用户的转换工作量很大。并且，为了使输出的chm文件内容有条理，需要添加目录，而添加目录需要创建目录文件hhc文件，然后手动配置每一个word文档在目录中的位置，过程复杂。

技术实现要素：

本申请提供了一种基于vbscript的帮助文档生成方法及装置，以解决现有chm帮助文件的生成，制作过程繁琐，文件转换工作量大，并且手动配置每一个word文档在目录中的位置，过程复杂的问题。

第一方面，本申请提供了一种基于vbscript的帮助文档生成方法，所述方法包括：

获取chm格式的帮助文档的配置文件及word格式的帮助文档，所述chm格式的帮助文档的配置文件包括chm格式的帮助文档的目录名称以及隶属于每个目录名称的帮助文档的名称和位置路径；

利用预先定义的转换规则，将word格式的帮助文档转换为htm格式的帮助文档；

将所述配置文件的目录名称、隶属于每个目录名称的帮助文档的名称和位置路径，按照hhc格式写入hhc文件中；

将隶属于每个目录名称的帮助文档的名称以及hhc文件写入hhp文件中；

根据所述hhc文件、hhp文件和htm格式的帮助文档，生成chm格式的帮助文档。

第二方面，本申请提供了一种基于vbscript的帮助文档生成装置，所述装置包括：

获取模块，获取chm格式的帮助文档的配置文件及word格式的帮助文档，所述chm格式的帮助文档的配置文件包括chm格式的帮助文档的目录名称以及隶属于每个目录名称的帮助文档的名称和位置路径；

转换模块，用于利用预先定义的转换规则，将word格式的帮助文档转换为htm格式的帮助文档；

第一写入模块，用于将所述配置文件的目录名称、隶属于每个目录名称的帮助文档的名称和位置路径，按照hhc格式写入hhc文件中；

第二写入模块，用于将隶属于每个目录名称的帮助文档的名称以及hhc文件写入hhp文件中；

生成模块，根据所述hhc文件、hhp文件和htm格式的帮助文档，生成chm格式的帮助文档。

由以上技术方案可知，本申请提供了一种基于vbscript的帮助文档生成方法及装置，可自动将word格式的帮助文档转化为htm格式的帮助文档，降低用户转换帮助文档格式的转化量，并且利用配置文件，用户在添加帮助文档时，仅需在配置文件帮助文档所属的目录名称中添加名称和位置路径即可，操作简单方便。

附图说明

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

图1为本申请提供的一种基于vbscript的帮助文档生成方法的流程图；

图2为步骤12的流程图；

图3为本申请提供的一种基于vbscript的帮助文档生成装置的结构示意图；

图4为转换模块的结构示意图。

具体实施方式

第一方面，参见图1，本申请的实施例提供了一种基于vbscript的帮助文档生成方法，包括如下步骤：

步骤11：获取chm格式的帮助文档的配置文件及word格式的帮助文档，所述chm格式的帮助文档的配置文件包括chm格式的帮助文档的目录名称以及隶属于每个目录名称的帮助文档的名称和位置路径。

chm格式的帮助文档的配置文件由用户根据所需的chm格式帮助文档的目录结构进行编写，配置文件可以采用任意可读文本文档，例如，txt文件、ini文件或xml文件。

例如要生成如下目录结构的chm格式帮助文件，

|---目录1

|---文档1

|---文档2

|---文档3

|---目录2

|---文档4

|---文档5

|---文档6

那么xml文件中内容如下所示：

<content1＝"目录1">

<file1name＝"文档1"activated＝"1">

</file1>

<file2name＝"文档2"activated＝"1">

</file2>

<file3name＝"文档3"activated＝"1">

</file3>

</content1>

<content2＝"目录2">

<file4name＝"文档4"activated＝"1">

</file4>

<file5name＝"文档5"activated＝"1">

</file5>

<file6name＝"文档6"activated＝"1">

</file6>

</content2>

步骤12：利用预先定义的转换规则，将word格式的帮助文档转换为htm格式的帮助文档。

步骤13：将所述配置文件的目录名称、隶属于每个目录名称的帮助文档的名称和位置路径，按照hhc格式写入hhc文件中。

hhc文件是一种windows操作系统上的文件格式，是用htmlhelpworkshop生成chm帮助文件过程中的中间文件格式，主要保存chm文件的目录信息。

步骤14：将隶属于每个目录名称的帮助文档的名称以及hhc文件写入hhp文件中。

hhp文件是chm工程文件，分为option，windows和files三部分。

典型的hhp文件结构如下：

[options]

compatibility＝1.1orlater

defaultwindow＝main默认的显示模式

defaultfont＝宋体,9,1默认的字体

contentsfile＝test.hhc内容文件

indexfile＝test.hhk索引文件

displaycompileprogress＝yes是否全文显示编译过程

full-textsearch＝yes是否全文搜索

language＝0x804中文(中国)默认语言

[windows]

main＝,"test.hhc","test.hhk",,,,,,,0x20,0xb4,0x104e,[80,60,720,540],0x0,0

x0,,,,,0

[files]

newtopic.html

步骤15：根据所述hhc文件、hhp文件和htm格式的帮助文档，生成chm格式的帮助文档。

由以上技术方案可知，本申请提供了一种基于vbscript的帮助文档生成方法，可自动将word格式的帮助文档转化为htm格式的帮助文档，降低用户转换帮助文档格式的转化量，并且利用配置文件，用户在添加帮助文档时，仅需在配置文件帮助文档所属的目录名称中添加名称和位置路径即可，操作简单方便。

参见图2，在本申请的另一实施例中，上述实施例的步骤12还包括如下步骤：

步骤21：利用预置的vbscript脚本文件，打开所述word格式的帮助文档。

vbscript脚本语言是程序开发语言visualbasic家族的新成员，具有强大的灵活性和格式化功能，可以不借助专业的代码开发工具进行快速开发，并对windows对象的支持可以进行更复杂的自动化测试。

步骤22：将所述word格式的帮助文档存储为htm格式的帮助文档。

利用预置的vbscript脚本文件可自动将word文档存储为htm格式的帮助文档，与现有技术相比，降低用户转换文本的工作量，提高工作效率。

第二方面，参见图3，本申请提供了一种基于vbscript的帮助文档生成装置，所述装置包括：

获取模块31，获取chm格式的帮助文档的配置文件及word格式的帮助文档，所述chm格式的帮助文档的配置文件包括chm格式的帮助文档的目录名称以及隶属于每个目录名称的帮助文档的名称和位置路径；

转换模块32，用于利用预先定义的转换规则，将word格式的帮助文档转换为htm格式的帮助文档；

第一写入模块33，用于将所述配置文件的目录名称、隶属于每个目录名称的帮助文档的名称和位置路径，按照hhc格式写入hhc文件中；

第二写入模块34，用于将隶属于每个目录名称的帮助文档的名称以及hhc文件写入hhp文件中；

生成模块35，根据所述hhc文件、hhp文件和htm格式的帮助文档，生成chm格式的帮助文档。

由以上技术方案可知，本申请提供了一种基于vbscript的帮助文档生成装置，可自动将word格式的帮助文档转化为htm格式的帮助文档，降低用户转换帮助文档格式的转化量，并且利用配置文件，用户在添加帮助文档时，仅需在配置文件帮助文档所属的目录名称中添加名称和位置路径即可，操作简单方便。

进一步地，参见图4，所述转换模块32包括：

开启单元41，用于利用预置的vbscript脚本文件，打开所述word格式的帮助文档；

存储单元42，用于将所述word格式的帮助文档存储为htm格式的帮助文档。

进一步地，所述chm格式的帮助文档的配置文件为任意可读文本文档。

由以上技术方案可知，本申请提供了一种基于vbscript的帮助文档生成方法及装置，可自动将word格式的帮助文档转化为htm格式的帮助文档，降低用户转换帮助文档格式的转化量，并且利用配置文件，用户在添加帮助文档时，仅需在配置文件帮助文档所属的目录名称中添加名称和位置路径即可，操作简单方便。