一种文档中静态资源保存和生成的方法与流程

本发明公开一种文档中静态资源保存和生成的方法，涉及文档资源管理技术领域。

背景技术：

软件文档的作用至关重要，具有多种桥梁作用，有助于程序员编制程序，有助于管理人员监督和管理软件开发，有助于用户了解软件的工作方式和操作过使用，有助于维护人员进行有效的修改和扩充。现有维护软件文档的方式，一般是使用word或pdf等二进制文档进行维护，此类文档方便编辑和阅读，但不便于文档的版本管理和多人协作编辑，而使用文本标记语言维护文档可以解决版本管理和多人协作编辑的问题。

文本标记语言使用纯文本格式存储，更方便版本管理，而且能够通过工具转换为其他更方便预览的文档，如html、word、epub等。目前为了保证最终转换的文档中的静态资源文件能够正常使用和展示，基于文本标记语言的文档源文件中往往与所生成文档中的静态资源文件路径保持一致，不利于源文件编辑和预览，而将静态资源存储到统一的文件存储服务器，并且基于文本标记语言的源文档和最终输出文档中的静态资源往往保存不一致，导致不利于后期维护。

静态资源文件一般指图片、样式文件等不会改变的文件。

本发明提供一种文档中静态资源保存和生成的方法，既方便编辑源文档时即时浏览，又不会影响最终文档的使用。能够解决基于文本标记语言的文档最终输出文档中的静态资源保存不一致的问题。

技术实现要素：

本发明针对现有技术的问题，提供一种文档中静态资源保存和生成的方法，既方便编辑源文档时即时浏览，又不会影响最终文档的使用。能够解决基于文本标记语言的文档最终输出文档中的静态资源保存不一致的问题。

本发明提出的具体方案是：

一种文档中静态资源保存和生成的方法，源文档中所引用的静态资源文件与源文档保存在同一文件夹下，源文档使用相对路径引用静态资源文件，

源文档生成最终文档的转换过程中，使用过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径，转换后的最终文档通过绝对路径访问到静态资源文件。

所述的方法中使用pandoc过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径。

所述的方法中使用pandoc过滤工具支持的lua过滤器，利用lua语言定义的过滤器源码，部署静态资源路径，获取静态资源所属文件夹，替换img标签的src为绝对路径。

所述的方法中具体步骤为：

步骤1：源文档进行文档编辑，将源文档中所引用的静态资源文件与源文档保存在同一文件夹下的子文件夹中，

步骤2：源文档生成最终文档的转换过程中，使用pandoc过滤工具的lua过滤器，利用lua语言定义的过滤器源码，部署静态资源路径，获取静态资源所属文件夹，替换img标签的src为静态资源服务器中绝对路径，将静态资源文件保存在静态资源服务器中，

步骤3：转换后的最终文档通过绝对路径访问到静态资源文件。

一种文档中静态资源保存和生成的工具，包括源文档编辑单元、转换单元及访问单元，

源文档编辑单元将源文档中所引用的静态资源文件与源文档保存在同一文件夹下，源文档使用相对路径引用静态资源文件，

转换单元在源文档生成最终文档的转换过程中，使用过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径，转换后的最终文档利用访问单元通过绝对路径访问到静态资源文件。

所述的工具中转换单元使用pandoc过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径。

所述的工具中转换单元使用pandoc过滤工具支持的lua过滤器，利用lua语言定义的过滤器源码，部署静态资源路径，获取静态资源所属文件夹，

替换img标签的src为绝对路径。

所述的工具使用过程的具体步骤为：

步骤1：源文档编辑单元进行源文档的文档编辑，将源文档中所引用的静态资源文件与源文档保存在同一文件夹下的子文件夹中，

步骤2：转换单元在源文档生成最终文档的转换过程中，使用pandoc过滤工具的lua过滤器，利用lua语言定义的过滤器源码，部署静态资源路径，获取静态资源所属文件夹，替换img标签的src为静态资源服务器中绝对路径，将静态资源文件保存在静态资源服务器中，

步骤3：转换后的最终文档利用访问单元通过绝对路径访问到静态资源文件。

本发明的有益之处是：

本发明提供一种文档中静态资源保存和生成的方法，源文档中所引用的静态资源文件与源文档保存在同一文件夹下，源文档使用相对路径引用静态资源文件，源文档生成最终文档的转换过程中，使用过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径，转换后的最终文档通过绝对路径访问到静态资源文件；与现有技术相比，避免在基于文本标记语言的文档中直接引用文件存储服务器中的绝对路径文件，既方便编辑源文档时即时浏览，又不会影响最终文档的使用，又大大方便了静态资源文件的维护。

附图说明

图1是本发明实施例的文件夹结构示意图；

图2本发明方法中静态资源分布情况示意图；

图3本发明方法流程示意图。

具体实施方式

