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.tex50
1 files changed, 26 insertions, 24 deletions
diff --git a/macros/latex/contrib/easybook/doc/easybook.tex b/macros/latex/contrib/easybook/doc/easybook.tex
index d2a9be0bdf..4cd23121b7 100644
--- a/macros/latex/contrib/easybook/doc/easybook.tex
+++ b/macros/latex/contrib/easybook/doc/easybook.tex
@@ -1,13 +1,9 @@
\documentclass{ctxdoc}
-\hypersetup
- {
- linkcolor = blue,
- urlcolor = blue
- }
+\hypersetup{linkcolor = blue,urlcolor = blue}
\title{\sffamily easybook书籍文档类}
\author{瞿毅}
-\date{2021/02/02\hskip\ccwd\relax v1.23\thanks{\url{https://gitee.com/texl3/easybook}}}
+\date{2021/02/08\hskip\ccwd\relax v1.23a\thanks{\url{https://gitee.com/texl3/easybook}}}
\begin{document}
\maketitle
@@ -19,7 +15,7 @@
\tableofcontents
\section{编译方式}
-模板含有一个使用示例文件,编译前建议满足以下的条件
+模板含有一个使用示例文件 \opt{easybook-demo.tex},编译前建议满足以下的条件
\begin{itemize}
\item 使用 \hologo{XeLaTeX}(推荐)或 \hologo{LuaLaTeX} 两种编译方式。
\item 参考文献支持用 \hologo{BibTeX}(默认)或 \hologo{biber} 后端处理。
@@ -40,7 +36,8 @@
LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.
\end{frameverb}
-\subsection{字体设置}\label{font settings}
+\subsection{字体设置}
+\label{font settings}
默认使用\CTeX 预置中文字库,当开启 \opt{font = noto} 选项时需要安装开源字体,中文使用方正系列的{\songti 方正书宋}、{\heiti 方正黑体}、{\kaishu 方正楷体}和{\fangsong 方正仿宋},英文使用思源系列的{\rmfamily Noto Serif}、{\sffamily Noto Sans}和{\ttfamily Noto Sans Mono},数学字体使用 \pkg{notomath}。相关选项可以见小节 \ref{document class options} 中的 \opt{font} 选项,字体点击此处下载\href{https://wws.lanzous.com/b01ns361i}{下载地址}。
如果您不想使用\CTeX 默认字体和方正、思源字体,\textbf{自定义字体}需启用选项 \opt{font = none},并可在导言区设置中文字体,粗体与斜体不设置会产生警告。
@@ -50,7 +47,8 @@
\setCJKmonofont{FangSong}
\end{ctexexam}
-\section{文档类选项}\label{document class options}
+\section{文档类选项}
+\label{document class options}
标准 \cls{book} 文类与 \cls{ctexbook} 文类的选项同样适用于本文档。除此之外选项分为两类
\begin{itemize}
\item 带有 \rexptarget\rexpstar{} 号的选项,需要在引入文档类的时候设定。
@@ -111,9 +109,9 @@
\end{function}
\subsection{风格}
-\begin{function}[EXP,added = 2021-01-05,updated = 2021-02-02]{style/color,style/capdash,style/multoc,style/withpart,style/perpart,style/perpage,style/notomath}
+\begin{function}[EXP,added = 2021-01-05,updated = 2021-02-08]{style/color,style/capdash,style/multoc,style/withpart,style/perpart,style/perpage,style/notomath}
\begin{syntax}
- color = <(none)|forest|energy|cyberpunk>
+ color = <(none)|seaside|energy|cyberpunk>
capdash = <true|(false)>
multoc = <true|(false)>
withpart = <true|(false)>
@@ -143,7 +141,8 @@
\item[notomath] 使用 \opt{noto} 风格的数学字体,将会加载 \pkg{newtxmath} 宏包。
\end{optdesc}
-\subsection{超链接}\label{hyperlinks}
+\subsection{超链接}
+\label{hyperlinks}
\begin{function}[EXP,added = 2021-01-05,updated = 2021-01-08]{link/hyperlink,link/linkcolor,link/linktopage}
\begin{syntax}
hyperlink = <(edge)|various|none>
@@ -189,7 +188,7 @@
\end{optdesc}
\subsection{其它字体}
-\begin{function}[EXP,added = 2021-01-08]{elfont/tabfont,elfont/figfont,elfont/lstfont,elfont/fnfont,elfont/marfont}
+\begin{function}[EXP,added = 2021-01-08,updated = 2021-02-08]{elfont/tabfont,elfont/figfont,elfont/lstfont,elfont/fnfont,elfont/marfont}
\begin{syntax}
tabfont = <\tn{sffamily}\tn{small}>
figfont = <\tn{sffamily}\tn{small}>
@@ -198,6 +197,7 @@
marfont = <\tn{rmfamily}\tn{footnotesize}>
\end{syntax}
\changes{v1.10}{2021/01/08}{加入自定义非正文字体选项。}
+\changes{v1.23a}{2021/02/08}{修复使用 \tn{zihao} 命令设置字体失效的问题。}
\end{function}
\begin{optdesc}
@@ -291,23 +291,23 @@
\end{function}
\subsection{页眉页脚}
-\begin{function}[EXP,added = 2021-01-13,updated = 2021-01-15]{hdrset,\fancyhead,\fancyfoot,...}
+\begin{function}[EXP,added = 2021-01-13,updated = 2021-02-08]{hdrset,\easyhead,\easyfoot,...}
\begin{syntax}
hdrset = <载入 \opt{fancyhdr} 的设置>
- \tn{fancyhead}\oarg{位置}\marg{内容}
- \tn{fancyfoot}\oarg{位置}\marg{内容}
+ \tn{easyhead}\oarg{位置}\marg{内容}
+ \tn{easyfoot}\oarg{位置}\marg{内容}
\end{syntax}
\changes{v1.21}{2021/01/11}{修复单面文档时页眉横线消失的问题。}
\changes{v1.21c}{2021/01/13}{增加配置页眉页脚的选项。}
-\opt{hdrset} 设置的命令由 \pkg{fancyhdr} 宏包提供支持,设置的是一个名为 \opt{fancy} 的页面风格。\pkg{fancyhdr} 将页眉页脚分成了左中右和奇数页(odd)、偶数页(even)共12个部分,可选参数中E、O代表偶数、奇数,L、C、R代表左、中、右部分。单面打印时,含有偶数的选项无效。
+\opt{hdrset} 设置的命令由 \pkg{fancyhdr} 宏包提供支持,命令 \tn{easyhead} 和 \tn{easyfoot} 的含义与 \tn{fancyhead} 和 \tn{fancyfoot} 相同,设置的是一个名为 \opt{fancy} 的页面风格。\pkg{fancyhdr} 将页眉页脚分成了左中右和奇数页(odd)、偶数页(even)共12个部分,可选参数中E、O代表偶数、奇数,L、C、R代表左、中、右部分。单面打印时,含有偶数的选项无效。
\begin{ctexexam}
\ctexset
{
hdrset =
{
- \fancyhead[ER]{\leftmark}
- \fancyhead[OL]{\rightmark}
- \fancyhead[EL,OR]{\textbf{\thepage}}
+ \easyhead[ER]{\leftmark}
+ \easyhead[OL]{\rightmark}
+ \easyhead[EL,OR]{\textbf{\thepage}}
}
}
\end{ctexexam}
@@ -365,7 +365,7 @@
\tn{item} <列表内容>
\tn{end}\marg{环境名}
\end{syntax}
-\pkg{enumitem} 宏包为系统自带的列表环境提供了更灵活的标签以及间距的控制。已设置默认格式,若自定义标签可例如
+\pkg{enumitem} 宏包为系统自带的列表环境提供了更灵活的标签以及间距的控制,可使用 \tn{setlist} 命令设置原有的三种列表格式。已设置默认格式,若自定义标签可例如
\begin{ctexexam}
\begin{enumerate}[label = \arabic*(a),leftmargin = 1cm,resume]
\begin{itemize}[label = \textbullet]
@@ -373,7 +373,8 @@
\end{ctexexam}
\end{function}
-\subsubsection{排序列表}\label{sort list}
+\subsubsection{排序列表}
+\label{sort list}
使用 \opt{enumerate} 环境可创建排序列表,使用 \opt{enumerate*} 环境产生行内部列表,可以使用\textbf{A、a、I、i和1}作为可选项为 \opt{enumerate} 与 \opt{enumerate*} 格式化标签。若生成\textbf{Item I、Item II、Item III}格式可以这样
\begin{ctexexam}
\begin{enumerate*}[(a)]
@@ -409,12 +410,13 @@
\end{function}
\subsection{习题}
-\begin{function}[added = 2021-01-05]{exercise}
+\begin{function}[added = 2021-01-05,updated = 2021-02-08]{exercise}
\begin{syntax}
\tn{begin}\marg{exercise}\oarg{颜色名}\oarg{编号}\oarg{标题}
\tn{item} <习题内容>
\tn{end}\marg{exercise}
\end{syntax}
+\changes{v1.23a}{2021/02/08}{增加准确的习题盒子标题目录锚点。}
习题环境 \opt{exercise} 的标题紧接上一节编号并加入目录与页眉,当使用星号环境时不进行编号。三个可选参数中颜色为自定义或 \pkg{xcolor} 包含的颜色名称(深色),正文编号格式与小节 \ref{sort list} 排序列表相同,标题名默认为摘要,参数只能\textbf{从右往左}省略。
\begin{ctexexam}
\begin{exercise}[black][1.][习题]
@@ -478,7 +480,7 @@
<行间代码>
\tn{end}\marg{lstlisting}
\end{syntax}
-使用 \pkg{listings} 宏包可以对代码格式进行高度定制,\tn{listoflistings} 命令用于输出代码目录。
+加载了 \pkg{listings} 宏包以对代码格式进行高度定制,代码样式可使用 \tn{lstset} 命令设置,\tn{listoflistings} 命令用于输出代码目录。
\end{function}
\subsection{物理量}