CN106815184B - 基于fog数据自动生成文档的系统及方法 - Google Patents

Abstract

本发明揭示了一种基于FOG数据自动生成文档的系统及方法，所述系统包括：文档样式文件定义模块、文档模板定义模块、文档自动生成模块；所述文档样式文件定义模块通过样式文件来定义生成文档的格式；所述文档模板定义模块通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；所述文档自动生成模块用以根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式。本发明可保证文档格式的统一，文档模板可以复用，保证了不同文档间相互引用的内容的一致性，同时可以降低文档维护难度，节省编写人员的时间和精力。

Description

基于FOG数据自动生成文档的系统及方法

技术领域

本发明属于计算机软件技术领域，涉及一种文档生成系统，尤其涉及一种基于FOG数据自动生成文档的系统；同时，本发明还涉及一种基于FOG数据自动生成文档的方法。

背景技术

在软件研发过程中，需要编写软件开发计划、软件质量保证计划、软件配置管理计划、需求规格说明等等相关文档。

在特定行业中，权威的标准会对文档的内容提出明确的要求。同时，行业中某些标准对文档的结构，包括文档的封面、修改页、目录、正文格式、章节、附录等都有一定的要求。

在项目研发过程中，相关研发人员依据项目要求在文档编辑工具(如MicrosoftWord)中手工编写文档，编写过程中或完成后依据行业内相关标准对文档内容格式的要求手工对文档进行格式样式调整、页眉页脚设置等。

现有的文档编写或生成技术存在以下缺点：

(1)文档格式难以统一。由于需要人工手动对文档格式进行调整，难以保证文档格式的统一性。

(2)文档格式难以复用。文档编写完成后，编写完成的文档的格式和章节不便于复用。

(3)文档内容相互依赖，一致性难以得到保证。当一份文档中某些内容发生更改后，与该内容有关联的文档需要全部手工修改。

(4)维护困难。当多人协同编写的文档完成后，需要多人同时进行维护。

有鉴于此，如今迫切需要设计一种新的文档编写方式，以便克服现有编写方式的上述缺陷。

发明内容

本发明所要解决的技术问题是：提供一种基于FOG数据自动生成文档的系统，可提高文档生成的效率及精确度。

此外，本发明还提供一种基于FOG数据自动生成文档的方法，可提高文档生成的效率及精确度。

为解决上述技术问题，本发明采用如下技术方案：

一种基于FOG数据自动生成文档的系统，所述系统包括：文档样式文件定义模块、文档模板定义模块、文档自动生成模块；

所述文档样式文件定义模块通过样式文件来定义生成文档的格式；样式文件中必须定义的样式有：表格、列表、正文、标题、图片、题注；对表格的定义包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框、对齐；对列表的定义包括生成文档时的项目符号、字体、字号、段落设置，支持定义两级列表，一级项目符号和二级项目符号；对正文的定义包括生成文档的字体、字号、段落设置；对标题的定义包括多级标题；设置生成文档时每一级标题的字体、字号、缩进；对图片的定义包括生成文档时图片的对齐方式，包括左对齐、右对齐、居中；对题注的定义包括生成文档时题注的对齐方式、字体、字号；

样式文件定义好之后，上传到本系统中，作为本系统后续生成文件时用于设置文件格式的基准定义；生成文档时，系统会根据样式文件中的格式对文档中的表格、列表、正文、标题、图片、题注的格式进行控制；

当需要生成的文档的格式要求需要发生变更时，对系统中的样式文件进行更改后重新上传；

所述文档模板定义模块通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；FOG数据按照类别划分为非条目化FOG数据和条目化FOG数据；

为了保证在编写文档内容时不同文档中内容相同的部分只需要进行一次编写，并便于在文档内容发生变更时，保证所有文档之间内容的一致性，将项目的所有文档按照章节拆分成非条目化FOG数据，并且确保每一个非条目化FOG数据的唯一性；同时，某些文档中要对项目中的需求、设计、测试用例及规程、源代码进行编写，这些内容与之对应的是条目化FOG数据；一份文档包含多个FOG数据，一个FOG数据存在于一个或多个文档中；

项目中的每一份文档对应一个文档模板；文档模板定义模块主要包括：原始文档模板创建单元、文档模板编辑单元、文档模板保存单元；

原始文档模板创建单元用以为每一份文档自动创建一个原始的文档模板，原始文档模板打开后里面内容为空白，并且会存在一个FOG数据管理的弹出框；文档模板通过内嵌的VBA程序将数据库表中的非条目化FOG数据、条目化FOG数据等字段抓取出来，在弹出框中以树状形式展现；拖动弹出框中的FOG数据节点至文档模板后，会生成相应的域代码，文档模板通过域代码与数据库中FOG数据关联，用于在生成文档时从数据库中抓取相应FOG数据内容；

