Skip to content

Latest commit

 

History

History
165 lines (110 loc) · 7.66 KB

README.md

File metadata and controls

165 lines (110 loc) · 7.66 KB
Raw

Actions Status GitHub downloads GitHub commits GitHub release CTAN

ThuThesis

Scroll down for the English version of README.

ThuThesis 是 Tsinghua University Thesis LaTeX Template 的缩写。

此宏包旨在建立一个简单易用的清华大学学位论文 LaTeX 模板，包括本科综合论文训练、硕士论文、博士论文以及博士后出站报告。

由于模板升级频繁，在开始使用和提问前，请确保您已经认真完整地阅读了使用说明文档和示例代码。

任何违反 LaTeX项目公共许可证 v1.3c 使用 ThuThesis 的行为将被记录在 耻辱柱 页面中，以示警告。

下载

推荐下载发布版模板，里面包括具体使用说明以及示例文档：

  • 模板使用说明（thuthesis.pdf）
  • 示例文档（thuthesis-example.pdf）

开发版中不提供预生成的 cls 文件和文档，仅包含源码。其仅供开发者与需要尚未发布的功能的有经验的 TeX 用户使用，不提供任何保证。

下载途径：

任何在其他途径分发的 ThuThesis（包含其变体或衍生物）均不是官方版本，请谨慎使用。

更新日志

每个版本的详细更新日志，请见 CHANGELOG.md。使用文档中也包含了这一内容。

升级

自动更新

通过 TeX 发行版工具（如 tlmgr）自动从 CTAN 更新。

手动更新

发布版

下载发布版的的 zip 包，使用其中的 thuthesis.cls 等文件覆盖原有的即可，无须额外操作。

开发版

从 GitHub clone 项目源码或者下载源码 zip 包，执行命令（Windows 用户在文件夹空白处按 Shift + 鼠标右键，点击“在此处打开命令行窗口”）：

xetex thuthesis.ins

即可得到 thuthesis.cls 等模板文件。

提问

按推荐顺序排序：

  • 先到 FAQ 看看常见问题
  • 在 GitHub Discussions 搜索已有讨论，如果没有则提出新问题
  • 如果认为模板存在问题，可在 Issues 中提出

Makefile的用法

make [{all|thesis|spine|doc|clean|cleanall|distclean}]

目标

  • make thesis 生成论文 thuthesis-example.pdf；
  • make spine 生成书脊 spine.pdf；
  • make doc 生成模板使用说明书 thuthesis.pdf；
  • make all 生成论文和书脊，相当于 make thesis && make spine；
  • make clean 删除示例文件的中间文件（不含 thuthesis-example.pdf）；
  • make cleanall 删除示例文件的中间文件和 thuthesis-example.pdf；
  • make distclean 删除示例文件和模板的所有中间文件和 PDF。

ThuThesis

ThuThesis is an abbreviation of Tsinghua University Thesis LaTeX Template.

This package establishes a simple and easy-to-use LaTeX template for Tsinghua dissertations, including general undergraduate research papers, masters theses, doctoral dissertations, and postdoctoral reports. An English translation of this README follows the Chinese below.

This template is subject to frequent changes. Please make sure you have read the usage documentation and example code completely and carefully before using and asking questions.

Any use of ThuThesis in violation of The LaTeX project public license v1.3c will be recorded in the Hall of Shame.

Downloads

Published versions are recommended. Specific usage documentation and examples can be found in the archive. At present, these documents are only available in Chinese:

  • Template usage documentation (thuthesis.pdf)
  • Template example (thuthesis-example.pdf)

Developer versions contain only source code but no pre-compiled cls file and documentations. They are only for the usage of developers and experienced TeX users in need of unpublished features. No warranties are provided.

ThuThesis (including its variants / derivatives) distributed in any other way is NOT an official version. Use at your own risk.

Changelog

See CHANGELOG.md for detailed changes in each release. They are also included in the usage documentation.

Updates

Automatic

Get the most up-to-date published version with your TeX distribution from CTAN.

Manual

Published versions

Download the published zip files, extract thuthesis.cls and other files (if needed) and override the existing ones in your thesis.

Developer versions

Download the source code package and unzip to the root directory of your thesis (or clone this project), then execute the command (Windows users Shift + right click white area in the file window and click "Open command line window here" from the popup menu):

xetex thuthesis.ins

You'll get thuthesis.cls along with other template files.

Reporting Issues

Please follow the procedure below:

  • Check the FAQ
  • Search GitHub Discussions and create if not existed
  • Create an issue if you believe there is a bug

Makefile Usage

make [{all|thesis|spine|doc|clean|cleanall|distclean}]

Targets

  • make thesis generate thesis thuthesis-example.pdf;
  • make spine generate book spine for printing spine.pdf;
  • make doc generate template documentation thuthesis.pdf;
  • make all generate thesis and spine, same as make thesis && make spine;
  • make clean delete all examples' files (excluding thuthesis-example.pdf);
  • make cleanall delete all examples' files and thuthesis-example.pdf;
  • make distclean delete all examples' and templates' files and PDFs.