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.tex108
1 files changed, 65 insertions, 43 deletions
diff --git a/macros/latex/contrib/easybook/doc/easybook.tex b/macros/latex/contrib/easybook/doc/easybook.tex
index ab65b0c7c8..0ccfde03c0 100644
--- a/macros/latex/contrib/easybook/doc/easybook.tex
+++ b/macros/latex/contrib/easybook/doc/easybook.tex
@@ -2,18 +2,19 @@
\hypersetup
{
colorlinks,
- linkcolor=blue,
- urlcolor=blue
+ linkcolor = blue,
+ urlcolor = blue
}
\title{\sffamily easybook书籍文档类}
\author{瞿毅}
-\date{2021/01/09\hskip\ccwd\relax v1.2\thanks{\url{https://gitee.com/TeX-doc/easybook}}}
+\date{2021/01/11\hskip\ccwd\relax v1.21\thanks{\url{https://gitee.com/TeX-doc/easybook}}}
\begin{document}
\maketitle
-\changes{v1.2}{2021/01/09}{修改和完善用户文档。}
-\changes{v1.2}{2021/01/09}{模板更改为使用CC-BY许可协议。}
+\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} 考虑了一些细节并载入一些常用宏包实现一般的排版需求,它适用于排版中英文书籍或笔记,甚至可稍加修改成为学位论文模板。
\end{abstract}
@@ -36,7 +37,7 @@
xelatex -shell-escape easybook-demo
\end{frameverb}
-需注意,正确\textbf{编译索引}需要增加 \opt{-shell-escape} 命令行选项。若不需要索引和参考文献,可以在正文中注释掉命令。若出现以下警告,再编译一次即可。
+需注意,正确\textsf{编译索引}需要增加 \opt{-shell-escape} 命令行选项。若不需要索引和参考文献,可以在正文中注释掉命令。若出现以下警告,再编译一次即可。
\begin{frameverb}
LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.
\end{frameverb}
@@ -44,7 +45,7 @@
\subsection{字体设置}
默认中文使用方正系列的{\songti 方正书宋}、{\heiti 方正黑体}、{\kaishu 方正楷体}和{\fangsong 方正仿宋},英文使用思源系列的{\rmfamily Noto Serif}、{\sffamily Noto Sans}和{\ttfamily Noto Sans Mono},数学字体使用 \pkg{notomath}。字体点击此处下载\href{https://wws.lanzous.com/b01ns361i}{下载地址}。
-如果您\textbf{懒于安装字体},可以见小节 \ref{subsec1} 使用\CTeX 预置中文字库。如果您不喜欢方正、思源字体,\textbf{自定义字体}需启用选项 \opt{font = none},并可在导言区设置中文字体,粗体与斜体不设置会产生警告。
+如果您\textsf{懒于安装字体},可以见小节 \ref{subsec1} 使用\CTeX 预置中文字库。如果您不喜欢方正、思源字体,\textsf{自定义字体}需启用选项 \opt{font = none},并可在导言区设置中文字体,粗体与斜体不设置会产生警告。
\begin{ctexexam}
\setCJKmainfont{SimSun}[BoldFont = SimHei,ItalicFont = KaiTi]
\setCJKsansfont{SimHei}
@@ -57,8 +58,8 @@
\item 带有 \rexptarget\rexpstar{} 号的选项,需要在引入文档类的时候设定。
\item 带有 \exptarget\expstar{} 号的选项,需要通过\CTeX 宏集提供的用户接口命令 \tn{ctexset} 设定。
\end{itemize}
-\subsection{文档类选项}\label{subsec1}
+\subsection{文档类选项}\label{subsec1}
\begin{function}[rEXP,added = 2021-01-05]{draft}
开启草稿模式会加快编译速度,表现有显示页面边框、行溢出的地方显示黑色方块、图片变成占位方框、显示当前日期和关闭超链接渲染。
\end{function}
@@ -107,15 +108,14 @@
\begin{syntax}
config = <配置文件名>
\end{syntax}
-\changes{v1.1}{2021/01/08}{加入载入用户配置选项。}
+\changes{v1.10}{2021/01/08}{加入载入用户配置选项。}
\opt{config}为载入用户配置选项,配置文件名不需加括号但需带有后缀名如 \opt{tex}、\opt{def} 和 \opt{cfg}。
\end{function}
\subsubsection{风格}
-\begin{function}[EXP,updated = 2021-01-08]{style/color,style/cite,style/thmbox,style/capdash,style/multoc,style/withpart,style/perchap,style/perpage}
+\begin{function}[EXP,updated = 2021-01-08]{style/color,style/thmbox,style/capdash,style/multoc,style/withpart,style/perchap,style/perpage}
\begin{syntax}
color = <(none)|forest|energy|cyberpunk>
- cite = <(number)|authoryear>
thmbox = <true|(false)>
capdash = <true|(false)>
multoc = <true|(false)>
@@ -123,26 +123,25 @@
perchap = <true|(false)>
perpage = <true|(false)>
\end{syntax}
-\changes{v1.1}{2021/01/08}{更改颜色实现方式与选项名。}
+\changes{v1.10}{2021/01/08}{更改颜色实现方式与选项名。}
\opt{style} 选项控制文章的风格。
\end{function}
\begin{optdesc}
- \item[color]主题颜色,包括标题、页眉颜色等,选项 \opt{none} 为黑白页面,但不包括超链接。
+ \item[color] 主题颜色,包括标题、页眉颜色等,选项 \opt{none} 为黑白页面,但不包括超链接。
\begin{function}{ctex@frame,ctex@emph,ctex@verb}
\begin{syntax}
\tn{definecolor}\oarg{类型}\marg{名称}\marg{模式列表}\marg{参数列表}
\end{syntax}
- \changes{v1.1}{2021/01/08}{可以自定义主题颜色。}
+ \changes{v1.10}{2021/01/08}{可以自定义主题颜色。}
主题颜色用到这三个颜色,可以使用 \tn{definecolor} 命令进行更改,类似地更改超链接颜色见小节 \ref{ssubsec1}。
\end{function}
- \item[cite]参考文献格式为中国的参考文献推荐标准GB/T 7714-2015,有顺序编码制和著者-出版年制两种风格,理工科类一般使用顺序编码制,文科类一般使用著者-出版年制。
- \item[thmbox]开启定理及习题环境的盒子边框。
- \item[capdash]将图表代码标题风格由例如\textsf{图1.1}变为\textsf{图1--1}的形式。
- \item[multoc]开启双栏目录,可与 \opt{onecolumn} 和 \opt{twocolumn} 选项配合出单栏正文、单栏目录,双栏正文、单栏目录,单栏正文、双栏目录和双栏正文、双栏目录四种方式 。
- \item[withpart]使章跟随每一部分编号,默认不跟随。
- \item[perchap]使脚注跟随每一章编号,默认不跟随。
- \item[perpage]使脚注跟随每一页编号,默认不跟随。
+ \item[thmbox] 开启定理及习题环境的盒子边框。
+ \item[capdash] 将图表代码标题风格由例如\textsf{图1.1}变为\textsf{图1\textendash 1}的形式。
+ \item[multoc] 开启双栏目录,可与 \opt{onecolumn} 和 \opt{twocolumn} 选项配合出单栏正文、单栏目录,双栏正文、单栏目录,单栏正文、双栏目录和双栏正文、双栏目录四种方式 。
+ \item[withpart] 使章跟随每一部分编号,默认不跟随。
+ \item[perchap] 使脚注跟随每一章编号,默认不跟随。
+ \item[perpage] 使脚注跟随每一页编号,默认不跟随。
\end{optdesc}
\subsubsection{超链接}\label{ssubsec1}
@@ -152,19 +151,19 @@
linkcolor = <(graphite)|cutepink|skyblue|crimson>
linktopage = <true|(false)>
\end{syntax}
-\changes{v1.1}{2021/01/08}{修复了 \opt{linktopage} 选项关闭时目录中标题编号无超链接的问题。}
+\changes{v1.10}{2021/01/08}{修复了 \opt{linktopage} 选项关闭时目录中标题编号无超链接的问题。}
\end{function}
\begin{optdesc}
- \item[hyperlink]\opt{edge} 使超链接为边框形式,\opt{various} 使超链接为彩色字体,有四种颜色风格。\opt{none} 关闭超链接边框与颜色,此时 \opt{linkcolor} 选项无效。
- \item[linkcolor]超链接颜色样式。
+ \item[hyperlink] \opt{edge} 使超链接为边框形式,\opt{various} 使超链接为彩色字体,有四种颜色风格。\opt{none} 关闭超链接边框与颜色,此时 \opt{linkcolor} 选项无效。
+ \item[linkcolor] 超链接颜色样式。
\begin{function}{ctex@link,ctex@url,ctex@cite}
\begin{syntax}
\tn{definecolor}\oarg{类型}\marg{名称}\marg{模式列表}\marg{参数列表}
\end{syntax}超链接颜色用到这三个颜色,可以使用 \tn{definecolor} 命令进行更改。
- \changes{v1.1}{2021/01/08}{可以自定义超链接颜色。}
+ \changes{v1.10}{2021/01/08}{可以自定义超链接颜色。}
\end{function}
- \item[linktopage]将目录中的超链接置于页码上,默认是置于标题上。
+ \item[linktopage] 将目录中的超链接置于页码上,默认是置于标题上。
\end{optdesc}
\subsubsection{行距}
@@ -180,11 +179,11 @@
\end{function}
\begin{optdesc}
- \item[linespread]正文行距。
- \item[tabspread]表格行距。
- \item[mathspread]数学环境行距。
- \item[capspread]图表代码标题行距。
- \item[fnspread]脚注行距。
+ \item[linespread] 正文行距。
+ \item[tabspread] 表格行距。
+ \item[mathspread] 数学环境行距。
+ \item[capspread] 图表代码标题行距。
+ \item[fnspread] 脚注行距。
\end{optdesc}
\subsubsection{其它字体}
@@ -196,18 +195,39 @@
fnfont = <\tn{rmfamily}>
marfont = <\tn{rmfamily}\tn{footnotesize}>
\end{syntax}
-\changes{v1.1}{2021/01/08}{加入自定义非正文字体选项。}
+\changes{v1.10}{2021/01/08}{加入自定义非正文字体选项。}
+\end{function}
+
+\begin{optdesc}
+ \item[tabfont] 表格标题的字体设置。
+ \item[figfont] 图片标题的字体设置。
+ \item[lstfont] 代码标题的字体设置。
+ \item[fnfont] 脚注的字体设置,请不要使用字号命令。
+ \item[marfont] 边注的字体设置。
+\end{optdesc}
+
+\subsubsection{参考文献}
+\begin{function}[EXP,added = 2021-01-11]{bibset/backend,bibset/bibstyle,bibset/citestyle,bibset/bibfile,\printbibliography}
+\begin{syntax}
+ backend = <(bibtex)|biblatex>
+ bibstyle = <(number)|authoryear|其它格式>
+ citestyle = <引用格式>
+ bibfile = <ref/refs.bib>
+ \tn{printbibliography}\oarg{选项列表}
+\end{syntax}
+\changes{v1.21}{2021/01/11}{增加 \opt{bibset} 选项,可以使用 \hologo{BibTeX} 或 \hologo{biber} 编译参考文献。}
\end{function}
\begin{optdesc}
- \item[tabfont]表格标题的字体设置。
- \item[figfont]图片标题的字体设置。
- \item[lstfont]代码标题的字体设置。
- \item[fnfont]脚注的字体设置,请不要使用字号命令。
- \item[marfont]边注的字体设置。
+ \item[backend] 参考文献处理后端,默认用传统的 \hologo{BibTeX} 处理参考文献。
+ \item[bibstyle] 参考文献格式为中国的参考文献推荐标准GB/T 7714-2015,有顺序编码制和著者-出版年制两种风格,理工科类一般使用顺序编码制,文科类一般使用著者-出版年制。若使用其它格式,使用 \hologo{BibTeX} 处理时需确保正确的 \opt{bst} 文件,使用 \hologo{biber} 处理可使用 \pkg{biblatex} 宏包支持的参考文献风格名称。
+ \item[citestyle] 引用参考文献的格式,对 \opt{backend = bibtex} 选项\textsf{无效},可使用 \pkg{biblatex} 宏包支持的引用文献风格名称。
+ \item[bibfile] 参考文献的数据文件,使用 \hologo{biber} 处理时要带有 \opt{bib} 后缀,默认为一个在 \opt{ref} 文件夹中以 \opt{refs.bib} 命名的文件。
+ \item[\tn{printbibliography}] 两种方式\textsf{均使用}此命令打印参考文献,其中可选项仅在 \hologo{biber} 处理时有效。
\end{optdesc}
\section{常用环境}
+
\subsection{公式}
\begin{function}[added = 2021-01-05]{equation,multline,gather,align}
\begin{syntax}
@@ -234,7 +254,7 @@
\end{function}
\subsubsection{排序列表}\label{ssubsec2}
-使用 \opt{enumerate} 环境可创建排序列表,使用 \opt{enumerate*} 环境产生行内部列表,可以使用\textsf{A、a、I、i和1}作为可选项为 \opt{enumerate} 与 \opt{enumerate*} 格式化标签。若生成\textbf{Item I、Item II、Item III}格式可以这样
+使用 \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)]
\begin{enumerate}[\bfseries{Item} I]
@@ -249,7 +269,8 @@
\begin{itemize}[$\star$]
\end{ctexexam}
-\subsubsection{主题列表}使用 \opt{description} 环境可创建带有主题词的列表。
+\subsubsection{主题列表}
+使用 \opt{description} 环境可创建带有主题词的列表。
\begin{ctexexam}
\begin{description}
\item[主题一] 内容一
@@ -330,14 +351,14 @@
\section{其它格式}
\subsection{代码}
-\begin{function}[added = 2021-01-05]{\lstinline,lstlisting}
+\begin{function}[added = 2021-01-05]{\lstinline,lstlisting,\listoflistings}
\begin{syntax}
\tn{lstinline}\oarg{键值列表}\marg{行内代码}
\tn{begin}\marg{lstlisting}\oarg{键值列表}
<行间代码>
\tn{end}\marg{lstlisting}
\end{syntax}
-使用 \pkg{listings} 宏包可以对代码格式进行高度定制。
+使用 \pkg{listings} 宏包可以对代码格式进行高度定制,\tn{listoflistings} 命令用于输出代码目录。
\end{function}
\subsection{物理量}
@@ -373,11 +394,12 @@
\end{function}
\subsubsection{索引}
-\begin{function}[added = 2021-01-05]{\index}
+\begin{function}[added = 2021-01-05]{\index,\printindex}
\begin{syntax}
\tn{index}\marg{标签}
+ \tn{printindex}\oarg{索引名}
\end{syntax}
-使用 \pkg{imakeidx} 生成索引,仅做了简单的设置如将索引设为双栏并加入目录,其他选项可另外配置。
+使用 \pkg{imakeidx} 生成索引,\tn{printindex} 命令用于生成索引目录。仅做了简单的设置如将索引设为双栏并加入目录,其他选项可另外配置。
\end{function}
\subsubsection{脚注}