从本系统中导出原始文档模板后，文档模板编辑单元根据生成文档中需要的内容，通过拖拽FOG数据节点，将文档所需内容对应的FOG数据拖拽到相应的位置，设置好FOG数据的前后顺序以及迭代；

在文档模板定制界面中定义的内容有：

-文档封面和页眉页脚中的“静态”内容，包括表格、图片、固定文字；

-文档封面和页眉页脚中的“动态”内容，包括FOG数据；

-使用“插入目录”功能在文档模板中插入的目录；

-通过“插入图表目录”功能在文档模板中插入的图表目录；

-“静态”的正文章节标题，章节的样式可在文档模板中设置；

-“动态”的正文章节，在文档模板中通过非条目化FOG数据中标题进行定义，“动态”章节在生成文档时创建章节；

-“静态”的正文内容，其样式在文档模板中设置；

-“动态”的正文内容，通过插入FOG数据等进行定义，包括富文本内容和非格式化文本内容；

-“静态”的表格，包括使用FOG数据的表格，其格式由文档模板样式决定；

以下内容是按照文档模板中定义的样式生成文档内容：

-插入的FOG数据内容在生成文档时使用文档模板文件在其插入位置所设定的样式，包括其字体、字号、段落设置；

-域在文档生成时应用其插入位置的样式；

-文档模板中定义的“静态”内容，包括文档模板封面、页眉页脚、正文章节、正文内容，其格式由文档模板的样式决定；

-“正文内容”中的非格式化文本内容在文档生成时使用文档模板文件在其插入位置所设定的样式，包括其字体、字号、段落设置；

当文档模板编辑完成后，文档模板中应该包含了文档的封面、章节目录结构树、图表目录结构树、页眉页脚、FOG数据的迭代、位置；文档模板保存单元用以保存编辑完成后的文档模板，生成文档时根据文档模板中的配置抓取相应的FOG数据内容生成文档内容；

当FOG数据内容编写完成之后选择需要生成的文档；文档自动生成模块用以根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式；文档自动生成模块生成文档的步骤如下：

步骤A1、解析文档模板，读取文档模板中的静态内容和动态内容；

步骤A2、文档自动生成模块将文档模板中的静态内容复制到所要生成的文档中；

步骤A3、文档自动生成模块生成文档中动态内容，步骤如下：步骤A31、解析动态内容中的域代码，获取FOG数据域、以及可能存在的循环迭代；步骤A32、解析FOG数据域中所定义的FOG数据，从系统数据库中获取相应的具体FOG数据；文档模板中如未定义FOG数据循环迭代，将获取的具体FOG数据插入至所需要生成的文档中；文档模板中如定义了FOG数据循环迭代，则根据迭代从系统数据库中循环获取相应的FOG数据，填充至文档模板；

步骤A4、合并静态内容和动态内容，生成内容完整的文档；

步骤A5、根据样式文件中配置的文档格式信息设置生成文档的格式，完成文档生成；

所述系统还支持不同FOG数据之间题注的交叉引用；所述系统包括：第一题注交叉引用模块、第二题注交叉引用模块；

第一题注交叉引用模块用以完成非条目化FOG数据间题注的交叉引用：支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用模块用以完成条目化FOG数据间题注的交叉引用：支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

一种基于FOG数据自动生成文档的系统，所述系统包括：文档样式文件定义模块、文档模板定义模块、文档自动生成模块；

所述文档样式文件定义模块通过样式文件来定义生成文档的格式；

所述文档模板定义模块通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；

所述文档自动生成模块用以根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式。

作为本发明的一种优选方案，所述文档样式文件定义模块定义样式文件中必须定义的样式有：表格、列表、正文、标题、图片、题注。

作为本发明的一种优选方案，对表格的定义包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框、对齐；

对列表的定义包括生成文档时的项目符号、字体、字号、段落设置，支持定义两级列表，一级项目符号和二级项目符号；

对正文的定义包括生成文档的字体、字号、段落设置；对标题的定义包括多级标题；设置生成文档时每一级标题的字体、字号、缩进；

对图片的定义包括生成文档时图片的对齐方式，包括左对齐、右对齐、居中；

对题注的定义包括生成文档时题注的对齐方式、字体、字号；

样式文件定义好之后，上传到本系统中，作为本系统后续生成文件时用于设置文件格式的基准定义；生成文档时，系统会根据样式文件中的格式对文档中的表格、列表、正文、标题、图片、题注的格式进行控制；

当需要生成的文档的格式要求需要发生变更时，对系统中的样式文件进行更改后重新上传。

