新增《教材》LaTeX 模板,从 sre 教材抽取版式骨架 #25
源:D:\Yongquan\code\sre =《软件需求工程导论》完整教材
(13 章 + 5 附录,78 万字节,265 页 PDF,elegantbook 文档类)
## 新增文件
教材/ouctextbook.sty 版式配置
教材/elegantbook.cls 本地化过的文档类(改过字体)
教材/教材.tex 示例正文(1 章 + 附录 + 参考文献)
教材/reference.bib 参考文献库(虚构条目)
教材/README.md 用法 + 踩坑记录
## 核心约束:字体的共用性
用户明确要求「注意字体的共用性」。原教材用 elegantbook 的
chinesefont=founder 档,加载方正四大字体:
FZShuSong-Z01 / FZHei-B01 / FZKai-Z03 / FZFangSong-Z02
这些是**商业字体,不能随仓库分发**(#17 定下的规矩)。
### elegantbook 三档字体全都不通用
| 选项 | 实际字体 | 问题 |
|---|---|---|
| founder(默认) | 方正四大字体 | 商业字体,换机器就废 |
| ctexfont | 系统字体(Win=SimSun,macOS=PingFang) | 三平台三种样子 |
| nofont | 不设 | 不配置就报错 |
### 只写 nofont 还不够 —— cls 自身还硬编码字体
elegantbook.cls 第 176/184 行:
\setmainfont{TeXGyreTermesX}[...]
\setsansfont{texgyreheros}[...]
这两款在精简 TeX Live 上都没有,报 9 个错误连发:
! Package fontspec Error: The font "texgyreheros-regular" cannot be found
**实测:在 \documentclass 之后用 \setsansfont 覆盖无效** ——
类加载时字体族已注册失败,后面重新指定救不回来。
⇒ 所以本模板必须带一份**本地化的 cls**,改三处(都留了"本地化"注释):
| 位置 | 改动 |
|---|---|
| ~176 行 | TeXGyreTermesX → texgyretermes + Path=../fonts/tex-gyre-termes/ |
| ~184 行 | texgyreheros → OUCSans + Path=../fonts/ouc-sans/ |
| \maketitle | example-image → \ouc@coverblank |
这是本模板与仓库其他模板的**唯一结构性差异**:别的模板只要
\input{../fonts.tex},本模板还要那份改过字体的 cls。
## 踩到的三个坑
### 1. 封面不写 \cover{} 会插一张 "Image" 占位图
cls 第 1288~1300 行:
\ifcsname @cover\endcsname ... \else
\includegraphics[width=\linewidth]{example-image} ← mwe 的灰底占位图
首页顶着 "Image" 两个大字。已把 else 分支换成空盒子。
### 2. 占位盒宽度不能是 0(这个坑耗了最久)
第一版 \rule{0pt}{0pt}(0 宽),立刻冒出:
Overfull \hbox (5.00002pt too wide) in paragraph at lines 44--44
试过全部无效,溢出量死钉在 5.00002pt 不动:
改 \hspace{2em} / \hspace{2.5em} 无效
改 minipage 的 0.67/0.27\linewidth 无效
改 tabular 列间距 @{}l@{} 无效
改 \colorbox 的 \makebox[\hsize] 无效
根因:0 宽空盒让 \linewidth 在 titlepage 里与 \textwidth 差 5pt,
后续并排的 \parbox{0.8\textwidth} + 两个 minipage 整体超宽。
✅ 正解:给占位盒满宽
\newcommand{\ouc@coverblank}{%
\rule{0pt}{0pt}\hspace{\linewidth}\rule{0pt}{0pt}}
实测 0 Overfull。
### 3. 封面色带改不动(一行 \colorlet 的位置问题)
cls 第 345 行 `\colorlet{coverlinecolor}{second}` 在**类加载末尾**执行,
把 coverlinecolor 绑到 second 色(black 模式下就是黑)。
⇒ 导言区写 \colorlet 会被覆盖,实测色带仍是纯黑。
必须用 \AtBeginDocument 排到它后面。
## build.sh 补了 bibtex 支持
原来只跑两遍 xelatex,教材的参考文献出不来。
新增:目录下有 .bib(排除 *-blx.bib 这种中间产物)就插一次 bibtex,
再补一遍 xelatex,最后跑统计那一遍。
## 验证
8 页 error 0 Overfull 0 Underfull 0
封面色带 RGB(32,178,170) 青绿,实测 fill=(0.125,0.698,0.667)
封面无 example-image 占位
字体(PDF 内嵌实测,全部来自仓库):
OUCSerif-Regular / -Bold 中文正文
OUCKai-Regular 中文斜体(楷体代)
TeXGyreTermes-Regular/-Bold/-Italic 西文
LMMono10-Regular \texttt 等宽(TeX Live 自带)
→ **无方正、无 SimSun/SimHei、无 Times New Roman**
全库 16/16 通过(新增第 16 项,已加入 verify_all.sh)。
⚠️ Windows 端本机未能编译:TeX Live 写字体缓存
(C:\texlive\2022\texmf-var)被安全策略拦截,属环境限制非模板问题。
模板只依赖 TeX Live 标准宏包与发行版自带字体;原教材本身就是在
Windows + TeX Live 2022 上编出来的。
## .gitignore 补充
新增 *-blx.bib、*.run.xml(biblatex 中间产物)、*/.preview/(预览图)。
## 与原教材的差异
| 项 | 原教材 | 本模板 | 原因 |
|---|---|---|---|
| 封面图 | cover.jpg | 无(纯色带) | 模板不附图片 |
| 字体 | 方正四大字体 | 仓库开源字体 | 商业字体不能分发 |
| 西文无衬线 | texgyreheros | OUC Sans | 仓库没有 Hero |
| 正文 | 13 章 265 页 | 1 章示例 | 只抽骨架 |
This commit is contained in:
@@ -0,0 +1,225 @@
|
||||
%======================================================================
|
||||
% 中国海洋大学 教材 模板(示例)
|
||||
%
|
||||
% 从《软件需求工程导论》(sre 仓库) 的版式抽取而来。
|
||||
% 正文内容为占位示例,只用来展示版式,不含原书内容。
|
||||
%
|
||||
% 编译: xelatex 教材.tex
|
||||
% 有参考文献时:xelatex → bibtex → xelatex → xelatex
|
||||
%
|
||||
% ------------------------------------------------------------------
|
||||
% ⚠️⚠️ 前两行不能动、不能换序
|
||||
%
|
||||
% 第 1 行 \documentclass 必须含 chinesefont=nofont
|
||||
% 第 2 行 \input{../fonts.tex} 接入仓库公共字体
|
||||
%
|
||||
% 写错任一处都会退回商业字体或系统字体,详见 ouctextbook.sty 第一节。
|
||||
% ------------------------------------------------------------------
|
||||
%======================================================================
|
||||
\documentclass[lang=cn,newtx,10pt,black,chinesefont=nofont]{elegantbook}
|
||||
\input{../fonts.tex}
|
||||
\usepackage{ouctextbook}
|
||||
|
||||
% ---- 书名信息 ----
|
||||
\title{教材模板示例}
|
||||
\subtitle{副标题写在这里}
|
||||
\author{作者甲 \quad 作者乙 \quad 作者丙}
|
||||
\institute{中国海洋大学}
|
||||
\date{2026/11/1}
|
||||
\version{第一版}
|
||||
\extrainfo{出版社}
|
||||
|
||||
% ---- 封面图 ----
|
||||
% ⚠️ 不写 \cover{} 就不出封面图,只出纯色带封面,不会报错。
|
||||
% 要加封面就把图片放进本目录,写 \cover{cover.jpg}。
|
||||
% 示例不放图,保持模板轻量。
|
||||
% \cover{cover.jpg}
|
||||
|
||||
% ---- 参考文献库(必须在 \begin{document} 之前)----
|
||||
\addbibresource[location=local]{reference.bib}
|
||||
|
||||
\begin{document}
|
||||
|
||||
% ---- 标题页(elegantbook 自动生成,含书名/作者/机构/版本/日期)----
|
||||
\maketitle
|
||||
|
||||
% ---- 前置部分:页码用罗马数字 ----
|
||||
\frontmatter
|
||||
\tableofcontents
|
||||
|
||||
%======================================================================
|
||||
% 前言
|
||||
%
|
||||
% ⚠️ 前言用 \chapter*(不进编号、不进目录),
|
||||
% 与正文章节的 \chapter 区分。原教材如此。
|
||||
%======================================================================
|
||||
\chapter*{前言}
|
||||
\markboth{前言}{前言}
|
||||
|
||||
这里写前言。教材前言通常包括:本书的写作背景与目的、读者对象、
|
||||
全书结构安排、各章内容简介、使用建议(可作为哪些课程的教材、
|
||||
需要哪些先修知识)、致谢、以及勘误联系方式。
|
||||
|
||||
\vspace{1.5em}
|
||||
|
||||
\hfill 编\quad 者\\
|
||||
\hfill 2026 年 11 月
|
||||
|
||||
% ---- 正文部分:页码用阿拉伯数字,章从 1 开始 ----
|
||||
\mainmatter
|
||||
|
||||
%======================================================================
|
||||
% 正文示例章
|
||||
%
|
||||
% ⚠️ 章的标准结构(原教材 13 章全部如此):
|
||||
% \chapter{标题}
|
||||
% → 导语(3~5 段,概述本章要点与结构)
|
||||
% → \section 正文各节
|
||||
% → \section{本章小结}
|
||||
% → \section{习题}
|
||||
%======================================================================
|
||||
\chapter{章节标题示例}
|
||||
|
||||
本章导语。教材每章开篇先有一段到几段导语,说明本章要解决什么问题、
|
||||
分几部分展开、与其他章的关系。这段文字通常在 3~5 段、200~400 字之间,
|
||||
让读者在进入细节前建立整体框架。
|
||||
|
||||
导语的第二段继续交代本章的组织逻辑。例如「首先……接着……随后……
|
||||
最后……」这样的行文,既是给读者的路线图,也是作者自查结构是否清晰的
|
||||
工具。
|
||||
|
||||
\section{节标题}
|
||||
|
||||
正文段落。教材正文 10pt,行距由 elegantbook 设定为 1.2 倍。
|
||||
|
||||
行内可以用 \textbf{黑体强调}、\emph{楷体强调},以及英文术语
|
||||
Requirements Engineering 和缩写 SRE。
|
||||
|
||||
\subsection{小节标题}
|
||||
|
||||
更细一层的展开。
|
||||
|
||||
\subsubsection{小小节标题}
|
||||
|
||||
最细一层。注意编号最多到这里(1.1.1.1)。
|
||||
|
||||
\paragraph{第五级标题}
|
||||
这一级不再进编号,改用「(1)(2)(3)」形式,避免编号过长。
|
||||
新的一段从段首开始。
|
||||
|
||||
\paragraph{再一个第五级标题}
|
||||
编号自动递增为(2)。
|
||||
|
||||
\section{列表与表格示例}
|
||||
|
||||
无序列表:
|
||||
|
||||
\begin{itemize}
|
||||
\item \textbf{项目软件。}由甲方委托开发,需求主要来自甲方。
|
||||
\item \textbf{产品软件。}面向普通用户,需求来自产品经理。
|
||||
\end{itemize}
|
||||
|
||||
有序列表:
|
||||
|
||||
\begin{enumerate}
|
||||
\item \textbf{系统化方法:}使用可重复的过程与标准工具。
|
||||
\item \textbf{工程原则:}模块化、抽象、分而治之。
|
||||
\item \textbf{质量保证:}通过测试、审查与验证确保质量。
|
||||
\end{enumerate}
|
||||
|
||||
表格示例(教材表格通常用三线表,见 \texttt{booktabs};
|
||||
这里演示最简的带框表格,与原教材一致):
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{表格标题示例}
|
||||
\label{tab:example}
|
||||
\begin{tabular}{|l|l|}
|
||||
\hline
|
||||
\textbf{列标题一} & \textbf{列标题二} \\ \hline
|
||||
内容 A & 15.9\% \\ \hline
|
||||
内容 B & 13.9\% \\ \hline
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
见表~\ref{tab:example} 可见表题在表上方。
|
||||
|
||||
\section{插图示例}
|
||||
|
||||
\begin{figure}[H]
|
||||
\centering
|
||||
% 有图时:\includegraphics[width=0.8\textwidth]{image/xxx.png}
|
||||
\fbox{\parbox[c][3cm][c]{0.6\textwidth}{\centering 图占位}}
|
||||
\caption{图标题示例}
|
||||
\label{fig:example}
|
||||
\end{figure}
|
||||
|
||||
见图~\ref{fig:example}。图题在图下方,与表题相反,这是通行惯例。
|
||||
|
||||
\section{TikZ 绘图示例}
|
||||
|
||||
教材里的关系图、流程图多用 TikZ 直接画,好处是矢量、可改、不用外部图片:
|
||||
|
||||
\begin{figure}[H]
|
||||
\centering
|
||||
\begin{tikzpicture}[
|
||||
box/.style={draw, rounded corners, align=center,
|
||||
fill=blue!6, minimum width=3.2cm, minimum height=1.0cm},
|
||||
font=\small]
|
||||
\node[box] (a) at (0,1.6) {甲方\\(提目标)};
|
||||
\node[box] (b) at (0,-1.6) {用户\\(提需求)};
|
||||
\node[box] (c) at (5,0) {开发团队};
|
||||
\draw[->, thick] (a) -- node[right]{业务需求} (c);
|
||||
\draw[->, thick] (b) -- node[above]{用户需求} (c);
|
||||
\end{tikzpicture}
|
||||
\caption{TikZ 绘图示例}
|
||||
\end{figure}
|
||||
|
||||
% ---- 章节收尾(原教材每章固定这两节)----
|
||||
\oucsummary
|
||||
|
||||
本章小结正文。原教材的小结通常是 1~2 段密集回顾,把本章的核心结论、
|
||||
关键数据、与其他章的衔接一次交代清楚,不重复正文细节。
|
||||
|
||||
\oucexercises
|
||||
|
||||
\begin{enumerate}
|
||||
\item 习题一示例。
|
||||
\item 习题二示例。
|
||||
\end{enumerate}
|
||||
|
||||
%======================================================================
|
||||
% 附录
|
||||
%
|
||||
% ⚠️ \appendix 之后章号自动变 A、B、C……
|
||||
% elegantbook 默认已是字母编号,但为保险显式重设一次
|
||||
% (原教材主文件也这么写)。
|
||||
%======================================================================
|
||||
\appendix
|
||||
\renewcommand{\thechapter}{\Alph{chapter}}
|
||||
|
||||
\chapter{附录标题示例}
|
||||
|
||||
附录正文。常见附录内容:术语表、缩略语表、工具清单、
|
||||
实验数据、参考规范全文等。
|
||||
|
||||
\chapter{另一个附录}
|
||||
|
||||
附录二正文。
|
||||
|
||||
%======================================================================
|
||||
% 参考文献
|
||||
%
|
||||
% ⚠️ 用 biblatex(elegantbook 已配好 biblatex + biber/bibtex 后端)
|
||||
% \addbibresource 在导言区、\printbibliography 在正文末尾。
|
||||
%
|
||||
% 本示例的 reference.bib 只有 2 条假条目,仅供演示格式。
|
||||
% 实际使用时替换为真实文献。
|
||||
%
|
||||
% ⚠️ \nocite{*} 表示"引用文献库里全部条目",模板演示用。
|
||||
% 正式写作应删掉它,只列实际引用的文献。
|
||||
%======================================================================
|
||||
\nocite{*}
|
||||
\printbibliography[heading=bibintoc, title=\ebibname]
|
||||
|
||||
\end{document}
|
||||
Reference in New Issue
Block a user