diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/easybook/easybook.dtx')
| -rw-r--r-- | Master/texmf-dist/source/latex/easybook/easybook.dtx | 79 |
1 files changed, 41 insertions, 38 deletions
diff --git a/Master/texmf-dist/source/latex/easybook/easybook.dtx b/Master/texmf-dist/source/latex/easybook/easybook.dtx index 8d861d47731..81f9679ad5b 100644 --- a/Master/texmf-dist/source/latex/easybook/easybook.dtx +++ b/Master/texmf-dist/source/latex/easybook/easybook.dtx @@ -23,12 +23,11 @@ % % \changes{v1.20}{2021/01/09}{修改和完善用户文档。} % \changes{v1.20}{2021/01/09}{模板更改为使用 CC-BY 许可协议。} -% \changes{v1.23}{2021/03/19}{修复在 \pkg{ctex} v2.5.6 更新后 \cls{easybook} 与 \pkg{hyperref} 冲突问题。} -% \changes{v1.25k}{2021/05/03}{取消附带的示例文件，可查看历史版本及其它来源的使用样例。} +% \changes{v1.25l}{2021/05/03}{取消附带的示例文件，可查看历史版本及其它来源的使用样例。} % % \title{\sffamily easybook 文档类手册} % \author{瞿毅} -% \date{2021/05/17\hskip\ccwd\relax v1.25k\thanks{\url{https://gitee.com/texl3/easybook}}} +% \date{2021/05/18\hskip\ccwd\relax v1.25l\thanks{\url{https://gitee.com/texl3/easybook}}} % % \maketitle % \begin{abstract} @@ -118,7 +117,7 @@ % \end{syntax} % 传递给 \cls{ctexbook} 设置字体，最好不要使用原有的 \opt{fontset} 选项，默认情况下使用自定义字体而不开启这个选项，可根据安装的字体及电脑系统选取。\opt{noto} 与 \opt{none} 选项的相关描述见小节 \ref{subsec:font settings}，\opt{overleaf} 是一个各系统通用选项，会检测系统环境选取对应字体。 % \changes{v1.21}{2021/01/12}{默认字体与 \CTeX 一致，不再是自定义字体。} -% \changes{v1.25k}{2021/05/04}{修复使用 \pkg{xeCJK} 与 \pkg{fontspec} 宏包的字体设置命令在 \hologo{LuaLaTeX} 下失效的问题。} +% \changes{v1.25l}{2021/05/04}{修复使用 \pkg{xeCJK} 与 \pkg{fontspec} 宏包的字体设置命令在 \hologo{LuaLaTeX} 下失效的问题。} % \end{function} % % \begin{function}[rEXP,added = 2021-01-05,updated = 2021-01-13]{paper} @@ -169,7 +168,7 @@ % \tn{listoflistings*+}\oarg{键值列表} % \end{syntax} % \tn{listoffigures} 命令输出图片目录，\tn{listoftables} 输出表格目录，\tn{listoflistings} 输出代码目录。带有星号的目录命令不将标题添加进主文档目录，带有+号的目录命令可以使当前标题编号。\tn{tableofcontents+} 与其它命令不同是用于输出双语目录，需要与双语目录标题命令 \tn{bichapter} 等或设置图片、表格和代码等英文目录的标题配合使用，附加代码是中文与英文目录之间的代码，可以插入文本和换页命令等。目录的键值列表选项如下 -% \changes{v1.25k}{2021/05/05}{命令 \tn{tableofcontents} 可以输出双语目录。} +% \changes{v1.25l}{2021/05/05}{命令 \tn{tableofcontents} 可以输出双语目录。} % \end{function} % % \begin{function}{multoc,title,format,aftertitle,pagestyle,book,article} @@ -200,7 +199,7 @@ % 双语目录的标题命令目前设置了常用的三个级别，它们将中文标题正常输出，并使中英文标题加入双语目录，这个功能是为国内一些大学的学位论文模板的要求设计，在一般情况和英文模式下不需要使用。 % % 它们的星号变体命令使文中标题不编号，但是仍然加入双语目录，若英文标题参数空置那么仅加入中文目录而不加入英文目录，这一特点与 \tn{chapter*} 等命令的行为不太一样，在一些情况下会用到。可选参数是目录中的中文标题，默认与中文标题一致，正文标题过长时可用它设置在目录中显示的标题。双语目录的格式是一致的，共享使用 \tn{tocset} 的设置，英文目录的章级别标题名及编号的修改方式如下 -% \changes{v1.25k}{2021/05/05}{增加与双语目录配合的标题命令。} +% \changes{v1.25l}{2021/05/05}{增加与双语目录配合的标题命令。} % \end{function} % % \begin{function}{biname,binmuber} @@ -300,8 +299,9 @@ % \ding{229} 以上选项路径为 \opt{refset/...} \\ % \opt{refset} 将超链接选项（包括以上选项）交给 \pkg{hyperref} 处理，除了一些关于 pdf 书签的选项可能会失效，其它由键值选项命令 \tn{hypersetup} 支持的多数选项可用。 % \changes{v1.10}{2021/01/08}{修复了 \opt{linktopage} 选项关闭时目录中标题编号无超链接的问题。} +% \changes{v1.23}{2021/03/19}{修复在 \pkg{ctex} v2.5.6 更新后 \cls{easybook} 与 \pkg{hyperref} 冲突问题。} % \changes{v1.24}{2021/04/05}{增加 \pkg{hyperref} 超链接选项完整的支持。} -% \changes{v1.25k}{2021/05/06}{模块名 \opt{link} 改为 \opt{refset}，\opt{link} 作为兼容性保留。} +% \changes{v1.25l}{2021/05/06}{模块名 \opt{link} 改为 \opt{refset}，\opt{link} 作为兼容性保留。} % \end{function} % % \begin{optdesc} @@ -380,7 +380,7 @@ % \changes{v1.21}{2021/01/11}{增加 \opt{bibset} 选项，可以使用 \hologo{BibTeX} 或 \hologo{biber} 编译参考文献。} % \changes{v1.23}{2021/02/23}{使用 \opt{bibset} 选项时可设置标注风格。} % \changes{v1.24}{2021/04/09}{可以不载入参考文献包手动配置参考文献格式。} -% \changes{v1.25k}{2021/05/12}{取消 \opt{bib-loadpkg} 选项，由是否设置参考文献数据库来决定载入宏包。} +% \changes{v1.25l}{2021/05/12}{取消 \opt{bib-loadpkg} 选项，由是否设置参考文献数据库来决定载入宏包。} % \end{function} % % \begin{optdesc} @@ -526,7 +526,7 @@ % footnoterule = <脚注横线格式> % \end{syntax} % \ding{229} 以上选项路径为 \opt{hdrset/...} \\ -% \opt{hdrset} 设置的命令由 \pkg{fancyhdr} 宏包提供支持。设置章节标志选项 \opt{chap-mark}、\opt{sec-mark} 和 \opt{subsec-mark} 时已做了情形考虑，不需要使用 \tn{markboth} 或 \tn{markright} 命令，其中参数\#1代表当前章、节或小节的标题。\opt{chap-mark} 和 \opt{sec-mark} 选项在 \opt{book} 模式时有意义，\opt{sec-mark} 和 \opt{subsec-mark} 选项在 \opt{article} 模式时有意义，这与标准文档类的行为一致。也可以直接重新定义这些标志命令，但此时 \opt{style/uppercase} 选项失效，这时可以用例如 \tn{MakeUppercase} 命令来设置标志内容的大小写。 +% \opt{hdrset} 设置的命令由 \pkg{fancyhdr} 宏包提供支持。设置章节标志选项 \opt{chap-mark}、\opt{sec-mark} 和 \opt{subsec-mark} 时已做了情形考虑，不需要使用 \tn{markboth} 或 \tn{markright} 命令，其中参数 \#1 代表当前章、节或小节的标题。\opt{chap-mark} 和 \opt{sec-mark} 选项在 \opt{book} 模式时有意义，\opt{sec-mark} 和 \opt{subsec-mark} 选项在 \opt{article} 模式时有意义，这与标准文档类的行为一致。也可以直接重新定义这些标志命令，但此时 \opt{style/uppercase} 选项失效，这时可以用例如 \tn{MakeUppercase} 命令来设置标志内容的大小写。 % % \opt{headrule}、\opt{footrule} 和 \opt{footnoterule} 三个横线选项一般可以使用 \tn{hrule} width \meta{长度} height \meta{高度} 命令来绘制，脚注横线默认为空。当然，手动绘制横线时线条粗细选项 \opt{style/rulewidth} 会失效。 % \changes{v1.21}{2021/01/11}{修复单面文档时页眉横线消失的问题。} @@ -574,7 +574,7 @@ % 上面几个选项用于设置脚注格式，\opt{fnparskip} 和 \opt{fnparindent} 选项仅在 \opt{fnhang = true} 时有效。\opt{fnhang} 用于将脚注设置为悬挂缩进的格式，\opt{fnmark-pos} 选项设置脚注编号的位置，正常文本或是上标形式。\opt{fnmark-num} 选项设置脚注编号的格式，默认为原生样式 \opt{plain}，还可以改为 \opt{pifont} 的各个版本，从左往右依次为普通版、阴文衬线版、阳文无衬线版和阴文无衬线版，缺点是它们的编号仅包括1-10。 % % \opt{fnmark-form} 是脚注标记的格式，默认为空，在此设置字体命令会覆盖 \opt{elsefont/footnote} 的设置，最后一个格式命令可以带有一个参数，这个参数接受脚注编号，一般配合 \opt{fnmark-num = plain} 使用。\opt{afterfnmark} 是脚注标记后的代码，一般用于设置标记与文本间的距离。 -% \changes{v1.25k}{2021/05/12}{增加脚注样式设置选项。} +% \changes{v1.25l}{2021/05/12}{增加脚注样式设置选项。} % \end{function} % % \subsection{目录样式} @@ -593,7 +593,7 @@ % \opt{format} 是目录中标题的格式，可以设置字体和加入垂直间距等，垂直间距最好使用无间距重合的 \tn{addvspace} 命令，带有加号的 \opt{format+} 选项用于在已有的格式命令后附加内容。\opt{indent} 是目录中标题在页面左侧的缩进距离，应该有长度单位。\opt{rule} 选项中一般应当使用 \tn{tocrule} 命令，将会在接下来介绍。\opt{numsep} 是有编号的标题在目录中编号与标题的间距。 % \changes{v1.21}{2021/01/13}{增加配置目录样式的选项。} % \changes{v1.24}{2021/04/20}{增加目录中编号与标题的间距选项 \opt{numsep}。} -% \changes{v1.25k}{2021/05/14}{可以分别设置图片、表格和代码目录的格式。} +% \changes{v1.25l}{2021/05/14}{可以分别设置图片、表格和代码目录的格式。} % \end{function} % % \begin{function}[added = 2021-01-13,updated = 2021-04-20]{\tocrule,\EbNumberline} @@ -603,7 +603,7 @@ % \end{syntax} % \tn{tocrule} 命令生成目录引导线，需要在 \opt{rule} 选项中使用。带有星号的命令会使当前级别的目录引导线右边与页码连接而不是对齐。引导点间距需带有长度单位，引导点大小不带单位，为引导点符号正常大小的倍数，引导点一般为英文句号或 \tn{cdot} 中心点符号。页码格式的内容位于页码前面，可以设置页码字体、距离。 % -% \tn{EbNumberline} 命令类似 \CTeX 的 \tn{CTEXnumberline} 命令，用于 \opt{tocline} 选项中设置目录标签的编号。区别是它需要在 \opt{tocset/hang = false} 时使用，否则目录中无法显示标题编号，使用它的时候 \opt{numsep} 选项仍然有效。\meta{编号类型} 为 \opt{chapter} 和 \opt{section} 等，也可用参数\#1代替当前级别类型，标题名用参数\#2代替一般不变。 +% \tn{EbNumberline} 命令类似 \CTeX 的 \tn{CTEXnumberline} 命令，用于 \opt{tocline} 选项中设置目录标签的编号。区别是它需要在 \opt{tocset/hang = false} 时使用，否则目录中无法显示标题编号，使用它的时候 \opt{numsep} 选项仍然有效。\meta{编号类型} 为 \opt{chapter} 和 \opt{section} 等，也可用参数 \#1 代替当前级别类型，标题名用参数 \#2 代替一般不变。 % \end{function} % % \begin{ctexexam} @@ -642,7 +642,7 @@ % \begin{optdesc} % \item[lolskip] \opt{lolskip} 是代码目录中章之间的代码标题的距离，与 \CTeX 的表格目录和图片目录中章之间的标题距离选项 \opt{lotskip} 和 \opt{lofskip} 类似，它们的值均默认0.8 pc，在 \opt{article} 模式中此选项失效。 % \item[belowoffset] \opt{belowoffset} 选项为主目录标题 \tn{contentsname} 后的间距补偿，一般为负值，用于抵消 \opt{format} 中设置的垂直间距。\opt{(level)} 中的 \opt{belowoffset} 与之意义类似，代表 figure、table 和 lstlisting 三个级别，也可以使用 \opt{list} 统一设置，一般为正值。建议距离 \opt{lolskip(0.8pc) + (level)/format/addvspace(0.2pc) + (level)/belowoffset(0pc) = belowoffset(-1pc)}。 -% \item[tocline] 目录标签整体使用 \opt{tocline} 设置，在图表标签的参数中\#1代表编号，代码标签中则是 \tn{thelstlisting} 代表编号，标签中还可包含标签名称，默认标签名称与图、表和代码环境的标题名称一致。下面举个设置标签的例子 +% \item[tocline] 目录标签整体使用 \opt{tocline} 设置，在图表标签的参数中 \#1 代表编号，代码标签中则是 \tn{thelstlisting} 代表编号，标签中还可包含标签名称，默认标签名称与图、表和代码环境的标题名称一致。下面举个设置标签的例子 % \begin{ctexexam} % \tocset % { @@ -678,7 +678,7 @@ % \tn{end}\marg{环境名} % \end{syntax} % \pkg{tabularray} 是一个较新的宏包，不仅提供了 \pkg{tabularx}、\pkg{multirow}、和 \pkg{booktabs} 宏包的功能，并且不依赖其它宏包与它们同时使用不会产生冲突，还实现了用简便的键值列表方式设置表格样式。目前除了表头斜线以及跨页功能存在不足，其它方面已满足对表格绝大多数格式的需求，具体用法可见宏包的说明文档。 -% \changes{v1.25k}{2021/05/17}{使用功能更便捷齐全的 \pkg{tabularray} 宏包设置表格样式。} +% \changes{v1.25l}{2021/05/17}{使用功能更便捷齐全的 \pkg{tabularray} 宏包设置表格样式。} % \end{function} % % \subsection{列表} @@ -834,21 +834,22 @@ % \end{function} % % \subsection{物理量} -% \begin{function}[added = 2021-01-05,updated = 2021-02-23]{\num,\si,\SI,\SIrange} +% \begin{function}[added = 2021-01-05,updated = 2021-05-18]{\num,\unit,\qty,\qtyrange} % \begin{syntax} % \tn{num}\oarg{键值列表}\marg{数字} -% \tn{si}\oarg{键值列表}\marg{单位} -% \tn{SI}\oarg{键值列表}\marg{数字}\oarg{前缀}\marg{单位} -% \tn{SIrange}\oarg{键值列表}\marg{数字1}\marg{数字2}\marg{单位} +% \tn{unit}\oarg{键值列表}\marg{单位} +% \tn{qty}\oarg{键值列表}\marg{数字}\oarg{前缀}\marg{单位} +% \tn{qtyrange}\oarg{键值列表}\marg{数字1}\marg{数字2}\marg{单位} % \end{syntax} -% \pkg{siunitx} 宏包的 \tn{num} 命令可以输出科学计数法，\tn{si} 命令支持数学模式，可以代替数学行内公式输入，而 \tn{SI} 命令可用来输出带有单位的量，\tn{SIrange} 可以输出带有范围和单位的量。 +% \pkg{siunitx} 宏包的 \tn{num} 命令可以输出以科学计数法表示的数值，单位格式化命令 \tn{unit} 包含文字项目（例如字母或数字）时，使用 . 和 \~{} 放置在单元乘积中间，并使用 \_ 和 \^{} 正确放置指定的下标和上标。格式化方法可在数学和文本模式下使用。而 \tn{qty} 命令可用来输出带有单位的量，\tn{qtyrange} 可以输出带有范围和单位的量。 +% \changes{v1.25l}{2021/05/18}{\pkg{siunitx} 宏包 v3.0.0 更新后用法改变，修改相关配置选项。} % \end{function} % % \begin{ctexexam} -% \num{-21x.3e5} -% \si{mL.min^{-1}} -% \SI{5}{\mole} -% \SIrange[unit-color = green]{1.5}{4}{kg} +% \numproduct{-21x3e5} +% \unit{mL~min^{-1}} +% \qty{5}{\mole} +% \qtyrange[unit-color = green]{1.5}{4}{kg} % \end{ctexexam} % % \subsection{化学式} @@ -866,7 +867,7 @@ % \tn{ref}\marg{标签} % \tn{labelformat}\marg{计数器}\marg{标签引用格式} % \end{syntax} -% 使用 \tn{ref} 命令引用 \tn{label} 设置的标签，将会检测临近计数器并添加相应的前缀，比如图表、章节标题和定理等。\tn{labelformat} 可以设置标签引用格式，第二个参数中\#1代表 \tn{the}\meta{计数器}，可以设置引用序号的前缀和后缀。 +% 使用 \tn{ref} 命令引用 \tn{label} 设置的标签，将会检测临近计数器并添加相应的前缀，比如图表、章节标题和定理等。\tn{labelformat} 可以设置标签引用格式，第二个参数中 \#1 代表 \tn{the}\meta{计数器}，可以设置引用序号的前缀和后缀。 % \changes{v1.24}{2021/04/11}{取消载入 \pkg{cleveref} 宏包来交叉引用。} % \end{function} % @@ -978,7 +979,7 @@ %<*class> \NeedsTeXFormat{LaTeX2e}[2020/10/01] \RequirePackage{l3keys2e,etoolbox} -\ProvidesExplClass{easybook}{2021/05/17}{1.25k}{beta} +\ProvidesExplClass{easybook}{2021/05/18}{1.25l}{beta} \cs_generate_variant:Nn \eb_ctex_define:nn { nx } \cs_generate_variant:Nn \int_to_arabic:n { v } @@ -1200,7 +1201,8 @@ { l3keys2e } { 2020/10/27 }, { ctex } { 2021/03/14 }, { thmtools } { 2020/08/01 }, - { caption } { 2020/08/24 } + { caption } { 2020/08/24 }, + { siunitx } { 2021/05/17 } } { \eb_package_later_bool:nn #1 } @@ -1216,7 +1218,7 @@ \cs_new_protected:Npn \eb_font_double_engine_set:n #1 { \exp_args:Nc \RenewDocumentCommand {set#1font}{O{}mO{}} - {\use:c { eb_set#1font:nn }{##2}{##1,##3}} + {\use:c { eb_set#1font:nn } {##2} {##1,##3}} } \seq_const_from_clist:Nn \c__eb_font_reset_family_seq { main,sans,mono,CJKmain,CJKsans,CJKmono } @@ -1934,8 +1936,7 @@ \tl_if_eq:NnTF \l__eb_toc_type_tl { book } { \bichapter{\eb@toc@title}{\eb@bitoc@title} } { \bisection{\eb@toc@title}{\eb@bitoc@title} } - } - { + }{ \IfBooleanTF{#2} { \eb_title_mark_notoc:n {\eb@toc@title} } { \eb_title_mark_intoc:n {\eb@toc@title} } @@ -2379,16 +2380,18 @@ } \sisetup { - detect-shape, - detect-family, - detect-weight, + mode = match, table-parse-only, - detect-display-math, - detect-inline-family = math, - detect-inline-weight = math, - range-phrase = \ensuremath{\sim}, - range-units = single, - group-digits = false + propagate-math-font, + text-family-to-math, + text-series-to-math, + reset-text-family = false, + reset-text-series = false, + reset-text-shape = false, + reset-math-version = false, + range-phrase = \ensuremath{\sim}, + range-units = single, + group-digits = none } \eb_at_begin_environment:nn { |