作为本发明的一种优选方案，所述文档模板定义模块将文档的编写拆分成FOG数据的编写；FOG数据按照类别划分为非条目化FOG数据和条目化FOG数据。

作为本发明的一种优选方案，将项目的所有文档按照章节拆分成非条目化FOG数据，并且确保每一个非条目化FOG数据的唯一性；同时，某些文档中要对项目中的需求、设计、测试用例及规程、源代码进行编写，这些内容与之对应的是条目化FOG数据；一份文档包含多个FOG数据，一个FOG数据存在于一个或多个文档中；

项目中的每一份文档对应一个文档模板；文档模板定义模块主要包括：原始文档模板创建单元、文档模板编辑单元、文档模板保存单元；

原始文档模板创建单元用以为每一份文档自动创建一个原始的文档模板，原始文档模板打开后里面内容为空白，并且会存在一个FOG数据管理的弹出框；

文档模板通过内嵌的VBA程序将数据库表中的非条目化FOG数据、条目化FOG数据等字段抓取出来，在弹出框中以树状形式展现；拖动弹出框中的FOG数据节点至文档模板后，会生成相应的域代码，文档模板通过域代码与数据库中FOG数据关联，用于在生成文档时从数据库中抓取相应FOG数据内容；

从本系统中导出原始文档模板后，文档模板编辑单元根据生成文档中需要的内容，通过拖拽FOG数据节点，将文档所需内容对应的FOG数据拖拽到相应的位置，设置好FOG数据的前后顺序以及迭代；

当文档模板编辑完成后，文档模板中应该包含了文档的封面、章节目录结构树、图表目录结构树、页眉页脚、FOG数据的迭代、位置；

文档模板保存单元用以保存编辑完成后的文档模板，生成文档时根据文档模板中的配置抓取相应的FOG数据内容生成文档内容。

作为本发明的一种优选方案，所述系统还支持不同FOG数据之间题注的交叉引用；所述系统包括：第一题注交叉引用模块、第二题注交叉引用模块；

第一题注交叉引用模块用以完成非条目化FOG数据间题注的交叉引用：支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用模块用以完成条目化FOG数据间题注的交叉引用：支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

一种基于FOG数据自动生成文档的方法，所述方法包括如下步骤：

文档样式文件定义步骤，通过样式文件来定义生成文档的格式；

文档模板定义步骤，通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；

文档自动生成步骤，根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式。

作为本发明的一种优选方案，所述方法还支持不同FOG数据之间题注的交叉引用；所述方法还包括：

第一题注交叉引用步骤，完成非条目化FOG数据间题注的交叉引用：支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用步骤，完成条目化FOG数据间题注的交叉引用：支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

本发明的有益效果在于：本发明提出的基于FOG数据自动生成文档的系统及方法，可提高文档生成的效率及精确度。

本发明与现有技术相比，具有以下优点：

(1)保证了文档格式的统一。所有文档生成时都由本系统控制文档格式的生成，当文档格式要求有所变动时，只要对样式文件、文档模板进行调整，重新生成后的所有文档的格式都能统一调整。

(2)文档模板可以复用。当不同项目对文档的要求一致或者差别不大时，可以复用之前配置好的文档模板，节约时间和成本。

(3)保证了不同文档间相互引用的内容的一致性。以FOG数据的形式对文档进行编写，不同文档间互相引用的内容由唯一的FOG数据进行控制，当该FOG数据内容发生变更时，所有与该FOG数据有关的文档内容都能统一更改，保证了内容的一致性。

(4)降低了文档维护难度。每个编写人员只需要维护自己编写的FOG数据，不需要关心哪些文档包含此FOG数据，也不需要关心同一份文档中其他人编写的FOG数据内容。

(5)节省编写人员的时间和精力。一旦根据标准要求配置好文档模板，编写人员不需要在编写过程中考虑和修改不同部分的格式，只需要把智力和精力集中在文档内容的编写上，更利于提升文档的编写速度和准确性。

附图说明

图1为目前软件研发过程中文档编写现状示意图。

图2为基于FOG数据文档生成系统的组成示意图。

图3为FOG数据与文档之间关系图。

图4为文档模板定义模块的组成示意图。

图5为文档模板中FOG数据管理框。

具体实施方式

下面结合附图详细说明本发明的优选实施例。

实施例一

为了满足行业内相关标准针对文档的要求，本发明揭示了一种基于FOG数据自动生成文档的方法和系统，该系统在定制好文档模板并完成FOG数据编写后，会根据文档模板中对FOG数据的配置，自动抓取相应的FOG数据生成符合标准要求的文档。该发明强调的理念是：文档的内容是可以拆分的，并且内容和格式要求是可以独立开的。通过FOG数据将文档内容拆分成细粒度的数据单元，通过专用的样式文件定义文档的格式，通过配置文档模板将不同的FOG数据进行组合，满足相关标准对内容格式的要求。以下以某个软件项目中的文档编写为例介绍本发明。

