diff options
author | Karl Berry <karl@freefriends.org> | 2021-12-15 21:30:48 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-12-15 21:30:48 +0000 |
commit | 59dd3641e1cf5191546700a204a1945455042229 (patch) | |
tree | 8ee82fa1c61f8212018de5c0b3c198bc2b79c4fa /Master/texmf-dist/doc | |
parent | 250a386a7265d7fffdeacac28254ec952b35b3e7 (diff) |
easybook (15dec21)
git-svn-id: svn://tug.org/texlive/trunk@61311 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/easybook/easybook.pdf | bin | 594412 -> 593159 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/easybook/easybook.tex | 120 |
2 files changed, 66 insertions, 54 deletions
diff --git a/Master/texmf-dist/doc/latex/easybook/easybook.pdf b/Master/texmf-dist/doc/latex/easybook/easybook.pdf Binary files differindex 1b28eb05a98..8676768a4a8 100644 --- a/Master/texmf-dist/doc/latex/easybook/easybook.pdf +++ b/Master/texmf-dist/doc/latex/easybook/easybook.pdf diff --git a/Master/texmf-dist/doc/latex/easybook/easybook.tex b/Master/texmf-dist/doc/latex/easybook/easybook.tex index 6231c55c107..f52cbce4364 100644 --- a/Master/texmf-dist/doc/latex/easybook/easybook.tex +++ b/Master/texmf-dist/doc/latex/easybook/easybook.tex @@ -20,8 +20,8 @@ name = easybook, color-scheme = blue, title = EASYBOOK 使用手册, - version = v1.41S, - date = 2021/12/12, + version = v1.41U, + date = 2021/12/15, authors = 瞿毅, info = 排版简体中文学位论文和书籍, email = q1jx@foxmail.com, @@ -224,8 +224,8 @@ 同时开启 \option{newline} 和 \keyis-{scheme}{plain} 选项以符合英文原生风格。 \keychoice{paper}{a4paper,b5paper,c5paper,letterpaper,other paper}\Default{a4paper} 文档页面尺寸选项将参数交给 \pkg*{geometry} 宏包处理,可使用它支持的所有纸张规格。建议选项值 \code{b5paper} 和 \keyis*-{zihao}{5},选项值 \code{a4paper} 和 \keyis*-{zihao}{-4} 配合。 - \keyval-{config}{配置文件名}\Default - 选项 \option{config} 载入用户配置文件,最好放在当前路径且需带有文件扩展名如 \code{tex}、\code{def} 和 \code{cfg}。 + \keyval-{config}{配置文件列表}\Default + 载入用户配置的文件名列表,文件列表以花括号包裹并以英文逗号分隔。文件名应包含如 \code{tex}、\code{def} 或 \code{cfg} 等扩展名。若配置文件不在当前文件夹则文件名需要包含路径。 \keybool{floatpage}\Default{false} 开启这个选项后浮动环境 \env*{table} 和 \env*{figure} 的比例参数会使用默认值,关闭它则尽可能避免出现浮动页,使图表环境与正文段落更加紧凑,减少多余的空白版面。 \end{options} @@ -356,16 +356,28 @@ \end{commands} \subsection{上标和下标} -上标和下标的功能来自 \pkg*{spbmark} 宏包,下面三个命令可以用于输出上标和下标。它们根据当前处于文本还是数学模式来匹配相应的模式,或者可以使用它们的星号变体命令来强制使用数学模式。也可以使用键值列表对偏移量进行全局设置,详情见\ref{subsubsec:super-sub-script}。 +上标和下标的功能来自 \pkg*{spbmark} 宏包,下面三个命令可以用于输出上标和下标。可以使用键值列表的形式对上下标格式进行局部或全局设置,这些命令两个可选参数的键值列表是等效的。全局设置的详情见\ref{subsubsec:super-sub-script}。 \begin{commands} - \command{super}[\sarg\oarg{垂直偏移}\splitoarg{高度,深度}\darg{格式代码}\marg{内容}\oarg{水平偏移}] - 上标命令,与简短命令 \cs{sp} 等效。水平和垂直偏移进行距离微调,可以为带有长度单位的正值或负值,为正值时代表向上或向右移动,否则相反,默认均为 \code{0pt}。\meta{格式代码} 可以插入字体或颜色等命令,代码中的最后一个命令可以接受一个为上标或下标的参数。 - \command{sub}[\sarg\oarg{垂直偏移}\splitoarg{高度,深度}\darg{格式代码}\marg{内容}\oarg{水平偏移}] - 下标命令,与简短命令 \cs{sp} 等效。水平和垂直偏移为正值时代表向下或向右移动,否则相反。其它用法和参数与上标命令 \cs{super} 类似。 - \command{supersub}[\sarg\oarg{间距}\darg{对齐方式}\marg{上标内容}\marg{下标内容}\oarg{水平偏移}\splitdarg{上标代码,下标代码}] - 同时输出上标和下标的命令,与简短命令 \cs{spb} 等效。\meta{间距} 为上下标的垂直间距,\meta{对齐方式} 是下标的水平对齐方式,参数与 \option{supersubalign} 相同,\meta{水平偏移} 默认为 \code{0pt}。 + \command{super}[\oarg{键值列表1}\splitoarg{高度,深度}\marg{内容}\oarg{键值列表2}] + 输出上标的命令,与简短命令 \cs{sp} 等效。 + \command{sub}[\oarg{键值列表1}\splitoarg{高度,深度}\marg{内容}\oarg{键值列表2}] + 输出下标的命令,与简短命令 \cs{sp} 等效。用法和参数与上标命令 \cs{super} 类似。 + \command{supersub}[\oarg{键值列表1}\marg{上标内容}\marg{下标内容}\oarg{键值列表2}] + 同时输出上标和下标的命令,与简短命令 \cs{spb} 等效。 \end{commands} +关于这三个命令键值列表中共同的选项如下所示。如果 \option{vshift}、\option{hshift} 和 \option{cmd} 选项用于 \module*{style} 模块的全局设置,它们将根据前面最近一个命令的类型设定相应值。 +\begin{options} + \keyval-{vshift}{刚性长度}\Default{0pt} + 上标或下标的垂直偏移。如果是上下标命令使用则代表上标和上标间的垂直距离 \option{vsep}。 + \keyval-{hshift}{刚性长度}\Default{0pt} + 上标或下标的水平偏移。如果是上下标命令使用则代表上标和上标的共同偏移。 + \keyval-{cmd}{格式命令}\Default + 上标或下标的格式命令选项。最后一个命令可以带有一个参数,这个参数用于接受上标或下标。 + \keychoice{mode}{text,math,match}\Default{match} + 上标或下标的输出格式。可以为文本 \code{text} 或数学 \code{math} 模式。当使用选项 \code{match} 时可以根据当前段落所处的模式自动匹配。 +\end{options} + \section{接口选项} \label{sec:interface options} \begin{commands} @@ -388,11 +400,11 @@ \begin{ctexexam} \ctexset { - style/color = seaside, - style = + style/color = seaside, + style = { - color = seaside, - uppercase = false + fntnumwith = page, + uppercase = false } } \ebstyle{connect-figure = {-}} @@ -408,16 +420,16 @@ 预置了四种颜色主题,默认主题 \code{none} 为黑白页面,颜色主题不包括超链接。 \begin{commands} \command{DeclareThemeColor}[\splitmarg{风格名称,ctex@frame,ctex@emph,ctex@verb}] - 可以使用 \cs{DeclareThemeColor} 命令声明新的颜色主题,它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成颜色主题。类似地更改超链接颜色见\ref{subsec:hyperlinks}。 + 声明新的颜色主题命令。它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成颜色主题。类似地更改超链接颜色见\ref{subsec:hyperlinks}。 \end{commands} \keyval-{color-every}{HTML颜色代码}\Default 统一设置主题的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。 \keyval-{multoc}{整数}\Default{2} 使目录多栏排版,与\ref{sec:document command} 中目录命令的同名选项有相同效果。 \keybool{withpart}\Default{false} - 使章标题跟随每一部分编号,开启新的一部分时章编号从 1 开始,默认不跟随。 - \keychoice{footwith}{part,chapter,page}\Default{chapter} - 使脚注跟随编号的计数器,默认跟随章,当开启新的一章时脚注编号从 1 开始。 + 使章标题跟随部分计数器编号,当开启新的一部分时章编号从 1 开始。 + \keychoice{fntnumwith}{part,chapter,page}\Default{chapter} + 使脚注跟随编号的计数器名。默认跟随章计数器,当开启新的一章时脚注编号从 1 开始。 \keybool{uppercase}\Default{true} 使用 \cs*{rightmark} 及 \cs*{leftmark} 等标题标记命令获取标题内容时英文是否大写。 \kvsplit{brackets}{左括号,右括号}\Default{\Carg{(\black{,})}} @@ -447,30 +459,30 @@ \subsubsection{上下标全局设置} \label{subsubsec:super-sub-script} \begin{options} - \keyval-{super-vshift}{刚性长度}\Default{0pt} - 上标垂直偏移量,对应上标命令 \cs{super} 的参数 \meta{垂直偏移}。 - \keyval-{super-hshift}{刚性长度}\Default{0pt} - 上标水平偏移量,对应上标命令 \cs{super} 的参数 \meta{水平偏移}。 - \keyval-{sub-vshift}{刚性长度}\Default{0pt} - 下标垂直偏移量,对应下标命令 \cs{sub} 的参数 \meta{垂直偏移}。 - \keyval-{sub-hshift}{刚性长度}\Default{0pt} - 下标水平偏移量,对应下标命令 \cs{sub} 的参数 \meta{水平偏移}。 + \keyval-{spvshift}{刚性长度}\Default{0pt} + 上标命令 \cs{super} 对应的上标垂直偏移量。 + \keyval-{sphshift}{刚性长度}\Default{0pt} + 上标命令 \cs{super} 对应的上标水平偏移量。 + \keyval-{sbvshift}{刚性长度}\Default{0pt} + 下标命令 \cs{sub} 对应的下标垂直偏移量。 + \keyval-{sbhshift}{刚性长度}\Default{0pt} + 下标命令 \cs{sub} 对应的下标水平偏移量。 \opt{nohshift}\Default! - 同时取消上标和下标的 \meta{水平偏移},与 \keyis-{super-hshift}{0pt} 和 \keyis-{sub-hshift}{0pt} 等效。 + 同时取消上标和下标的 \meta{水平偏移},与 \keyis-{sphshift}{0pt} 和 \keyis-{sbhshift}{0pt} 等效。 \opt{novshift}\Default! - 同时取消上标和下标的 \meta{垂直偏移},与 \keyis-{super-vshift}{0pt} 和 \keyis-{sub-vshift}{0pt} 等效。 - \keyval-{super-format}{上标格式}\Default - 上标的格式,对应上标命令 \cs{super} 的参数 \meta{格式代码}。 - \keyval-{sub-format}{下标格式}\Default - 下标的格式,对应下标命令 \cs{sub} 的参数 \meta{格式代码}。 - \keyval-{supersub-hshift}{刚性长度}\Default{0pt} - 上下标水平偏移量,对应上下标命令 \cs{supersub} 的参数 \meta{水平偏移}。 - \kvsplit{supersub-format}{上标格式,下标格式}\Default - 上下标格式,对应上下标命令 \cs{supersub} 的参数 \splitmeta{上标格式,下标格式}。以英文逗号分隔为前后部分,也可以只有前部分,表示上标的格式。 - \keyval-{supersubsep}{刚性长度}\Default{0.3ex} - 上下标垂直间距,对应上下标命令 \cs{supersub} 的参数 \meta{间距}。 - \keychoice{supersubalign}{l,c,r}\Default{l} - 上下标的水平对齐方式,有左对齐、居中对齐和右对齐三种 \meta{对齐方式}。 + 同时取消上标和下标的 \meta{垂直偏移},与 \keyis-{spvshift}{0pt} 和 \keyis-{sbvshift}{0pt} 等效。 + \keyval-{spcmd}{格式命令}\Default + 上标命令 \cs{super} 对应的上标的格式命令。 + \keyval-{sbcmd}{格式命令}\Default + 下标命令 \cs{sub} 对应的下标的格式命令。 + \keyval-{spbhshift}{刚性长度}\Default{0pt} + 上下标命令 \cs{supersub} 对应的上下标共同水平偏移量。 + \kvsplit{spbcmd}{上标格式,下标格式}\Default + 上下标命令 \cs{supersub} 对应的上下标格式命令。以英文逗号分隔为前后两个部分分别设置上下标格式,也可以只有前部分,表示上标的格式。 + \keyval-{vsep}{刚性长度}\Default{0.3ex} + 上下标命令 \cs{supersub} 对应的上下标垂直距离。 + \keychoice{halign}{l,c,r}\Default{l} + 上下标命令 \cs{supersub} 对应的上下标水平对齐方式,有左 \code{l}、居中 \code{c} 和右 \code{r} 三种对齐方式。 \end{options} \subsection{超链接} @@ -483,7 +495,7 @@ 超链接颜色样式,预置了四种超链接颜色风格。为使相关颜色能够正确显示,\option{linkcolor} 选项应当在 \option{linktype} 前使用。 \begin{commands} \command{DeclareLinkColor}[\splitmarg{风格名称,ctex@link,ctex@url,ctex@cite}] - 可以使用 \cs{DeclareLinkColor} 命令声明新的超链接颜色样式,它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成超链接颜色。 + 声明新的超链接颜色样式命令。它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成超链接颜色。 \end{commands} \keyval-{linkcolor-every}{HTML颜色代码}\Default 统一设置超链接的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。 @@ -549,13 +561,13 @@ \label{subsec:reference} \begin{options} \keychoice{backend}{bibtex,biblatex}\Module{bibset}\Default{bibtex} - 参考文献处理后端,默认用传统的 \hologo{BibTeX} 处理参考文献\footnote{使用 \hologo{BibTeX} 引擎时加载 \pkg*{natbib} 宏包,使用 \hologo{biber} 时将加载 \pkg*{biblatex} 宏包。}。 + 参考文献处理后端。默认用传统的 \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} 宏包支持的参考文献风格名称。 + 参考文献格式为中国的参考文献推荐标准 GB/T 7714-2015,有顺序编码制和著者-出版年制两种风格。理工科类一般使用顺序编码制,文科类一般使用著者-出版年制。若使用其它格式,使用 \hologo{BibTeX} 处理时需确保正确的 \code{bst} 文件,使用 \hologo{biber} 处理可使用 \pkg*{biblatex} 宏包支持的参考文献风格名称。 \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} 宏包,此时需要手动载入相关宏包配置参考文献。 + 标注参考文献的风格。选项 \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} 宏包,此时需要手动载入相关宏包配置参考文献。 \end{options} \subsubsection{配置参考文献} @@ -637,7 +649,7 @@ \tcolorboxenvironment{caixiang}{tc-theorem} \end{ctexexam} \command{deftheorem}[\marg{环境名}\oarg{英文标题}\marg{中文标题}\darg{盒子风格}\oarg{键值列表}] - 定理环境定义命令 \cs{deftheorem} 更便捷,\meta{键值列表} 中支持的选项与命令 \cs{declaretheorem} 完全相同。但它与后者命令有以下几个区别: + 定理环境定义命令 \cs{deftheorem} 更加便捷,\meta{键值列表} 中支持的选项与命令 \cs{declaretheorem} 完全相同。但它与后者命令有以下几个区别: \begin{itemize} \item 可以重复定义已存在的定理环境而不会报错。 \item 中英文模式下定理标题自动切换。针对中文定理标题的特点将 \meta{中文标题} 设计为必选参数,\meta{英文标题} 则默认为首字母大写的 \meta{环境名}。 @@ -1209,19 +1221,19 @@ \keyval-{width}{符号宽度}\Default{10pt} 设置适当的符号宽度可以防止文字重叠和边界溢出等问题。 \keyval-{delim}{引导符}\Default{\Carg{——}} - 全局的符号对照引导符,\cs{symb} 局部的 \meta{引导符} 和对齐方式是基于这个符号的宽度。 + 全局的符号对照引导符。\cs{symb} 局部的 \meta{引导符} 和对齐方式是基于这个符号的宽度。 \keyval-{space}{符号间隙}\Default{0.25em} 符号间隙为引导符两侧与符号和说明文字间的距离。 \keychoice{item-align}{l,c,r}\Default{r} - 符号的对齐方式,分为左(\code{l})、中(\code{c})和右(\code{r})三种对齐方式。 + 符号的对齐方式,分为左 \code{l}、中 \code{c} 和右 \code{r} 三种对齐方式。 \keychoice{delim-align}{l,c,r}\Default{c} - 引导符的对齐方式,分为左(\code{l})、中(\code{c})和右(\code{r})三种对齐方式。 + 引导符的对齐方式,分为左 \code{l}、中 \code{c} 和右 \code{r} 三种对齐方式。 \keyval-{enumitem}{键值列表2} 可以使用选项 \option{enumitem} 或命令 \cs{seteqcomplist} 调整对照列表的水平和垂直间距。 \keyval-{intro}{首行文字}\Default - 符号对照的说明文字,应当为简短的几个字,只显示在第一行,其后为悬挂缩进的对照列表。 + 符号对照的说明文字。应当为简短的几个字,只显示在第一行,其后为悬挂缩进的对照列表。 \keyval-{font}{符号字体}\Default - 符号的字体,数学和文本符号模式应采用不同的字体命令,最后一个命令可以接受一个参数,这个参数为符号。 + 符号的字体。数学和文本符号模式应采用不同的字体命令,最后一个命令可以接受一个参数,这个参数为符号。 \keychoice{mode}{math,text}\Default{math} 符号字体模式,可以为数学字体或者文本字体。 \end{options} @@ -1230,7 +1242,7 @@ \subsection{交叉引用} \begin{commands} \command*{ref}[\marg{标签名}] - 使用 \cs*{ref} 命令引用 \cs*{label} 设置的 \meta{标签名},将会检测临近计数器并添加相应的前缀,比如图表、章节标题和定理等。 + 使用 \cs*{ref} 命令引用 \cs*{label} 设置的 \meta{标签名},将会检测临近计数器并添加相应的前缀,比如图表题注、章节标题和定理等。 \command{footref}[\marg{脚注标签名}] 对自动编号的脚注进行引用可使用 \cs{footref} 命令,与引用的标记共享一个编号与格式。 \command{labelformat}[\marg{计数器}\marg{标签引用格式}] |