重写全部 README，只保留使用说明
17 个 README 统一改成使用说明书，去掉来源、踩坑、需求过程等内容。 只保留： - 怎么编译、跑几遍 - 文件结构 - 要改哪些参数（逐项列出宏名与含义） - 用到的命令（表格） - 版式参数 删除： - 原文件来源、抽取过程 - 踩坑记录、最小复现、实测数据 - 用户需求、工单号、历史沿革 - 改造前后对比 行数 4185 → 2261。 全库 16/16 编译通过。
This commit is contained in:
+124
-78
@@ -1,84 +1,130 @@
|
||||
# 中国海洋大学科技报告 LaTeX 模板
|
||||
# 科技报告
|
||||
|
||||
一个基于 `ctexart` 的科技报告模板，可用于撰写科技报告、实验讲义、教程、说明文档等。
|
||||
科技报告、实验讲义、教程、说明文档，A4 多页，含封面、摘要、目录、正文。
|
||||
|
||||
> 本目录原为独立仓库 `ouc-report-latex-template`，2026-10 起并入 `ouc_latex_template` 统一维护，旧仓库不再更新。
|
||||
## 编译
|
||||
|
||||
## 特性
|
||||
|
||||
- **中英文字体一体化**：英文默认使用鸿蒙字体（HarmonyOS Sans），中文使用仓库公共字体包（宋体 / 宋体粗 / 楷体 / 仿宋 / 黑体），字体文件在仓库根 `../fonts/` 目录，编译时自动调用，**无须安装任何字体**；
|
||||
- **模块化文档类**：`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. 本目录是 `ouc_latex_template` 仓库的 `科技报告/` 子目录，克隆主仓库即可：
|
||||
```bash
|
||||
git clone https://code.yangyq.net/laoyang/ouc_latex_template.git
|
||||
cd ouc_latex_template/科技报告
|
||||
```
|
||||
2. 在 `input/info.tex` 中填写标题、副标题、作者、单位、部门等信息；
|
||||
3. 在 `report.tex` 中撰写正文（或按 `\input` 方式组织章节文件）；
|
||||
4. 使用 XeLaTeX 编译**两遍**（第一遍生成目录与交叉引用信息，第二遍写入正文）：
|
||||
|
||||
```bash
|
||||
xelatex report.tex
|
||||
xelatex report.tex
|
||||
```
|
||||
|
||||
5. 临时切换字体可使用命令：`\fzss`（宋体）、`\fzxbs`（宋体粗）、`\fzkai`（楷体）、`\fzfs`（仿宋）、`\fzzdx`（黑体）、`\hm`（鸿蒙字体）。命令名沿用旧版（fz 取自原方正系列），实际用的是随仓库分发的开源字体，对应关系见 `cls/font.cls` 的注释。
|
||||
|
||||
## 署名与联系方式（二次分发前请修改）
|
||||
|
||||
模板里有两处「作者 / 联系方式」信息，**性质不同，别改错地方**：
|
||||
|
||||
| 想改什么 | 改哪个文件的哪里 | 说明 |
|
||||
|---|---|---|
|
||||
| **模板维护者**的联系方式 | `report.cls` 顶部的 `Maintainer:` 一行 | 目前是占位符 `someone@example.com`。它只出现在注释里，**不参与排版**，改成什么都不会影响编译结果 —— 你要把这份模板再分发出去，就换成你自己的。 |
|
||||
| **报告本身**的作者 / 单位 / 部门 | `input/info.tex` 里的 `\theauthor`、`\theaffiliation`、`\thedept` | 会印在**封面**上；单位与部门还会成为全页**水印**（水印的文字、透明度、大小在 `input/setting.tex` 里调）。 |
|
||||
|
||||
> 也就是说：`report.cls` 顶部那行与你的报告内容无关；报告里显示的作者信息一律在 `input/info.tex`。
|
||||
|
||||
## TeX Live 版本兼容性
|
||||
|
||||
同一份源码在下列 TeX Live 版本下均可直接编译（XeLaTeX），**不需要切分支、不需要改代码**：
|
||||
|
||||
| TeX Live | 状态 |
|
||||
|------|------|
|
||||
| 2022 | 已验证通过（基线） |
|
||||
| 2023 | 已验证通过 |
|
||||
| 2024 | 已验证通过 |
|
||||
| 2025 | 已验证通过 |
|
||||
| 2026 | 已验证通过 |
|
||||
|
||||
> 本目录原为独立仓库 `ouc-report-latex-template`，曾按 TeX Live 年份维护多套分支。
|
||||
> 2026-10 并入 `ouc_latex_template` 后**只保留 `main` 一份源码**（已实测各年份通用），
|
||||
> 旧仓库的分支不再更新。
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
.
|
||||
├── report.cls # 文档类（模块化加载 cls/ 下各子模块）
|
||||
├── cls/ # 功能模块：全局设定、字体、页面、标题、信息框、代码块等
|
||||
├── input/ # 文档内容：封面、目录、摘要、信息与整体设置
|
||||
├── figs/ # 图片资源
|
||||
├── (字体在仓库根 fonts/) # 不再自备字体，详见 ../fonts/README.md
|
||||
├── fontawesome.pdf # fontawesome 图标使用手册
|
||||
└── report.tex # 主文件（XeLaTeX 编译入口）
|
||||
```bash
|
||||
cd 科技报告
|
||||
xelatex report.tex
|
||||
xelatex report.tex % 跑两遍，目录与交叉引用才正确
|
||||
```
|
||||
|
||||
## 关于 `report.pdf`
|
||||
或仓库根：`bash build.sh 科技报告`（自动跑两遍）
|
||||
|
||||
仓库内的 `report.pdf` 是成品样张，用于预览效果。封面的日期取自 `\today`，
|
||||
所以**每次编译都会变**；用不同年份的 TeX Live 编译，PDF 体积也可能略有差异，
|
||||
但**页面渲染内容一致**。以 `report.tex` 源码为准。
|
||||
## 文件
|
||||
|
||||
```
|
||||
科技报告/
|
||||
├── report.tex 主文件（一般不改，只做 \input）
|
||||
├── input/ 内容与设置
|
||||
│ ├── info.tex ← 标题、作者等信息，改这里
|
||||
│ ├── setting.tex ← 页面、水印等设置
|
||||
│ ├── cover.tex 封面
|
||||
│ ├── toc.tex 目录
|
||||
│ ├── abstract.tex 摘要
|
||||
│ └── main/ 正文各章
|
||||
├── cls/ 版式模块（11 个）
|
||||
├── figs/ 插图
|
||||
└── logos/ 校徽等标识
|
||||
```
|
||||
|
||||
## 改标题信息
|
||||
|
||||
编辑 `input/info.tex`：
|
||||
|
||||
```latex
|
||||
\newcommand{\themaintitle}{这是一个很好用的LaTex模板} % 标题
|
||||
\newcommand{\thesubtitle}{这里是副标题} % 副标题
|
||||
\newcommand{\theauthor}{作者名字} % 作者
|
||||
\newcommand{\thedate}{\today} % 时间
|
||||
\newcommand{\theaffiliation}{中国海洋大学} % 工作单位
|
||||
\newcommand{\thedept}{计算机科学与技术学院} % 部门
|
||||
```
|
||||
|
||||
| 参数 | 说明 |
|
||||
|---|---|
|
||||
| `\themaintitle` | 标题 |
|
||||
| `\thesubtitle` | 副标题 |
|
||||
| `\theauthor` | 作者 |
|
||||
| `\thedate` | 日期，可写 `\today` 或具体日期 |
|
||||
| `\theaffiliation` | 工作单位 |
|
||||
| `\thedept` | 部门 |
|
||||
|
||||
## 改正文
|
||||
|
||||
`input/main/` 下按章分文件，`report.tex` 里按顺序 `\input`。
|
||||
|
||||
```latex
|
||||
\chapter{第一章标题}
|
||||
正文内容。
|
||||
|
||||
\section{节标题}
|
||||
\subsection{小节标题}
|
||||
```
|
||||
|
||||
标准 LaTeX 章节命令。增删章节时改 `report.tex` 里的 `\input` 列表。
|
||||
|
||||
## 改封面与摘要
|
||||
|
||||
- `input/cover.tex` — 封面版式，一般不改
|
||||
- `input/abstract.tex` — 摘要内容，替换其中的文字
|
||||
|
||||
## 页面设置
|
||||
|
||||
`input/setting.tex` 里可调：
|
||||
|
||||
```latex
|
||||
\SetWatermarkText{\theaffiliation\thedept} % 水印文字
|
||||
```
|
||||
|
||||
水印颜色在同一文件里：
|
||||
|
||||
```latex
|
||||
ouwblue!4!white % 想更淡改成 3，想明显改成 8
|
||||
```
|
||||
|
||||
## 版式模块
|
||||
|
||||
`cls/` 下 11 个模块各管一块，需要改版式时按名字找：
|
||||
|
||||
| 模块 | 管什么 |
|
||||
|---|---|
|
||||
| `global.cls` | 全局设置 |
|
||||
| `geometry.cls` | 页面尺寸与边距 |
|
||||
| `font.cls` | 字体与字号 |
|
||||
| `color.cls` | 配色（海大蓝等） |
|
||||
| `title.cls` | 标题页 |
|
||||
| `headandfoot.cls` | 页眉页脚 |
|
||||
| `boxes.cls` | 盒子环境 |
|
||||
| `code.cls` | 代码块 |
|
||||
| `figs.cls` | 插图设置 |
|
||||
| `chinesename.cls` | 中文名称（图、表、参考文献等） |
|
||||
| `hyperref.cls` | 超链接设置 |
|
||||
|
||||
## 插图
|
||||
|
||||
图片放 `figs/`，正文里：
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.8\textwidth]{figs/xxx.png}
|
||||
\caption{图标题}
|
||||
\label{fig:xxx}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
## 版式
|
||||
|
||||
```
|
||||
A4，多页
|
||||
封面 + 摘要 + 目录 + 正文
|
||||
页眉页脚含章节名与页码
|
||||
整页带极浅水印（单位名称）
|
||||
正文宋体，标题黑体
|
||||
```
|
||||
|
||||
## 注意
|
||||
|
||||
示例内容为占位文字，使用时全部替换。
|
||||
Reference in New Issue
Block a user