请参阅图2，基于FOG数据自动生成文档的系统包括：文档样式文件定义模块DG-01、文档模板定义模块DG-02、文档自动生成模块DG-03。

【文档样式文件定义模块DG-01】

文档样式文件定义模块DG-01用以定义文档样式文件。

本发明通过样式文件来定义生成文档的格式。样式文件中必须定义的样式有：

a)表格：可以定义包括生成文档时表格的表头格式、表体的格式等，格式包括字体、字号、边框、对齐等。

b)列表：可以定义包括生成文档时的项目符号、字体、字号、段落设置，目前支持定义两级列表，一级项目符号和二级项目符号。

c)正文：可以定义包括生成文档的字体、字号、段落设置等。

d)标题：可以定义多级标题。设置生成文档时每一级标题的字体、字号、缩进等。

e)图片：可以定义生成文档时图片的对齐方式，包括左对齐、右对齐、居中。

f)题注：可以定义生成文档时题注的对齐方式、字体、字号等。

样式文件定义好之后，可以上传到本系统中，作为本系统后续生成文件时用于设置文件格式的基准定义。生成文档时，系统会根据样式文件中的格式对文档中的表格、列表、正文、标题、图片、题注等的格式进行控制。

当需要生成的文档的格式要求需要发生变更时，可以对系统中的样式文件进行更改后重新上传。

【文档模板定义模块DG-02】

本发明通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写。FOG数据按照类别划分为非条目化FOG数据和条目化FOG数据。如图3所示，一个软件项目需要编写《软件审定计划》、《软件需求数据》、《软件追踪数据》、《软件实施概要》等若干文档。这些文档当中有些章节是一致的，例如《软件审定计划》、《软件实施概要》中都包含该项目的系统概述和软件概述等章节。为了保证在编写文档内容时不同文档中内容相同的部分只需要进行一次编写，并便于在文档内容发生变更时，保证所有文档之间内容的一致性，该发明将项目的所有文档按照章节拆分成非条目化FOG数据，并且确保每一个非条目化FOG数据的唯一性。同时，某些文档中要对项目中的需求、设计、测试用例及规程、源代码等进行编写，这些内容与之对应的是条目化FOG数据。一份文档包含多个FOG数据，一个FOG数据也可能存在于多个文档中。

项目中的每一份文档对应一个文档模板。请参阅图4，文档模板定义主要包括以下几个步骤：

a)创建原始文档模板

本系统会为每一份文档自动创建一个原始的文档模板，原始文档模板打开后里面内容为空白，并且会存在一个FOG数据管理的弹出框。文档模板通过内嵌的VBA程序将数据库表中的非条目化FOG数据、条目化FOG数据等字段抓取出来，在弹出框中以树状形式展现，如图5所示，拖动弹出框中的FOG数据节点至文档模板后，会生成相应的域代码，文档模板通过域代码与数据库中FOG数据关联，用于在生成文档时从数据库中抓取相应FOG数据内容。

b)编辑文档模板

从本系统中导出原始文档模板后，根据生成文档中需要的内容，通过拖拽图5中的FOG数据节点，将文档所需内容对应的FOG数据拖拽到相应的位置，设置好FOG数据的前后顺序以及迭代等。

在文档模板定制界面中可以定义的内容有：

●文档封面和页眉页脚中的“静态”内容，包括表格、图片、固定文字(如组织名称、“页”等)。

●文档封面和页眉页脚中的“动态”内容，包括FOG数据(如项目信息数据、文档信息数据)。

●使用“插入目录”功能在文档模板中插入的目录。

●通过“插入图表目录”功能在文档模板中插入的图表目录。

●“静态”的正文章节标题，章节的样式可在文档模板中设置。

●“动态”的正文章节，在文档模板中通过非条目化FOG数据中标题进行定义，“动态”章节在生成文档时创建章节。

●“静态”的正文内容(例如一段文本)，其样式在文档模板中设置。

●“动态”的正文内容，通过插入FOG数据等进行定义，包括富文本内容和非格式化文本内容。

●“静态”的表格(包括使用FOG数据的表格)，其格式由文档模板样式决定。

以下内容是按照文档模板中定义的样式生成文档内容：

●插入的FOG数据内容在生成文档时使用文档模板文件在其插入位置所设定的样式，包括其字体、字号、段落设置

●域(如页码、总页数等)在文档生成时应用其插入位置的样式

