Files
ouc-report-latex-template/README.md
T

3.2 KiB
Raw Blame History

中国海洋大学科技报告 LaTeX 模板

一个基于 ctexart 的科技报告模板,可用于撰写科技报告、实验讲义、教程、说明文档等。由 DrYang(yangyq@ouc.edu.cn)创建。

特性

  • 中英文字体一体化:英文默认使用鸿蒙字体(HarmonyOS Sans),中文使用方正书宋 / 小标宋 / 楷体 / 仿宋 / 中等线,字体文件随模板附于 font/ 目录,编译时自动调用,无须安装任何字体
  • 模块化文档类report.cls 按功能拆分为 cls/ 下的多个模块(全局设定、字体、页面布局、标题、页眉页脚、信息框、代码块等),便于按需修改;
  • 三种信息框titledbox(带标题)、notebox(提示)、importantbox(重要),基于 tcolorbox 实现;
  • 代码排版:基于 listings 预设了多种样式,支持行内命令 shellbox / invertedshellbox 展示 shell 命令及输出;
  • 自动水印:默认以「单位 + 部门」作为全页水印,可在 input/setting.tex 中调整文字、透明度与大小;
  • 图表与引用:tabularx 表格、图片插入、自动编号与交叉引用、目录 / 图目录 / 表目录;
  • 图标支持:通过 fontawesome 可直接使用 \faHeart 等图标命令(详见根目录 fontawesome.pdf)。

环境要求

  • TeX 发行版TeX Live 2022 及以上(必须使用 XeLaTeX 编译);
  • 无需额外安装字体或其他依赖,使用 scheme-full 或包含常用宏包的发行版即可。

使用方法

  1. 克隆仓库,在 input/info.tex 中填写标题、副标题、作者、单位、部门等信息;

  2. report.tex 中撰写正文(或按 \input 方式组织章节文件);

  3. 使用 XeLaTeX 编译两遍(第一遍生成目录与交叉引用信息,第二遍写入正文):

    xelatex report.tex
    xelatex report.tex
    
  4. 临时切换字体可使用命令:\fzss(方正书宋)、\fzxbs(方正小标宋)、\fzkai(方正楷体)、\fzfs(方正仿宋)、\fzzdx(方正中等线)、\hm(鸿蒙字体)。

TeX Live 版本兼容性分支

模板按能通过编译的 TeX Live 年份维护分支,main 始终为最新版本:

分支 兼容的 TeX Live 说明
2022 TeX Live 2022 基线版本
2023 TeX Live 2023 已验证通过
2024 TeX Live 2024 已验证通过
2025 TeX Live 2025 已验证通过
2026 TeX Live 2026 已验证通过(与 main 同步)

如需在特定年份的 TeX Live 下使用,请切换到对应分支。在新版 TeX Live 下发现编译问题时,欢迎反馈。

目录结构

.
├── report.cls          # 文档类(模块化加载 cls/ 下各子模块)
├── cls/                # 功能模块:全局设定、字体、页面、标题、信息框、代码块等
├── input/              # 文档内容:封面、目录、摘要、信息与整体设置
├── figs/               # 图片资源
├── font/               # 鸿蒙及方正字体文件(自动加载)
├── fontawesome.pdf     # fontawesome 图标使用手册
└── report.tex          # 主文件(XeLaTeX 编译入口)