summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easybook
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2022-02-03 03:00:49 +0000
committerNorbert Preining <norbert@preining.info>2022-02-03 03:00:49 +0000
commit5f2b3969a73a6756d3cd224240ae1be6408d5801 (patch)
tree83306cdc5f971dc2901afd81fc37fd242f2f3e74 /macros/latex/contrib/easybook
parent460879b45ff6e83765da88734e8cc0c6da5043eb (diff)
CTAN sync 202202030300
Diffstat (limited to 'macros/latex/contrib/easybook')
-rw-r--r--macros/latex/contrib/easybook/easybook.dtx12
-rw-r--r--macros/latex/contrib/easybook/easybook.pdfbin575857 -> 575027 bytes
-rw-r--r--macros/latex/contrib/easybook/easybook.tex206
3 files changed, 113 insertions, 105 deletions
diff --git a/macros/latex/contrib/easybook/easybook.dtx b/macros/latex/contrib/easybook/easybook.dtx
index a95ac16fc4..ec17a0f52b 100644
--- a/macros/latex/contrib/easybook/easybook.dtx
+++ b/macros/latex/contrib/easybook/easybook.dtx
@@ -15,7 +15,7 @@
%<*class>
\NeedsTeXFormat{LaTeX2e}[2020/10/01]
\RequirePackage{l3keys2e}
-\ProvidesExplClass{easybook}{2022/02/01}{1.59}
+\ProvidesExplClass{easybook}{2022/02/02}{1.60}
{Typeset Chinese theses or books}
\bool_set_false:N \l__eb_compile_draft_bool
@@ -305,7 +305,7 @@
%<*package>
\NeedsTeXFormat{LaTeX2e}[2020/10/01]
\RequirePackage{l3keys2e,etoolbox}
-\ProvidesExplPackage{easybase}{2022/02/01}{1.59}
+\ProvidesExplPackage{easybase}{2022/02/02}{1.60}
{Typeset Chinese theses or books}
\cs_generate_variant:Nn \dim_set:Nn { NV }
@@ -377,8 +377,7 @@
\tl_if_blank:nTF {#2}
{ \msg_warning:nnn { easybase } { package-repeat-load-ii } {#1} }
{ \msg_warning:nnnn { easybase } { package-repeat-load-i } {#1} {#2} }
- }
- {#3\disable@package@load{#1}{}}
+ }{#3}
}
\msg_new:nnn { easybase } { package-repeat-load-i }
{
@@ -1849,8 +1848,7 @@
{ asterisk } { \textasteriskcentered },
{ arabic } { \arabic*. },
{ alph } { (\alph*) },
- { roman } { \roman*. },
- { outline } { \upshape\ding{111} }
+ { roman } { \roman*. }
}
{ \eb_enumitem_label_set:nn #1 }
\SetEnumitemValue{font}{sf}{\color{ctex@emph}\normalfont\sffamily}
@@ -2343,7 +2341,7 @@
}
%</package>
%<*tcolorbox>
-\ProvidesExplFile{eb-tcolorbox.cfg}{2022/02/01}{1.59}
+\ProvidesExplFile{eb-tcolorbox.cfg}{2022/02/02}{1.60}
{Customization of tcolorbox for easybook}
\cs_set_protected:Npn \addtotcbstyle #1#2
diff --git a/macros/latex/contrib/easybook/easybook.pdf b/macros/latex/contrib/easybook/easybook.pdf
index cca5377c8e..e9d8282bef 100644
--- a/macros/latex/contrib/easybook/easybook.pdf
+++ b/macros/latex/contrib/easybook/easybook.pdf
Binary files differ
diff --git a/macros/latex/contrib/easybook/easybook.tex b/macros/latex/contrib/easybook/easybook.tex
index 8c16272c70..355b35bd00 100644
--- a/macros/latex/contrib/easybook/easybook.tex
+++ b/macros/latex/contrib/easybook/easybook.tex
@@ -21,8 +21,8 @@
name = easybook,
color-scheme = blue,
title = EASYBOOK 使用手册,
- version = v1.59,
- date = 2022/02/01,
+ version = v1.60,
+ date = 2022/02/02,
authors = 瞿毅,
info = 排版简体中文学位论文和书籍,
email = q1jx@foxmail.com,
@@ -86,6 +86,16 @@
\newcommand{\spemmeta}{\splitmeta[\code{|}]}
\newsplitarg[\spemmeta]{\spemcoarg}{[}{]}
\newcommand{\harg}{\textcolor{argument}{\code{-}}}
+\RenewDocumentCommand{\key}{s}
+ {
+ \IfBooleanTF{#1}{\cnltx@key@aux*}{\cnltx@key@aux{}}
+ \meta
+ }
+\RenewDocumentCommand{\keyis}{s}
+ {
+ \IfBooleanTF{#1}{\cnltx@key@aux*}{\cnltx@key@aux{}}
+ \@firstofone
+ }
% A tag that distinguishes the options for different paths
\NewDocumentCommand{\dtag}{O{\ding{73}}}
{
@@ -238,10 +248,10 @@
\keychoice{scheme}{chinese,plain}\Default{chinese}
文档主题方案选项 \option{scheme} 扩展了 C\TeX 文档类中同名选项原有的作用范围,选项值 \code{plain} 可使各类标题变为英文形式。包括章节标题、图表标题和定理名等。
\opt{enmode}
- 同时开启 \option{newline} 和 \keyis-{scheme}{plain} 选项以符合英文原生风格。
+ 同时开启 \option{newline} 和 \keyis{scheme}{plain} 选项以符合英文原生风格。
\keychoice{paper}{a4paper,b5paper,c5paper,letterpaper,other paper}\dtag\Default{a4paper}
文档页面尺寸选项将参数交给 \pkg*{geometry} 宏包处理,可使用它支持的所有标准纸张规格。
- \keyval-{config}{配置文件列表}
+ \keyval{config}{配置文件列表}
载入用户配置的文件名列表,文件列表以花括号包裹并以英文逗号分隔。文件名应包含如 \code{tex}、\code{def} 或 \code{cfg} 等扩展名。若配置文件不在当前文件夹则文件名需要包含路径。
\keybool{floatpage}\dtag\Default{false}
开启这个选项后浮动环境 \env*{table} 和 \env*{figure} 的比例参数会使用默认值。关闭它则尽可能避免出现浮动页,使图表环境与正文段落更加紧凑,减少多余的空白版面。
@@ -254,7 +264,7 @@
\keychoice{cjkfont}{adobe,fandol,founder,mac,macnew,macold,ubuntu,windows,none}
中文字体采用 C\TeX 宏集包含的字库并与其一致,具体配置方案可以查看 C\TeX 使用手册。它与 \option*{fontset} 选项是等效的,如果没有指定 \option{cjkfont} 的值,将会自动检测操作系统并选择相应的字体。
- 如果需要使用其它中文字体,可以在启用选项 \keyis-{cjkfont}{none} 后,再使用 \pkg*{xeCJK} 宏包的相关命令设置字体以及声明字体族:
+ 如果需要使用其它中文字体,可以在启用选项 \keyis{cjkfont}{none} 后,再使用 \pkg*{xeCJK} 宏包的相关命令设置字体以及声明字体族:
\begin{ctexexam}
\setCJKmainfont{SimSun}[BoldFont = SimHei,ItalicFont = KaiTi]
\setCJKsansfont{SimHei}
@@ -295,9 +305,9 @@
\keychoice{class}{book,article}\dtag\Default{book}
使用 \cls*{easybook} 文档类可以有两种模式,默认为 \cls*{book} 模式。选用 \code{article} 会变为 \code{oneside} 单面排版,同时使文档编号、结构等与标准 \cls*{article} 文档类的特性相似,可用于短篇幅的文章,不需要再使用 \cs*{chapter} 命令。此时\ref{sec:document command} 中目录命令的 \option{chapter} 选项会失效,将以 \code{section} 标题级别输出目录。如果使用 \cls*{ctexart} 配合 \pkg*{easybase} 宏包,则选项值 \code{book} 会失效。
\opt{book}\dtag
- 开启 \cls*{book} 书籍模式,与 \keyis*-{class}{book} 等效。
+ 开启 \cls*{book} 书籍模式,与 \keyis*{class}{book} 等效。
\opt{article}\dtag
- 开启 \cls*{article} 文章模式,与 \keyis*-{class}{article} 等效。
+ 开启 \cls*{article} 文章模式,与 \keyis*{class}{article} 等效。
\end{options}
\section{文档命令}
@@ -337,17 +347,17 @@
使当前目录标题按照 \code{section} 节级别输出。
\opt{none}
使当前目录没有 \code{chapter} 或 \code{section} 级别的标题,仅输出目录原始内容。
- \keyval-{multoc}{整数}\Default{2}
+ \keyval{multoc}{整数}\Default{2}
与 \module*{style} 模块的 \option{multoc} 选项具有相同的效果,但是具有优先性且可单独设置不同类型目录的排版栏数。\meta{整数} 为目录栏数,不指定栏数值则默认为双栏。
\kvsplit{title}{中文目录标题,英文目录标题}
用于更改目录的标题。标题之间用一个英文逗号分开,也可以只有一部分,表示中文目录的标题。当设置了英文目录标题时,英文目录标题将会自动加入文档主目录 \cs*{tableofcontents}\parg{} 命令。
\keychoice{bilist}{mix,new}\Default{new}
确定文档主目录中双语标题列表的输出排列方式。选项 \code{mix} 使每个英文标题条目在中文目录中跟随对应的中文标题输出,\code{new} 则新建一个英文目录输出英文标题。
- \keyval-{format}{目录标题格式}
+ \keyval{format}{目录标题格式}
在 \cls*{book} 模式且 \option{chapter} 选项开启或者 \cls*{article} 模式的情况下,\option{format} 用于设置目录标题的格式。
- \keyval-{aftertitle}{目录标题格式}
+ \keyval{aftertitle}{目录标题格式}
目录标题文本之后插入的代码。
- \keyval-{pagestyle}{标题页的页面格式}\Default{empty}
+ \keyval{pagestyle}{标题页的页面格式}\Default{empty}
目录标题所在页的页面格式,仅当目录以 \code{chapter} 级别输出时有效。除了上述选项还支持 C\TeX 键值列表路径 \module*{chapter} 或 \module*{section} 所有的章节标题样式选项。
\end{options}
@@ -366,7 +376,7 @@
\begin{options}
\kvsplit{biname}{英文目录前名字,英文目录后名字}\Module{chapter}\Default{Chapter\cs*{space}}
更改英文目录 \code{chapter} 级别的标题编号前后名字,类似于 C\TeX 的 \option*{name} 选项。
- \keyval-{binmuber}{英文目录数字输出命令}\Default{\cs*{arabic}\Marg{chapter}}
+ \keyval{binmuber}{英文目录数字输出命令}\Default{\cs*{arabic}\Marg{chapter}}
更改英文目录 \code{chapter} 级别的标题编号输出格式,类似于 C\TeX 的 \option*{number} 选项。
\end{options}
@@ -392,15 +402,15 @@
上下标命令键值列表中共同的选项如下所示。当下面除 \option{mode} 以外的选项用于 \module*{style} 模块全局设置时,它们将根据前面最近一个命令的类型设定相应值。
\begin{options}
- \keyval-{vmove}{刚性长度}\Default{0pt}
+ \keyval{vmove}{刚性长度}\Default{0pt}
上标或下标的垂直偏移。如果是上下标命令使用则代表上标和上标间的额外垂直距离 \option{vsep}。
- \keyval-{hmove}{刚性长度}\Default{0pt}
+ \keyval{hmove}{刚性长度}\Default{0pt}
上标或下标的水平偏移。如果是上下标命令使用则代表上标和上标的共同偏移。
- \keyval-{cmd}{格式命令}
+ \keyval{cmd}{格式命令}
上标或下标的格式命令选项。最后一个命令可以带有一个参数,这个参数用于接受上标或下标。
- \keyval-{height}{刚性长度}
+ \keyval{height}{刚性长度}
段落中当前行上标或下标的基线与前一行的间距。
- \keyval-{depth}{刚性长度}
+ \keyval{depth}{刚性长度}
段落中当前行上标或下标的基线与下一行的间距。
\keychoice{mode}{text,math,match}\Default{match}
上标或下标的输出格式。可以为文本 \code{text} 或数学 \code{math} 模式。当使用选项 \code{match} 时可以根据当前段落所处的模式自动匹配。
@@ -450,9 +460,9 @@
\command{DeclareThemeColor}[\splitmarg{风格名称,ctex@frame,ctex@emph,ctex@verb}]
声明新的颜色主题命令。它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成主题颜色列表。类似地更改超链接颜色见\ref{subsec:hyperlinks}。
\end{commands}
- \keyval-{color-every}{HTML颜色代码}
+ \keyval{color-every}{HTML颜色代码}
统一设置主题的各部分颜色。参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。
- \keyval-{multoc}{整数}\Default{2}
+ \keyval{multoc}{整数}\Default{2}
使目录多栏排版,与\ref{sec:document command} 中目录命令的同名选项有相同效果。
\keybool{withpart}\Default{false}
使章标题跟随部分计数器编号,当开启新的一部分时章编号从 1 开始。
@@ -472,42 +482,42 @@
\subsubsection{连字符}
\begin{options}
- \keyval-{hyphen-figure}{图片连字符}\Default{\Marg{.}}
+ \keyval{hyphen-figure}{图片连字符}\Default{\Marg{.}}
设置图片题注编号的连字符。
- \keyval-{hyphen-table}{表格连字符}\Default{\Marg{.}}
+ \keyval{hyphen-table}{表格连字符}\Default{\Marg{.}}
设置表格题注编号的连字符。
- \keyval-{hyphen-listing}{代码连字符}\Default{\Marg{.}}
+ \keyval{hyphen-listing}{代码连字符}\Default{\Marg{.}}
设置代码题注编号的连字符。
- \keyval-{hyphen-equation}{公式连字符}\Default{\Marg{.}}
+ \keyval{hyphen-equation}{公式连字符}\Default{\Marg{.}}
设置公式题注编号的连字符。
- \keyval-{hyphen-every}{连字符}\Default{\Marg{.}}
+ \keyval{hyphen-every}{连字符}\Default{\Marg{.}}
统一设置上述所有编号的连字符。
\end{options}
\subsubsection{上下标全局设置}
\label{subsubsec:super-sub-script}
\begin{options}
- \keyval-{spvmove}{刚性长度}\Default{0pt}
+ \keyval{spvmove}{刚性长度}\Default{0pt}
上标命令 \cs{super} 对应的上标垂直偏移量。
- \keyval-{sphmove}{刚性长度}\Default{0pt}
+ \keyval{sphmove}{刚性长度}\Default{0pt}
上标命令 \cs{super} 对应的上标水平偏移量。
- \keyval-{sbvmove}{刚性长度}\Default{0pt}
+ \keyval{sbvmove}{刚性长度}\Default{0pt}
下标命令 \cs{sub} 对应的下标垂直偏移量。
- \keyval-{sbhmove}{刚性长度}\Default{0pt}
+ \keyval{sbhmove}{刚性长度}\Default{0pt}
下标命令 \cs{sub} 对应的下标水平偏移量。
\opt{nohmove}
- 同时取消上标和下标的 \meta{水平偏移},与 \keyis-{sphmove}{0pt} 和 \keyis-{sbhmove}{0pt} 等效。
+ 同时取消上标和下标的 \meta{水平偏移},与 \keyis{sphmove}{0pt} 和 \keyis{sbhmove}{0pt} 等效。
\opt{novmove}
- 同时取消上标和下标的 \meta{垂直偏移},与 \keyis-{spvmove}{0pt} 和 \keyis-{sbvmove}{0pt} 等效。
- \keyval-{spcmd}{格式命令}
+ 同时取消上标和下标的 \meta{垂直偏移},与 \keyis{spvmove}{0pt} 和 \keyis{sbvmove}{0pt} 等效。
+ \keyval{spcmd}{格式命令}
上标命令 \cs{super} 对应的上标的格式命令。
- \keyval-{sbcmd}{格式命令}
+ \keyval{sbcmd}{格式命令}
下标命令 \cs{sub} 对应的下标的格式命令。
- \keyval-{spbhmove}{刚性长度}\Default{0pt}
+ \keyval{spbhmove}{刚性长度}\Default{0pt}
上下标命令 \cs{supersub} 对应的上下标共同水平偏移量。
\kvsplit{spbcmd}{上标格式,下标格式}
上下标命令 \cs{supersub} 对应的上下标格式命令。以英文逗号分隔为前后两个部分分别设置上下标格式,也可以只有前部分,表示上标的格式。
- \keyval-{vsep}{刚性长度}\Default{0.6ex}
+ \keyval{vsep}{刚性长度}\Default{0.6ex}
上下标命令 \cs{supersub} 对应的上下标额外垂直距离。
\keychoice{halign}{l,c,r}\Default{l}
上下标命令 \cs{supersub} 对应的上下标水平对齐方式,有左 \code{l}、居中 \code{c} 和右 \code{r} 三种对齐方式。
@@ -525,7 +535,7 @@
\command{DeclareLinkColor}[\splitmarg{风格名称,ctex@link,ctex@url,ctex@cite}]
声明新的超链接颜色样式命令。它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成超链接颜色列表。
\end{commands}
- \keyval-{linkcolor-every}{HTML颜色代码}
+ \keyval{linkcolor-every}{HTML颜色代码}
统一设置超链接的各部分颜色。参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。
\keychoice{linktoc}{none,section,page,all}\Default{all}
将目录中的超链接取消、置于标题上、置于页码上或置于标题和页码上。
@@ -535,44 +545,44 @@
\label{subsec:spacing}
行距因子用于设置各种行距倍数,\meta{数值} 是不带有长度单位的浮点数。各类行距既可以在导言区全局设置,也可以在正文中设置对后面生效。
\begin{options}
- \keyval-{line}{数值}\Module{spread}\Default{1.354}
+ \keyval{line}{数值}\Module{spread}\Default{1.354}
正文行距因子,注意 C\TeX 宏集原有的行距选项 \option*{linespread} 失效。
- \keyval-{table}{数值}\Default{1.354}
+ \keyval{table}{数值}\Default{1.354}
表格内容行距因子。对传统表格 \env*{tabular} 和 \env*{tabularx} 等环境以及 \pkg*{tabularray} 宏包的 \env{tblr} 环境生效,同时 \env{tblr} 也自带有 \option*{stretch} 选项设置行距系数。
- \keyval-{math}{数值}\Default{1.3}
+ \keyval{math}{数值}\Default{1.3}
数学环境的行距因子,包含了 \pkg*{amsmath} 和 \pkg*{mathtools} 宏包提供的公式环境。
- \keyval-{caption-figure}{数值}\Default{1.2}
+ \keyval{caption-figure}{数值}\Default{1.2}
图片题注的行距因子。
- \keyval-{caption-table}{数值}\Default{1.2}
+ \keyval{caption-table}{数值}\Default{1.2}
表格题注的行距因子。
- \keyval-{caption-listing}{数值}\Default{1.2}
+ \keyval{caption-listing}{数值}\Default{1.2}
代码题注的行距因子。
- \keyval-{caption-every}{数值}\Default{1.2}
+ \keyval{caption-every}{数值}\Default{1.2}
同时设置图片、表格和代码题注的行距因子。
- \keyval-{footnote}{数值}\Default{1.2}
+ \keyval{footnote}{数值}\Default{1.2}
脚注内容整体的行距因子,可以使用 \option{fnpara-form} 的代码覆盖每个脚注单独的行距,从而与不同脚注的段落间距不同\footnote{若在正文区中更改脚注行距,脚注横线下方的间距不会随当前行距改变。}。
\begin{ctexexam}
\ebspread{footnote = 1.3}
\ebhdrset{fnpara-form = \linespread{1.2}\selectfont}
\end{ctexexam}
- \keyval-{every}{数值}
+ \keyval{every}{数值}
统一设置上述所有的行距因子。
\end{options}
\subsection{其它字体}
\label{subsec:other font}
\begin{options}
- \keyval-{caption-table}{字体命令}\Module{subfont}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval{caption-table}{字体命令}\Module{subfont}\Default{\cs*{sffamily}\cs*{small}}
设置表格题注的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{caption-figure}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval{caption-figure}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
设置图片题注的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{caption-listing}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval{caption-listing}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
设置代码题注的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{caption-every}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
+ \keyval{caption-every}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
同时设置图片、表格和代码题注的字体命令。
- \keyval-{footnote}{字体命令}
+ \keyval{footnote}{字体命令}
设置脚注标记与内容的字体,包括字体族、字体系列和字体形状命令。
- \keyval-{marginpar}{字体命令}\Default{\cs*{footnotesize}}
+ \keyval{marginpar}{字体命令}\Default{\cs*{footnotesize}}
设置边注的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
\end{options}
@@ -592,9 +602,9 @@
参考文献处理后端。默认用传统的 \hologo{BibTeX} 处理参考文献\footnote{使用 \hologo{BibTeX} 引擎时加载 \pkg*{natbib} 宏包,使用 \hologo{biber} 时将加载 \pkg*{biblatex} 宏包。}。
\keychoice{bibstyle}{numerical,authoryear,other sty}\Default{numerical}
参考文献格式使用中国参考文献推荐标准 GB/T 7714-2015,对应顺序编码制和著者—出版年制两种风格。若使用其它格式,使用 \hologo{BibTeX} 处理时需确保正确的 \code{bst} 文件,使用 \hologo{biber} 处理可使用 \pkg*{biblatex} 宏包支持的参考文献风格名称。
- \keyval-{citestyle}{标注风格}
- 标注参考文献的风格。选项 \keyis-{backend}{bibtex} 下可使用 \option{super}(数字上标标注,默认)或 \option{numbers}(数字标注)等 \pkg*{natbib} 宏包带有的标注风格,选项 \keyis-{backend}{biblatex} 下可使用 \pkg*{biblatex} 宏包支持的标注风格名称。
- \keyval-{datafile}{参考文献数据库列表}
+ \keyval{citestyle}{标注风格}
+ 标注参考文献的风格。选项 \keyis{backend}{bibtex} 下可使用 \option{super}(数字上标标注,默认)或 \option{numbers}(数字标注)等 \pkg*{natbib} 宏包带有的标注风格,选项 \keyis{backend}{biblatex} 下可使用 \pkg*{biblatex} 宏包支持的标注风格名称。
+ \keyval{datafile}{参考文献数据库列表}
参考文献数据库的文件名列表,文件列表以花括号包裹并以英文逗号分隔。使用 \hologo{biber} 处理时要带有 \code{bib} 后缀,若参考文献文件不在当前文件夹则文件名需要包含路径。不设置参考文献数据库名时 \module*{bibset} 模块中的选项会失效,即不自动载入 \pkg*{natbib} 或 \pkg*{biblatex} 宏包,此时需要手动载入相关宏包配置参考文献。
\end{options}
@@ -656,25 +666,25 @@
\command{declaretheoremstyle}[\oarg{键值列表1}\marg{定理样式}\oarg{键值列表2}]
定理样式声明命令,键值列表支持自身以及定理声明命令 \cs{declaretheorem} 的所有选项。可选参数的 \meta{键值列表1} 与 \meta{键值列表2} 等效,其中支持的选项如下:
\begin{options}
- \keyval-{headfont}{字体命令}
+ \keyval{headfont}{字体命令}
定理标题部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{notefont}{字体命令}
+ \keyval{notefont}{字体命令}
定理题注部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{bodyfont}{字体命令}
+ \keyval{bodyfont}{字体命令}
定理内容部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
- \keyval-{headpunct}{代码}
+ \keyval{headpunct}{代码}
紧随定理标题末尾的标记代码,位于定理第一段内容的间距 \option{postheadspace} 之前,可以是字符或插入换行符 \cs*{newline} 等命令。
- \keyval-{headindent}{刚性长度}
+ \keyval{headindent}{刚性长度}
定理标题的缩进。默认无缩进,可用 \cs*{parindent} 命令设置为段落缩进。
- \keyval-{postheadspace}{刚性长度}
+ \keyval{postheadspace}{刚性长度}
定理标题后与定理第一段内容的间距。
- \keyval-{spaceabove}{弹性长度}
+ \keyval{spaceabove}{弹性长度}
定理环境前的间距,使用 \pkg*{tcolorbox} 的盒子环境包装后被覆盖。
- \keyval-{spacebelow}{弹性长度}
+ \keyval{spacebelow}{弹性长度}
定理环境后的间距,使用 \pkg*{tcolorbox} 的盒子环境包装后被覆盖。
\kvsplit-{notebraces}{\marg{左括号}\marg{右括号}}
设置定理题注两边的括号,两个必选参数分别代表左括号和右括号。
- \keyval-{headformat}{标题排列}
+ \keyval{headformat}{标题排列}
定理标题各组成元素的位置排列和格式。定理标题由定理名、编号和题注组成,\meta{标题排列} 中命令 \cs*{NAME}、\cs*{NUMBER} 和 \cs*{NOTE} 分别代表定理名、编号和题注。
\end{options}
@@ -696,8 +706,8 @@
\label{subsec:page margins}
模块 \module*{geoset} 会将除了前两个附加的选项交给页面尺寸宏包 \pkg*{geometry} 处理,并且支持它的键值列表,预置的页面尺寸与 \cls*{Word} 的默认值接近。下面列举几种代表性选项,其它选项可查阅宏包帮助文档。当在此设置纸张规格时,会覆盖文类选项 \option{paper} 的设置。
\begin{options}\noitemsep
- \keyval-{headruleskip}{页眉线间距}\Module{geoset}\Default*{0pt}
- \keyval-{footruleskip}{页脚线间距}\Default*{3.5pt}
+ \keyval{headruleskip}{页眉线间距}\Module{geoset}\Default*{0pt}
+ \keyval{footruleskip}{页脚线间距}\Default*{3.5pt}
\kvsplit*{hdivide}{左边距,页面文本宽度,右边距}\default{}
\kvsplit*{hmargin}{左边距,右边距}\default{}
\keyval*-{textheight}{页面文本高度}\default{}
@@ -717,11 +727,11 @@
\label{subsec:header and footer}
模块 \module*{hdrset} 设置的命令由 \pkg*{fancyhdr} 宏包提供支持。标题标记由标签和标题组成,选项中参数 \code{\#1} 代表当前章、节或小节的标题。在 \cls*{book} 模式时使用标题标记选项 \option{chap-mark} 和 \option{sec-mark},在 \cls*{article} 模式时使用 \option{sec-mark} 和 \option{subsec-mark} 选项,这与标准文档类的行为一致。重新设置标题标记选项时标记大小写选项 \option{uppercase} 会失效。
\begin{options}
- \keyval-{chap-mark}{标题标记}\Module{hdrset}
+ \keyval{chap-mark}{标题标记}\Module{hdrset}
标题标记命令 \cs*{chaptermark} 的内容,包括了标签选项 \option{chap-label} 的内容。
- \keyval-{sec-mark}{标题标记}
+ \keyval{sec-mark}{标题标记}
标题标记命令 \cs*{sectionmark} 的内容,包括了标签选项 \option{sec-label} 的内容。
- \keyval-{subsec-mark}{标题标记}
+ \keyval{subsec-mark}{标题标记}
标题标记命令 \cs*{subsectionmark} 的内容,包括了标签选项 \option{subsec-label} 的内容。
\kvsplit-{chap-label}{\oarg{数字输出命令}\marg{距离命令}}\Default{\cs*{hspace}\Marg{1em}}
标题标记命令 \cs*{chaptermark} 内容的标签(标题有编号时)。比标题标记选项更常用,可选参数是对应于章节编号计数器的输出命令,必选参数是编号与标题之间的距离命令:
@@ -736,15 +746,15 @@
标题标记命令 \cs*{sectionmark} 内容的标签,用法与 \option{chap-label} 类似。
\kvsplit-{subsec-label}{\oarg{数字输出命令}\marg{距离命令}}\Default{\cs*{hspace}\Marg{0.5em}}
标题标记命令内容 \cs*{subsectionmark} 的标签,用法与 \option{chap-label} 类似。
- \keyval-{headrule}{横线命令}
+ \keyval{headrule}{横线命令}
绘制页眉横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。
- \keyval-{footrule}{横线命令}
+ \keyval{footrule}{横线命令}
绘制页脚横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。
- \keyval-{footnoterule}{横线命令}
+ \keyval{footnoterule}{横线命令}
绘制脚注横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。
- \keyval-{headrulewd}{刚性长度}\Default{0.5pt}
+ \keyval{headrulewd}{刚性长度}\Default{0.5pt}
页眉横线默认的粗细。
- \keyval-{footnoterulewd}{刚性长度}\Default{0.5pt}
+ \keyval{footnoterulewd}{刚性长度}\Default{0.5pt}
脚注横线默认的粗细。
\end{options}
@@ -776,16 +786,16 @@
模块 \module*{hdrset} 还可以灵活调整脚注编号和内容的格式。格式主要包括脚注标记的编号类型、字体、附加符号、对齐方式和缩进距离等,以及脚注内容的首行缩进、行距和字体等。基本思想是默认脚注和自定义编号脚注标记的格式分离,两种类型脚注各自正文和内容的标记又共享格式,默认脚注中正文和内容标记的编号类型分离。
\begin{options}
\keychoice{footnotetype}{hang,default,flush,bottom}\Module{hdrset}\Default{hang}
- 脚注的类型。悬挂缩进 \code{hang} 是默认值,\code{default} 是原始的类型。在一些浮动体排版的情况下,脚注可能位于页面中间,\code{bottom} 使脚注始终位于页面底端,\code{flush} 使脚注内容标记位于脚注首行边缘外侧并右对齐。其中 \code{bottom} 是复合选项,可以与前三种类型重复或复合使用:
+ 脚注的类型。悬挂缩进 \code{hang} 是默认值,\code{default} 是原始的类型,\code{flush} 使脚注内容标记位于脚注首行边缘外侧并右对齐。在一些浮动体排版的情况下,脚注可能位于页面中间,\code{bottom} 使脚注始终位于页面底端。其中 \code{bottom} 是复合选项,可以与前三种类型重复或复合使用:
\begin{ctexexam}
\ebhdrset{footnotetype = default,footnotetype = bottom}
\ebhdrset{footnotetype = {hang,bottom}}
\end{ctexexam}
- \keyval-{fnindent}{刚性长度}\Default{0.75em}
+ \keyval{fnindent}{刚性长度}\Default{0.75em}
每个脚注首段的首行缩进(选项 \option*{hang} 为整体缩进),等于长度 \cs{footindent} 的值。
- \keyval-{fnparskip}{弹性长度}\Default{0ex}
+ \keyval{fnparskip}{弹性长度}\Default{0ex}
不同脚注的段落间距,等于长度 \cs{footparskip} 的值。
- \keyval-{fnparindent}{刚性长度}\Default{2em}
+ \keyval{fnparindent}{刚性长度}\Default{2em}
每个脚注第二段及之后段落的首行缩进,等于长度 \cs{footparindent} 的值。
\keychoice{fntext-pos}{normal,super}\Default{super}
设置脚注内容标记的位置,正常文本或是上标形式。
@@ -822,7 +832,7 @@
\keychoice{fntext-vmove}{fixed length,match}\Default{0pt}
脚注内容标记的垂直偏移。可以设为刚性长度,或用 \code{match} 匹配 \option*{spvmove} 全局的值。
\keychoice{fnmate-form}{format code,match}
- 默认脚注标记的格式,选项 \code{match} 可以匹配 \option*{spcmd} 全局的值。一般配合 \keyis-{fnmate-num}{plain} 原生编号形式使用,例如用 \pkg*{circledsteps} 宏包的带圈符号命令 \cs*{Circled} 给脚注标记添加圆圈:
+ 默认脚注标记的格式,选项 \code{match} 可以匹配 \option*{spcmd} 全局的值。一般配合 \keyis{fnmate-num}{plain} 原生编号形式使用,例如用 \pkg*{circledsteps} 宏包的带圈符号命令 \cs*{Circled} 给脚注标记添加圆圈:
\begin{ctexexam}
\usepackage{circledsteps}
\ebhdrset
@@ -860,7 +870,7 @@
\end{commands}
\keychoice{fnboth-form}{format code,match}
同时设定默认脚注标记 \option{fnmate-form} 和自定义脚注标记 \option{fncust-form} 的格式。两种脚注标记匹配上标格式 \option*{spcmd} 的值是独立的,使用 \code{match} 则可以同时匹配。标记格式选项含有字体命令会覆盖 \option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注标记。
- \keyval-{fnpara-form}{格式代码}
+ \keyval{fnpara-form}{格式代码}
脚注内容的格式,在此设置字体命令会覆盖 \option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注内容。
\kvsplit{fntext-code}{前代码,后代码}
可以用 \meta{前代码} 与 \meta{后代码} 额外增加脚注内容标记前后的代码。也可以只有前部分,\meta{前代码} 中最后一个格式命令可以带有一个参数接受脚注内容标记。由于脚注标记处于水平模式,一般用于在脚注内容标记与脚注首行间插入一点距离,或与脚注正文标记的格式稍有不同。
@@ -877,17 +887,17 @@
\label{subsec:catalog style}
模块 \module*{tocset} 将使用 \pkg*{titletoc} 宏包处理目录样式。模块或扩展包括了 \module*{part}、\module*{chapter}、\module*{section}、\module*{subsection}、\module*{figure}、\module*{table} 和 \module*{lstlisting} 二级路径,而使用 \module*{list} 路径可以统一设置图片、表格和代码目录的样式。选项前带有 \ding{73} 符号表示支持所有相应\textbf{标题级别}的路径,其它选项则处于 \module*{tocset} 路径下。目前支持标准的论文目录样式,更复杂的样式可以查看 \pkg*{titletoc} 的相关用法。
\begin{options}
- \keyval-{tocformat}{条目格式}\dtag\smodule{tocset}%
+ \keyval{tocformat}{条目格式}\dtag\smodule{tocset}%
目录中各级别条目的格式。可以设置条目字体和加入垂直间距等,垂直间距最好使用防止垂直间距重合的 \cs*{addvspace} 命令。
- \keyval-{tocformat+}{条目格式}\dtag
+ \keyval{tocformat+}{条目格式}\dtag
与 \option{tocformat} 用法一样,只是在已有的格式命令后附加代码。
- \keyval-{tocindent}{刚性长度}\dtag
+ \keyval{tocindent}{刚性长度}\dtag
各级别目录中的标题左边缩进距离,通常标题级别越低缩进越大。
- \keyval-{tocrule}{引导线命令}\dtag
+ \keyval{tocrule}{引导线命令}\dtag
引导线选项 \option{tocrule} 中一般可以使用基于 \cs*{xleaders} 命令的 \cs{tocrule} 绘制引导线。
- \keyval-{tocafter}{距离命令}\dtag\Default{\cs*{hspace}\Marg{1em}}
+ \keyval{tocafter}{距离命令}\dtag\Default{\cs*{hspace}\Marg{1em}}
在各级别目录中标签与标题间的代码,默认为插入 \code{1em} 横向距离。
- \keyval-{tocline}{条目定义}\dtag
+ \keyval{tocline}{条目定义}\dtag
这个选项扩展了图片、表格或代码题注在目录文件中的定义。选项中参数 \code{\#1} 代表相应题注编号 \cs*{the}\meta{计数器} 的值,参数 \code{\#2} 代表相应题注内容。
\begin{ctexexam}[labelref = exam:list command usage]
\ctexset
@@ -922,19 +932,19 @@
\begin{options}
\keybool{hang}\Default{true}
悬挂缩进选项 \option{hang} 使目录标题为悬挂缩进形式。缩进距离为标签及其与标题间距的长度,但此时标题编号会失去超链接。这个选项对所有标题级别有效。
- \keyval-{lolskip}{弹性长度}\Default{10pt}
+ \keyval{lolskip}{弹性长度}\Default{10pt}
代码目录中每章代码标题的额外距离。与 C\TeX 的表格和图片目录中每章间的标题距离选项 \option*{lotskip} 和 \option*{lofskip} 类似,在 \cls*{article} 模式中此选项失效。
- \keyval-{between}{代码钩子}
+ \keyval{between}{代码钩子}
目录标题与内容间的钩子,一般插入负的垂直距离代码用于抵消目录首行额外的垂直间距。一级路径此选项对应文档主目录的钩子,二级路径为 \module*{figure}、\module*{table} 和 \module*{lstlisting},或者用位于 \module*{list} 路径的此选项统一设置相应类型目录的钩子。
\keybool{dotalign}\Default{true}
引导线选项 \option{dotalign} 可以使目录引导线右端对齐并与页码保持一定间距,否则会与页码相连。
- \keyval-{pagenumwd}{刚性长度}\Default{1.55em}
+ \keyval{pagenumwd}{刚性长度}\Default{1.55em}
目录条目页码的宽度。开启 \option{dotalign} 选项时宽度越大引导线与页码的距离就越大。
- \keyval-{tocafter-every}{距离命令}\Default{\cs*{hspace}\Marg{1em}}
+ \keyval{tocafter-every}{距离命令}\Default{\cs*{hspace}\Marg{1em}}
统一设置所有级别在目录中标签与标题间的代码。
- \keyval-{tocindent-every}{刚性长度}
+ \keyval{tocindent-every}{刚性长度}
统一设置所有级别的目录标题左边缩进。
- \keyval-{tocrule-every}{引导线命令}
+ \keyval{tocrule-every}{引导线命令}
统一设置所有级别的目录引导线样式。
\end{options}
@@ -1040,8 +1050,8 @@
\end{environments}
\begin{options}\noitemsep
- \keyval-{lstlistlistingname}{代码目录标题名}\default{}
- \keyval-{lstlistingname}{代码题注标题名}
+ \keyval{lstlistlistingname}{代码目录标题名}\default{}
+ \keyval{lstlistingname}{代码题注标题名}
代码目录名与代码环境题注名选项 \option*{lstlistlistingname} 和 \option*{lstlistingname} 用法与 C\TeX 使用手册标题汉化一节类似,可以看作对这节的扩展。
\end{options}
@@ -1190,21 +1200,21 @@
\command{seteqcomp}[\marg{键值列表1}]
对照环境的 \meta{键值列表1} 可以使用 \cs{seteqcomp} 全局设置,它的选项如下:
\begin{options}
- \keyval-{width}{符号宽度}\Default{10pt}
+ \keyval{width}{符号宽度}\Default{10pt}
设置适当的符号宽度可以防止文字重叠和边界溢出等问题。
- \keyval-{delim}{引导符}\Default{——}
+ \keyval{delim}{引导符}\Default{——}
全局的符号对照引导符。\cs{symb} 局部的 \meta{引导符} 和对齐方式是基于这个符号的宽度。
- \keyval-{space}{符号间隙}\Default{0.25em}
+ \keyval{space}{符号间隙}\Default{0.25em}
符号间隙为引导符两侧与符号和说明文字间的距离。
\keychoice{item-align}{l,c,r}\Default{r}
符号的对齐方式,分为左 \code{l}、中 \code{c} 和右 \code{r} 三种对齐方式。
\keychoice{delim-align}{l,c,r}\Default{c}
引导符的对齐方式,分为左 \code{l}、中 \code{c} 和右 \code{r} 三种对齐方式。
- \keyval-{enumitem}{键值列表2}
+ \keyval{enumitem}{键值列表2}
可以使用选项 \option{enumitem} 或命令 \cs{seteqcomplist} 调整对照列表的水平和垂直间距。
- \keyval-{intro}{首行文字}
+ \keyval{intro}{首行文字}
符号对照的说明文字。应当为简短的几个字,只显示在第一行,其后为悬挂缩进的对照列表。
- \keyval-{font}{符号字体}
+ \keyval{font}{符号字体}
符号的字体。数学和文本符号模式应采用不同的字体命令,最后一个命令可以接受一个参数,这个参数为符号。
\keychoice{mode}{math,text}\Default{math}
符号字体模式,可以为数学字体或者文本字体。