●文档模板中定义的“静态”内容，包括文档模板封面、页眉页脚、正文章节、正文内容，其格式由文档模板的样式决定

●“正文内容”中的非格式化文本内容在文档生成时使用文档模板文件在其插入位置所设定的样式，包括其字体、字号、段落设置

c)保存文档模板

当文档模板编辑完成后，文档模板中应该包含了文档的封面、章节目录结构树、图表目录结构树、页眉页脚、FOG数据的迭代、位置等。

本系统会保存编辑完成后的文档模板，生成文档时，系统会根据文档模板中的配置抓取相应的FOG数据内容生成文档内容。

【文档自动生成模块DG-03】

当FOG数据内容编写完成之后，可以在本系统中选择需要生成的文档。文档自动生成模块会根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式,文档自动生成模块生成文档的步骤如下：

步骤A1、解析文档模板，读取文档模板中的静态内容和动态内容；

步骤A2、文档自动生成模块将文档模板中的静态内容复制到所要生成的文档中；

步骤A3、文档自动生成模块生成文档中动态内容，步骤如下：

步骤A31、解析动态内容中的域代码，获取FOG数据域、以及可能存在的循环迭代；

步骤A32、解析FOG数据域中所定义的FOG数据，从系统数据库中获取相应的具体FOG数据；文档模板中如未定义FOG数据循环迭代，将获取的具体FOG数据插入至所需要生成的文档中；文档模板中如定义了FOG数据循环迭代，则根据迭代从系统数据库中循环获取相应的FOG数据，填充至文档模板；

步骤A4、合并静态内容和动态内容，生成内容完整的文档；

步骤A5、根据样式文件中配置的文档格式信息设置生成文档的格式，完成文档生成。

另外，本发明还支持不同FOG数据之间题注的交叉引用。所述系统包括：第一题注交叉引用模块、第二题注交叉引用模块。

第一题注交叉引用模块用以完成非条目化FOG数据间题注的交叉引用。本发明支持同一文档模板中不同非条目化FOG数据间题注的交叉引用。

当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中。当需要引用题注时，本系统会通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，可以从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用。

第二题注交叉引用模块用以完成条目化FOG数据间题注的交叉引用。本发明支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用。

当编写一个条目化FOG数据时，如果需要引用题注，本系统会从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据(同类型是指条目化FOG数据都为系统需求或都为软件需求等等)，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

本发明还揭示一种基于FOG数据自动生成文档的方法，所述方法包括如下步骤：

文档样式文件定义步骤，通过样式文件来定义生成文档的格式；

文档模板定义步骤，通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；

文档自动生成步骤，根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式。

所述文档自动生成步骤具体包括：

步骤A1、解析文档模板，读取文档模板中的静态内容和动态内容；

步骤A2、文档自动生成模块将文档模板中的静态内容复制到所要生成的文档中；

步骤A3、文档自动生成模块生成文档中动态内容，步骤如下：步骤A31、解析动态内容中的域代码，获取FOG数据域、以及可能存在的循环迭代；步骤A32、解析FOG数据域中所定义的FOG数据，从系统数据库中获取相应的具体FOG数据；文档模板中如未定义FOG数据循环迭代，将获取的具体FOG数据插入至所需要生成的文档中；文档模板中如定义了FOG数据循环迭代，则根据迭代从系统数据库中循环获取相应的FOG数据，填充至文档模板；

步骤A4、合并静态内容和动态内容，生成内容完整的文档；

步骤A5、根据样式文件中配置的文档格式信息设置生成文档的格式，完成文档生成。

以上各个步骤的具体实现方式可以参照对应模块的介绍。

此外，所述方法还支持不同FOG数据之间题注的交叉引用。所述方法还包括：

第一题注交叉引用步骤，完成非条目化FOG数据间题注的交叉引用。支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用步骤，完成条目化FOG数据间题注的交叉引用。支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

综上所述，本发明提出的基于FOG数据自动生成文档的系统及方法，可保证文档格式的统一，文档模板可以复用，保证了不同文档间相互引用的内容的一致性，同时可以降低文档维护难度，节省编写人员的时间和精力。

这里本发明的描述和应用是说明性的，并非想将本发明的范围限制在上述实施例中。这里所披露的实施例的变形和改变是可能的，对于那些本领域的普通技术人员来说实施例的替换和等效的各种部件是公知的。本领域技术人员应该清楚的是，在不脱离本发明的精神或本质特征的情况下，本发明可以以其它形式、结构、布置、比例，以及用其它组件、材料和部件来实现。在不脱离本发明范围和精神的情况下，可以对这里所披露的实施例进行其它变形和改变。

Claims (9)

1.一种基于FOG数据自动生成文档的系统，其特征在于，所述系统包括：文档样式文件定义模块、文档模板定义模块和文档自动生成模块；

