summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easybook/easybook.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2022-01-11 03:01:10 +0000
committerNorbert Preining <norbert@preining.info>2022-01-11 03:01:10 +0000
commit39394e7cba63ab69525546760c8e542bb98f48e0 (patch)
tree9a63254086c5722f6670adad372c9c68efcb4948 /macros/latex/contrib/easybook/easybook.tex
parentd50bfeb7feb32d585a89393c364ef5f9e1b915d0 (diff)
CTAN sync 202201110301
Diffstat (limited to 'macros/latex/contrib/easybook/easybook.tex')
-rw-r--r--macros/latex/contrib/easybook/easybook.tex96
1 files changed, 52 insertions, 44 deletions
diff --git a/macros/latex/contrib/easybook/easybook.tex b/macros/latex/contrib/easybook/easybook.tex
index 259bbd6bd4..f54b553500 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.44,
+ version = v1.45,
date = 2022/01/08,
authors = 瞿毅,
info = 排版简体中文学位论文和书籍,
@@ -250,7 +250,7 @@
\subsection{英文字体}
\begin{options}
\keychoice{font}{noto,times,times*,ebgaramond,libertine,palatino,auto}\Default{auto}
- 预置的英文字体相关配置方案如下表所示,这些字体已经包含在了 \TeX Live 发行版中,所以通常不需要再专门安装。如果您想使用其他英文字体,可以使用 \pkg*{fontspec} 宏包的相关命令进行设置。
+ 预置的英文字体相关配置方案如下表所示,这些字体已经包含在了 \TeX Live 发行版中,所以通常不需要再专门安装。如果您想使用其它英文字体,可以使用 \pkg*{fontspec} 宏包的相关命令进行设置。
\insertblr
{
colspec = @{}*{4}{c}@{},
@@ -607,8 +607,8 @@
\label{subsec:theorem of style}
文档类已预置 12 个定理环境,环境名及对应的定理名见\ref{subsec:theorem},它们均使用预置的定理样式 \code{fancy}。下面 \module*{thmset} 模块选项的用法名称与 \pkg*{thmtools} 宏包基本一致,且仅对预置定理样式生效。如果下面的选项不满足需求,可使用支持完整选项的相关命令创建定理环境。
\begin{options}
- \keybool{thmframe}\Module{thmset}\Default{false}
- 给定理环境使用彩色盒子。这个特殊选项在本模块中使用 \pkg*{tcolorbox} 宏包来支持,\meta{盒子风格} 默认为 \code{tc-theorem}。注意它应当在定理声明命令前使用。\pkg*{thmtools} 具有类似的选项 \option*{thmbox}。
+ \keybool{tcbwrap}\Module{thmset}\Default{false}
+ 给定理环境使用彩色盒子。这个特殊选项在本模块中使用 \pkg*{tcolorbox} 宏包来支持,\meta{盒子风格} 默认为 \code{tc-theorem}。注意它应当在定理声明命令前使用。\pkg*{thmtools} 具有类似的选项 \option*{shaded}。
\keyval-{headfont}{字体命令}\Default{\cs*{color}\Carg{ctex@emph}\cs*{sffamily}}
定理标题部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{notefont}{字体命令}\Default
@@ -658,12 +658,12 @@
\begin{itemize}
\item 可以重复定义已存在的定理环境而不会报错。
\item 中英文模式下定理标题自动切换。针对中文定理标题的特点将 \meta{中文标题} 设计为必选参数,\meta{英文标题} 则默认为首字母大写的 \meta{环境名}。
- \item 自动定义交叉引用的格式,引用标签前缀为相应定理名。
- \item 定理盒子选项 \option{thmframe} 仍然生效,\meta{盒子风格} 可以使用 \cs{deftcbstyle} 命令创建。
+ \item 自动定义交叉引用的格式,标签引用前缀为相应定理名。
+ \item 定理盒子选项 \option{tcbwrap} 仍然生效,\meta{盒子风格} 可以使用 \cs{deftcbstyle} 命令创建。
\item 新建定理环境默认使用的 \meta{定理样式} 为 \code{fancy},而不是 \pkg*{thmtools} 的默认样式。
\end{itemize}
- 下面新建一个与\ref{exam:new theorem env} 相同的定理环境猜想,并使用 \cs{addtotcbstyle} 命令调整 \option{thmframe} 开启时默认的盒子风格。它的第一个参数为 \code{tc-theorem},关于命令的介绍在\ref{subsec:box}。
+ 下面新建一个与\ref{exam:new theorem env} 相同的定理环境猜想,并使用 \cs{addtotcbstyle} 命令调整 \option{tcbwrap} 开启时默认的盒子风格。它的第一个参数为 \code{tc-theorem},关于命令的介绍在\ref{subsec:box}。
\begin{ctexexam}
\deftheorem{caixiang}{猜想}[style = mythm]
\addtotcbstyle{tc-theorem}{colback = GreenYellow}
@@ -776,6 +776,10 @@
脚注正文标记编号的类型,默认为原生样式 \code{plain},还可以改为 \code{pifont} 的各个版本,从左往右依次为普通版、阴文衬线版、阳文无衬线版和阴文无衬线版,缺点是它们的编号仅包括 1-10。
短编号的形式与列表环境类似,不过增加了中文数字 \code{c} 和符号 \code{s} 格式参数。原生样式 \code{plain} 等同于单独使用数字 \code{1} 参数。这个选项可以用在正文中改变其后脚注编号类型。
+ \begin{commands}
+ \command{footref}[\marg{脚注标签名}]
+ 在当前位置对自动编号的脚注进行引用,与被引用的正文标记共享一个编号与格式。
+ \end{commands}
\begin{ctexexam}
\ebhdrset{fnmark-num = 1} % 等于编号类型plain
\ebhdrset{fnmark-num = (a)}
@@ -811,7 +815,16 @@
}
\end{ctexexam}
\keychoice{fncust-form}{format code,match}\Default
- 单独设定自定义脚注标记的格式,选项 \code{match} 可以匹配 \option*{spcmd} 全局的值。自定义脚注的命令与用法可以见\ref{subsubsec:custom footnotes}。
+ 单独设定自定义脚注标记的格式,选项 \code{match} 可以匹配 \option*{spcmd} 全局的值。自定义脚注的命令与用法可以见下方的介绍。
+ \begin{commands}\noitemsep
+ \command{Footnote}[\oarg{内容标记}\marg{正文标记}\marg{脚注文本}]\default{}
+ \command{Footnotetext}[\marg{内容标记}\marg{脚注文本}]\default{}
+ \command{Footnotemark}[\marg{正文标记}]
+ 这些是自定义标记且不影响正常编号的脚注命令,用法与它们对应首字母小写的命令类似。\meta{内容标记} 默认与 \meta{正文标记} 一致,可以进行微调。如果当前标记为空,那么将会使用上一个脚注标记。
+ \begin{ctexexam}
+ \Footnote{*}{这是可以自定义标记的脚注。}
+ \end{ctexexam}
+ \end{commands}
\keychoice{fnboth-form}{format code,match}\Default
同时设定默认脚注标记 \option{fnmate-form} 和自定义脚注标记 \option{fncust-form} 的格式。两种脚注标记匹配上标格式 \option*{spcmd} 的值是独立的,使用 \code{match} 则可以同时匹配。标记格式选项含有字体命令会覆盖 \option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注标记。
\keyval-{fnpara-form}{格式代码}\Default
@@ -905,7 +918,6 @@
\subsection{表格}
\begin{environments}\noitemsep
- \environment*{tabularx}[\marg{长度}\marg{列格式}]\default{}
\environment*{tabular}[\marg{列格式}]\default{}
\environment{tblr}[\marg{键值列表}]
\pkg*{tabularray} 是一个强大且全面的表格宏包,不依赖其它表格宏包所以同时使用不会产生冲突。不仅提供了各种传统表格宏包的功能,还实现了用键值列表方式简便地设置表格样式。具体用法可见宏包的说明文档,下面演示一个 \env{tblr} 表格的用法:
@@ -952,7 +964,7 @@
\begin{ctexexam}
\setlist*{wide = 0em} % 取消所有列表的左边距
\begin{enumerate}[label = (\arabic*),leftmargin = 1cm,resume]
- \begin{enumerate}[(1)] % 短编号形式
+ \begin{enumerate*}[(1)] % 短编号形式
\begin{itemize}[label = \textbullet,labelsep = *]
\begin{description}[font = \sffamily\bfseries,style = nextline]
\end{ctexexam}
@@ -973,7 +985,7 @@
\environment{remark}\default{}
\environment{conjecture}\default{}
\environment{problem}
- 这些是预置的定理环境,可使用选项 \option{thmframe} 为它们添加盒子边框,其中注与证明环境不编号,证明末尾会自动添加证明结束符,声明新的定理环境或更改定理盒子样式见\ref{subsec:theorem of style}。环境名与之对应的定理名如下:
+ 这些是预置的定理环境,可使用选项 \option{tcbwrap} 为它们添加盒子边框和背景,其中注与证明环境不编号,证明末尾会自动添加证明结束符,声明新的定理环境或更改定理盒子样式见\ref{subsec:theorem of style}。环境名与之对应的定理名如下:
\insertblr
{
colspec = @{}*{6}{c}@{},
@@ -1056,10 +1068,9 @@
\end{ctexexam}
\end{commands}
-\subsubsection{行间盒子}
\begin{environments}
\environment{easybox}[\sarg\oarg{颜色名}\darg{段落标题}\oarg{配置选项}]
- 环境 \env{easybox} 创建一个带有三个可选参数的扁平盒子。使用星号参数时给盒子添加边框,\meta{颜色名} 选项设置背景颜色,\meta{段落标题} 选项可以设置标题,默认无标题。
+ 行间环境 \env{easybox} 创建一个带有三个可选参数的扁平盒子。使用星号参数时给盒子添加边框,\meta{颜色名} 选项设置背景颜色,\meta{段落标题} 选项可以设置标题,默认标题为空。
\begin{ctexexam}
\addtotcbstyle{tc-easybox}{arc = 6pt}
\begin{easybox}*[DarkCyan](段落标题)
@@ -1069,18 +1080,17 @@
\end{easybox}
\end{ctexexam}
\environment{ebparbox}[\sarg\oarg{颜色名}\darg{段落标题}\oarg{配置选项}]
- 环境 \env{ebparbox} 用法与 \env{easybox} 类似,同样带有三个可选参数。当使用星号参数时盒子左边带有一条竖线,\meta{颜色名} 选项可以自定义竖线颜色,使用带有星号的环境则盒子带有竖线颜色的浅色背景。\meta{段落标题} 选项可以设置标题,默认无标题。
+ 环境 \env{ebparbox} 用法与 \env{easybox} 类似,同样带有三个可选参数。盒子的左边带有一条粗竖线,\meta{颜色名} 选项可以自定义这条竖线颜色,使用星号参数则盒子带有竖线颜色的浅色背景。
\end{environments}
-\subsubsection{行内盒子}
\begin{commands}
\command{ebemph}[\oarg{颜色名}\marg{内容}\oarg{配置选项}]
- 行内盒子均为抄录命令。盒子 \cs{ebemph} 具有模糊边缘类似高亮的效果。
+ 行内盒子命令 \cs{ebemph} 具有模糊边缘类似高亮的效果。
\command{ebfbox}[\oarg{颜色名}\marg{内容}\oarg{配置选项}]
- 盒子 \cs{ebfbox} 则有直角边缘和四周框线,效果类似带颜色的 \cs*{fbox} 盒子。
+ 行内盒子命令 \cs{ebfbox} 则有直角边缘和四周框线,效果类似带颜色的 \cs*{fbox} 盒子。
\end{commands}
-\section{更多用法}
+\section{扩展功能}
\subsection{物理量}
\begin{commands}
@@ -1106,12 +1116,32 @@
\command{counteruse}[\sarg\oarg{父计数器}\darg{编号}\marg{计数器}\oarg{分隔符}\darg{整数}]
命令 \cs{newcounter} 是 \LaTeX 自带的创建计数器命令,计数器值输出命令 \cs{counteruse} 以一定的格式使用由它创建的计数器,将会以 \cs*{the}\meta{父计数器}\meta{分隔符}\cs*{the}\meta{计数器} 输出这种计数器的值。命令 \cs{counteruse} 仅具有\textbf{输出功能},并不会改变计数器原有的绑定关系。默认每使用一次命令 \meta{计数器} 的值增加 1,带有星号的命令使 \meta{计数器} 值保持不变,\meta{计数器} 的值也可以设为指定的 \meta{整数}。计数器的 \meta{编号} 为 \code{arabic} 或 \code{alph} 等计数形式。
- 在一定的场合下可能用到 \cs{counteruse} 命令,比如通过新建快捷命令在一些位置使用定理环境的计数器,使用 \cs{labelformat} 设置计数器的引用标签需添加 \code{eb@}:
+ 在一定的场合下可能用到 \cs{counteruse} 命令,比如通过新建快捷命令在一些位置使用定理环境的计数器,使用 \cs{labelformat} 设置计数器的标签引用需添加 \code{eb@}:
\begin{ctexexam}
\labelformat{eb@theorem}{定理 #1}
\newcommand{\theoremhead}[1]{定理\counteruse[chapter]{theorem}\hspace{1em}#1}
\theoremhead{定理内容}\label{thm:theorem}
\end{ctexexam}
+
+ \command{counterwithin}[\sarg\oarg{格式}\marg{计数器}\marg{父计数器}]
+ 对计数器进行绑定的命令。将 \meta{计数器} 绑定于 \meta{父计数器},即 \meta{父计数器} 的值递增时 \meta{计数器} 的值会归零,输出格式 \cs*{the}\meta{计数器} 被改为 \cs*{the}\meta{父计数器}\code{.}\meta{格式}\marg{计数器}。\meta{格式} 应当为接受计数器值并改变编号形式的命令,默认为 \cs*{arabic}。带有星号参数的命令仅进行绑定不更改输出格式。
+ \command{counterwithout}[\sarg\oarg{格式}\marg{计数器}\marg{父计数器}]
+ 对计数器关系进行解绑的命令。将 \meta{计数器} 解绑于 \meta{父计数器},同时输出格式被改为 \meta{格式}\marg{计数器}。带有星号参数的命令仅进行解绑不更改输出格式。
+ \begin{ctexexam}
+ \counterwithin[\Roman]{child}{parent}
+ \counterwithout*{child}{parent}
+ \end{ctexexam}
+\end{commands}
+
+\subsection{标签引用}
+\begin{commands}
+ \command{labelformat}[\marg{计数器}\marg{标签引用格式}]
+ 标签格式命令 \cs{labelformat} 可以设置标签引用格式,\meta{标签引用格式} 中 \code{\#1} 代表 \cs*{the}\meta{计数器},可以设置引用序号的前缀和后缀。也可以使用 \pkg*{cleveref} 宏包提供更强大的标签功能。
+ \begin{ctexexam}
+ \labelformat{chapter}{第 #1 章}
+ \labelformat{chapter}{第\thechapter 章}
+ \AtBeginDocument{\usepackage{cleveref}}
+ \end{ctexexam}
\end{commands}
\subsection{图表题注}
@@ -1176,17 +1206,7 @@
\end{options}
\end{commands}
-\subsection{交叉引用}
-\begin{commands}
- \command*{ref}[\marg{标签名}]
- 使用 \cs*{ref} 命令引用 \cs*{label} 设置的 \meta{标签名},将会检测临近计数器并添加相应的前缀,比如图表题注、章节标题和定理等。
- \command{footref}[\marg{脚注标签名}]
- 对自动编号的脚注进行引用可使用 \cs{footref} 命令,与引用的标记共享一个编号与格式。
- \command{labelformat}[\marg{计数器}\marg{标签引用格式}]
- 标签格式命令 \cs{labelformat} 可以设置引用标签格式,\meta{标签引用格式} 中 \code{\#1} 代表 \cs*{the}\meta{计数器},可以设置引用序号的前缀和后缀。
-\end{commands}
-
-\subsubsection{索引}
+\subsection{索引}
\begin{commands}
\command*{indexsetup}[\marg{键值列表}]
\pkg*{imakeidx} 宏包增强了索引的功能,这是它的的接口命令,用于设置索引表的整体格式。
@@ -1198,19 +1218,7 @@
现在索引表生成命令 \cs{printindex} 被重新定义,\meta{键值列表} 中的选项与\ref{sec:document command} 其它目录命令相同,但是原本接口命令 \cs*{indexsetup} 的部分选项失效。
\end{commands}
-\subsubsection{自定义脚注}
-\label{subsubsec:custom footnotes}
-\begin{commands}\noitemsep
- \command{Footnote}[\oarg{内容标记}\marg{正文标记}\marg{脚注文本}]\default{}
- \command{Footnotetext}[\marg{内容标记}\marg{脚注文本}]\default{}
- \command{Footnotemark}[\marg{正文标记}]
- 这些是自定义标记且不影响正常编号的脚注命令,用法与它们对应首字母小写的命令类似。\meta{内容标记} 默认与 \meta{正文标记} 一致,可以进行微调。如果当前标记为空,那么将会使用上一个脚注标记。
- \begin{ctexexam}
- \Footnote{*}{这是可以自定义标记的脚注。}
- \end{ctexexam}
-\end{commands}
-
-\subsubsection{边注}
+\subsection{边注}
\begin{commands}
\command{marginnote}[\oarg{左文本}\marg{右文本}\oarg{垂直偏移}]
命令 \cs{marginnote} 可以生成简单的边注,如果只给定了 \meta{右文本},那么边注在奇偶数页文字相同。如果同时给定了 \meta{左文本},则偶数页使用 \meta{左文本} 的文字。
@@ -1238,7 +1246,7 @@
\appendix
\begin{changelog}[title = 更新日志]
- \shortversion{v = 1.44,date = 2022/01/08,changes = 经过前期各模块的功能调整和错误修复,稳定版本正式发布。}
+ \shortversion{v = 1.45,date = 2022/01/08,changes = 经过前期各模块的功能调整和错误修复,稳定版本正式发布。}
\end{changelog}
\nocite{*}