diff --git a/elegantbook-cn.tex b/elegantbook-cn.tex index 4c06750..f60829c 100644 --- a/elegantbook-cn.tex +++ b/elegantbook-cn.tex @@ -1,5 +1,4 @@ -\documentclass[cn,11pt,fancy,hide]{elegantbook} - +\documentclass[cn,11pt]{elegantbook} \title{ElegantBook:优美的 \LaTeX{} 书籍模板} \subtitle{Elegant\LaTeX{} 经典之作} @@ -7,16 +6,15 @@ \author{Ethan Deng \& Liam Huang} \institute{Elegant\LaTeX{} Program} \date{\today} -\version{3.07} +\version{3.08} -\equote{Victory won\rq t come to us unless we go to it. --- M. Moore} +\extrainfo{Victory won\rq t come to us unless we go to it. --- M. Moore} \logo{logo.png} \cover{cover.jpg} - \begin{document} \maketitle @@ -28,37 +26,120 @@ \hypersetup{pageanchor=true} \chapter{Elegant\LaTeX{} 系列模板介绍} -Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote},\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook},\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成,分别用于排版笔记,书籍和工作论文。如果你在使用本模板,推荐最新版本!最新正式版下载地址:\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Github}。本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎在 Github 上给我们提交 \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} 或者邮件\footnote{\email{elegantlatex2e@gmail.com}.}联系我们。最近我们新建了一个 QQ 用户交流群(Q 群:692108391),欢迎加入。 -\section{ElegantBook 更新说明} -在这几年间,我们收到了很多用户的反馈,主要的问题涉及到字体安装,编码支持,定理浮动,定理跨页,交叉引用等等。我们思前想后,原先让用户安装字体以追求视觉上的美观并不完美,用户陷入了巨大的麻烦,这违背了我们的模板初衷。因此我们在新版中删除了这部分,用户无需安装任何字体。ElegantBook 3.x 版本更新的主要内容有: +Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote},\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook},\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成,分别用于排版笔记,书籍和工作论文。强烈推荐使用最新正式版本!本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎在 Github 上给我们提交 \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} 或者邮件联系我们。 + +我们的相关联系方式: +\begin{itemize} +\item 官网:\href{https://elegantlatex.org/}{https://elegantlatex.org/} +\item Github 网址:\href{https://github.com/ElegantLaTeX/}{https://github.com/ElegantLaTeX/} +\item CTAN 地址:\href{https://ctan.org/pkg/elegantbook}{https://ctan.org/pkg/elegantbook} +\item 文档 Wiki:\href{https://github.com/ElegantLaTeX/ElegantBook/wiki}{https://github.com/ElegantLaTeX/ElegantBook/wiki} +\item 下载地址:\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{正式发行版},\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版} +\item 微博:ElegantLaTeX +\item 微信公众号:ElegantLaTeX +\item 用户 QQ 群:692108391 +\item 邮件:\email{elegantlatex2e@gmail.com} +\end{itemize} + + +\section{ElegantBook 更新说明} +此次更新主要涉及 \begin{enumerate} - \item 删除了自定义字体设置,改用 \lstinline{ctex} 宏包支持中文; - \item 模板拆分为中英文模式(\lstinline{lang=cn/en}); - \item 支持 \lstinline{PDFLaTeX} 与 \lstinline{XeLaTeX}; - \item 使用 \lstinline{tcolorbox} 宏包改写定理类环境,可跨页; - \item 定理类环境名字更新,修复定理环境交叉引用; - \item 更新颜色主题,增加灰色和黑色主题; - \item 颜色名字更新,统一链接颜色; - \item 重新绘制 Elegant\LaTeX{} 的 Logo; - \item 更新封面与装饰物,删除水印; - \item 修正附录相关内容; - \item 增加代码高亮; - \item 美化列表环境; - \item 增加简化模式; - \item 增加 base 隐藏选项。 +\item 修复 \lstinline|\part| 命令; +\item 增加 pad 模式; +\item 增加 mtpro2 宏包选项支持; +\item 修改参考文献默认为 numbers 格式; +\item 增加章节介绍 introduction 环境; +\item 增加章节习题 problemset 环境; +\item 增加旁注,\lstinline{\elegantpar} 命令(测试); +\item 减少公式前后距离; +\item \lstinline{\equote} 改为 \lstinline{\extrainfo},并且多行显示; +\item 完善文档,增加致谢等部分。 \end{enumerate} \begin{note} -由于新版本进行了重构,3.x 版本并不兼容 2.x 版本,如果你想把 2.x 版本的文件转为 3.x 版本,请查看\href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{跨版本转换}。今后不再回答关于 2.x 版本的问题。 +由于新版本进行了重构,3.x 版本并不兼容 2.x 版本,并且在 3.06 版本更新过封面,如果你想把 3.06 版本(包括 2.x 版本)之前的文件转为最新版本兼容的文件,请仔细查看\href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{跨版本转换}。今后不再回答关于 2.x 版本的问题。 \end{note} -\chapter{ElegantBook 设置说明} +\section{模板安装与更新} +你可以通过免安装的方式使用本模板,也可以通过安装模板的方式使用。 + +免安装使用方法如下,从 Github 或者 CTAN 下载最新(正式)版文件,严格意义上只需要类文件 \lstinline{elegantbook.cls}。然后将模板文件放在你的工作目录下即可使用。这样使用的好处是,无需安装,简便;缺点是,当模板进行更新之后,你需要手动替换 \lstinline{cls} 文件。 + +如果你是 \TeX{} Live 2019 用户,我们非常推荐你直接进行安装和更新。你可以通过 \TeX{} Live 2019 自带的 \lstinline{tlshell}\footnote{也叫 \TeX{} Live Manager} 进行安装。安装非常简单,步骤如下,搜索并打开 \lstinline{tlshell},然后通过 \lstinline{File -> Load Default Repository} 加载远程仓库,如果你不想使用默认的仓库,你可以通过 \lstinline{Options} 下的菜单设置远程仓库。设置好仓库之后,等待仓库加载完毕,你可以在下面的搜索栏搜索 \lstinline{elegantbook},然后选择进行安装与更新。 + +\begin{figure}[htbp] +\centering +\includegraphics[width=0.7\textwidth]{tlshell.png} +\caption{使用 \TeX{} Live Shell 安装 ElegantBook 模板} +\end{figure} + +如果你是 \TeX{} Live 2018 的用户,由于 2018 无法直接更新到 2019,所以你想更新的话,需要卸载 2018 重装 2019。如果你实在不想折腾,那么你仍然可以使用本模板。你可以手动安装模板,将 \lstinline{elegantbook.cls} 复制到你的 \TeX{} Live 目录下,默认安装目录为 \lstinline|C:\texlive\2019\texmf-dist\tex\latex\elegantbook|,然后通过命令行(管理员权限),运行 \lstinline{texhash} 即可。 + +啥?你是 C\TeX{} 用户?Sorry,本模板不提供支持。 -\section{编译方式} +更多关于 \TeX{} Live 2019 的安装使用以及 C\TeX{} 与 \TeX{} Live 的兼容、系统路径问题,请参考官方文档以及啸行的\href{https://github.com/OsbertWang/install_latex/releases}{一份简短的安装 \LaTeX{} 的介绍}。 -本模板基于基础的 book 文类,所以 book 的选项对于本模板也是有效的。默认编码为 UTF-8,推荐使用 \TeX{} Live 编译。本文编写环境为 Win10 (64bit) + \TeX{} Live 2018,支持 \lstinline{PDFLaTeX} 以及 \lstinline{XeLaTeX} 编译。 +\section{在线使用模板} +考虑到用户的在线合作需求,我们把三套模板全部上传到 \href{https://www.overleaf.com/}{Overleaf} 上了,网络通畅的用户可以直接通过 Overleaf 在线使用我们的模板。这样的好处是无需安装 \TeX{} Live 2019,可以随时随地访问自己的文件。查找模板,请在 Overleaf 模板库里面搜索 \lstinline{elegantlatex} 即可,你也可以直接访问\href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{搜索结果}。选择适当的模板之后,将其 \lstinline{Open as Template},即可把模板存到自己账户下,然后可以自由编辑以及与别人一起协作。更多关于 Overleaf 的介绍和使用,请参考 Overleaf 的\href{https://www.overleaf.com/learn}{官方文档}。 + +\begin{remark} +Overleaf 上,中文需要使用 \lstinline{XeLaTeX} 进行编译,英文可以使用 \lstinline{PDFLaTeX} 与 \lstinline{XeLaTeX} 进行编译。 +\end{remark} + +\section{用户作品计划} +Elegant\LaTeX{} 系列模板从创立至今已经有 8 年了,我们的模板也受到了很多用户的喜爱,在此,为了促进模板用户之间的交流,了解用户需求,完善本模板,我们将建立一个区域专门展示用户的文档,包括但不限于 Github 和官网等。如果你愿意将自己的作品展示出来,请邮件或者其他方式联系我们。如果自己代码已经传到 Github 或者 Gitee 等网站,可以提供对应网址。 + +\section{关于提交} +出于某些因素的考虑,Elegant\LaTeX{} 项目自 2019 年 5 月 20 日开始,\textbf{不再接受任何非作者预约性质的提交}(pull request)!如果你想改进模板,你可以给我们提交 issues,或者可以在遵循协议(LPPL-1.3c)的情况下,克隆到自己仓库下进行修改。 + +\section{协作人员招募} +招募 Elegant\LaTeX{} 的协作人员,没有工资。工作内容:翻译 Elegant\LaTeX{} 系列模板相关的文稿(中文->英文),维护模板的 wiki(主要涉及 Markdown 语法),如果有公众号文稿写作经历的话,也可以帮忙写微信稿。本公告长期有效。 + +\section{致谢} +2019 年 5 月 20 日,ElegantBook 模板在 Github 上的 star 数达到了 100,并且 21 日上了 Github 网站 \TeX{} 语言的\href{https://github.com/trending/tex?since=daily}{日趋势榜单}。这对于 Elegant\LaTeX{} 系列模板都是一个里程碑! + +在此特别感谢 China\TeX{} 以及 \href{http://www.latexstudio.net/}{\LaTeX{} 工作室}对于本系列模板的大力宣传与推广。\LaTeX{} 工作室网站上有很多精彩的帖子和精致的模板,欢迎大家去挖掘里面的宝藏。这也是国内最全面的 \LaTeX{} 相关的网站。 + +特别感谢 \href{https://github.com/muzimuzhi}{muzimuzhi} 对于模板的完善。 + +如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。 +\begin{figure}[htbp] +\centering +\includegraphics[width=\textwidth]{star.png} +\caption{一键三连求赞} +\end{figure} + +之前我们模板从未发布过捐赠/打赏信息,近期有用户反映他们对我们模板非常喜爱,想打赏没有支付码,不禁感叹,这世道变了啊,还有主动打赏的,那么我们就“勉为其难”地发布我们的打赏二维码吧! + +\begin{figure}[htbp] +\centering +\includegraphics[width=0.5\textwidth]{donate.jpg} +\end{figure} + +赞赏费用的使用解释权归 Elegant\LaTeX{} 所有,并且不接受监督,请自愿理性打赏,10 元以上的赞赏,我们将列入捐赠榜,谢谢各位金主! + +\begin{table}[htbp] + \centering + \caption{捐赠榜} + \begin{tabular}{cccc} + \toprule + 捐赠者 & 金额 & 时间 & 渠道 \\ + \midrule + Lerh & 10 元 & 2019/5/15 & 微信 \\ + 越过地平线 & 10 元 & 2019/5/15 & 微信 \\ + 大熊 & 20 元 & 2019/5/27 & 微信 \\ + \bottomrule + \end{tabular}% +\end{table}% + +再次感谢大家对于模板的喜爱! + +\chapter{ElegantBook 设置说明} + +本模板基于基础的 book 文类,所以 book 的选项对于本模板也是有效的。默认编码为 UTF-8,推荐使用 \TeX{} Live 编译。本文编写环境为 Win10 (64bit) + \TeX{} Live 2019,支持 \lstinline{PDFLaTeX} 以及 \lstinline{XeLaTeX} 编译。 \section{语言模式} @@ -69,13 +150,18 @@ \section{语言模式} \end{lstlisting} \begin{remark} -不管选用中文环境(\lstinline{lang=cn})还是英文环境(\lstinline{lang=en})均可输入中文。另外如果在笔记中使用了抄录环境(\lstinline{lstlisting}),并抄录代码中有中文,请务必使用 \lstinline{XeLaTeX} 编译。 +只有中文环境(\lstinline{lang=cn})才可以输入中文。另外如果抄录环境(\lstinline{lstlisting})中有中文字符,请务必使用 \lstinline{XeLaTeX} 编译。 \end{remark} - +\section{设备选项} +最早我们在 ElegantNote 模板中加入了设备选项(\lstinline{device}),后来,我们觉得这个设备选项的设置可以应用到 ElegantBook 中\footnote{不过因为 ElegantBook 模板封面图片的存在,在修改页面设计时,需要对图片进行裁剪。},而且 Book 一般内容比较多,如果在 iPad 上看无需切边,放大,那用户的阅读体验将会得到巨大提升。你可以使用下面的选项将版面设置为 iPad 设备模式\footnote{默认为 normal 模式,也即 A4 纸张大小。} +\begin{lstlisting} +\documentclass[pad]{elegantbook} %or +\documentclass[device=pad]{elegantbook} +\end{lstlisting} \section{颜色主题} -本模板内置 5 组颜色主题,分别为 \textcolor{main1}{\lstinline{green}}\footnote{为原先默认主题}、\textcolor{main2}{\lstinline{cyan}}、\textcolor{main3}{\lstinline{blue}}(默认)、\textcolor{main4}{\lstinline{gray}}、\textcolor{main5}{\lstinline{black}}。另外还有一个自定义的选项 \lstinline{nocolor}。调用颜色主题 \lstinline{green} 的方法为 +本模板内置 5 组颜色主题,分别为 \textcolor{structure1}{\lstinline{green}}\footnote{为原先默认主题。}、\textcolor{structure2}{\lstinline{cyan}}、\textcolor{structure3}{\lstinline{blue}}(默认)、\textcolor{structure4}{\lstinline{gray}}、\textcolor{structure5}{\lstinline{black}}。另外还有一个自定义的选项 \lstinline{nocolor}。调用颜色主题 \lstinline{green} 的方法为 \begin{lstlisting} \documentclass[green]{elegantbook} %or \documentclass[color=green]{elegantbook} @@ -124,7 +210,7 @@ \section{颜色主题} \end{tabular} \end{table} -如果需要自定义颜色的话请选择 \lstinline{nocolor} 选项或者使用 \lstinline{color=none},然后在导言区定义 structure、main、second、third 颜色,具体方法如下: +如果需要自定义颜色的话请选择 \lstinline{nocolor} 选项或者使用 \lstinline{color=none},然后在导言区定义 structurecolor、main、second、third 颜色,具体方法如下: \begin{lstlisting} \definecolor{structurecolor}{RGB}{0,0,0} \definecolor{main}{RGB}{70,70,70} @@ -166,12 +252,12 @@ \section{数学环境简介} \subsection{定理类环境的使用} 由于本模板使用了 \lstinline{tcolorbox} 宏包来定制定理类环境,所以和普通的定理环境的使用有些许区别,定理的使用方法如下: \begin{lstlisting} -\begin{theorem}{}{