summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easybook/easybook.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-10-26 03:00:52 +0000
committerNorbert Preining <norbert@preining.info>2021-10-26 03:00:52 +0000
commitcb60b1f56842abe15407a00ea01cc7b74f5a67f1 (patch)
tree91334e966d7ba28dae3b49ce5b1a7feaaddbfd58 /macros/latex/contrib/easybook/easybook.tex
parentce07680b939eecc96f42a3ee4e777c5c183503de (diff)
CTAN sync 202110260300
Diffstat (limited to 'macros/latex/contrib/easybook/easybook.tex')
-rw-r--r--macros/latex/contrib/easybook/easybook.tex56
1 files changed, 24 insertions, 32 deletions
diff --git a/macros/latex/contrib/easybook/easybook.tex b/macros/latex/contrib/easybook/easybook.tex
index 86cb8e5722..3212c48e3b 100644
--- a/macros/latex/contrib/easybook/easybook.tex
+++ b/macros/latex/contrib/easybook/easybook.tex
@@ -9,7 +9,7 @@
\definecolorscheme{blue}
{
cs => purple,
- option => teal,
+ option => black!10!teal,
cnltx => Blue,
link => magenta,
module => violet,
@@ -20,8 +20,8 @@
name = easybook,
color-scheme = blue,
title = EASYBOOK 使用手册,
- version = v1.40B,
- date = 2021/10/21,
+ version = v1.40C,
+ date = 2021/10/25,
authors = 瞿毅,
info = 排版简体中文学位论文和书籍,
email = q1jx@foxmail.com,
@@ -539,7 +539,7 @@
\subsection{定理样式}
\label{subsec:theorem of style}
-文档类已预置 8 个定理环境,环境名及对应的定理名见小节 \ref{subsec:theorem},它们均使用预置的定理样式 \code{easy-theorem}。下面 \module*{thmset} 模块的选项仅对这个定理样式生效,由 \pkg*{thmtools} 宏包提供支持。
+文档类已预置 8 个定理环境,环境名及对应的定理名见小节 \ref{subsec:theorem},它们均使用预置的定理样式 \code{easy-theorem}。下面 \module*{thmset} 模块的选项仅对这个定理样式生效,由 \pkg*{thmtools} 宏包提供支持。如果下面的选项不满足需求,可使用支持完整选项的相关命令新建定理环境。
\begin{options}
\keybool{thmframe}\Module{thmset}\Default{false}
给定理环境使用彩色盒子。这个特殊选项在 \module*{thmset} 模块中使用 \pkg*{tcolorbox} 宏包来支持,\meta{盒子风格} 默认为 \code{tc-theorem}。\pkg*{thmtools} 具有类似的选项 \option*{thmbox},可在新建定理样式的命令中使用。
@@ -567,18 +567,18 @@
定理标题各组成元素的位置排列和格式。定理标题由定理名、编号和题注组成,\meta{标题排列} 中参数 \cs*{NAME}、\cs*{NUMBER} 和 \cs*{NOTE} 分别代表定理名、编号和题注。
\end{options}
-\subsubsection{新建定理样式}
+\subsubsection{新建定理环境}
\begin{commands}
\command{declaretheorem}[\oarg{键值列表1}\marg{定理环境}\oarg{键值列表2}]
声明新的定理环境命令,\cs{newtheorem} 命令与它等效。可选参数的 \meta{键值列表1} 与 \meta{键值列表2} 等效,用法与原来的同名命令一致。键值列表中常用的选项如下:
\begin{options}
\keyval*-{name}{定理名}
定理名的默认值是首字母大写的环境名称(英文标题)。
- \keychoice*{numbered}{no,yes,unless unique}\Default{yes}
+ \keychoice*{numbered}{no,yes,unless unique}
定理可以被编号、不被编号或者只有在文档中多次出现时才被编号。
- \keyval*-{numberlike}{计数器}\Default
+ \keyval*-{numberlike}{计数器}
定理将使用此 \meta{计数器} 进行编号,通常这是另一个定理环境的名称。
- \keyval*-{style}{定理样式}\Default
+ \keyval*-{style}{定理样式}
选项的值为使用 \cs{declaretheoremstyle} 命令新定义的定理样式。
\end{options}
\command{deftheorem}[\marg{环境名}\oarg{英文标题}\marg{中文标题}\darg{盒子风格}\oarg{键值列表}]
@@ -622,8 +622,8 @@
\keyval-{footruleskip}{页脚线间距}\Default*
\keyval*-{left}{页面左边距}\Default*{3.17cm}
\keyval*-{top}{页面上边距}\Default*{2.54cm}
- \keyval*-{hmargin}{左边距,右边距}\Default*
- \keyval*-{textwidth}{页面文本区宽度}\Default*
+ \kvsplit{hmargin}{左边距,右边距}
+ \keyval*-{textwidth}{页面文本区宽度}\default{}
\keybool*{includehead}\Default*{false}
\begin{ctexexam}
\geoset
@@ -642,9 +642,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} 代表当前章、节或小节的标题。也可以直接重新定义这些选项对应的标题标记命令,但此时标记大写选项 \option{uppercase} 失效。
\begin{options}
- \keyval-{headfoot}{页眉页脚代码}\Module{hdrset}
- 设置页眉页脚的格式,使用 \pkg*{fancyhdr} 支持的 \cs*{fancyhead} 和 \cs*{fancyhead} 等命令,或在正文中使用这些命令改变其后的页面风格。
- \keyval-{chap-mark}{标题标记}
+ \keyval-{chap-mark}{标题标记}\Module{hdrset}
标题标记命令 \cs*{chaptermark} 的内容,包括了标签选项 \option{chap-label} 的内容。
\keyval-{sec-mark}{标题标记}
标题标记命令 \cs*{sectionmark} 的内容,包括了标签选项 \option{sec-label} 的内容。
@@ -672,9 +670,9 @@
\end{options}
\begin{commands}\noitemsep
- \command{easyhead}[\oarg{位置}\marg{内容}]\default{}
- \command{easyfoot}[\oarg{位置}\marg{内容}]
- 命令 \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} 代表左、中和右部分。单面打印时,含有偶数位置的命令无效。
+ \command{fancyhead}[\oarg{位置}\marg{内容}]\default{}
+ \command{fancyfoot}[\oarg{位置}\marg{内容}]
+ 使用 \cs{fancyhead} 和 \cs{fancyfoot} 等命令设置页眉页脚时为了显示正确的页面,在导言区时需要在页面边距的命令之后。默认设置的是一个名为 \code{fancy} 的页面风格。\pkg*{fancyhdr} 将页眉页脚分成了左中右和奇数页(odd)、偶数页(even)共 12 个部分,可选参数中 \code{E} 和 \code{O} 代表偶数和奇数,\code{L}、\code{C} 和 \code{R} 代表左、中和右部分。单面打印时,含有偶数位置的命令无效。
\end{commands}
\begin{commands}\noitemsep
@@ -687,16 +685,10 @@
\command{markrule}[\oarg{长度}\darg{颜色名}\marg{线宽}\spemcoarg{上间距,下间距}]
命令 \cs{markrule} 既可在 \meta{横线命令} 中用于绘制页眉页脚横线,也可以在正文中使用。\meta{长度} 默认为页面文本区的宽度,上下间距为横线与上下方部件的间距,带有长度单位,上下间距之间用 \code{|} 符号分开,若只有一部分则表示 \meta{上间距}。下面举一个设置页眉内容的例子:
\begin{ctexexam}
- \hdrset
- {
- headfoot =
- {
- \easyhead[ER]{\leftmark}
- \easyhead[OL]{\rightmark}
- \easyhead[EL,OR]{\textbf{\thepage}}
- },
- headrule = \markrule(DarkOrchid){0.5pt}[2pt|2pt]
- }
+ \hdrset{headrule = \markrule(DarkOrchid){0.5pt}[2pt|2pt]}
+ \fancyhead[ER]{\leftmark}
+ \fancyhead[OL]{\rightmark}
+ \fancyhead[EL,OR]{\textbf{\thepage}}
\end{ctexexam}
\end{commands}
@@ -720,15 +712,15 @@
\keychoice{fnmark-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
脚注正文标记编号的类型,默认为原生样式 \code{plain},还可以改为 \code{pifont} 的各个版本,从左往右依次为普通版、阴文衬线版、阳文无衬线版和阴文无衬线版,缺点是它们的编号仅包括 1-10。
- 短编号的形式与列表环境类似,不过增加了一个中文数字格式参数 \code{c}。原生样式 \code{plain} 等同于单独使用数字 \code{1} 参数。这个选项可以用在正文中改变其后脚注编号格式。
+ 短编号的形式与列表环境类似,不过增加了一个中文数字格式参数 \code{c}。原生样式 \code{plain} 等同于单独使用数字 \code{1} 参数。这个选项可以用在正文中改变其后脚注编号类型。
\begin{ctexexam}
- \hdrset{fnmark-num = 1} % 等于编号格式plain
+ \hdrset{fnmark-num = 1} % 等于编号类型plain
\hdrset{fnmark-num = (a)}
\end{ctexexam}
\keychoice{fntext-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
- 脚注内容标记编号的类型,用法与 \option{fnmark-num} 一样,所以脚注内容与正文标记编号格式\textbf{可以不同}。
+ 脚注内容标记编号的类型,用法与 \option{fnmark-num} 一样,所以脚注内容与正文标记编号类型\textbf{可以不同}。
\keychoice{fnmate-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
- 同时设定脚注正文标记编号 \option{fnmark-num} 与脚注内容标记编号 \option{fntext-num} 的类型。目前脚注编号格式选项对于迷你页环境 \env*{minipage} 无效,其中的脚注保持默认英文字母的编号形式。
+ 同时设定脚注正文标记编号 \option{fnmark-num} 与脚注内容标记编号 \option{fntext-num} 的类型。目前脚注编号类型选项对于迷你页环境 \env*{minipage} 无效,其中的脚注保持默认英文字母的编号类型。
\keychoice{fnmark-vshift}{fixed length,match}\Default{0pt}
脚注正文标记的垂直偏移,可以设为刚性长度,或用 \code{match} 匹配 \option*{super-vshift} 全局的值。
\keychoice{fnmark-hshift}{fixed length,match}\Default{0pt}
@@ -841,7 +833,7 @@
\environment*{tabularx}[\marg{长度}\marg{列格式}]\default{}
\environment*{tabular}[\marg{列格式}]\default{}
\environment{tblr}[\marg{键值列表}]
- \pkg*{tabularray} 是一个较新的表格宏包,不仅提供了 \pkg*{tabularx}、\pkg*{multirow}、和 \pkg*{booktabs} 宏包的功能,并且不依赖其它宏包与它们同时使用不会产生冲突,还实现了用简便的键值列表方式设置表格样式。具体用法可见宏包的说明文档,下面演示一个 \env{tblr} 表格的用法:
+ \pkg*{tabularray} 是一个较新且强大的表格宏包,不依赖其它表格宏包所以同时使用不会产生冲突。不仅提供 \pkg*{tabularx}、\pkg*{multirow}、和 \pkg*{booktabs} 等宏包的功能,还实现了用键值列表方式简便地设置表格样式。具体用法可见宏包的说明文档,下面演示一个 \env{tblr} 表格的用法:
\begin{ctexexam}
\begin{tblr}
{
@@ -985,7 +977,7 @@
习题标题盒子背景颜色,可以使用 \pkg*{xcolor} 自定义颜色或使用色库。
\keyval-{title}{环境标题}
习题的标题,可以匹配中英文模式,习题环境使用 \parg{} 参数时无效。
- \keyval-{number}{习题编号格式}\Default{1.}
+ \keyval-{number}{习题编号类型}\Default{1.}
标题编号输出选项 \option{number} 为短编号形式,应当包含 \code{A}、\code{a}、\code{I}、\code{i}、或 \code{1} 其中一个符号。
\keyval-{numsep}{编号与标题的间距}\Default{0.5em}
习题标题编号与后方标题文本的间距,习题环境使用星号参数时无效。