使用md文件生成docx

需求说明

需要将markdown格式的文件生成docx,比较特殊的是需要将无序列表和有序列表转化为大写字母的有序列表。

解决方案

Google之后,有了以下两种解决方案:

  1. 使用pandoc,直接将md转化为docx
  2. 解析md文件,使用officegen生成docx文件

最终使用方案一解决了需求,生成docx文件,两种方案都可以很简单的实现,麻烦的是将无序列表和有序列表转化为大写字母的有序列表,现在是通过pandoc的filter来实现的。

  1. 安装pandoc,windows直接下载安装文件安装,设置环境变量;linux使用命令sudo apt-get install pandoc安装。
  2. 安装过滤器,过滤器可以是任意语言编写,其主要作用是处理json文件,pandoc在写入文件之后,输出文件之前都会先将转化为json,过滤器就是在这个过程之中处理json。我使用的过滤器是pandoc-filter-node
  3. 执行命令pandoc -s [*.md] --filter [filter] -f [format] -o [*.docx],即可生成。
  4. 在项目中使用,使用child_process执行命令,代码child_process.execSync(\pandoc --filter ./scripts/filter.js -f markdown_github -o ${dirDocx + file}`, {input: content})`,content是输入内容。
// 过滤文件
var pandoc = require('pandoc-filter');

function action (type, value, format, meta) {
  if (type === 'BulletList') {
    return pandoc.OrderedList([
      1,
      {
        "t": "UpperAlpha"
      },
      {
        "t": "Period"
      }
    ], value)
  }
}

pandoc.stdio(action)

过程探究

1

最终的解决方案方案并不是很复杂,但得出方案的过程就比较曲折。
首先尝试第一个方案,先查看pandoc文档,了解到pandoc安装过程,知道了pandoc命令的作用,这时已经可以生成docx文档,接下来是修改docx样式,使用命令参数--reference-docx=FILE,可以设置docx的样式,测试后发现,对于标题、文字样式都是有效的,但是列表样式无法生效。

2

于是我开始尝试使用第二个方案,生成docx文档简单,关键是将无序列表转化为大写字符的有序列表,使用officegen可以设置有序或无序,但是无法设置为大写字母的有序列表,阅读officegen源码,发现officegen生成docx文件的原理是将一系列XML文件添加进docx中,再次谷歌,document.xml保存信息,styles.xml保存样式,numbering.xml保存列表标题设置,这就是pandoc中设置docx对列表序号无效的原因。officegen列表相关生成代码没有看出头绪,所以准备采取替代方法,将无序列表转换为大写字母的有序列表,其实可以在读取md后,为无序列表添加大写字母,作为普通文本输出即可。采取这种方式,使用pandoc可以,继续使用officegen也可,而使用pandoc无需手动解析md,于是又回到pandoc的使用上。

3

再次阅读pandoc文档,发现了新的内容,pandoc关于脚本使用的说明,其中Text.Pandoc.Definition说明了json数据结构各个字段的意义。详细阅读后写出了最终的过滤方法,解决了全部需求。

结果分析

1

从项目完成的意义上,这次解决问题是失败的。完成这个功能浪费太多时间,拖慢了项目的整体进度,如果一开始就采用手动添加大写字母替代的方法,很快就能够解决问题,但是因为不采用最好的方法就感觉哪里不舒服的心理,没有第一时间采取这种方法。这种心理并不可取,特别是在完成项目时,这次最终完美解决还好,而很多时候并没有完美的解决方法,最终也只能退而求其次。项目进度最重要,研究原理,寻找更好的解决方法可以之后有时间再尝试。

2

从学习方法阅读文档的角度上,过于马虎了。官方文档阅读一部分后,就进行谷歌使用案例,然后根据案例进行实践,但其实很多时候案例只能告诉我们怎么解决问题,无法告诉我们为什么这样做可以解决问题,如果我们的需求与案例相同是可以很快解决,而一旦略有不同我们就束手无策了。而官方的文档更复杂,但是也更详细,如果谷歌解决不了我们的问题,我们可以溯本求源,在文档中求得答案,如果仔细阅读文档还没有答案就只好采取其他方案了。

3

虽然对于项目来说,浪费了不少时间,但是对于个人却在其中学习到不少知识。如docx文档的组成,以后碰到需要生成固定模板(如请假表、简历)的docx文件时,就可以通过替换修改document.xml的数据完成。所以多花时间多研究,对于提升自己的能力,拓展自己的知识面很有帮助。

参考文档:
使用 Pandoc Markdown 进行学术论文写作
docx组成文件介绍
docx xml 说明

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,039评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,223评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,916评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,009评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,030评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,011评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,934评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,754评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,202评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,433评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,590评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,321评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,917评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,568评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,738评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,583评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,482评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,056评论 25 707
  • 推荐书籍 人的宗教 本书不是宗教史,而是环绕宗教引发的价值进行论述,人生下来必须有信仰,不一定非得是宗教,但是...
    胖胖胖蓝胖子阅读 110评论 0 1
  • 夜幕漫漫张开 清晖沉郁 清幽的影子洒满落寞 喧嚣隐身 清冽彰显 流星闪过 心弦丝丝抖动 明敏复活 希冀游弋 星河皎...
    雪韵_莲心阅读 274评论 18 22
  • 之前学习 Python 的时候,觉得还不错,然后发现 Swift 里面也有。 1、map 函数 -- 对数组中的...
    PierceDark阅读 877评论 0 3