所述文档样式文件定义模块通过样式文件来定义生成文档的格式；样式文件中必须定义的样式有：表格、列表、正文、标题、图片和题注；对表格的定义包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框和对齐；对列表的定义包括生成文档时的项目符号、字体、字号和段落设置，支持定义两级列表，一级项目符号和二级项目符号；对正文的定义包括生成文档的字体、字号和段落设置；对标题的定义包括多级标题；设置生成文档时每一级标题的字体、字号和缩进；对图片的定义包括生成文档时图片的对齐方式，包括左对齐、右对齐和居中；对题注的定义包括生成文档时题注的对齐方式、字体和字号；

样式文件定义好之后，上传到本系统中，作为本系统后续生成文件时用于设置文件格式的基准定义；生成文档时，系统会根据样式文件中的格式对文档中的表格、列表、正文、标题、图片和题注的格式进行控制；

当需要生成的文档的格式要求需要发生变更时，对系统中的样式文件进行更改后重新上传；

所述文档模板定义模块通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；FOG数据按照类别划分为非条目化FOG数据和条目化FOG数据；

为了保证在编写文档内容时不同文档中内容相同的部分只需要进行一次编写，并便于在文档内容发生变更时，保证所有文档之间内容的一致性，将项目的所有文档按照章节拆分成非条目化FOG数据，并且确保每一个非条目化FOG数据的唯一性；同时，某些文档中要对项目中的需求、设计、测试用例及规程和源代码进行编写，这些内容与之对应的是条目化FOG数据；一份文档包含多个FOG数据，一个FOG数据存在于一个或多个文档中；

项目中的每一份文档对应一个文档模板；文档模板定义模块包括：原始文档模板创建单元、文档模板编辑单元和文档模板保存单元；

原始文档模板创建单元用以为每一份文档自动创建一个原始的文档模板，原始文档模板打开后里面内容为空白，并且会存在一个FOG数据管理的弹出框；文档模板通过内嵌的VBA程序将数据库表中的非条目化FOG数据、条目化FOG数据字段抓取出来，在弹出框中以树状形式展现；拖动弹出框中的FOG数据节点至文档模板后，会生成相应的域代码，文档模板通过域代码与数据库中FOG数据关联，用于在生成文档时从数据库中抓取相应FOG数据内容；

从本系统中导出原始文档模板后，文档模板编辑单元根据生成文档中需要的内容，通过拖拽FOG数据节点，将文档所需内容对应的FOG数据拖拽到相应的位置，设置好FOG数据的前后顺序以及迭代；

在文档模板定制界面中定义的内容有：

-文档封面和页眉页脚中的“静态”内容，包括表格、图片和固定文字；

-文档封面和页眉页脚中的“动态”内容，包括FOG数据；

-使用“插入目录”功能在文档模板中插入的目录；

-通过“插入图表目录”功能在文档模板中插入的图表目录；

-“静态”的正文章节标题，章节的样式在文档模板中设置；

-“动态”的正文章节，在文档模板中通过非条目化FOG数据中标题进行定义，“动态”章节在生成文档时创建章节；

-“静态”的正文内容，其样式在文档模板中设置；

-“动态”的正文内容，通过插入FOG数据进行定义，包括富文本内容和非格式化文本内容；

-“静态”的表格，包括使用FOG数据的表格，其格式由文档模板样式决定；

以下内容是按照文档模板中定义的样式生成文档内容：

-插入的FOG数据内容在生成文档时使用文档模板文件在其插入位置所设定的样式，包括其字体、字号和段落设置；

-域在文档生成时应用其插入位置的样式；

-文档模板中定义的“静态”内容，包括文档模板封面、页眉页脚、正文章节和正文内容，其格式由文档模板的样式决定；

-“正文内容”中的非格式化文本内容在文档生成时使用文档模板文件在其插入位置所设定的样式，包括其字体、字号和段落设置；

当文档模板编辑完成后，文档模板中包含了文档的封面、章节目录结构树、图表目录结构树、页眉页脚、FOG数据的迭代和位置；文档模板保存单元用以保存编辑完成后的文档模板，生成文档时根据文档模板中的配置抓取相应的FOG数据内容生成文档内容；

当FOG数据内容编写完成之后选择需要生成的文档；文档自动生成模块用以根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式,文档自动生成模块生成文档的步骤如下：

步骤A1、解析文档模板，读取文档模板中的静态内容和动态内容；

步骤A2、文档自动生成模块将文档模板中的静态内容复制到所要生成的文档中；

