From a607bd31ca2f248c3553f46abe08f9bc257390d8 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Thu, 14 Jan 2021 03:03:23 +0000 Subject: CTAN sync 202101140303 --- macros/latex/contrib/easybook/doc/easybook.tex | 113 ++++++++++++++++++++----- 1 file changed, 94 insertions(+), 19 deletions(-) (limited to 'macros/latex/contrib/easybook/doc/easybook.tex') diff --git a/macros/latex/contrib/easybook/doc/easybook.tex b/macros/latex/contrib/easybook/doc/easybook.tex index 44fc91afd6..bb52059ba9 100644 --- a/macros/latex/contrib/easybook/doc/easybook.tex +++ b/macros/latex/contrib/easybook/doc/easybook.tex @@ -8,15 +8,14 @@ \title{\sffamily easybook书籍文档类} \author{瞿毅} -\date{2021/01/12\hskip\ccwd\relax v1.21b\thanks{\url{https://gitee.com/TeX-doc/easybook}}} +\date{2021/01/13\hskip\ccwd\relax v1.21c\thanks{\url{https://gitee.com/TeX-doc/easybook}}} \begin{document} \maketitle \changes{v1.20}{2021/01/09}{修改和完善用户文档。} \changes{v1.20}{2021/01/09}{模板更改为使用CC-BY许可协议。} -\changes{v1.21}{2021/01/11}{修复单面文档时页眉横线消失的问题。} \begin{abstract} - \cls{easybook} 是基于 \cls{ctexbook} 书籍文档类创建以极简为风格的模板,可以看作对 \cls{ctexbook} 的进一步包装。虽然\CTeX 文档类提供了较好的中文支持,但想实现个性化功能一般需要在其基础上载入更多宏包来定制。\cls{easybook} 考虑了一些细节并载入一些常用宏包实现一般的排版需求,它适用于排版中英文书籍或笔记,甚至可稍加修改成为学位论文模板。 + \cls{easybook} 是基于 \cls{ctexbook} 书籍文档类创建以极简为风格的模板,可以看作对 \cls{ctexbook} 的进一步包装。虽然\CTeX 文档类提供了较好的中文支持,但想实现个性化功能一般需要在其基础上载入更多宏包来定制。\cls{easybook} 考虑了一些细节并载入一些常用宏包实现一般的排版需求,它适用于排版中英文书籍或笔记,甚至可稍加调整成为学位论文模板。 \end{abstract} \tableofcontents @@ -29,7 +28,6 @@ \end{itemize} \subsection{编译步骤} - \begin{frameverb} xelatex -shell-escape easybook-demo bibtex easybook-demo @@ -53,14 +51,13 @@ \setCJKmonofont{FangSong} \end{ctexexam} -\section{模板选项} +\section{文档类选项}\label{subsec2} 标准 \cls{book} 文类与 \cls{ctexbook} 文类的选项同样适用于本文档。除此之外选项分为两类 \begin{itemize} \item 带有 \rexptarget\rexpstar{} 号的选项,需要在引入文档类的时候设定。 \item 带有 \exptarget\expstar{} 号的选项,需要通过\CTeX 宏集提供的用户接口命令 \tn{ctexset} 设定。 \end{itemize} -\subsection{文档类选项}\label{subsec2} \begin{function}[rEXP,added = 2021-01-05]{draft} 开启草稿模式会加快编译速度,表现有显示页面边框、行溢出的地方显示黑色方块、图片变成占位方框、显示当前日期和关闭超链接渲染。 \end{function} @@ -91,14 +88,14 @@ 传递给 \cls{ctexbook} 设置字体,最好不要使用原有的 \opt{fontset} 选项,默认情况下使用自定义字体而不开启这个选项,可根据安装的字体及电脑系统选取。\opt{myfont} 与 \opt{none} 选项的相关描述见小节 \ref{subsec1},\opt{overleaf} 是一个各系统通用选项,会检测系统环境选取对应字体。 \end{function} -\begin{function}[rEXP,added = 2021-01-05]{paper} +\begin{function}[rEXP,added = 2021-01-05,updated = 2021-01-13]{paper} \begin{syntax} - paper = <(a4)|b5> + paper = <(a4paper)|b5paper|letterpaper|...> \end{syntax} -设置版面规格,有A4和B5两种纸张大小,建议 选项 \opt{a4} 和 \opt{zihao = 5},选项 \opt{b5} 和 \opt{zihao = -4} 配合。 +设置页面大小,交给 \pkg{geometry} 宏包处理,可使用它支持的所有规格。建议选项 \opt{b5paper} 和 \opt{zihao = 5},选项 \opt{a4paper} 和 \opt{zihao = -4} 配合。 \end{function} -\subsection{接口选项} +\section{接口选项} \begin{function}[added = 2021-01-05]{\ctexset} \begin{syntax} \tn{ctexset}\marg{键值列表} @@ -114,7 +111,7 @@ \opt{config}为载入用户配置选项,配置文件名不需加括号但需带有后缀名如 \opt{tex}、\opt{def} 和 \opt{cfg}。 \end{function} -\subsubsection{风格} +\subsection{风格} \begin{function}[EXP,added = 2021-01-05,updated = 2021-01-12]{style/color,style/capdash,style/multoc,style/withpart,style/perchap,style/perpage} \begin{syntax} color = <(none)|forest|energy|cyberpunk> @@ -135,7 +132,7 @@ \tn{definecolor}\oarg{类型}\marg{名称}\marg{模式列表}\marg{参数列表} \end{syntax} \changes{v1.10}{2021/01/08}{可以自定义主题颜色。} - 主题颜色用到这三个颜色,可以使用 \tn{definecolor} 命令进行更改,类似地更改超链接颜色见小节 \ref{ssubsec1}。 + 主题颜色用到这三个颜色,可以使用 \tn{definecolor} 命令进行更改,类似地更改超链接颜色见小节 \ref{subsec3}。 \end{function} \item[capdash] 将图表代码标题风格由例如\textsf{图1.1}变为\textsf{图1\textendash 1}的形式。 \item[multoc] 开启双栏目录,可与 \opt{onecolumn} 和 \opt{twocolumn} 选项配合出单栏正文、单栏目录,双栏正文、单栏目录,单栏正文、双栏目录和双栏正文、双栏目录四种方式 。 @@ -144,7 +141,7 @@ \item[perpage] 使脚注跟随每一页编号,默认不跟随。 \end{optdesc} -\subsubsection{超链接}\label{ssubsec1} +\subsection{超链接}\label{subsec3} \begin{function}[EXP,added = 2021-01-05,updated = 2021-01-08]{link/hyperlink,link/linkcolor,link/linktopage} \begin{syntax} hyperlink = <(edge)|various|none> @@ -166,7 +163,7 @@ \item[linktopage] 将目录中的超链接置于页码上,默认是置于标题上。 \end{optdesc} -\subsubsection{行距} +\subsection{行距} \begin{function}[EXP,added = 2021-01-05,updated = 2021-01-12]{spread/linespread,spread/tabspread,spread/mathspread,spread/capspread,spread/fnspread,spread/fnsep} \begin{syntax} linespread = <(1.3)> @@ -189,7 +186,7 @@ \item[fnspread] 脚注与脚注线间的距离,需带有长度单位。 \end{optdesc} -\subsubsection{其它字体} +\subsection{其它字体} \begin{function}[EXP,added = 2021-01-08]{elfont/tabfont,elfont/figfont,elfont/lstfont,elfont/fnfont,elfont/marfont} \begin{syntax} tabfont = <\tn{sffamily}\tn{small}> @@ -209,7 +206,7 @@ \item[marfont] 边注的字体设置。 \end{optdesc} -\subsubsection{参考文献} +\subsection{参考文献} \begin{function}[EXP,added = 2021-01-11]{bibset/backend,bibset/bibstyle,bibset/citestyle,bibset/bibfile,\printbibliography} \begin{syntax} backend = <(bibtex)|biblatex> @@ -229,7 +226,7 @@ \item[\tn{printbibliography}] 两种方式\textsf{均使用}此命令打印参考文献,其中可选项仅在 \hologo{biber} 处理时有效。 \end{optdesc} -\subsubsection{定理样式} +\subsection{定理样式} \begin{function}[EXP,added = 2021-01-12]{thmset/thmbox,thmset/numberwith,thmset/headpunct,thmset/bodyfont,thmset/notefont,thmset/headindent,thmset/spaceabove,thmset/spacebelow} \begin{syntax} thmbox = @@ -261,6 +258,84 @@ \declaretheorem[style = mythm,name = 定理名]{定理环境名} \end{ctexexam} 若要重新定义一个全新的定理样式,具体参数可以查看 \pkg{thmtools} 宏包帮助文档。 + +\subsection{页面边距} +\begin{function}[EXP,added = 2021-01-13]{geoset/left,geoset/top,geoset/hmargin,geoset/textwidth,geoset/includehead,...} +\begin{syntax} + left = <长度> + top = <长度> + hmargin = \marg{左边距,右边距} + textwidth = <长度> + includehead = +\end{syntax} +\changes{v1.21c}{2021/01/13}{增加配置页面边距的选项。} +\opt{geoset} 将选项交给 \pkg{geometry} 宏包接口命令 \tn{geometry} 处理,并且选项的键值列表与之相同,支持的参数可查阅宏包帮助文档。当在此设置页面大小时,会覆盖 \opt{paper} 选项的设置。 +\begin{ctexexam} + \ctexset + { + geoset = + { + top = 2.5cm, + bottom = 2.5cm, + left = 3.2cm, + right = 3.2cm + } + } +\end{ctexexam} +\end{function} + +\subsection{页眉页脚} +\begin{function}[EXP,added = 2021-01-13]{hdrset/elhead,hdrset/echead,hdrset/ochead,hdrset/orhead,hdrset/olfoot,...} +\begin{syntax} + elhead = \tn{color{ctex@frame}}\tn{thepage} + echead = \tn{color{ctex@frame}}\tn{kaishu}\tn{leftmark} + ochead = \tn{color{ctex@frame}}\tn{kaishu}\tn{rightmark} + orhead = \tn{color{ctex@frame}}\tn{thepage} + olfoot = <未设置> +\end{syntax} +\changes{v1.21}{2021/01/11}{修复单面文档时页眉横线消失的问题。} +\changes{v1.21c}{2021/01/13}{增加配置页眉页脚的选项。} +\opt{hdrset} 将选项交给 \pkg{fancyhdr} 宏包页面风格命令 \tn{fancyhf} 处理,\pkg{fancyhdr} 将页眉页脚分成左中右和奇数页(odd)、偶数页(even)共12个部分,所以设置了对应的12个选项。\opt{head} 与 \opt{foot} 表示页眉与页脚区域,前缀e、o代表偶数、奇数,前缀l、c、r代表左、中、右部分。单面打印时,偶数前缀的选项无效。 +\begin{ctexexam} + \ctexset + { + hdrset = + { + erhead = \leftmark, + elhead = \textbf{\thepage}, + olhead = \rightmark, + orhead = \textbf{\thepage} + } + } +\end{ctexexam} +\end{function} + +\subsection{目录样式} +\begin{function}[EXP,added = 2021-01-13]{tocset/.../format,tocset/.../indent,tocset/.../rule,\tocrule} +\begin{syntax} + format = <目录标题格式> + indent = <目录标题左边缩进> + rule = <目录引导线样式> + \tn{tocrule} = \oarg{引导点间距}\oarg{引导点大小}\marg{引导点}\oarg{页码格式} +\end{syntax} +\changes{v1.21c}{2021/01/13}{增加配置目录样式的选项。} +\opt{tocset} 将目录样式交给 \pkg{titletoc} 处理,预置了 \opt{part}、\opt{chapter}、\opt{section}、\opt{subsection} 和 \opt{lists} 五种级别的目录标题,键值列表中的...代表它们。\opt{lists} 为图片、表格和代码目录格式的级别。\tn{tocrule} 命令生成目录引导线,需要在 \opt{rule} 选项中使用,其中引导线间距需带有长度单位,引导点大小不带单位,为引导点符号正常大小的倍数,引导点一般为英文句号或 \tn{cdot} 中心点符号。页码格式的内容位于页码前面,可以设置页码字体、距离。 +\begin{ctexexam} + \ctexset + { + tocset = + { + chapter = + { + format = \addvspace{8pt}\large, + indent = 1.5\ccwd, + rule = \tocrule[0.6pc][1.1]{.}[\zihao{5}] + } + } + } +\end{ctexexam} +\end{function} + \section{常用环境} \subsection{公式} @@ -288,7 +363,7 @@ \end{ctexexam} \end{function} -\subsubsection{排序列表}\label{ssubsec2} +\subsubsection{排序列表}\label{ssubsec1} 使用 \opt{enumerate} 环境可创建排序列表,使用 \opt{enumerate*} 环境产生行内部列表,可以使用\textsf{A、a、I、i和1}作为可选项为 \opt{enumerate} 与 \opt{enumerate*} 格式化标签。若生成\textsf{Item I、Item II、Item III}格式可以这样 \begin{ctexexam} \begin{enumerate*}[(a)] @@ -330,7 +405,7 @@ \tn{item} <习题内容> \tn{end}\marg{exercise} \end{syntax} -习题环境 \opt{exercise} 的标题紧接上一节编号并加入目录与页眉,当使用星号环境时不进行编号。三个可选参数中颜色为自定义或 \pkg{xcolor} 包含的颜色名称(深色),正文编号格式与小节 \ref{ssubsec2} 排序列表相同,标题名默认为摘要,参数只能\textsf{从右往左}省略。 +习题环境 \opt{exercise} 的标题紧接上一节编号并加入目录与页眉,当使用星号环境时不进行编号。三个可选参数中颜色为自定义或 \pkg{xcolor} 包含的颜色名称(深色),正文编号格式与小节 \ref{ssubsec1} 排序列表相同,标题名默认为摘要,参数只能\textsf{从右往左}省略。 \begin{ctexexam} \begin{exercise}[black][1.][习题] \item 习题内容 -- cgit v1.2.3