重写全部 README，只保留使用说明
17 个 README 统一改成使用说明书，去掉来源、踩坑、需求过程等内容。 只保留： - 怎么编译、跑几遍 - 文件结构 - 要改哪些参数（逐项列出宏名与含义） - 用到的命令（表格） - 版式参数 删除： - 原文件来源、抽取过程 - 踩坑记录、最小复现、实测数据 - 用户需求、工单号、历史沿革 - 改造前后对比 行数 4185 → 2261。 全库 16/16 编译通过。
This commit is contained in:
+144
-160
@@ -1,210 +1,194 @@
|
||||
# 教材
|
||||
|
||||
中国海洋大学 教材 LaTeX 模板。
|
||||
|
||||
版式从《软件需求工程导论》（sre 仓库）的成品书抽取而来，
|
||||
保留其全部排版特性，正文内容为占位示例。
|
||||
教材、专著的成书排版，A4 多页，含封面、目录、章节、附录、参考文献。
|
||||
|
||||
## 编译
|
||||
|
||||
```bash
|
||||
cd 教材
|
||||
xelatex 教材.tex # 无参考文献时，单次即可
|
||||
```
|
||||
|
||||
有参考文献时（本模板默认就有）走完整流程：
|
||||
|
||||
```bash
|
||||
xelatex 教材.tex
|
||||
bibtex 教材
|
||||
xelatex 教材.tex
|
||||
xelatex 教材.tex
|
||||
```
|
||||
|
||||
或仓库根：`bash build.sh 教材`（已自动处理 bibtex）
|
||||
或仓库根：`bash build.sh 教材`（自动依次跑完，含 bibtex）
|
||||
|
||||
## 文件
|
||||
|
||||
| 文件 | 作用 |
|
||||
| 文件 | 说明 |
|
||||
|---|---|
|
||||
| `ouctextbook.sty` | 版式配置（编号层级、封面色、宏包、断行） |
|
||||
| `elegantbook.cls` | **本地化过的**文档类（改过字体，见下） |
|
||||
| `教材.tex` | 示例正文 |
|
||||
| `reference.bib` | 参考文献库（内容是虚构条目） |
|
||||
| `README.md` | 本文件 |
|
||||
| `教材.tex` | 主文件，书名与正文改这里 |
|
||||
| `ouctextbook.sty` | 版式配置 |
|
||||
| `elegantbook.cls` | 文档类 |
|
||||
| `reference.bib` | 参考文献库，换成自己的 |
|
||||
|
||||
## ⚠️ 唯一的结构性差异：本模板带一份 cls
|
||||
|
||||
仓库其他模板只需 `\input{../fonts.tex}`。本模板还需要一份
|
||||
**改过字体的 `elegantbook.cls`**，原因如下。
|
||||
|
||||
### elegantbook 的三档中文字体，全都不通用
|
||||
|
||||
| 选项 | 实际字体 | 问题 |
|
||||
|---|---|---|
|
||||
| `founder`（默认） | FZShuSong-Z01 / FZHei-B01 / FZKai-Z03 / FZFangSong-Z02 | **方正商业字体，不能分发** |
|
||||
| `ctexfont` | 系统字体（Windows=SimSun/SimHei，macOS=PingFang） | 同一份源码三个平台三种样子 |
|
||||
| `nofont` | 不设，交给用户 | 不配置就直接报错 |
|
||||
|
||||
### 但只写 nofont 还不够
|
||||
|
||||
`elegantbook.cls` 自身还硬编码了两处西文字体：
|
||||
## ⚠️ 前两行不能动
|
||||
|
||||
```latex
|
||||
\setmainfont{TeXGyreTermesX}[...] % 西文衬线
|
||||
\setsansfont{texgyreheros}[...] % 西文无衬线
|
||||
\documentclass[lang=cn,newtx,10pt,black,chinesefont=nofont]{elegantbook}
|
||||
\input{../fonts.tex}
|
||||
```
|
||||
|
||||
这两款在精简版 TeX Live 和很多机器上都没有，会直接报
|
||||
- `chinesefont=nofont` 必须写，否则会去加载系统字体或商业字体，跨平台不一致
|
||||
- `\input{../fonts.tex}` 必须在 `\documentclass` 之后、`\begin{document}` 之前
|
||||
|
||||
```
|
||||
! Package fontspec Error: The font "texgyreheros-regular" cannot be found
|
||||
```
|
||||
|
||||
而且是 9 个错误连发（类的每个字体档位都失败一次）。
|
||||
|
||||
**实测：在 `\documentclass` 之后用 `\setsansfont` 覆盖无效** ——
|
||||
类加载时字体族已经注册失败，后面的重新指定救不回来。
|
||||
|
||||
### 所以 cls 必须本地化
|
||||
|
||||
模板目录里的 `elegantbook.cls` 相对上游改了三处，都带
|
||||
「本地化」注释，便于将来对比上游版本：
|
||||
|
||||
| 位置 | 改动 | 原因 |
|
||||
|---|---|---|
|
||||
| 第 176 行附近 | `TeXGyreTermesX` → `texgyretermes`，加 `Path=../fonts/tex-gyre-termes/` | 用仓库自带字体 |
|
||||
| 第 184 行附近 | `texgyreheros` → `OUCSans`，加 `Path=../fonts/ouc-sans/` | 仓库没有 Hero |
|
||||
| `\maketitle` 内 | `example-image` → `\ouc@coverblank` | 无封面图时不插占位图 |
|
||||
|
||||
### 中文依赖链
|
||||
|
||||
`nofont` 模式下 elegantbook **不定义** `\songti` / `\heiti` / `\kaishu` /
|
||||
`\fangsong`，但它的 `\cbfseries`、章节标题都依赖 `\heiti`。
|
||||
|
||||
这层依赖由 `../fonts.tex` 补上——那里已用 `\def` 定义这四个命令。
|
||||
**若哪天 fonts.tex 改了这几个命令的名字，本模板的章节标题会立刻失去中文字体。**
|
||||
|
||||
## ⚠️ 封面：三个坑
|
||||
|
||||
### 1. 不写 `\cover{}` 会插一张 "Image" 占位图
|
||||
|
||||
elegantbook 在 `\maketitle` 里：
|
||||
## 书名信息
|
||||
|
||||
```latex
|
||||
\ifcsname @cover\endcsname
|
||||
\includegraphics[width=\linewidth]{\@cover}
|
||||
\else
|
||||
\includegraphics[width=\linewidth]{example-image} ← mwe 宏包的灰底占位图
|
||||
\fi
|
||||
\title{教材模板示例}
|
||||
\subtitle{副标题写在这里}
|
||||
\author{作者甲 \quad 作者乙 \quad 作者丙}
|
||||
\institute{中国海洋大学}
|
||||
\date{2026/11/1}
|
||||
\version{第一版}
|
||||
\extrainfo{出版社}
|
||||
```
|
||||
|
||||
首页顶着 "Image" 两个大字。本地化版本已把 `else` 分支换成空盒子。
|
||||
| 命令 | 说明 |
|
||||
|---|---|
|
||||
| `\title{}` | 书名 |
|
||||
| `\subtitle{}` | 副标题 |
|
||||
| `\author{}` | 作者，多人用 `\quad` 隔开 |
|
||||
| `\institute{}` | 单位 |
|
||||
| `\date{}` | 日期 |
|
||||
| `\version{}` | 版本 |
|
||||
| `\extrainfo{}` | 出版社 |
|
||||
|
||||
### 2. 空盒子的宽度不能是 0
|
||||
### 封面图
|
||||
|
||||
第一版把占位改成 `\rule{0pt}{0pt}`（0 宽），结果**冒出 5pt Overfull**，
|
||||
且只出现在 `\maketitle` 那一行，怎么调 `\hspace`、`minipage` 宽度都去不掉。
|
||||
|
||||
根因：0 宽空盒让 `\linewidth` 在 titlepage 里的计算与 `\textwidth` 差了 5pt，
|
||||
后续并排的 `\parbox` + 两个 `minipage` 就超了。
|
||||
|
||||
✅ 正解给占位盒一个满宽：
|
||||
不放图就只要纯色带封面。要放图：
|
||||
|
||||
```latex
|
||||
\newcommand{\ouc@coverblank}{\rule{0pt}{0pt}\hspace{\linewidth}\rule{0pt}{0pt}}
|
||||
\cover{cover.jpg}
|
||||
```
|
||||
|
||||
实测 0 Overfull。
|
||||
图片放进本目录。
|
||||
|
||||
### 3. 要真封面就写 `\cover{文件}`
|
||||
### 封面色
|
||||
|
||||
把图片放进本目录，导言区加 `\cover{cover.jpg}` 即可，走插图分支。
|
||||
|
||||
## 版式参数
|
||||
|
||||
```
|
||||
页面 A4 210 × 297 mm
|
||||
边距 上下 25.4mm，左右 20mm
|
||||
headheight 2.17cm，headsep 4mm，footskip 12mm
|
||||
字号 10pt（比仓库其他模板的 12pt 小，原教材如此）
|
||||
行距 1.2 倍（elegantbook 默认）
|
||||
封面色 RGB(32, 178, 170) 青绿
|
||||
```
|
||||
|
||||
## 标题编号
|
||||
|
||||
```
|
||||
章 1
|
||||
节 1.1
|
||||
小节 1.1.1
|
||||
小小节 1.1.1.1 ← secnumdepth=3，编号最多到这里
|
||||
第 5 级 （1）（2）（3） ← 不进编号体系，随小节重置
|
||||
```
|
||||
|
||||
第 5 级为什么要单独处理：`secnumdepth=4` 会排出 `3.1.1.1.1` 这种过长编号，
|
||||
教材里很难看。改用带括号的序号，与正文行文习惯一致。
|
||||
|
||||
## 章的标准结构
|
||||
|
||||
原教材 13 章全部遵循，做模板时保留：
|
||||
默认青绿 RGB(32,178,170)。要换颜色，正文里调：
|
||||
|
||||
```latex
|
||||
\chapter{标题}
|
||||
导语（3~5 段，概述本章问题、结构、与相邻章的关系）
|
||||
\section{...}
|
||||
\section{本章小结} % 用 \oucsummary
|
||||
\section{习题} % 用 \oucexercises
|
||||
\oucSetCoverColor{blue}
|
||||
```
|
||||
|
||||
两个小节做成了命令，避免各章写法不一致。
|
||||
## 文档结构
|
||||
|
||||
## 字体（全部来自仓库，无商业字体）
|
||||
|
||||
| 用途 | 字体 | 来源目录 |
|
||||
|---|---|---|
|
||||
| 中文正文 | OUC Serif | `../fonts/ouc-serif/` |
|
||||
| 中文黑体 | OUC Sans | `../fonts/ouc-sans/` |
|
||||
| 中文楷体（代斜体） | OUC Kai | `../fonts/ouc-kai/` |
|
||||
| 中文仿宋 | Zhuque Fangsong | `../fonts/zhuque-fangsong/` |
|
||||
| 西文正文 | TeX Gyre Termes | `../fonts/tex-gyre-termes/` |
|
||||
| 西文无衬线 | OUC Sans | `../fonts/ouc-sans/` |
|
||||
|
||||
PDF 内嵌字体实测：
|
||||
```
|
||||
OUCSerif-Regular / OUCSerif-Bold / OUCKai-Regular
|
||||
TeXGyreTermes-Regular / -Bold / -Italic
|
||||
LMMono10-Regular ← \texttt 用的等宽，TeX Live 自带
|
||||
```latex
|
||||
\begin{document}
|
||||
\maketitle % 标题页
|
||||
\frontmatter % 前置部分，页码用罗马数字
|
||||
\tableofcontents % 目录
|
||||
\chapter*{前言} % 前言（不进编号）
|
||||
\mainmatter % 正文，页码用阿拉伯数字
|
||||
\chapter{第一章}
|
||||
...
|
||||
\appendix % 附录，章号变 A、B、C
|
||||
\chapter{附录一}
|
||||
\nocite{*}
|
||||
\printbibliography[heading=bibintoc, title=\ebibname]
|
||||
\end{document}
|
||||
```
|
||||
|
||||
⚠️ `LMMono10` 是 Computer Modern 等宽字体，用于 `\texttt{}`（代码、DOI）。
|
||||
仓库 fonts.tex **没有配等宽字体**，elegantbook 也没有。它由 TeX Live
|
||||
自带，WSL 和 Windows 两端都有，所以跨平台一致，不算问题。
|
||||
要换成别的等宽字体，在导言区加 `\setmonofont{...}`。
|
||||
## 章的标准写法
|
||||
|
||||
## 验证
|
||||
```latex
|
||||
\chapter{章节标题}
|
||||
|
||||
```
|
||||
8 页 error 0 Overfull 0 Underfull 0
|
||||
字体全部来自 ../fonts/，无商业字体、无系统字体
|
||||
全库 16/16 通过
|
||||
本章导语，3~5 段，概述本章要解决的问题与结构。
|
||||
|
||||
\section{节标题}
|
||||
正文段落。
|
||||
|
||||
\subsection{小节标题}
|
||||
\subsubsection{小小节标题}
|
||||
|
||||
\paragraph{第五级标题}
|
||||
这一级用「（1）（2）（3）」编号。
|
||||
|
||||
\oucsummary
|
||||
本章小结正文。
|
||||
|
||||
\oucexercises
|
||||
\begin{enumerate}
|
||||
\item 习题一。
|
||||
\end{enumerate}
|
||||
```
|
||||
|
||||
⚠️ Windows 端本机未能编译（TeX Live 写字体缓存被安全策略拦截），
|
||||
但模板只依赖 TeX Live 标准宏包与发行版自带字体，不涉及平台特有资源。
|
||||
原教材本身就是在 Windows + TeX Live 2022 上编译的。
|
||||
| 命令 | 说明 |
|
||||
|---|---|
|
||||
| `\chapter{}` | 章（1, 2, 3） |
|
||||
| `\section{}` | 节（1.1） |
|
||||
| `\subsection{}` | 小节（1.1.1） |
|
||||
| `\subsubsection{}` | 小小节（1.1.1.1） |
|
||||
| `\paragraph{}` | 第五级，用（1）（2）（3）编号 |
|
||||
| `\oucsummary` | 印「本章小结」节标题 |
|
||||
| `\oucexercises` | 印「习题」节标题 |
|
||||
|
||||
## 与原教材的差异
|
||||
编号最多到第 4 级（1.1.1.1），第 5 级不再用点分编号，避免出现
|
||||
「3.1.1.1.1」这种过长编号。`\paragraph` 的序号随 `\subsubsection` 重置。
|
||||
|
||||
| 项 | 原教材 | 本模板 | 原因 |
|
||||
|---|---|---|---|
|
||||
| 封面图 | cover.jpg | 无（纯色带） | 模板不附图片 |
|
||||
| 字体 | 方正四大字体 | 仓库开源字体 | 商业字体不能分发（#17 的规矩） |
|
||||
| 西文无衬线 | texgyreheros | OUC Sans | 仓库没有 Hero |
|
||||
| 正文 | 13 章 265 页 | 1 章示例 | 只抽骨架 |
|
||||
## 参考文献
|
||||
|
||||
## 已知问题
|
||||
```latex
|
||||
\addbibresource[location=local]{reference.bib} % 导言区
|
||||
\nocite{*} % 正文末尾，引用全部条目
|
||||
\printbibliography[heading=bibintoc, title=\ebibname]
|
||||
```
|
||||
|
||||
`\texttt{}` 用的是 Computer Modern 等宽（LMMono10），与正文西文
|
||||
Termes 风格不搭。成因是仓库未统一配置等宽字体，见上文字体表。
|
||||
目前仅 2 处用到（示例里的 `booktabs` 和一条 DOI），不影响观感。
|
||||
`\nocite{*}` 表示列出文献库里全部条目。正式写作时删掉它，只列实际引用的。
|
||||
|
||||
`reference.bib` 里的条目是虚构的，替换成自己的文献库。
|
||||
|
||||
## 插图与表格
|
||||
|
||||
```latex
|
||||
\begin{figure}[H]
|
||||
\centering
|
||||
\includegraphics[width=0.8\textwidth]{image/xxx.png}
|
||||
\caption{图标题}
|
||||
\label{fig:example}
|
||||
\end{figure}
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{表标题}
|
||||
\label{tab:example}
|
||||
\begin{tabular}{|l|l|}
|
||||
\hline
|
||||
列一 & 列二 \\ \hline
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
图题在图下方，表题在表上方。`[H]` 强制图跟文字，教材排版常用。
|
||||
|
||||
TikZ 可直接画关系图、流程图：
|
||||
|
||||
```latex
|
||||
\begin{tikzpicture}[box/.style={draw, rounded corners, align=center,
|
||||
fill=blue!6, minimum width=3.2cm}]
|
||||
\node[box] (a) at (0,0) {甲方};
|
||||
\node[box] (b) at (4,0) {乙方};
|
||||
\draw[->, thick] (a) -- (b);
|
||||
\end{tikzpicture}
|
||||
```
|
||||
|
||||
已加载的 TikZ 库：`shapes.geometric`、`shapes.misc`、`arrows.meta`、
|
||||
`arrows`、`decorations.pathreplacing`、`decorations.markings`、
|
||||
`positioning`、`calc`、`fit`、`backgrounds`。
|
||||
|
||||
## 版式
|
||||
|
||||
```
|
||||
A4，边距 上下 25.4mm，左右 20mm
|
||||
正文 10pt，行距 1.2 倍
|
||||
标题：章 22pt 黑体，节 14pt 黑体
|
||||
封面色带 RGB(32,178,170) 青绿
|
||||
页码：前置罗马数字，正文阿拉伯数字
|
||||
```
|
||||
|
||||
## 注意
|
||||
|
||||
示例内容为占位文字，使用时全部替换。
|
||||
Reference in New Issue
Block a user