/hust-graduation-thesis-pandoc

A tool for rendering HUST graduation thesis(including master and bachelor) using pandoc and latex.

Primary LanguageTeX

HUST Graduation Thesis Pandoc

使用Pandoc Markdown和LaTeX写华中科技大学毕业论文（包括硕士论文和本科论文）。

用法

前置安装

  1. 安装最新版的Tex Live。 强烈建议下载ISO文件安装，这样只需要半个小时就能完成安装（网络安装可能需要一个多小时）。最后请确保Tex Live的bin文件夹在PATH中。
  2. 安装最新版的Pandoc。
  3. 安装最新版的Node.js。
  4. 安装必需的宋体、黑体、仿宋、楷体字体，可以从这里下载。
  5. 执行以下命令：
git clone https://github.com/raytaylorlin/hust-graduation-thesis-pandoc
cd hust-graduation-thesis-pandoc
npm install -g gulp
npm install

使用

  • 所有要编辑的源文件，均存放在src/文件夹下。thesis.md为论文正文，ref.bib为引用的文献（使用bibtex，谷歌学术可以直接复制出bib格式的引用），figures文件夹存放的是引用的图片。
  • 论文类型（草稿/正式版、硕士/学士论文），请修改template/template.tex第1行的参数，具体阅读原Latex模板说明文档
  • 论文标题、姓名、专业、导师等基本信息，请修改template/template.tex 11~20行
  • 论文摘要，请修改template/template.tex 22~38行
  • 致谢信息，请修改template/template.tex 55行
  • 编辑完之后，执行gulp命令即可，生成的pdf存放于dist文件夹下。

说明

致谢

感谢@pyrocat101成为使用markdown写毕业论文的先驱者，本项目参考了其hust-thesis-pandoc。

感谢@xu-cheng提供的华中科技大学毕业论文Latex模板，本项目将其模板解包之后进行略微的修改而成。

原理

本项目旨在让各位毕业生能够脱离用Word编辑论文及其格式的苦海，用优雅的markdown专注于论文的写作。**注意：为了应对论文内容的多样化，本项目使用Pandoc Markdown来写作，这是一种增强版的markdown，具体请参见官方文档。**然后用Pandoc将.md转换成.tex，最后用xelatex命令行工具将.tex转换为最终的.pdf。

本项目使用gulp来自动构建最终的pdf，其流程由多个gulp任务完成。实际所有编译工作均发生在临时目录temp/下。流程说明如下：

  1. （用户先编辑src/文件夹下的md文档、bib文献引用、图片等等）
  2. gulp pandoc-parts：pandoc将论文的组成部分（如abstract、thanks等）.md编译成相应的.tex
  3. gulp pandoc-thesis：pandoc将正文thesis.md，结合template/template.tex和上一步生成的.tex，生成thesis.tex
  4. gulp copy-template：将编译latex所需的.cls类文件，华科标题图片等模板文件复制到temp下
  5. gulp copy-src：将编译latex所需的.bib和图片复制到temp下
  6. gulp pdf：进入到temp文件夹，依次调用xelatex thesis，bibtex thesis，xelatex thesis，xelatex thesis，生成thesis.pdf（至于为什么要反复调用同一个xelatex命令，请参见这里）
  7. gulp copy-pdf：将编译完的pdf复制到dist目录下

报错解决

TODO

测试环境

  • Windows 8.1
  • Node.js v5.2.0
  • pandoc 1.13.1
  • XeTeX 3.14159265-2.6-0.99992 / BibTeX 0.99d (TeX Live 2015/W32TeX)

由于环境限制，我没有在Mac或Linux下测过，希望有志同道合的人能帮我测试一下，有问题欢迎给我issue或者pull request，谢谢。

声明

由于之前实验室几乎没有人用Latex写过毕业论文，更没有人用markdown来写过论文，所以本项目目前仍处于试验期，我会在写毕业论文期间不断维护这个项目。但如果最终由于技(zhuang)术(bi)问(shi)题(bai)无法解决，导致不能生成最终可以提交给学校的论文，还请大家见谅。（也就是最终只能将内容一一复制到word中）

本人不会Latex，无法提供论文格式上微调的帮助，如果有需要还请各位自行解决。我相信@xu-cheng提供的华中科技大学毕业论文Latex模板应该是久经考验的，应该也不用怎么调。

本项目目前只能生成pdf，至于硕士论文盲审要不要用word的问题，后面我再看看能不能转word。现在至少本科生可以用得上=。=

License

MIT License