步骤A3、文档自动生成模块生成文档中动态内容，步骤如下：步骤A31、解析动态内容中的域代码，获取FOG数据域、以及可能存在的循环迭代；步骤A32、解析FOG数据域中所定义的FOG数据，从系统数据库中获取相应的具体FOG数据；文档模板中如未定义FOG数据循环迭代，将获取的具体FOG数据插入至所需要生成的文档中；文档模板中如定义了FOG数据循环迭代，则根据迭代从系统数据库中循环获取相应的FOG数据，填充至文档模板；

步骤A4、合并静态内容和动态内容，生成内容完整的文档；

步骤A5、根据样式文件中配置的文档格式信息设置生成文档的格式，完成文档生成；

所述系统还支持不同FOG数据之间题注的交叉引用；所述系统包括：第一题注交叉引用模块、第二题注交叉引用模块；

第一题注交叉引用模块用以完成非条目化FOG数据间题注的交叉引用：支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用模块用以完成条目化FOG数据间题注的交叉引用：支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

2.根据权利要求1所述的基于FOG数据自动生成文档的系统，其特征在于：

所述文档样式文件定义模块定义样式文件中必须定义的样式有：表格、列表、正文、标题、图片和题注。

3.根据权利要求2所述的基于FOG数据自动生成文档的系统，其特征在于：

对表格的定义包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框和对齐；

对列表的定义包括生成文档时的项目符号、字体、字号和段落设置，支持定义两级列表，一级项目符号和二级项目符号；

对正文的定义包括生成文档的字体、字号和段落设置；对标题的定义包括多级标题；设置生成文档时每一级标题的字体、字号和缩进；

对图片的定义包括生成文档时图片的对齐方式，包括左对齐、右对齐和居中；

对题注的定义包括生成文档时题注的对齐方式、字体和字号；

样式文件定义好之后，上传到本系统中，作为本系统后续生成文件时用于设置文件格式的基准定义；生成文档时，系统会根据样式文件中的格式对文档中的表格、列表、正文、标题、图片和题注的格式进行控制；

当需要生成的文档的格式要求需要发生变更时，对系统中的样式文件进行更改后重新上传。

4.根据权利要求1所述的基于FOG数据自动生成文档的系统，其特征在于：

所述文档模板定义模块将文档的编写拆分成FOG数据的编写；FOG数据按照类别划分为非条目化FOG数据和条目化FOG数据。

5.根据权利要求4所述的基于FOG数据自动生成文档的系统，其特征在于：

将项目的所有文档按照章节拆分成非条目化FOG数据，并且确保每一个非条目化FOG数据的唯一性；同时，某些文档中要对项目中的需求、设计、测试用例及规程和源代码进行编写，这些内容与之对应的是条目化FOG数据；

一份文档包含多个FOG数据，一个FOG数据存在于一个或多个文档中；

项目中的每一份文档对应一个文档模板；文档模板定义模块包括：原始文档模板创建单元、文档模板编辑单元和文档模板保存单元；

原始文档模板创建单元用以为每一份文档自动创建一个原始的文档模板，原始文档模板打开后里面内容为空白，并且会存在一个FOG数据管理的弹出框；

文档模板通过内嵌的VBA程序将数据库表中的非条目化FOG数据、条目化FOG数据字段抓取出来，在弹出框中以树状形式展现；拖动弹出框中的FOG数据节点至文档模板后，会生成相应的域代码，文档模板通过域代码与数据库中FOG数据关联，用于在生成文档时从数据库中抓取相应FOG数据内容；

从本系统中导出原始文档模板后，文档模板编辑单元根据生成文档中需要的内容，通过拖拽FOG数据节点，将文档所需内容对应的FOG数据拖拽到相应的位置，设置好FOG数据的前后顺序以及迭代；

当文档模板编辑完成后，文档模板中应该包含了文档的封面、章节目录结构树、图表目录结构树、页眉页脚、FOG数据的迭代和位置；

文档模板保存单元用以保存编辑完成后的文档模板，生成文档时根据文档模板中的配置抓取相应的FOG数据内容生成文档内容。

6.根据权利要求1所述的基于FOG数据自动生成文档的系统，其特征在于：

所述系统还支持不同FOG数据之间题注的交叉引用；所述系统包括：第一题注交叉引用模块、第二题注交叉引用模块；

第一题注交叉引用模块用以完成非条目化FOG数据间题注的交叉引用：支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用模块用以完成条目化FOG数据间题注的交叉引用：支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

7.一种基于FOG数据自动生成文档的方法，其特征在于，所述方法包括如下步骤：

