diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/easybook/easybook.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/easybook/easybook.tex | 62 |
1 files changed, 40 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/easybook/easybook.tex b/Master/texmf-dist/doc/latex/easybook/easybook.tex index 20fd6cbb522..ae9ecb96b53 100644 --- a/Master/texmf-dist/doc/latex/easybook/easybook.tex +++ b/Master/texmf-dist/doc/latex/easybook/easybook.tex @@ -21,7 +21,7 @@ name = easybook, color-scheme = blue, title = EASYBOOK使用手册, - version = v1.642, + version = v1.643, date = 2022/03/08, authors = 瞿毅, info = 简便地排版中文学位论文或书籍, @@ -322,7 +322,7 @@ \command{backmatter} 后记区命令。页码格式与编号保持不变，章标题不编号。 \command{cleardoublepage}[\oarg{页面风格}]\Default{empty} - 清双页命令可以确保下一页文本总在奇数页开始，在奇数页使用它会产生空白偶数页。文区命令 \cs{frontmatter} 和 \cs{mainmatter} 会用到清双页命令，在启用文类选项 \option*{openright} 时标题命令 \cs*{part} 和 \cs*{chapter} 也会用到清双页命令。 + 清双页命令可以确保下一页文本总在奇数页开始，在奇数页使用它会产生空白偶数页。文区命令 \cs{frontmatter} 和 \cs{mainmatter} 会用到清双页命令，在启用文类选项 \option*{openright} 时标题命令 \cs*{part} 和 \cs*{chapter} 也会默认用到清双页命令。 \command{blankpagestyle}[\marg{页面风格}] 多出空白页的 \meta{页面风格} 用空白页面风格命令 \cs{blankpagestyle} 全局指定，或使用清双页命令的可选参数局部指定。空白页默认的风格为 \code{empty}，即空的页眉页脚。 \end{commands} @@ -793,7 +793,7 @@ 模块 \module*{hdrset} 还可以灵活调整脚注编号和内容的格式。格式主要包括脚注标记的编号类型、字体、附加符号、对齐方式和缩进距离等，以及脚注内容的首行缩进、行距和字体等。基本思想是默认脚注和自定义编号脚注标记的格式分离，两种类型脚注各自正文和内容的标记又共享格式，默认脚注中正文和内容标记的编号类型分离。 \begin{options} \keychoice{footnotetype}{hang,default,flush,bottom}\Module{hdrset}\Default{hang} - 脚注的类型。悬挂缩进 \code{hang} 是默认值，\code{default} 是原始的类型，\code{flush} 使脚注内容标记位于脚注首行边缘外侧并右对齐。在一些浮动体排版的情况下，脚注可能位于页面中间，\code{bottom} 使脚注始终位于页面底端。其中 \code{bottom} 是复合选项，可以与前三种类型重复或复合使用： + 脚注的类型。悬挂缩进 \code{hang} 是默认值，\code{default} 是原始的类型，\code{flush} 使脚注内容标记位于脚注首行边缘外侧并右对齐。当存在浮动环境排版时，脚注可能位于页面中间，\code{bottom} 使脚注始终位于页面底端。其中 \code{bottom} 是复合选项，可以与前三种类型重复或复合使用： \begin{ctexexam} \ebhdrset{footnotetype = default,footnotetype = bottom} \ebhdrset{footnotetype = {hang,bottom}} @@ -892,7 +892,7 @@ \subsection{目录样式} \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} 的相关用法。 +模块 \module*{tocset} 将使用 \pkg*{titletoc} 宏包处理目录样式。默认包括 \module*{part}、\module*{chapter}、\module*{section}、\module*{subsection}、\module*{figure}、\module*{table} 和 \module*{lstlisting} 二级路径，而使用 \module*{float} 路径可以统一设置图片、表格和代码目录的样式。选项前带有 \ding{73} 符号表示支持所有相应\textbf{条目名}的路径，其它选项则处于 \module*{tocset} 一级路径下。目前支持标准的论文目录样式，更复杂的样式可以查看 \pkg*{titletoc} 的相关用法。 \begin{options} \keyval{tocformat}{条目格式}\dtag\smodule{tocset}% 目录中各级别条目的格式。可以设置条目字体和加入垂直间距等，垂直间距最好使用防止垂直间距重合的 \cs*{addvspace} 命令。 @@ -902,12 +902,16 @@ 目录条目左边的缩进距离，通常标题级别越低缩进越大。 \keyval{tocrule}{引导线命令}\dtag 引导线选项 \option{tocrule} 中一般可以使用基于 \cs*{xleaders} 命令的 \cs{tocrule} 绘制引导线。 + \begin{commands} + \command{tocrule}[\sarg\harg\oarg{引导点间距}\darg{放大因子}\marg{引导点}\oarg{页码格式}] + 生成目录引导线的命令，需要在引导线选项 \option{tocrule} 中使用。带有星号的命令与 \keyis{dotalign}{false} 效果相同。带有 \harg{} 号的命令不添加引导线后的目录页码。\meta{引导点间距} 需带有长度单位，\meta{放大因子} 为 \meta{引导点} 的放大倍数。\meta{页码格式} 的代码位于页码前面，可以设置页码字体和距离等，最后一个命令可以带有一个参数为页码编号。 + \end{commands} \keyval{tocafter}{距离命令}\dtag\Default{\cs*{hspace}\Marg{1em}} 目录条目编号与标题间的代码，默认为插入 \code{1em} 横向距离。 \keyval{tocbelow}{距离命令}\dtag\newtag% 在目录条目下方执行的代码，可以插入垂直距离等命令。 \keyval{tocline}{条目定义}\dtag[\textcolor{red}{\ding{73}}] - 这个选项扩展了图片、表格或代码题注在目录文件中的定义。选项中参数 \code{\#1} 代表相应题注编号 \cs*{the}\meta{计数器} 的值，参数 \code{\#2} 代表相应题注内容。 + 这个选项在章节标题基础上扩展了浮动环境的题注在目录文件中的定义。选项中参数 \code{\#1} 代表相应题注编号 \cs*{the}\meta{计数器} 的值，参数 \code{\#2} 代表相应题注内容。 \begin{ctexexam} \ctexset { @@ -924,14 +928,23 @@ \begin{commands} \command{RegisterTocName}[\marg{条目名}]\newtag% - 给 \meta{条目名} 注册上述设置目录样式的选项，选项前有红色的符号 \textcolor{red}{\ding{73}} 表示目前在注册后不可用。 + 给名称为 \meta{条目名} 的浮动环境注册设置目录样式的选项，选项前有符号 \ding{73} 表示在注册后可用。 \command{contentsuse}[\marg{条目名}\marg{扩展名}] - 激活名为 \meta{条目名} 的目录条目定制功能，它使用的目录文件后缀为 \meta{扩展名}。需要在激活条目后再使用命令 \cs{RegisterTocName} 注册选项。 - \command{tocrule}[\sarg\harg\oarg{引导点间距}\darg{放大因子}\marg{引导点}\oarg{页码格式}] - 生成目录引导线的命令，需要在引导线选项 \option{tocrule} 中使用。带有星号的命令会使当前级别的目录引导线右端与页码相连而不是对齐。带有 \harg{} 号的命令不添加引导线后的目录页码。\meta{引导点间距} 需带有长度单位，\meta{放大因子} 不带单位，为 \meta{引导点} 的放大倍数，\meta{引导点} 一般为英文句号或 \cs*{cdot} 中心点符号。\meta{页码格式} 的代码位于页码前面，可以设置页码字体和距离等，最后一个命令可以带有一个参数为页码编号。 + 激活名称为 \meta{条目名} 的浮动环境目录定制功能，它使用的目录文件后缀为 \meta{扩展名}。需要在激活条目后再使用命令 \cs{RegisterTocName} 注册选项。 + \command{DeclareFloatList}[\marg{条目名}\marg{扩展名}]\newtag% + 声明一个新的 \cs*{listof}\meta{条目名}\code{\textcolor{cs}{s}} 的浮动环境目录命令，并且支持\ref{sec:document command} 中图表目录命令的机制。使用这个命令要确保将条目加入目录的机制已经存在，推荐搭配 \pkg*{newfloat} 宏包创建新的浮动环境。选项前有符号 \textcolor{red}{\ding{73}} 表示在声明后可用。下面举一个声明算法目录的例子： + \begin{ctexexam} + \usepackage{newfloat} + \DeclareFloatingEnvironment[ + fileext = loa, + listname = 算法清单 + ]{algorithm} + \DeclareFloatList{algorithm}{loa} + \listofalgorithms[multoc] % 在正文中输出双栏算法目录 + \end{ctexexam} \command{listnumberline}[\marg{条目名}] - 在图片、表格或代码目录中插入条目编号的命令，默认包含与题注名相同的标签名。其中 \meta{条目名} 需要显示指定，即为 \code{figure}、\code{table} 或 \code{lstlisting}。关于命令的用法可见\ref{exam:list command usage}。 - \begin{ctexexam}[labelref = exam:list command usage] + 在图表等浮动环境目录中插入条目标签和编号，默认标签可以由格式命令 \cs{labelformat} 设置。注意其中 \meta{条目名} 需要用对应名称\textbf{显示指定}。 + \begin{ctexexam} \ctexset { figure/tocline = \listnumberline{figure}#2, @@ -945,8 +958,8 @@ 悬挂缩进选项 \option{hang} 使目录条目为悬挂缩进形式。缩进距离为条目编号及其与标题间距的长度和。这个选项对所有条目名同时生效。 \keyval{lolskip}{弹性长度}\Default{10pt} 代码目录中每章第一个条目上方增加的垂直距离。与 \CTeX 的表格和图片目录中每章间的条目距离选项 \option*{lotskip} 和 \option*{lofskip} 类似，在 \cls*{article} 模式中此选项失效。 - \keyval{between}{代码钩子} - 目录标题与内容间的钩子（作用于标题下方间距之后），一般插入负的垂直距离代码用于抵消目录首行额外的垂直间距。一级路径此选项对应文档主目录的钩子，二级路径为 \module*{figure}、\module*{table} 和 \module*{lstlisting}，或者用位于 \module*{list} 路径的此选项统一设置相应类型目录的钩子。 + \keyval{between}{代码钩子}\dtag[\textcolor{red}{\ding{73}}] + 目录标题与内容间的钩子（作用于标题下方间距之后），一般插入负的垂直距离代码用于抵消目录首行额外的垂直间距。一级路径此选项对应文档主目录的钩子，二级路径为浮动环境的 \meta{条目名}。 \keyval{bibetween}{代码钩子}\newtag% 与选项 \option{between} 类似，是位于一级路径的英文文档主目录（如果启用）代码钩子。 \keybool{dotalign}\Default{true} @@ -1140,13 +1153,13 @@ \subsection{计数器} \begin{commands}\noitemsep \command{newcounter}[\marg{计数器}\oarg{父计数器}]\default{} - \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} 等计数形式。 + \command{counteruse}[\sarg\oarg{编号}\darg{分隔符}\marg{计数器}\oarg{父计数器}] + 命令 \cs{newcounter} 是 \LaTeX 自带的创建计数器命令，计数器值输出命令 \cs{counteruse} 将会以 \cs*{the}\meta{父计数器}\meta{分隔符}\cs*{the}\meta{计数器} 形式输出这种计数器的值。命令 \cs{counteruse} 仅具有\textbf{输出功能}，并不会改变计数器原有的绑定关系。默认每使用一次命令 \meta{计数器} 的值增加1，带有星号参数的命令使 \meta{计数器} 的值保持不变。计数器的 \meta{编号} 为 \code{arabic} 或 \code{alph} 等计数形式。 在一定的场合下可能用到 \cs{counteruse} 命令，比如通过新建快捷命令在一些位置使用定理环境的计数器，使用 \cs{labelformat} 设置计数器的标签引用需添加 \code{eb@}： \begin{ctexexam} \labelformat{eb@theorem}{定理#1} - \newcommand{\theoremhead}[1]{定理\counteruse[chapter]{theorem}\hspace{1em}#1} + \newcommand{\theoremhead}[1]{定理\counteruse{theorem}[chapter]\hspace{1em}#1} \theoremhead{定理内容}\label{thm:theorem} \end{ctexexam} \command{counterwithin}[\sarg\oarg{格式}\marg{计数器}\marg{父计数器}] @@ -1162,7 +1175,7 @@ \subsection{标签引用} \begin{commands} \command{labelformat}[\marg{计数器}\marg{标签引用格式}] - 标签格式命令 \cs{labelformat} 可以设置标签引用格式，\meta{标签引用格式} 中 \code{\#1} 代表 \cs*{the}\meta{计数器}，可以设置引用序号的前缀和后缀。也可以使用 \pkg*{cleveref} 宏包提供更强大的标签功能。 + 标签格式命令 \cs{labelformat} 可以设置标签引用格式。\meta{标签引用格式} 中 \code{\#1} 代表 \cs*{the}\meta{计数器}，可以设置引用序号的前缀和后缀。也可以使用 \pkg*{cleveref} 宏包提供更强大的标签功能。 \command{AtEndPreamble}[\marg{钩子代码}] 导言区末尾的钩子命令。为了保证兼容性 \pkg*{hyperref} 宏包被设计在导言区末尾载入，一些情况下需要合适的钩子在 \pkg*{hyperref} 后方执行 \meta{钩子代码}，例如载入 \pkg*{cleveref} 宏包。 \begin{ctexexam} @@ -1182,7 +1195,7 @@ \command{caption}[\sarg\oarg{目录标题}\marg{标题}]\default{} \command{captionof}[\sarg\marg{条目名}\oarg{目录标题}\marg{标题}]\default{} \command{bicaption}[\sarg\oarg{目录中文标题}\marg{中文标题}\oarg{目录英文标题}\marg{英文标题}] - 题注命令 \cs{caption} 用于在图表上下方插入题注，需要在浮动体环境 \env*{figure} 和 \env*{table} 中使用。在浮动环境外可以使用 \cs{captionof} 命令，第一个参数指定条目名。可以搭配 \pkg*{newfloat} 宏包创建更多类型的浮动环境并设置相应题注。\cs{bicaption} 命令可以实现中英文双语题注，需要在导言区载入 \pkg*{bicaption} 宏包，具体用法见说明文档。 + 题注命令 \cs{caption} 用于在图表上下方插入题注，需要在浮动环境 \env*{figure} 和 \env*{table} 中使用。在浮动环境外可以使用 \cs{captionof} 命令，第一个参数指定条目名。可以搭配 \pkg*{newfloat} 宏包创建更多类型的浮动环境并设置相应题注。\cs{bicaption} 命令可以实现中英文双语题注，需要在导言区载入 \pkg*{bicaption} 宏包，具体用法见说明文档。 \end{commands} \subsection{化学式} @@ -1237,13 +1250,17 @@ \subsection{索引} \begin{commands} \command*{indexsetup}[\marg{键值列表}] - \pkg*{imakeidx} 宏包增强了索引的功能，这是它的的接口命令，用于设置索引表的整体格式。 + \pkg*{imakeidx} 宏包增强了索引的功能。这是它的的接口命令，用于设置索引表的整体格式。 \command*{index}[\oarg{索引名}\marg{标签}] - 索引标签命令 \cs*{index} 的 \meta{索引名} 与索引打印命令 \cs{printindex} 一致，可以存在多个索引表。 + 索引标签命令 \cs*{index} 的 \meta{索引名} 与索引输出命令 \cs{printindex} 一致，可以存在多个索引表。 \command*{makeindex}[\oarg{键值列表}] 使用 \cs*{makeindex} 命令开启索引收集。这个命令可以重复使用打印多个索引表，以不同的 \meta{索引名} 作为区分，如果仅打印一个索引表就没必要再使用。 - \command{printindex}[\sarg\oarg{键值列表}\darg{索引名}] - 现在索引表生成命令 \cs{printindex} 被重新定义，\meta{键值列表} 中的选项与\ref{sec:document command} 其它目录命令相同，但是原本接口命令 \cs*{indexsetup} 的部分选项失效。 + \command{printindex}[\sarg\oarg{键值列表}] + 现在索引表生成命令 \cs{printindex} 被重新定义。\meta{键值列表} 中的选项与\ref{sec:document command} 其它目录命令相同，但是原本接口命令 \cs*{indexsetup} 的部分选项失效。 + \begin{options} + \keyval{name}{索引名} + 指定输出名为 \meta{索引名} 的索引表，如果只使用一个索引表则默认为项目文件名不需要指定。 + \end{options} \end{commands} \subsection{边注} @@ -1301,6 +1318,7 @@ \item 增加英文主文档目录钩子选项 \option{bibetween}。 \end{version} \shortversion{v = 1.638,date = 2022/03/04,changes = 增加目录条目样式选项注册命令 \cs{RegisterTocName}。} + \shortversion{v = 1.643,date = 2022/03/08,changes = 增加浮动环境目录声明命令 \cs{DeclareFloatList} 配合 \pkg*{caption} 宏包。} \end{changelog} \nocite{*} |