centixkadon / nju-thesis-markdown

南京大学学位论文排版工具(硕士/本科) - Life is short, you need Markdown.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

南京大学学位论文排版工具

Life is short, you need Markdown.

本项目提供了一个基于 Pandoc 导出 docx 南京大学学位论文的 Lua Filter 。该模板想必可以满足硕士学位论文的需求,帮助没有 LaTeX 基础且没有强迫症的南京大学同学们极其方便地排版出够用的学位论文。

功能特色

  • 可排版硕士、学士学位论文(学士论文封面、摘要暂未直接生成);
  • 相比 LaTeX 简单多了,兼顾文本文件的版本控制和 Microsoft Word 的编辑功能;
  • 导出的 docx 文件用书签和域来引用,插入图、表、公式导致的编号变化可以直接更新;
  • 导出的 docx 文件可以给不使用 LaTeX 的导师修改;
  • 功能不足的地方可以导出 docx 文件后用 Microsoft Word 补足。

参考的格式要求

因学校会清理过期网页,但未清理过期文件,所以引用了下载文件的链接。

比较后发现2020届和2021届的撰写规范没有区别。

比较后发现2021届和2022届的撰写规范没有区别,但是2022届多了一个毕业论文 Word 模板,里面多了亿点点小细节,今年来不及支持了。好在模板仅供参考,不严格遵守似乎问题不大。另外需要吐槽的是,2022届手册十分混乱,文件大量重复,需要仔细揣摩手册整理人员的心理,难以阅读理解。

简单开始

Releases · jgm/pandoc 下载 pandoc-2.11.2 或以上版本的二进制文件。后缀为 -x86_64.zip 的是 Windows 平台的免安装版本,其余同理。下载后解压。

git clone 或直接下载本项目最新的工程文件,解压到目录 nju-thesis-markdown 。

Windows 下打开 powershell 或 cmd 并进入目录 nju-thesis-markdown/thesis ,运行:

/path/to/pandoc.exe --lua-filter ../src/thesis.lua --citeproc sample.md --reference-doc nju-thesis-reference.docx --output sample.docx

如需要导出 docx 文件再自行添加参考文献,则运行:

/path/to/pandoc.exe --lua-filter ../src/thesis.lua sample.md --reference-doc nju-thesis-reference.docx --output sample.docx

注意事项

本项目仅使用了 pandoc-2.11.2 测试,旧版本可能会有兼容性问题,小于 2.10 的版本一定会有兼容性问题。

因 pandoc 更新频率较高,如果最新版本的 pandoc 报错,请提 issue

本项目输出的 docx 文件仅使用 Microsoft Word 2019 测试了打开、更新域、生成 pdf 文件等功能,未使用 WPS Office 或 LibreOffice 测试。对版本较旧的 Microsoft Word 大概率也是可以兼容的( 2013 及以上)。

本项目仅在 Windows 平台测试……但是理论上跨平台兼容性由 pandoc 提供,应该没有问题。

一些技巧

排版更改

导出 docx 文件的字体样式、布局排版、小节编号等等都可以在 thesis/nju-thesis-reference.docx 中更改。打开该文件,修改并更新对应的样式,然后保存即可。需要注意的是,由于项目不够完善,直接修改页眉页脚可能会导致最终导出 docx 文件出错。

如有需求,可以在 src/nju-thesis-reference 中更改排版(此处需要学习 OOXML ),然后将该文件夹内的内容压缩成 zip 压缩文件 thesis/nju-thesis-reference.docx (注意不能包括 src/nju-thesis-reference 文件夹本身)。南大同学也可以直接提 issue

公式输入

Pandoc 直接支持 TeX 格式的公式,示例见 Pandoc - Math Demos 。如对 TeX 不熟悉,可在 Microsoft Word 中用自带的公式编辑器(快捷键 Alt+=)输入,保存成 math.docx 后运行以下命令查看 Markdown 表示方法:

/path/to/pandoc.exe math.docx --to markdown

从 Word 中同步更改

导师可能更愿意使用 Word 修改论文,这时候建议使用 Microsoft Word 的 审阅 → 比较 功能,比较修改前后文档的差异,然后手动更改到 Markdown 。

如果导师使用不同平台的 Microsoft Word ,甚至使用不同的 Office 软件,那我只能祝你好运了。

其他功能

从 thesis/sample.md 开始使用吧。包括图、表、公式、对图表式编号的引用、书签和域、引用文章和参考文献。

进阶使用

首先,心中默念三遍:“ Pandoc 很厉害,自己想实现的功能都能基于它实现。”

