summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easybook/doc/easybook.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/easybook/doc/easybook.tex')
-rw-r--r--macros/latex/contrib/easybook/doc/easybook.tex83
1 files changed, 59 insertions, 24 deletions
diff --git a/macros/latex/contrib/easybook/doc/easybook.tex b/macros/latex/contrib/easybook/doc/easybook.tex
index 0ccfde03c0..44fc91afd6 100644
--- a/macros/latex/contrib/easybook/doc/easybook.tex
+++ b/macros/latex/contrib/easybook/doc/easybook.tex
@@ -8,7 +8,7 @@
\title{\sffamily easybook书籍文档类}
\author{瞿毅}
-\date{2021/01/11\hskip\ccwd\relax v1.21\thanks{\url{https://gitee.com/TeX-doc/easybook}}}
+\date{2021/01/12\hskip\ccwd\relax v1.21b\thanks{\url{https://gitee.com/TeX-doc/easybook}}}
\begin{document}
\maketitle
@@ -20,15 +20,16 @@
\end{abstract}
\tableofcontents
-\section{编译文档}
-成功地编译演示文档,可能需要满足以下的条件
+\section{编译方式}
+模板含有一个使用示例文件,编译前建议满足以下的条件
\begin{itemize}
- \item 使用 \hologo{XeLaTeX}(推荐)或 \hologo{LuaLaTeX} 两种编译方式,参考文献使用 \hologo{BibTeX} 编译。
- \item 默认情况下安装方正与思源字体。
- \item 安装最新的\TeX 发行版并将宏包升级为最新。
+ \item 使用 \hologo{XeLaTeX}(推荐)或 \hologo{LuaLaTeX} 两种编译方式,
+ \item 参考文献支持用 \hologo{BibTeX}(默认)或 \hologo{biber} 后端处理。
+ \item 由于用到了一些较新的宏包,建议安装最新的\TeX 发行版并将宏包升级为最新。
\end{itemize}
\subsection{编译步骤}
+
\begin{frameverb}
xelatex -shell-escape easybook-demo
bibtex easybook-demo
@@ -42,10 +43,10 @@
LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.
\end{frameverb}
-\subsection{字体设置}
-默认中文使用方正系列的{\songti 方正书宋}、{\heiti 方正黑体}、{\kaishu 方正楷体}和{\fangsong 方正仿宋},英文使用思源系列的{\rmfamily Noto Serif}、{\sffamily Noto Sans}和{\ttfamily Noto Sans Mono},数学字体使用 \pkg{notomath}。字体点击此处下载\href{https://wws.lanzous.com/b01ns361i}{下载地址}。
+\subsection{字体设置}\label{subsec1}
+默认使用\CTeX 预置中文字库,当开启 \opt{font = myfont} 选项时需要安装开源字体,中文使用方正系列的{\songti 方正书宋}、{\heiti 方正黑体}、{\kaishu 方正楷体}和{\fangsong 方正仿宋},英文使用思源系列的{\rmfamily Noto Serif}、{\sffamily Noto Sans}和{\ttfamily Noto Sans Mono},数学字体使用 \pkg{notomath}。相关选项可以见小节 \ref{subsec2},字体点击此处下载\href{https://wws.lanzous.com/b01ns361i}{下载地址}。
-如果您\textsf{懒于安装字体},可以见小节 \ref{subsec1} 使用\CTeX 预置中文字库。如果您不喜欢方正、思源字体,\textsf{自定义字体}需启用选项 \opt{font = none},并可在导言区设置中文字体,粗体与斜体不设置会产生警告。
+如果您不想使用\CTeX 默认字体和方正、思源字体,\textsf{自定义字体}需启用选项 \opt{font = none},并可在导言区设置中文字体,粗体与斜体不设置会产生警告。
\begin{ctexexam}
\setCJKmainfont{SimSun}[BoldFont = SimHei,ItalicFont = KaiTi]
\setCJKsansfont{SimHei}
@@ -59,7 +60,7 @@
\item 带有 \exptarget\expstar{} 号的选项,需要通过\CTeX 宏集提供的用户接口命令 \tn{ctexset} 设定。
\end{itemize}
-\subsection{文档类选项}\label{subsec1}
+\subsection{文档类选项}\label{subsec2}
\begin{function}[rEXP,added = 2021-01-05]{draft}
开启草稿模式会加快编译速度,表现有显示页面边框、行溢出的地方显示黑色方块、图片变成占位方框、显示当前日期和关闭超链接渲染。
\end{function}
@@ -82,11 +83,12 @@
同时开启 \opt{newline}、\opt{entitle} 和 \opt{english} 三个选项以符合英文原生风格。
\end{function}
-\begin{function}[rEXP,added = 2021-01-05]{font}
+\begin{function}[rEXP,added = 2021-01-05,updated = 2021-01-12]{font}
\begin{syntax}
- font = <adobe|founder|mac|windows|linux|overleaf|none>
+ font = <adobe|founder|mac|windows|linux|(overleaf)|none|myfont>
\end{syntax}
-传递给 \cls{ctexbook} 设置字体,最好不要使用原有的 \opt{fontset} 选项,默认情况下使用自定义字体而不开启这个选项,可根据安装的字体及电脑系统选取。\opt{overleaf} 是一个各系统通用选项,会检测系统环境选取对应字体。
+\changes{v1.21b}{2021/01/12}{默认字体与\CTeX 一致,不再是自定义字体。}
+传递给 \cls{ctexbook} 设置字体,最好不要使用原有的 \opt{fontset} 选项,默认情况下使用自定义字体而不开启这个选项,可根据安装的字体及电脑系统选取。\opt{myfont} 与 \opt{none} 选项的相关描述见小节 \ref{subsec1},\opt{overleaf} 是一个各系统通用选项,会检测系统环境选取对应字体。
\end{function}
\begin{function}[rEXP,added = 2021-01-05]{paper}
@@ -113,10 +115,9 @@
\end{function}
\subsubsection{风格}
-\begin{function}[EXP,updated = 2021-01-08]{style/color,style/thmbox,style/capdash,style/multoc,style/withpart,style/perchap,style/perpage}
+\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>
- thmbox = <true|(false)>
capdash = <true|(false)>
multoc = <true|(false)>
withpart = <true|(false)>
@@ -136,7 +137,6 @@
\changes{v1.10}{2021/01/08}{可以自定义主题颜色。}
主题颜色用到这三个颜色,可以使用 \tn{definecolor} 命令进行更改,类似地更改超链接颜色见小节 \ref{ssubsec1}。
\end{function}
- \item[thmbox] 开启定理及习题环境的盒子边框。
\item[capdash] 将图表代码标题风格由例如\textsf{图1.1}变为\textsf{图1\textendash 1}的形式。
\item[multoc] 开启双栏目录,可与 \opt{onecolumn} 和 \opt{twocolumn} 选项配合出单栏正文、单栏目录,双栏正文、单栏目录,单栏正文、双栏目录和双栏正文、双栏目录四种方式 。
\item[withpart] 使章跟随每一部分编号,默认不跟随。
@@ -145,7 +145,7 @@
\end{optdesc}
\subsubsection{超链接}\label{ssubsec1}
-\begin{function}[EXP,updated = 2021-01-08]{link/hyperlink,link/linkcolor,link/linktopage}
+\begin{function}[EXP,added = 2021-01-05,updated = 2021-01-08]{link/hyperlink,link/linkcolor,link/linktopage}
\begin{syntax}
hyperlink = <(edge)|various|none>
linkcolor = <(graphite)|cutepink|skyblue|crimson>
@@ -167,15 +167,17 @@
\end{optdesc}
\subsubsection{行距}
-\begin{function}[EXP,added = 2021-01-05]{spread/linespread,spread/tabspread,spread/mathspread,spread/capspread,spread/fnspread}
+\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)>
tabspread = <(1)>
mathspread = <(1)>
capspread = <(1)>
fnspread = <(1)>
+ fnsep = <(0ex)>
\end{syntax}
-行距因子用于设置各种行距倍数,只能是浮点数,不能带有长度单位。\tn{ctexset} 原有的行距选项\opt{linespread}失效。各行距既可在导言区全局设置也可正文中设置对后面生效,行距的意义为
+\changes{v1.21b}{2021/01/12}{增加脚注线间的距离选项。}
+除了 \opt{fnsep} 选项,其它是行距因子用于设置各种行距倍数,只能是浮点数,不能带有长度单位。\tn{ctexset} 原有的行距选项\opt{linespread}失效。各行距既可在导言区全局设置也可正文中设置对后面生效,行距的意义为
\end{function}
\begin{optdesc}
@@ -184,6 +186,7 @@
\item[mathspread] 数学环境行距。
\item[capspread] 图表代码标题行距。
\item[fnspread] 脚注行距。
+ \item[fnspread] 脚注与脚注线间的距离,需带有长度单位。
\end{optdesc}
\subsubsection{其它字体}
@@ -226,6 +229,38 @@
\item[\tn{printbibliography}] 两种方式\textsf{均使用}此命令打印参考文献,其中可选项仅在 \hologo{biber} 处理时有效。
\end{optdesc}
+\subsubsection{定理样式}
+\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 = <true|(false))>
+ numberwith = <(chapter)|section|其它环境|空置>
+ headpunct = <(未设置)>
+ bodyfont = <(未设置)>
+ notefont = <(未设置)>
+ headindent = <(0\tn{ccwd})>
+ spaceabove = <(0.75ex plus .1ex)>
+ spacebelow = <(0.75ex plus .1ex)>
+\end{syntax}
+\changes{v1.21b}{2021/01/12}{增加配置定理环境样式的选项。}
+\end{function}
+
+\begin{optdesc}
+ \item[thmbox] 开启定理及习题环境的盒子边框。
+ \item[numberwith] 定理编号格式,默认跟随章的编号,也可以与其它定理环境共享编号,空置时不跟随其它计数器编号。
+ \item[headpunct] 定理标题后的标记。
+ \item[bodyfont] 定理内容部分的字体。
+ \item[notefont] 定理标题内容的字体。
+ \item[headindent] 定理标题的缩进,默认无缩进,可用 \tn{parindent} 命令设置为段落缩进。
+ \item[spaceabove] 定理环境前的间距。
+ \item[spacebelow] 定理环境后的间距。
+\end{optdesc}
+
+\subsubsection{新的定理样式}
+定理由 \pkg{thmtools} 设置,自带定理的样式为 \opt{mythm},如果使用这个样式而只是增加新的定理名称,可以这样
+\begin{ctexexam}
+ \declaretheorem[style = mythm,name = 定理名]{定理环境名}
+\end{ctexexam}
+若要重新定义一个全新的定理样式,具体参数可以查看 \pkg{thmtools} 宏包帮助文档。
\section{常用环境}
\subsection{公式}
@@ -272,14 +307,14 @@
\subsubsection{主题列表}
使用 \opt{description} 环境可创建带有主题词的列表。
\begin{ctexexam}
-\begin{description}
- \item[主题一] 内容一
- \item[主题二] 内容二
-\end{description}
+ \begin{description}
+ \item[主题一] 内容一
+ \item[主题二] 内容二
+ \end{description}
\end{ctexexam}
\subsection{定理}
-\begin{function}[updated = 2021-01-08]{theorem,definition,lemma,corollary,proposition,example,remark,proof}
+\begin{function}[added = 2021-01-05,updated = 2021-01-08]{theorem,definition,lemma,corollary,proposition,example,remark,proof}
\begin{syntax}
\tn{begin}\marg{环境名}
<定理内容>