文档样式文件定义步骤，通过样式文件来定义生成文档的格式；样式文件中必须定义的样式有：表格、列表、正文、标题、图片和题注；对表格的定义包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框和对齐；对列表的定义包括生成文档时的项目符号、字体、字号和段落设置，支持定义两级列表，一级项目符号和二级项目符号；对正文的定义包括生成文档的字体、字号和段落设置；对标题的定义包括多级标题；设置生成文档时每一级标题的字体、字号和缩进；对图片的定义包括生成文档时图片的对齐方式，包括左对齐、右对齐和居中；对题注的定义包括生成文档时题注的对齐方式、字体和字号；

文档模板定义步骤，通过文档模板来定义待生成文档中所包含的FOG数据，将文档的编写拆分成FOG数据的编写；FOG数据按照类别划分为非条目化FOG数据和条目化FOG数据；

为了保证在编写文档内容时不同文档中内容相同的部分只需要进行一次编写，并便于在文档内容发生变更时，保证所有文档之间内容的一致性，将项目的所有文档按照章节拆分成非条目化FOG数据，并且确保每一个非条目化FOG数据的唯一性；同时，某些文档中要对项目中的需求、设计、测试用例及规程和源代码进行编写，这些内容与之对应的是条目化FOG数据；一份文档包含多个FOG数据，一个FOG数据存在于一个或多个文档中；

所述文档模板定义步骤包括：原始文档模板创建步骤、文档模板编辑步骤和文档模板保存步骤；

原始文档模板创建步骤用以为每一份文档自动创建一个原始的文档模板，原始文档模板打开后里面内容为空白，并且会存在一个FOG数据管理的弹出框；文档模板通过内嵌的VBA程序将数据库表中的非条目化FOG数据、条目化FOG数据字段抓取出来，在弹出框中以树状形式展现；拖动弹出框中的FOG数据节点至文档模板后，会生成相应的域代码，文档模板通过域代码与数据库中FOG数据关联，用于在生成文档时从数据库中抓取相应FOG数据内容；

文档模板编辑步骤根据生成文档中需要的内容，通过拖拽FOG数据节点，将文档所需内容对应的FOG数据拖拽到相应的位置，设置好FOG数据的前后顺序以及迭代；

文档模板保存步骤用以保存编辑完成后的文档模板，生成文档时根据文档模板中的配置抓取相应的FOG数据内容生成文档内容；

文档自动生成步骤，根据文档模板中配置的每个文档的FOG数据从数据库中抓取相应FOG数据的内容信息生成文档的内容，并且通过样式文件中配置的文档格式信息生成文档的格式。

8.根据权利要求7所述的基于FOG数据自动生成文档的方法，其特征在于：

所述方法还支持不同FOG数据之间题注的交叉引用；所述方法还包括：

第一题注交叉引用步骤，完成非条目化FOG数据间题注的交叉引用：支持同一文档模板中不同非条目化FOG数据间题注的交叉引用；当编写一个非条目化FOG数据时，为其中图表添加的每一个题注会以记录的形式保存在数据库相应的表中；当需要引用题注时，第一题注交叉引用模块通过配置好的文档模板找出该文档中所有的非条目化FOG数据，再从数据库表中提取出这些非条目化FOG数据中建立的所有题注，从中选择需要的题注，从而实现不同非条目化FOG数据间题注的交叉引用；

第二题注交叉引用步骤，完成条目化FOG数据间题注的交叉引用：支持条目化FOG数据对所有非条目化FOG数据题注的引用以及同一类型的条目化FOG数据间题注的交叉引用；当编写一个条目化FOG数据时，如果需要引用题注，第二题注交叉引用模块从数据库表中找出所有与编写的FOG数据同类型的条目化FOG数据，以及直接在数据库表中找出所有非条目化FOG数据，再从数据库表中提取出这两类FOG数据的题注，从而实现条目化FOG数据间题注的交叉引用。

9.根据权利要求7所述的基于FOG数据自动生成文档的方法，其特征在于：

所述文档自动生成步骤具体包括：

步骤A1、解析文档模板，读取文档模板中的静态内容和动态内容；

步骤A2、文档自动生成模块将文档模板中的静态内容复制到所要生成的文档中；

步骤A3、文档自动生成模块生成文档中动态内容，步骤如下：步骤A31、解析动态内容中的域代码，获取FOG数据域、以及可能存在的循环迭代；步骤A32、解析FOG数据域中所定义的FOG数据，从系统数据库中获取相应的具体FOG数据；文档模板中如未定义FOG数据循环迭代，将获取的具体FOG数据插入至所需要生成的文档中；文档模板中如定义了FOG数据循环迭代，则根据迭代从系统数据库中循环获取相应的FOG数据，填充至文档模板；

步骤A4、合并静态内容和动态内容，生成内容完整的文档；

步骤A5、根据样式文件中配置的文档格式信息设置生成文档的格式，完成文档生成。

Images