本发明提供一种文档中静态资源保存和生成的方法，源文档中所引用的静态资源文件与源文档保存在同一文件夹下，源文档使用相对路径引用静态资源文件，源文档生成最终文档的转换过程中，使用过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径，转换后的最终文档通过绝对路径访问到静态资源文件。

同时提供与上述方法相对应的一种文档中静态资源保存和生成的工具，包括源文档编辑单元、转换单元及访问单元，

源文档编辑单元将源文档中所引用的静态资源文件与源文档保存在同一文件夹下，源文档使用相对路径引用静态资源文件，

转换单元在源文档生成最终文档的转换过程中，使用过滤工具将源文档引用静态资源文件的相对路径转换为静态资源文件保存在静态资源服务器中的绝对路径，转换后的最终文档利用访问单元通过绝对路径访问到静态资源文件。

下面结合附图和具体实施例对本发明作进一步说明，以使本领域的技术人员可以更好地理解本发明并能予以实施，但所举实施例不作为对本发明的限定。

利用本发明方法，以附图1中的文档和静态资源文件的保存为例，其中help文件夹存放文档的源文件usermanual，img文件夹中存放了源文件中引用的图片文件，usermanual的部分内容如下：

用户打开浏览器，在地址栏中输入公共数据开放平台的地址，即可看到图片1.θ所示的平台主页面，在平台主页面轮播图中，可查看当前平台开放部门数、数据集数量、数据总条数、数据文件数量、api数量、访问量和下载量。

！[](img/shouye.png)

上述源文档usermanual进行文档编辑，将源文档中所引用的图片与源文档保存在同一文件夹下的子文件夹中，

源文档usermanual生成最终文档的转换过程中，使用pandoc过滤工具的lua过滤器，利用lua语言定义的过滤器源码，主要代码为：

使用pandoc过滤工具转换源文件后，内容如下所示：

<p>用户打开浏览器，在地址栏中，输入山东省公共数据开放平台的地址(http:/data.sd.gov.cn/)

即可看到如图1.θ所示的平台主页面，在平台主页面轮播图中，可查看当前平台开放的部门数、数据覆盖领域数、数据总条数、应用数量、数据集数量</p><p><ahref＝http://127.θ.θ.1/www/static/help/img/index.png”data-fancybox＝””data-animation-effect＝”zoom-in-out”><imgsrc＝”http://127.θ.θ.1/www/static/help/img/index.png”/></a></p>；

src＝”http://127.θ.θ.1/www/static/help/img/index.png”为静态资源文件保存在静态资源服务器中的路径，

运行pandoc的命令pandoc--from＝markdown-n-toc--highlight-style＝zenburn--lua-filter＝filter.lua-otargetusermanual.md，转换后的最终文档通过绝对路径访问到静态资源文件。

利用本发明工具进行静态资源文件保存，以附图1中的文档和静态资源文件的保存为例，其中help文件夹存放文档的源文件usermanual，img文件夹中存放了源文件中引用的图片文件，usermanual的部分内容如下：

用户打开浏览器，在地址栏中输入公共数据开放平台的地址，即可看到图片1.θ所示的平台主页面，在平台主页面轮播图中，可查看当前平台开放部门数、数据集数量、数据总条数、数据文件数量、api数量、访问量和下载量。

！[](img/shouye.png)

利用源文档编辑单元对上述源文档usermanual进行文档编辑，将源文档中所引用的图片与源文档保存在同一文件夹下的子文件夹中，

在源文档usermanual生成最终文档的转换过程中，转换单元使用pandoc过滤工具的lua过滤器，利用lua语言定义的过滤器源码，主要代码为：

使用pandoc过滤工具转换源文件后，内容如下所示：

<p>用户打开浏览器，在地址栏中，输入山东省公共数据开放平台的地址(http:/data.sd.gov.cn/)

即可看到如图1.θ所示的平台主页面，在平台主页面轮播图中，可查看当前平台开放的部门数、数据覆盖领域数、数据总条数、应用数量、数据集数量</p><p><ahref＝http://127.θ.θ.1/www/static/help/img/index.png”data-fancybox＝””data-animation-effect＝”zoom-in-out”><imgsrc＝”http://127.θ.θ.1/www/static/help/img/index.png”/></a></p>；

src＝”http://127.θ.θ.1/www/static/help/img/index.png”为静态资源文件保存在静态资源服务器中的路径，

运行pandoc的命令pandoc--from＝markdown-n-toc--highlight-style＝zenburn--lua-filter＝filter.lua-otargetusermanual.md，转换后的最终文档利用访问单元通过绝对路径访问到静态资源文件。

以上所述实施例仅是为充分说明本发明而所举的较佳的实施例，本发明的保护范围不限于此。本技术领域的技术人员在本发明基础上所作的等同替代或变换，均在本发明的保护范围之内。本发明的保护范围以权利要求书为准。