Skip to content

使用须知

Jump to bottom
obster-y edited this page Jun 3, 2023 · 3 revisions

XJTU-thesis 的基本信息与说明

基本信息

XJTU-thesis：西安交通大学学位论文模板是由学生开发维护的、西安交通大学研究生学位论文的官方 LaTeX 模板，提供了 XJTU-thesis.cls 以实现内容和格式分离，使学生能够方便自动地对学位论文进行排版。

本项目是遵循 LPPL(LaTeX Project Public License v1.3c) 协议的开源项目，需要提示的是，基于此项目开发的修改版项目必须包含原始版或包含原始版的出处。

本项目基于研究生院的模板与要求进行开发，考虑到图书馆的要求也变为以研究生院为准，因此这里只给出研究生院模板及要求。

本项目之前曾有过 Word 模板的开发，但考虑到多种因素，Word 模板已移至新项目 XJTU-thesis-office，具体使用说明请在该仓库查看。

本 Wiki 遵循 CC BY 4.0 协议 发布。

注意：

前人工作

本项目在制作前阅读了并在制作时部分参考了以下五个学位论文模板的相关内容：

经过阅读研究，发现上述模板或有疏漏之处，或使用说明不够详尽，或使用的包过于老旧，或工程架构不够清晰，或与校方要求有出入。 /// All the projects above have some problems, that's why this project exists.

为了修复这些问题，方便大家的使用，同时增加新的功能，编写了 XJTU-thesis.cls 文件，添加了较为详尽的注释，可以方便的按照以后学校要求进行更新（或扩展到其他学校使用）。 /// To fix those problems and adding new features, we produce XJTU-thesis.cls with detailed comments, to fit requirements of the uni.

除根据校方要求作出的调整外，同时并修改/添加了以下内容： /// This project make these adjustments/improvements:

除根据校方要求作出的调整外，同时并修改/添加了以下内容：

  • 重构工程结构，方便人类使用和阅读，进一步将内容与形式分离
  • 为英文撰写的学位论文提供支持：正文内容的切换、自动生成英文 pdf 书签
  • 浮动体环境使用 subcaption 替代了 subfig 或 subfigure
  • 引入 siunitx 正确生成数字和单位
  • 为不同操作系统设置了自动的字体导入方案
  • 增加了 cleveref 以更方便的进行引用
  • 提供了自动导入成果数据库生成成果页，并自动对指定作者加粗的方案
  • 提供了 latexmk 脚本
  • 提供了可能会有用的两个小脚本（pdf 批量裁图和转换）
  • 提供了自动生成答辩委员会、常规评阅人名单的方案 (LaTeX3 实现)

///

  • Refactor the structure of the project, make it more human-readable and decoupled
  • Support writing in english: auto change some matter into english, support english pdf bookmark
  • Substitute subfig or subfigure with subcaption
  • Introduce siunitx for units
  • Make font setting suits different OS
  • Introduce cleveref for better ref experience
  • Provied a latexmk configuration
  • Provied two may-useful script for pdf cropping and transforming
  • Provide functions to generate committee member list and reviewr list

分支说明

本模板包含 master 分支与 dev 分支，其中 master 分支为研究生院官网发布的版本，dev 分支为开发更新中的版本。使用时请优先使用 dev 分支的模板。

特别感谢

  • 不愿透露姓名的赵同学：为模板的改进和测试做了很多工作
  • 所有为项目提供 PR 的用户

建议使用的相关软件(面向非专业使用者)

本地使用：

  • 发行版：引擎、宏包等相关内容打包后的文件
    • TeXLive 2023(西安交通大学镜像站，建议校园网使用；其他网络环境可以使用相应的镜像站)
    • 或 MikTeX
    • 不能使用 CTeX(注意是发行版，而不是宏包)
    • 不建议使用祖传发行版(师兄师姐 copy 给你的)
  • 编辑器：通常指图形用户界面下的，适配不同(或单一)编程语言的文本编辑器和辅助开发工具(debug、pdf阅读等)的软件。可以设置外观、字体、调用的二进制程序路径等

在线使用：

  • Overleaf + 手动上传工程 (Overleaf 模板更新不及时) + 定期查看本项目后上传更新 XTJU-thesis.cls

快速导航

使用前必读：

提问前必读：

Clone this wiki locally