diff options
author | Karl Berry <karl@freefriends.org> | 2021-12-08 21:07:11 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-12-08 21:07:11 +0000 |
commit | 1657eb1ea20d453e066007abbeed9a6fe1eec8f1 (patch) | |
tree | e9c5363bfafd8362e64deeff7071c70cf249ea42 /Master/texmf-dist/doc | |
parent | f6978120a0dcdb3287c9987cc90b1b1bb4926d1b (diff) |
easybook (8dec21)
git-svn-id: svn://tug.org/texlive/trunk@61251 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/easybook/easybook.pdf | bin | 586391 -> 590568 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/easybook/easybook.tex | 111 |
2 files changed, 63 insertions, 48 deletions
diff --git a/Master/texmf-dist/doc/latex/easybook/easybook.pdf b/Master/texmf-dist/doc/latex/easybook/easybook.pdf Binary files differindex aed29d91ad2..9d298312428 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 f2796f76843..ffb579a3b04 100644 --- a/Master/texmf-dist/doc/latex/easybook/easybook.tex +++ b/Master/texmf-dist/doc/latex/easybook/easybook.tex @@ -11,7 +11,7 @@ cs => purple, option => black!10!teal, cnltx => Blue, - link => magenta, + link => OrangeRed, module => violet, meta => black } @@ -20,8 +20,8 @@ name = easybook, color-scheme = blue, title = EASYBOOK 使用手册, - version = v1.41I, - date = 2021/12/06, + version = v1.41L, + date = 2021/12/08, authors = 瞿毅, info = 排版简体中文学位论文和书籍, email = q1jx@foxmail.com, @@ -47,6 +47,7 @@ \setlist{nosep,labelindent = \parindent,leftmargin = *,labelsep = 0.5em} \setlist[itemize,1]{label = \small\color{Blue}\textbullet} \setcounter{tocdepth}{2} +\SetTblrInner{hline{1,Z} = {1pt,Blue}} \ExplSyntaxOn\makeatletter \newcommand{\splitmeta}[2][\code{,}] @@ -189,7 +190,6 @@ \insertblr { colspec = @{}*{5}{c}@{}, - hline{1,6} = {1pt,Blue}, cells = {cmd = \pkg*}, cell{1}{3,4} = brown8, cell{2}{5} = brown8, @@ -208,7 +208,7 @@ \section{文档类选项} \label{sec:document class options} -文档类选项应当在使用 \cls*{easybook} 文档类或 \pkg*{easybase} 宏包(部分支持)时载入,可见小节 \ref{subsec:basic usage} 的例子。目前 \pkg*{easybase} 宏包可用的选项有 \option{class}、\option{draft}、\option{paper} 和 \option{floatpage}。除了下面列举的选项,还可使用标准文档类和 C\TeX 文档类的选项。 +文档类选项应当在使用 \cls*{easybook} 文档类或 \pkg*{easybase} 宏包(部分支持)时载入,可见小节 \ref{subsec:basic usage} 的例子。目前 \pkg*{easybase} 宏包可用的选项有 \option{class}、\option{draft}、\option{paper} 和 \option{floatpage}。除了下面列举的选项以外,还支持标准和 C\TeX 文档类的选项。 \begin{options} \opt{draft}\Default! 开启草稿模式会加快编译速度,表现有显示页面边框、行溢出的地方显示黑色方块、图片变成占位方框、显示当前日期和关闭超链接渲染。不使用绘图宏包及依赖于 \pkg*{tcolorbox} 宏包的盒子环境也会增快编译速度,详情见小节 \ref{subsec:box}。 @@ -247,7 +247,6 @@ \insertblr { colspec = @{}*{4}{c}@{}, - hline{1,8} = {1pt,Blue}, hline{2} = {0.6pt,Blue}, row{1} = {font = \sffamily}, column{1} = {cmd = \code} @@ -326,7 +325,7 @@ 目录标题所在页的页面格式,仅当目录以 \code{chapter} 级别输出时有效。除了上述选项还支持 C\TeX 键值列表路径 \module*{chapter} 或 \module*{section} 所有的章节标题样式选项。 \end{options} -\subsection{标题命令} +\subsection{双语标题} 双语目录标题命令目前设置了常用的三个级别,它们将中文标题正常输出,并使中英文标题加入双语目录。类似于标准文档类,这三个标题命令分别具有独立的计数器\footnote{默认情况下与普通标题命令共享使用计数器。},并对应 \cs*{the}\meta{计数器} 的值,可以用于 \option{binumber} 选项更改英文目录中的编号。这个功能是为国内一些高校的学位论文模板的要求设计,在一般情况和英文模式下\textbf{不需要使用}。 \begin{commands} \command{bichapter}[\sarg\oarg{目录中文标题}\marg{中文标题}\marg{目录英文标题}] @@ -353,7 +352,7 @@ \end{commands} \subsection{上标和下标} -上标和下标的功能来自 \pkg*{spbmark} 宏包,\cs{super}、\cs{sub} 和 \cs{supersub} 三个命令可以用于输出上标和下标。它们根据当前处于文本还是数学模式来匹配相应的模式,或者可以使用它们的星号变体命令来强制使用数学模式。也可以使用键值列表对偏移量进行全局设置,详情见小节 \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{格式代码} 可以插入字体或颜色等命令,代码中的最后一个命令可以接受一个为上标或下标的参数。 @@ -371,7 +370,6 @@ \insertblr { colspec = @{}*{5}{c}@{}, - hline{1,5} = {1pt,Blue}, hline{3} = {0.6pt,Blue}, row{1,3} = {font = \sffamily,belowsep = 0pt}, row{2,4} = {cmd = \module*} @@ -408,7 +406,7 @@ \command{DeclareThemeColor}[\splitmarg{风格名称,ctex@frame,ctex@emph,ctex@verb}] 可以使用 \cs{DeclareThemeColor} 命令声明新的颜色主题,它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成颜色主题。类似地更改超链接颜色见小节 \ref{subsec:hyperlinks}。 \end{commands} - \keyval-{color-all}{HTML颜色代码}\Default + \keyval-{color-every}{HTML颜色代码}\Default 统一设置主题的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。 \keyval-{multoc}{整数}\Default{2} 使目录多栏排版,与节 \ref{sec:document command} 中目录命令的同名选项有相同效果。 @@ -436,15 +434,15 @@ \subsubsection{连接符} \begin{options} - \keyval-{figure-connect}{图片连接符}\Default{\Carg{.}} + \keyval-{connect-figure}{图片连接符}\Default{\Carg{.}} 设置图片题注编号的连接符。 - \keyval-{table-connect}{表格连接符}\Default{\Carg{.}} + \keyval-{connect-table}{表格连接符}\Default{\Carg{.}} 设置表格题注编号的连接符。 - \keyval-{listing-connect}{代码连接符}\Default{\Carg{.}} + \keyval-{connect-listing}{代码连接符}\Default{\Carg{.}} 设置代码题注编号的连接符。 - \keyval-{equation-connect}{公式连接符}\Default{\Carg{.}} + \keyval-{connect-equation}{公式连接符}\Default{\Carg{.}} 设置公式题注编号的连接符。 - \keyval-{connect-all}{连接符}\Default{\Carg{.}} + \keyval-{connect-every}{连接符}\Default{\Carg{.}} 统一设置上述所有编号的连接符。 \end{options} @@ -489,7 +487,7 @@ \command{DeclareLinkColor}[\splitmarg{风格名称,ctex@link,ctex@url,ctex@cite}] 可以使用 \cs{DeclareLinkColor} 命令声明新的超链接颜色样式,它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成超链接颜色。 \end{commands} - \keyval-{linkcolor-all}{HTML颜色代码}\Default + \keyval-{linkcolor-every}{HTML颜色代码}\Default 统一设置超链接的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。 \keychoice{linktoc}{none,section,page,all}\Default{all} 将目录中的超链接取消、置于标题上、置于页码上或置于标题和页码上。 @@ -500,40 +498,55 @@ 行距因子用于设置各种行距倍数,\meta{数值} 是不带有长度单位的浮点数。各类行距既可以在导言区全局设置,也可以在正文中设置对后面生效。 \begin{options} \keyval-{line}{数值}\Module{spread}\Default{1.354} - 正文行距因子,C\TeX 原有的行距选项 \option*{linespread} 失效。 + 正文行距因子,注意 C\TeX 宏集原有的行距选项 \option*{linespread} 失效。 \keyval-{table}{数值}\Default{1.354} - 表格行距因子,对传统表格 \env*{tabular} 和 \env*{tabularx} 等环境以及 \pkg*{tabularray} 宏包的 \env{tblr} 环境生效,同时 \env{tblr} 也自带有 \option*{stretch} 选项设置行距系数。 + 表格内容行距因子,对传统表格 \env*{tabular} 和 \env*{tabularx} 等环境以及 \pkg*{tabularray} 宏包的 \env{tblr} 环境生效,同时 \env{tblr} 也自带有 \option*{stretch} 选项设置行距系数。 \keyval-{math}{数值}\Default{1.2} 数学环境的行距因子,包含了 \pkg*{amsmath} 和 \pkg*{mathtools} 宏包提供的公式环境。 - \keyval-{caption}{数值}\Default{1.2} - 图片、表格和代码题注的行距因子。 + \keyval-{caption-figure}{数值}\Default{1.2} + 图片题注的行距因子。 + \keyval-{caption-table}{数值}\Default{1.2} + 表格题注的行距因子。 + \keyval-{caption-listing}{数值}\Default{1.2} + 代码题注的行距因子。 + \keyval-{caption-every}{数值}\Default{1.2} + 同时设置图片、表格和代码题注的行距因子。 \keyval-{footnote}{数值}\Default{1.2} - 脚注内容整体的行距因子,可以使用 \option{fnpara-form} 的代码覆盖每个脚注单独的行距,从而与不同脚注的段落间距不同。 + 脚注内容整体的行距因子,可以使用 \option{fnpara-form} 的代码覆盖每个脚注单独的行距,从而与不同脚注的段落间距不同\footnote{若在正文区中更改脚注行距,脚注横线下方的间距不会随当前行距改变。}。 \begin{ctexexam} \spread{footnote = 1.3} \hdrset{fnpara-form = \linespread{1.2}\selectfont} \end{ctexexam} - \keyval-{spread-all}{数值}\Default - 统一设置上述各种行距因子。 + \keyval-{every}{数值}\Default + 统一设置上述所有的行距因子。 \end{options} \subsection{其它字体} \label{subsec:other font} \begin{options} \keyval-{caption-table}{字体命令}\Module{subfont}\Default{\cs*{sffamily}\cs*{small}} - 表格标题的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 + 表格题注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 \keyval-{caption-figure}{字体命令}\Default{\cs*{sffamily}\cs*{small}} - 图片标题的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 + 图片题注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 \keyval-{caption-listing}{字体命令}\Default{\cs*{sffamily}\cs*{small}} - 代码标题的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 - \keyval-{caption}{字体命令}\Default{\cs*{sffamily}\cs*{small}} + 代码题注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 + \keyval-{caption-every}{字体命令}\Default{\cs*{sffamily}\cs*{small}} 同时设置图片、表格和代码题注的字体命令。 - \keyval-{footnote}{字体命令}\Default{\cs*{rmfamily}} + \keyval-{footnote}{字体命令}\Default{\cs*{rmfamily}\cs*{footnotesize}} 设置脚注标记与内容的字体,包括字体族、字体系列、字体尺寸和字体形状命令。 \keyval-{marginpar}{字体命令}\Default{\cs*{rmfamily}\cs*{footnotesize}} 边注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。 \end{options} +\begin{commands} + \command{addsubfont}[\marg{字体类型}\marg{字体命令}] + 用于在上述各种字体原有的格式上附加代码。其中 \meta{字体命令} 也可以包括行距命令且相对于 \module*{spread} 模块具有优先性,不同题注的 \meta{字体类型} 则为相应选项的后缀名。 + \begin{ctexexam} + \addsubfont{every}{\linespread{1.5}\selectfont} + \addsubfont{footnote}{\sffamily} + \end{ctexexam} +\end{commands} + \subsection{参考文献} \label{subsec:reference} \begin{options} @@ -577,7 +590,7 @@ \subsection{定理样式} \label{subsec:theorem of style} -文档类已预置 8 个定理环境,环境名及对应的定理名见小节 \ref{subsec:theorem},它们均使用预置的定理样式 \code{easy-theorem}。下面 \module*{thmset} 模块的选项仅对这个定理样式生效,由 \pkg*{thmtools} 宏包提供支持。如果下面的选项不满足需求,可使用支持完整选项的相关命令新建定理环境。 +文档类已预置 11 个定理环境,环境名及对应的定理名见小节 \ref{subsec:theorem},它们均使用预置的定理样式 \code{easy-theorem}。下面 \module*{thmset} 模块的选项仅对这个定理样式生效,由 \pkg*{thmtools} 宏包提供支持。如果下面的选项不满足需求,可使用支持完整选项的相关命令新建定理环境。 \begin{options} \keybool{thmframe}\Module{thmset}\Default{false} 给定理环境使用彩色盒子。这个特殊选项在本模块中使用 \pkg*{tcolorbox} 宏包来支持,\meta{盒子风格} 默认为 \code{tc-theorem}。\pkg*{thmtools} 具有类似的选项 \option*{thmbox},可在新建定理样式的命令中使用。 @@ -694,11 +707,11 @@ \kvsplit-{subsec-label}{\oarg{数字输出命令}\marg{距离命令}}\Default{\cs*{hspace}\Carg{0.5em}} 标题标记命令内容 \cs*{subsectionmark} 的标签,用法与 \option{chap-label} 类似。 \keyval-{headrule}{横线命令} - 绘制页眉横线的选项,可以使用 \cs*{hrule}、\cs*{rule} 或下述 \cs{markrule} 等画线命令来绘制横线。手动绘制横线时线条粗细选项 \option{rulewidth} 会失效。 + 绘制页眉横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。手动绘制横线时线条粗细选项 \option{rulewidth} 会失效。 \keyval-{footrule}{横线命令}\Default - 绘制页脚横线的选项,可以使用 \cs*{hrule}、\cs*{rule} 或下述 \cs{markrule} 等画线命令来绘制横线。 + 绘制页脚横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。 \keyval-{footnoterule}{横线命令} - 绘制脚注横线的选项,可以使用 \cs*{hrule}、\cs*{rule} 或下述 \cs{markrule} 等画线命令来绘制横线。 + 绘制脚注横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。 \end{options} \begin{commands}\noitemsep @@ -753,7 +766,7 @@ \begin{commands}\noitemsep \command{DefineFntSymbols}[\marg{符号表名}\marg{符号数量}\marg{符号列表}]\default{} \command{setfntsymbol}[\marg{符号表名}] - 这两个命令用于在脚注短编号标记为 \code{s} 自定义符号型时设置符号列表。\cs{DefineFntSymbols} 命令用于设置符号列表,\cs{setfntsymbol} 命令用于选择已定义符号列表。默认的脚注符号列表是空的,定义新列表时应注意 \meta{符号列表} 的写法和命令顺序: + 这两个命令用于在脚注短编号标记为 \code{s} 自定义符号型时设置符号列表。\cs{DefineFntSymbols} 命令用于设置符号列表,\cs{setfntsymbol} 命令用于选择已定义的符号列表。默认的脚注符号列表是空的,定义新列表时应注意 \meta{符号列表} 的写法和命令顺序: \begin{ctexexam} \DefineFntSymbols{myfnsymb}{2}{{1}{*}{2}{@}} \setfntsymbol{myfnsymb} @@ -850,13 +863,13 @@ 目录标题与内容间的钩子,一般插入负的垂直距离代码,用于抵消目录首行额外的垂直间距。一级路径此选项对应文档主目录的钩子,二级路径为 \module*{figure}、\module*{table} 和 \module*{lstlisting},或者用位于 \module*{list} 路径的此选项统一设置相应类型目录的钩子。 \keybool{dotalign}\Default{true} 引导线选项 \option{dotalign} 可以使目录引导线右端对齐并与页码保持一定间距,否则会与页码相连。 - \keyval-{pnumwd}{刚性长度}\Default{1.55em} + \keyval-{pagenumwd}{刚性长度}\Default{1.55em} 目录条目页码的宽度。开启 \option{dotalign} 选项时宽度越大引导线与页码的距离就越大。 - \keyval-{tocafter-all}{距离命令}\Default{\cs*{hspace}\Carg{1em}} + \keyval-{tocafter-every}{距离命令}\Default{\cs*{hspace}\Carg{1em}} 统一设置所有级别在目录中标签与标题间的代码。 - \keyval-{tocindent-all}{刚性长度} + \keyval-{tocindent-every}{刚性长度} 统一设置所有级别的目录标题左边缩进。 - \keyval-{tocrule-all}{目录引导线样式} + \keyval-{tocrule-every}{目录引导线样式} 统一设置所有级别的目录引导线样式。 \end{options} @@ -928,25 +941,27 @@ \subsection{定理} \label{subsec:theorem} \begin{environments}\noitemsep - \environment{theorem}\default{} - \environment{definition}\default{} - \environment{lemma}\default{} - \environment{corollary}\default{} - \environment{proposition}\default{} - \environment{example}\default{} - \environment{remark}\default{} + \environment{theo}\default{} + \environment{defi}\default{} + \environment{lemm}\default{} + \environment{corol}\default{} + \environment{prop}\default{} + \environment{exam}\default{} + \environment{conj}\default{} + \environment{assum}\default{} + \environment{axiom}\default{} + \environment{rema}\default{} \environment{proof} 这些是预置的定理环境,可使用选项 \option{thmframe} 为它们添加盒子边框,其中注与证明环境不编号,证明末尾会自动添加证明结束符,声明新的定理环境或更改定理盒子样式见小节 \ref{subsec:theorem of style}。环境名与之对应的定理名如下: \insertblr { - colspec = @{}*{8}{c}@{}, - hline{1,3} = {1pt,Blue}, + colspec = @{}*{11}{c}@{}, hline{2} = {0.6pt,Blue}, row{1} = {font = \sffamily}, row{2} = {cmd = \env} }{ - 定理 & 定义 & 引理 & 推论& 性质 & 例 & 注 & 证明 \\ - theorem & definition & lemma & corollary & proposition & example & remark & proof + 定理 & 定义 & 引理 & 推论& 性质 & 例 & 猜想 & 假设 & 公理 & 注 & 证明 \\ + theo & defi & lemm & corol & prop & exam & conj & assum & axiom & rema & proof } \end{environments} |