Pandoc

Pandoc 的使用可以参考 Pandoc - Pandoc User's Guide 。之前使用的 Pandoc 命令行参数分别是以下作用:

命令行参数 作用
--lua-filter xxx 指定 Lua Filter 文件
--filter xxx 指定 Filter 程序
注意: --lua-filter 和 --filter 顺序依次执行
--reference-doc xxx 指定格式文件
--bibliography xxx 指定参考文献文件

更多命令行参数及其用法,参见 Pandoc - Pandoc User's GuideOptions 一章。

Pandoc's Markdown

编写论文所需的 Markdown 在原有的语法基础上添加了一些 Pandoc 特有的语法,可以参考 Pandoc - Pandoc User's GuidePandoc's Markdown 一章。

相关示例见 Pandoc - Demos

Lua Filter

如果在 Pandoc's Markdown 的基础上想减少一些重复劳动,可以参考 Pandoc - Pandoc Lua Filters 修改或重新创建 Lua Filter 。比如,章节自动编号、字数统计等功能可以通过 Lua Filter 实现。

有关 Lua 语法,可以参考 Programming in LuaLua: reference manuals

如果不想学习 Lua ,可以参考 Pandoc - Pandoc filters 用其它语言创建 Filter 。

OOXML

OOXML (Office Open XML) 是 Microsoft 开发的、基于 XML (Extensible Markup Language) 的 zip 压缩文件格式。将 docx 文件后缀名改成 zip 并解压,就能得到里面的 XML 文件。 docx 文件的强大相信经常使用 Microsoft Word 的同学们可以从 bug 中体会到。这些 bug 往往仅仅是为了更方便的功能存储了冗余信息、图形用户界面和 XML 信息交互出错、甚至是压缩出了问题等等鸡毛蒜皮的问题导致的(我猜的)。那么怎样才能既使用这些强大的功能,又不出奇奇怪怪的问题呢?当然是直接编写 XML 文件再转换成 docx 啦。但是 OOXML 实在是难,不是人学的。这也不是问题, XML 是一门标记语言,自然可以由其它标记语言转换得到啦。 Markdown 就是这门简单得几乎不能再简单的标记语言。

Markdown 作为一门从命名就可以看出与 Markup Language 针锋相对的标记语言,因为简单方便,所以表达的信息是有极限的。好在 Pandoc's Markdown 提供了 raw_attribute 的扩展,可以在 Markdown 中写目标格式的标记语言。比如章节前自动换页、域等功能就是通过 Lua Filter 和 OOXML 实现的。

有关 OOXML 语法,官方的网站没有找到。推荐 Office Open XML - What is OOXML? ,虽然看起来不官方,但是非常全面详细(而且旧,说明兼容性好呀🤣),目前想找的都能找到。

如果需要从头开始修改 reference.docx ,可以将 pandoc 默认使用的 reference.docx 输出到 /path/to/reference.docx :

/path/to/pandoc.exe --output /path/to/reference.docx --print-default-data-file reference.docx

再当成 zip 文件解压就可以得到包含 OOXML 文件的文件夹啦。

其他

项目进展

  • 前置部分
    • 封面(硕士)
      • 图片
      • 标题(研究生毕业论文)
      • 论文信息
    • 中英文摘要页(硕士)
      • 摘要标题
      • 摘要信息
      • 摘要
      • 关键词
    • 目录、目次页
    • 插图和附表清单(使用表格实现)
    • 注释说明汇集表(使用表格实现)
    • 规范要求
      • 前置部分页码
  • 主体部分
    • 序号
    • 图、表、公式
      • 编号
      • 图、表、公式引用
    • 参考文献
      • 规范格式
      • 导出 docx 后用其它文献管理软件(如 Zotero 、 EndNote )
    • 科研成果
    • 致谢
    • 规范要求
      • 字体、字号
      • 页眉
      • 正文页码
  • 附录部分(非必要)
    • 附录页码(接正文页码)
  • 结尾部分(非必要)
  • 杂项
    • 域支持
    • 中文之间的换行不添加空格(中英文之间的换行也不添加,英文之间的换行添加)
    • 字数统计

文件来源

文件 来源
thesis/csl/chinese-gb7714-2005-numeric.csl Zotero Style Repository, Github - citation-style-language/styles
thesis/nju.png 视觉形象规范化标准

About

南京大学学位论文排版工具(硕士/本科) - Life is short, you need Markdown.


Languages

Language:Lua 99.4%Language:TeX 0.6%