summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easybook/easybook.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/easybook/easybook.tex')
-rw-r--r--macros/latex/contrib/easybook/easybook.tex54
1 files changed, 27 insertions, 27 deletions
diff --git a/macros/latex/contrib/easybook/easybook.tex b/macros/latex/contrib/easybook/easybook.tex
index 43d36ab171..60736dc607 100644
--- a/macros/latex/contrib/easybook/easybook.tex
+++ b/macros/latex/contrib/easybook/easybook.tex
@@ -20,7 +20,7 @@
name = easybook,
color-scheme = blue,
title = EASYBOOK 使用手册,
- version = v1.3X,
+ version = v1.40,
date = 2021/10/21,
authors = 瞿毅,
info = 排版简体中文学位论文和书籍,
@@ -28,7 +28,7 @@
url = https://gitee.com/texl3/easybook,
abstract =
{
- \cls*{easybook} 是基于 \cls*{ctexbook} 书籍文档类创建以极简为风格的模板,同时兼具 \cls*{book} 与 \cls*{article} 文档类的功能。结合中国各高校学位论文的通用框架设计,提供多个命令和接口可以使用户简便地定制论文模板。它的基础宏包 \pkg*{easybase} 还可以搭配 C\TeX 和标准文档类使用。
+ \cls*{easybook} 是基于 \cls*{ctexbook} 书籍文档类创建以极简为风格的模板,同时兼具 \cls*{book} 与 \cls*{article} 文档类的功能。结合中国许多高校学位论文的通用框架设计,提供多个命令和接口可以使用户简便地定制论文模板。它的基础宏包 \pkg*{easybase} 还可以搭配 C\TeX 和标准文档类使用。
},
arg-format = \normalfont\small\itshape,
abstract-format = \small,
@@ -191,7 +191,7 @@
文档页面尺寸选项将参数交给 \pkg*{geometry} 宏包处理,可使用它支持的所有纸张规格。建议选项值 \code{b5paper} 和 \keyis*-{zihao}{5},选项值 \code{a4paper} 和 \keyis*-{zihao}{-4} 配合。
\keyval-{config}{配置文件名}\Default
选项 \option{config} 载入用户配置文件,最好放在当前路径且需带有文件扩展名如 \code{tex}、\code{def} 和 \code{cfg}。
- \keybool{floatpage}\Default{true}
+ \keybool{floatpage}\Default{false}
开启这个选项后浮动环境 \env*{table} 和 \env*{figure} 的比例参数会使用默认值,关闭它则尽可能避免出现浮动页,使图表环境与正文段落更加紧凑,减少多余的空白版面。
\end{options}
@@ -216,7 +216,7 @@
\begin{center}
\begin{tblr}
{
- colspec = cccc,
+ colspec = @{}*{4}{c}@{},
hline{1,7} = {1pt,cnltxblue},
hline{2} = {0.6pt,cnltxblue}
}
@@ -225,7 +225,7 @@
\code{garamond} & EB Garamond & Libertinus Sans & LM Mono \\
\code{palatino} & TG Pagella & Libertinus Sans & LM Mono \\
\code{libertine} & TG Pagella & Libertinus Sans & LM Mono \\
- \code{times} & XITS & TG Heros & TG Cursor \\
+ \code{times} & XITS & TG Heros & TG Cursor
\end{tblr}
\end{center}
\end{options}
@@ -338,14 +338,14 @@
\begin{center}
\begin{tblr}
{
- colspec = *{5}{c},
+ colspec = @{}*{5}{c}@{},
hline{1,5} = {1pt,cnltxblue},
hline{3} = {0.6pt,cnltxblue}
}
\hyperref[subsec:style]{风格} & \hyperref[subsec:other font]{其它字体} & \hyperref[subsec:spacing]{行距} & \hyperref[subsec:hyperlinks]{超链接} & \hyperref[subsec:reference]{参考文献} \\
\module*{style} & \module*{subfont} & \module*{spread} & \module*{refset} & \module*{bibset} \\
\hyperref[subsec:theorem of style]{定理样式} & \hyperref[subsec:page margins]{页面尺寸} & \hyperref[subsec:header and footer]{页眉页脚} & \hyperref[subsec:catalog style]{目录样式} & \\
- \module*{thmset} & \module*{geoset} & \module*{hdrset} & \module*{tocset} & \\
+ \module*{thmset} & \module*{geoset} & \module*{hdrset} & \module*{tocset} &
\end{tblr}
\end{center}
@@ -360,7 +360,7 @@
uppercase = false
}
}
- \style{figure-con = {-}}
+ \style{figure-connect = {-}}
\end{ctexexam}
文档类有三种选项:布尔型 \boolkey*{key},选项的值为 \code{true} 或 \code{false},如果不指定默认为真。键值型 \key*-{key}{value} 需要为选项指定值,后面 \code{=} 号不能省略。选择型 \choicekey*{key}{one,\default{two},three} 根据提供的可选值进行设定。
@@ -395,15 +395,15 @@
\subsubsection{连接符}
\begin{options}
- \keyval-{figure-con}{图片连接符}\Module{style}\Default{\Carg{.}}
+ \keyval-{figure-connect}{图片连接符}\Module{style}\Default{\Carg{.}}
设置图片题注编号的连接符。
- \keyval-{table-con}{表格连接符}\Default{\Carg{.}}
+ \keyval-{table-connect}{表格连接符}\Default{\Carg{.}}
设置表格题注编号的连接符。
- \keyval-{listing-con}{代码连接符}\Default{\Carg{.}}
+ \keyval-{listing-connect}{代码连接符}\Default{\Carg{.}}
设置代码题注编号的连接符。
- \keyval-{equation-con}{公式连接符}\Default{\Carg{.}}
+ \keyval-{equation-connect}{公式连接符}\Default{\Carg{.}}
设置公式题注编号的连接符。
- \keyval-{number-con}{连接符}\Default{\Carg{.}}
+ \keyval-{connect-all}{连接符}\Default{\Carg{.}}
统一设置上述所有编号的连接符。
\end{options}
@@ -448,7 +448,7 @@
\command{DeclareLinkColor}[\splitmarg{风格名称,ctex@link,ctex@url,ctex@cite}]
可以使用 \cs{DeclareLinkColor} 命令声明新的超链接颜色样式,它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成超链接颜色。
\end{commands}
- \keyval-{linkcol-all}{HTML颜色代码}\Default
+ \keyval-{linkcolor-all}{HTML颜色代码}\Default
统一设置超链接的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。
\keychoice{linktoc}{none,section,page,all}\Default{all}
将目录中的超链接取消、置于标题上、置于页码上或置于标题和页码上。
@@ -479,11 +479,11 @@
\subsection{其它字体}
\label{subsec:other font}
\begin{options}
- \keyval-{table-cap}{字体命令}\Module{subfont}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval-{caption-table}{字体命令}\Module{subfont}\Default{\cs*{sffamily}\cs*{small}}
表格标题的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{figure-cap}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval-{caption-figure}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
图片标题的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{listing-cap}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval-{caption-listing}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
代码标题的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{footnote}{字体命令}\Default{\cs*{rmfamily}}
设置脚注标记与内容的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
@@ -496,9 +496,9 @@
\begin{options}
\keychoice{backend}{bibtex,biblatex}\Module{bibset}\Default{bibtex}
参考文献处理后端,默认用传统的 \hologo{BibTeX} 处理参考文献\footnote{使用 \hologo{BibTeX} 引擎时加载 \pkg*{natbib} 宏包,使用 \hologo{biber} 时将加载 \pkg*{biblatex} 宏包。}。
- \keychoice{bib-style}{numerical,authoryear,other sty}\Default{numerical}
+ \keychoice{bibstyle}{numerical,authoryear,other sty}\Default{numerical}
参考文献格式为中国的参考文献推荐标准 GB/T 7714-2015,有顺序编码制和著者-出版年制两种风格,理工科类一般使用顺序编码制,文科类一般使用著者-出版年制。若使用其它格式,使用 \hologo{BibTeX} 处理时需确保正确的 \code{bst} 文件,使用 \hologo{biber} 处理可使用 \pkg*{biblatex} 宏包支持的参考文献风格名称。
- \keyval-{cite-style}{标注风格}\Default
+ \keyval-{citestyle}{标注风格}\Default
标注参考文献的风格,选项 \keyis-{backend}{bibtex} 下可使用 \option{super}(数字上标标注,默认)或 \option{numbers}(数字标注)等 \pkg*{natbib} 宏包带有的标注风格,选项 \keyis-{backend}{biblatex} 下可使用 \pkg*{biblatex} 宏包支持的标注风格名称。
\keyval-{datafile}{参考文献数据库名}\Default
参考文献数据库的文件名,可以是单个文件也可以是以括号包裹并以英文逗号分隔的文件列表,使用 \hologo{biber} 处理时要带有 \code{bib} 后缀,若不在当前文件夹名称需要包含路径。不设置参考文献数据库名时 \module*{bibset} 中的选项会失效,即不自动载入 \pkg*{natbib} 或 \pkg*{biblatex} 宏包,此时需要手动载入相关宏包配置参考文献。
@@ -637,7 +637,7 @@
\label{subsec:header and footer}
模块 \module*{hdrset} 设置的命令由 \pkg*{fancyhdr} 宏包提供支持。在 \cls*{book} 模式时使用章节标题标记选项 \option{chap-mark} 和 \option{sec-mark},在 \cls*{article} 模式时使用 \option{sec-mark} 和 \option{subsec-mark} 选项,这与标准文档类的行为一致。标题标记由标签和标题组成,选项中参数 \code{\#1} 代表当前章、节或小节的标题。也可以直接重新定义这些选项对应的标题标记命令,但此时标记大写选项 \module*{style/}\option{uppercase} 失效。
\begin{options}
- \keyval-{head-foot}{页眉页脚代码}\Module{hdrset}
+ \keyval-{headfoot}{页眉页脚代码}\Module{hdrset}
设置页眉页脚的格式,使用 \pkg*{fancyhdr} 支持的 \cs*{fancyhead} 和 \cs*{fancyhead} 等命令,或在正文中使用这些命令改变其后的页面风格。
\keyval-{chap-mark}{标题标记}
标题标记命令 \cs*{chaptermark} 的内容,包括了标签选项 \option{chap-label} 的内容。
@@ -669,7 +669,7 @@
\begin{commands}\noitemsep
\command{easyhead}[\oarg{位置}\marg{内容}]\default{}
\command{easyfoot}[\oarg{位置}\marg{内容}]
- 命令 \cs{easyhead} 和 \cs{easyfoot} 的使用方法与 \cs{fancyhead} 和 \cs{fancyfoot} 完全相同,它们需要在 \option{head-foot} 选项中使用,设置的是一个名为 \code{fancy} 的页面风格。\pkg*{fancyhdr} 将页眉页脚分成了左中右和奇数页(odd)、偶数页(even)共 12 个部分,可选参数中 \code{E} 和 \code{O} 代表偶数和奇数,\code{L}、\code{C} 和 \code{R} 代表左、中和右部分。单面打印时,含有偶数位置的命令无效。
+ 命令 \cs{easyhead} 和 \cs{easyfoot} 的使用方法与 \cs{fancyhead} 和 \cs{fancyfoot} 完全相同,它们需要在 \option{headfoot} 选项中使用,设置的是一个名为 \code{fancy} 的页面风格。\pkg*{fancyhdr} 将页眉页脚分成了左中右和奇数页(odd)、偶数页(even)共 12 个部分,可选参数中 \code{E} 和 \code{O} 代表偶数和奇数,\code{L}、\code{C} 和 \code{R} 代表左、中和右部分。单面打印时,含有偶数位置的命令无效。
\end{commands}
\begin{commands}\noitemsep
@@ -684,7 +684,7 @@
\begin{ctexexam}
\hdrset
{
- head-foot =
+ headfoot =
{
\easyhead[ER]{\leftmark}
\easyhead[OL]{\rightmark}
@@ -722,7 +722,7 @@
\end{ctexexam}
\keychoice{fntext-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
脚注内容标记编号的类型,用法与 \option{fnmark-num} 一样,所以脚注内容与正文标记编号格式\textbf{可以不同}。
- \keychoice{fnboth-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
+ \keychoice{fnmate-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
同时设定脚注正文标记编号 \option{fnmark-num} 与脚注内容标记编号 \option{fntext-num} 的类型。目前脚注编号格式选项对于迷你页环境 \env*{minipage} 无效,其中的脚注保持默认英文字母的编号形式。
\keychoice{fnmark-vshift}{fixed length,match}\Default{0pt}
脚注正文标记的垂直偏移,可以设为刚性长度,或用 \code{match} 匹配 \option*{super-vshift} 全局的值。
@@ -743,7 +743,7 @@
\keychoice{fncust-form}{format code,match}\Default
单独设定自定义脚注标记的格式,\code{match} 可以匹配 \option*{super-format} 全局的值。自定义脚注的命令与用法见小节 \ref{subsubsec:custom footnotes}。
\keychoice{fnboth-form}{format code,match}\Default
- 同时设定默认脚注标记 \option{fnmate-form} 和自定义脚注标记 \option{fncust-form} 的格式,两种脚注标记匹配上标格式 \option*{super-format} 的值是独立的,使用 \code{match} 则可以同时匹配。标记格式选项含有字体命令会覆盖 \module*{subfont/}\option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注标记。
+ 同时设定默认脚注标记 \option{fnmate-form} 和自定义脚注标记 \option{fncust-form} 的格式。两种脚注标记匹配上标格式 \option*{super-format} 的值是独立的,使用 \code{match} 则可以同时匹配。标记格式选项含有字体命令会覆盖 \module*{subfont/}\option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注标记。
\keyval-{fnpara-form}{格式代码}\Default
脚注内容的格式,在此设置字体命令会覆盖 \module*{subfont/}\option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注内容。
\kvsplit{fntext-code}{前代码,后代码}\newline
@@ -794,7 +794,7 @@
\begin{options}
\keyval-{lolskip}{弹性长度}\Default{10pt}
代码目录中每章代码标题的额外距离,与 C\TeX 的表格和图片目录中每章间的标题距离选项 \option*{lotskip} 和 \option*{lofskip} 类似,在 \cls*{article} 模式中此选项失效。
- \keyval-{toc-voffset}{弹性长度}
+ \keyval-{tocvoffset}{弹性长度}
主文档目录标题下方的间距补偿,一般为正值,用于抵消目录中首行的额外垂直间距。
\keyval-{voffset}{弹性长度}
图片、表格或代码目录标题下方的间距补偿,一般为正值,用于抵消目录中首行的额外垂直间距。路径为 \module*{figure}、\module*{table} 和 \module*{lstlisting},或者用 \module*{list} 路径统一设置。
@@ -900,12 +900,12 @@
\begin{center}
\begin{tblr}
{
- colspec = *{8}{c},
+ colspec = @{}*{8}{c}@{},
hline{1,3} = {1pt,cnltxblue},
hline{2} = {0.6pt,cnltxblue}
}
\env{theorem} & \env{definition} & \env{lemma} & \env{corollary} & \env{proposition} & \env{example} & \env{remark} & \env{proof} \\
- 定理 & 定义 & 引理 & 推论& 性质 & 例 & 注 & 证明 \\
+ 定理 & 定义 & 引理 & 推论& 性质 & 例 & 注 & 证明
\end{tblr}
\end{center}
\end{environments}