3.08 cn wiki

_Sidebar.md

@@ -1,17 +1,25 @@
 ## 中文版本
 
 * [模板介绍](https://github.com/ElegantLaTeX/ElegantBook/wiki/介绍)
-* 模板使用
+	* [安装与更新](https://github.com/ElegantLaTeX/ElegantBook/wiki/安装)
-    * [安装说明](https://github.com/ElegantLaTeX/ElegantBook/wiki/安装)
+	* [更新说明](https://github.com/ElegantLaTeX/ElegantBook/wiki/更新说明)
-    * [编译方式](https://github.com/ElegantLaTeX/ElegantBook/wiki/编译方式)
+	* [用户作品计划](https://github.com/ElegantLaTeX/ElegantBook/wiki/用户作品计划)
+	* [关于提交](https://github.com/ElegantLaTeX/ElegantBook/wiki/关于提交)
+	* [协作人员招募](https://github.com/ElegantLaTeX/ElegantBook/wiki/协作人员招募)
+	* [致谢](https://github.com/ElegantLaTeX/ElegantBook/wiki/致谢)
+* [模板使用](https://github.com/ElegantLaTeX/ElegantBook/wiki/使用)
     * [语言模式](https://github.com/ElegantLaTeX/ElegantBook/wiki/语言模式)
+	* [设备选项](https://github.com/ElegantLaTeX/ElegantBook/wiki/设备选项)
     * [颜色主题](https://github.com/ElegantLaTeX/ElegantBook/wiki/颜色主题)
     * [显示风格](https://github.com/ElegantLaTeX/ElegantBook/wiki/显示风格)
     * [定理类环境](https://github.com/ElegantLaTeX/ElegantBook/wiki/定理类环境)
+	* [装饰物](https://github.com/ElegantLaTeX/ElegantBook/wiki/装饰物)
     * [封面徽标](https://github.com/ElegantLaTeX/ElegantBook/wiki/封面徽标)
     * [列表环境](https://github.com/ElegantLaTeX/ElegantBook/wiki/列表环境)
     * [参考文献](https://github.com/ElegantLaTeX/ElegantBook/wiki/参考文献)
     * [添加序章](https://github.com/ElegantLaTeX/ElegantBook/wiki/添加序章)
+	* [章节摘要](https://github.com/ElegantLaTeX/ElegantBook/wiki/章节摘要)
+	* [章后习题](https://github.com/ElegantLaTeX/ElegantBook/wiki/章后习题)	
 * [示例](https://github.com/ElegantLaTeX/ElegantBook/wiki/最小示例)
 * [跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)
 * 作者
@@ -19,25 +27,32 @@
     * [个人主页](https://ddswhu.me/)
 
 
+
 ## English Version
 
 * [Introduction](https://github.com/ElegantLaTeX/ElegantBook/wiki/Introduction)
 * How To Use
-    * [Installation](https://github.com/ElegantLaTeX/ElegantBook/wiki/Installation)
+    * [Installation and Update](https://github.com/ElegantLaTeX/ElegantBook/wiki/Installation)
     * [Compilation Methods](https://github.com/ElegantLaTeX/ElegantBook/wiki/CompilationMethods)
     * [Languages](https://github.com/ElegantLaTeX/ElegantBook/wiki/Languages)
     * [Color Themes](https://github.com/ElegantLaTeX/ElegantBook/wiki/ColorThemes)
-    * [Languages](https://github.com/ElegantLaTeX/ElegantBook/wiki/Languages)
     * [Display Styles](https://github.com/ElegantLaTeX/ElegantBook/wiki/DisplayStyles)
     * [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantBook/wiki/TheoremClassEnvironments)
     * [Cover and Logo](https://github.com/ElegantLaTeX/ElegantBook/wiki/CoverLogo)
     * [Lists](https://github.com/ElegantLaTeX/ElegantBook/wiki/Lists)
     * [Bibliography](https://github.com/ElegantLaTeX/ElegantBook/wiki/Bibliography)
     * [Preface](https://github.com/ElegantLaTeX/ElegantBook/wiki/Preface)
+    * [Device Mode Option](https://github.com/ElegantLaTeX/ElegantBook/wiki/DeviceModeOption)
+    * [Base Hide Option](https://github.com/ElegantLaTeX/ElegantBook/wiki/BaseHideOption)
 * [Minimal Example](https://github.com/ElegantLaTeX/ElegantBook/wiki/MinimalExample)
+* [Problem Set](https://github.com/ElegantLaTeX/ElegantBook/wiki/ProblemSet)
 * Author
     * [Github](https://github.com/EthanDeng)
     * [Homepage](https://ddswhu.me/)
+* [User's Selected Works Plan](https://github.com/ElegantLaTeX/ElegantBook/wiki/UserSelectedWorksPlan)
+* [About Pull Request](https://github.com/ElegantLaTeX/ElegantBook/wiki/AboutPullRequest)
+* [Recruit Support Members](https://github.com/ElegantLaTeX/ElegantBook/wiki/RecruitSupportMembers)
+* [Acknowledgement](https://github.com/ElegantLaTeX/ElegantBook/wiki/Acknowledgement)
 
 ## Links/相关链接
 

介绍.md

@@ -1,20 +1,14 @@
-值此版本发行之际，我们 ElegantLaTeX 项目组向大家重新介绍一下我们的工作，我们致力于打造一系列美观、优雅、简便的模板方便用户使用。ElegantLaTeX 系列模板目前由 [ElegantNote](https://github.com/ElegantLaTeX/ElegantNote)，[ElegantBook](https://github.com/ElegantLaTeX/ElegantBook)，[ElegantPaper](https://github.com/ElegantLaTeX/ElegantPaper) 组成，分别用于排版笔记，书籍和工作论文。这些子项目的名词是一体的，请在使用这些名词的时候不要将其断开（如 Elegant Note 是不正确的写法）。并且，ElegantLaTeX Book 指的即是 ElegantBook。
+ElegantLaTeX 项目组向致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 [ElegantNote](https://github.com/ElegantLaTeX/ElegantNote), [ElegantBook](https://github.com/ElegantLaTeX/ElegantBook), [ElegantPaper](https://github.com/ElegantLaTeX/ElegantPaper) 组成，分别用于排版笔记，书籍和工作论文。强烈推荐使用最新正式版本！本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题，建议或者意见，欢迎在 Github 上给我们提交 [issue](https://github.com/ElegantLaTeX/ElegantBook/issues) 或者邮件联系我们。
 
-最新版本下载地址：[Github:ElegantBook/releases](https://github.com/ElegantLaTeX/ElegantBook/releases)。本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题，建议或者意见，欢迎联系我们。
+相关联系方式：
 
-## ElegantBook 更新说明
+* 官网：[https://elegantlatex.org/](https://elegantlatex.org/)
+* Github 网址：[https://github.com/ElegantLaTeX/](https://github.com/ElegantLaTeX/)
+* CTAN 地址：[https://ctan.org/pkg/elegantbook](https://ctan.org/pkg/elegantbook)
+* 文档 Wiki：[https://github.com/ElegantLaTeX/ElegantBook/wiki](https://github.com/ElegantLaTeX/ElegantBook/wiki)
+* 下载地址：[正式发行版](https://github.com/ElegantLaTeX/ElegantBook/releases)，[最新版](https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip)
+*  微博：ElegantLaTeX
+* 微信公众号：ElegantLaTeX
+* 用户 QQ 群：692108391 
+* 邮件：[elegantlatex2e@gmail.com](elegantlatex2e@gmail.com)
 
-在这几年间，我们收到了很多用户的反馈，主要的问题涉及到字体安装，编码支持，定理浮动，定理跨页，交叉引用等等。我们思前想后，原先让用户安装字体以追求视觉上的美观并不完美，用户陷入了巨大的麻烦，这违背了我们的模板初衷。因此我们在新版中删除了这部分，用户无需安装任何字体。让我们来看下此次 ElegantBook 模板 3.x 更新的主要内容有：
-
-1. 删除了自定义字体设置，改用 `ctex` 宏包或者系统默认字体；
-2. 模板拆分为中英文模式（`lang=cn/en`）；
-3. `PDFLaTeX` 与 `XeLaTeX` 支持；
-4. 使用 `tcolorbox` 宏包改写定理类环境，可跨页；
-5. 定理类环境名字更新，修复定理环境交叉引用；
-6. 颜色名字更新，统一链接颜色；
-7. 重新绘制 ElegantLaTeX 的 Logo；
-8. 更新封面与装饰物，删除水印；
-9. 修正附录相关内容；
-10. 增加灰色主题 `color=plain`；
-11. 增加代码高亮；
-12. 美化列表环境。

使用.md

@@ -0,0 +1,3 @@
+本模板基于基础的 book 文类，所以 book 的选项对于本模板也是有效的。默认编码为 UTF-8，推荐使用 TeX Live 编译。本文编写环境为 Win10 (64bit) + TeX Live 2019，支持 PDFLaTeX 以及 XeLaTeX 编译。
+
+

关于提交.md

@@ -0,0 +1,3 @@
+### 关于提交
+
+出于某些因素的考虑，ElegantLaTeX 项目自 2019 年 5 月 20 日开始，**不再接受任何非作者预约性质的提交**（pull request)！如果你想改进模板，你可以给我们提交 issues，或者可以在遵循协议（LPPL-1.3c）的情况下，克隆到自己仓库下进行修改。

协作人员招募.md

@@ -0,0 +1,10 @@
+### Support 招募
+
+招募 ElegantLaTeX 的协作人员，没有工资。工作内容：翻译 ElegantLaTeX系列模板相关的文稿（中文 -> 英文），维护模板的 wiki（主要涉及 Markdown 语法），如果有文稿写作经历也可以帮忙写微信公众号推送。本公告长期有效。
+
+感谢我们 ElegantLaTeX 的协作人员，感谢他们无私的工作！
+
+- 官方指南翻译:   [YPY](https://github.com/peggy2006xzyz);
+- Wiki 维护:  [Ingo Zinngo](https://github.com/izinngo);
+- QQ 群管理:  [Sikouhjw](https://github.com/sikouhjw).
+

参考文献.md

@@ -1,7 +1,16 @@
-此模板使用了 `BibTeX` 来生成参考文献，默认使用的文献样式（bib style）是 `aer`。参考文献示例：Chen et al. (2018) 使用了中国一个大型的 P2P 平台（人人贷）的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。
+此模板使用了 BibTeX 来生成参考文献，在中文示例中，使用了 gbt7714 宏包。参考文献示例：[1-3] 使用了中国一个大型的 P2P 平台（人人贷）的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。
 
 你可以在谷歌学术，Mendeley，Endnote 中获得文献条目（bib item），然后把它们添加到 `reference.bib` 中。在文中引用的时候，引用它们的键值（bib key）即可。注意需要在编译的过程中添加 `BibTeX` 编译。如果你想在参考文献中添加未引用的文献，可以使用
 
 ```tex
-\nocite{EINAV2010,Havrylchyk2018} 
+\nocite{EINAV2010,Havrylchyk2018} %or include some bibitems
+\nocite{*} %include all the bibitems
 ```
+
+本模板还添加了 `cite=numbers` 和 `cite=authoryear` 两个参考文献选项，用于设置参考文献格式的设置，默认为 numbers。据我们所知，理工科类一般使用 numbers，而文科类使用 authoryear 比较多，所以我们将 numbers 作为默认格式。如果需要改为 authoryear，可以使用
+
+```tex
+\documentclass[cite=authoryear]{elegantbook} %or
+\documentclass[authoryear]{elegantbook}
+```
+

安装.md

@@ -1,35 +1,24 @@
-本节以 TeX Live 2018 为例，介绍如何通过命令行或者包管理工具安装模板（包）。
+本节介绍如何通过免安装或者安装模板（包）方式使用。
 
-## 命令行方式安装
+### 免安装方式安装
 
-以管理员权限打开命令行，在命令行输入下面命令即可安装 elegantbook 模板。
+从 Github 或者 CTAN 下载最新（正式）版文件，严格意义上只需要类文件 `elegantbook.cls`。然后将模板文件放在你的工作目录下即可使用。这样使用的好处是，无需安装，简便；缺点是，当模板进行更新之后，你需要手动替换。
 
-```shell
+### 安装模板方式安装
-tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet
-tlmgr install elegantbook
-```
 
-升级和卸载分别使用
+如果你是 TeX Live 2019 用户，我们非常推荐你直接进行安装和更新。你可以通过 TeX Live 2019 自带的tlshell进行安装。安装非常简单，步骤如下，搜索并打开 tlshell，然后通过 `File -> Load Default Repository` 加载远程仓库，如果你不想使用默认的仓库，你可以通过 Options 下的菜单设置远程仓库。设置好仓库之后，等待仓库加载完毕，你可以在下面的搜索栏搜索 elegantbook，然后选择进行安装与更新。
 
-```shell
+![](https://raw.githubusercontent.com/wiki/izinngo/public/image/tlshell.png)
-tlmgr update elegantbook
-tlmgr uninstall elegantbook 
-```
 
-## 包管理工具方式安装
+如果你是 TeX Live 2018 的用户，由于 2018 无法更新到 2019，所以你想更新的话，需要卸载 2018 重装 2019。如果你实在不想折腾，那么你仍然可以使用本模板，你可以手动安装模板，将elegantbook.cls复制到你的 TeXLive 目录下，默认安装目录为 `C:\texlive\2019\texmf-dist\tex\latex\elegantbook`，然后通过命令行（管理员权限），运行 texhash 即可。
 
-在 Windows 里面搜索 tlmgr，找到 TeX Live Manager 并打开：
+啥？你是 CTeX 用户？Sorry，本模板不提供支持。
 
-![tlmgr](https://elegantlatex.org/image/tlmgr.png)
+更多关于 TeX Live 2019 的安装使用以及 CTeX 与 TeX Live 的兼容、系统路径问题，请参考官方文档以及啸行的[一份简短的安装 LaTeX的介绍](https://github.com/OsbertWang/install_latex/releases)。
 
-然后通过菜单 `tlmgr` 选择 
+### 在线使用模板
 
-```shell
+考虑到用户的在线合作需求，我们把三套模板全部上传到 [Overleaf](https://www.overleaf.com/) 上了，网络通畅的用户可以直接通过 Overleaf 在线使用我们的模板。这样的好处是无需安装 TeX Live 2019，可以随时随地访问自己的文件。查找模板，请在 Overleaf 模板库里面搜索 elegantlatex 即可，你也可以直接访问[搜索结果](https://www.overleaf.com/latex/templates?addsearch=elegantlatex)。选择适当的模板之后，将其Open as Template，即可把模板存到自己账户下，然后可以自由编辑以及与别人一起协作。更多关于 Overleaf 的介绍和使用，请参考 Overleaf 的[官方文档](https://www.overleaf.com/learn)。
-Load standard net repository: http://mirror.ctan.org/systems/texlive/tlnet
-```
 
-![tlmgr](https://elegantlatex.org/image/tlmgr-1.png)
+**注**：Overleaf 上，中文需要使用 XeLaTeX 进行编译，英文可以使用 PDFLaTeX 与 XeLaTeX 进行编译。
 
-然后在匹配框内输入包的名字，比如 `elegantbook`，在搜索结果中勾选需要安装/更新/卸载的包：
-
-![tlmgr](https://elegantlatex.org/image/tlmgr-book.png)

定理类环境.md

@@ -1,3 +1,10 @@
+在我们这个模板中，我们定义了两种不同的定理模式（mode），包括简单模式（simple）和炫彩模式（fancy），默认为 fancy 模式，不同模式的选择为
+
+```tex
+\documentclass[simple]{elegantbook} %or
+\documentclass[mode=simple]{elegantbook}
+```
+
 在我们这个模板中，定义了四大类环境
 
 + __定理类环境__：包含标题和内容两部分，全部定理类环境的编号均以章节编号。根据格式的不同分为 3 种
@@ -8,21 +15,17 @@
 + __证明类环境__：，有 proof、note 环境，特点是，有引导符或者结尾符，note 环境有引导符号，proof 环境有证明完毕符号。
 + __结论类环境__：有 conclusion、assumption、property，remark、solution 环境，三者均以粗体的引导词为开头，和普通段落格式一致。
 
-__评论：__ 在选用 `lang=cn` 时，定理类环境的引导词全部会改为中文。
+###  定理类环境的使用
-
-##  定理类环境的使用
 
 由于本模板使用了 tcolorbox 宏包来定制定理类环境，所以和普通的定理环境的使用有些许区别，定理的使用方法如下：
 
 ```tex
-\begin{theorem}{<theorem name>}{<label>}
+\begin{theorem}{theorem name}{label}
 The content of theorem.
 \end{theorem}
 ```
 
-第一个必选项 `<theorem name>` 是定理的名字，第二个必选项 `<label>` 是交叉引
+第一个必选项 `theorem name` 是定理的名字，第二个必选项 `label` 是交叉引用时所用到的标签，交叉引用的方法为 `\ref{thm:label}`。请注意，交叉引用时必须加上前缀 `thm:`。其他相同用法的定理类环境有：
-用时所用到的标签，交叉引用的方法为 `\ref{thm:label}`。请注意，交叉引用时必
-须加上前缀 `thm`:。其他相同用法的定理类环境有：
 
 | 环境名       | 标签名  | 前缀  | 交叉引用            |
 |-------------|--------|------|-------------------|

封面徽标.md

@@ -1,7 +1,6 @@
-本模板使用的封面图片来源于 [pixabay.com](https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/)<sup>[1](#myfootnote1)</sup>，图片完全免费，可用于任何场
+本模板使用的封面图片来源于 [pixabay.com](https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/)<sup>[5](#myfootnote1)</sup>，图片完全免费，可用于任何场
 景。封面图片的尺寸为 1280*1024, 更换图片的时候请 __严格__ 按照封面图片尺寸进
 行裁剪。推荐一个免费的在线图片裁剪网站 [befunky.com](https://www.befunky.com/create/crop-photo/)。
 
 本文用到的 Logo 比例为 1:1，也即正方形图片，在更换图片的时候请选择合适的图片进行替换。
 
-<a name="myfootnote1">1</a>: 感谢 ChinaTEX 提供免费图源网站，另外还推荐 [pexels.com](https://www.pexels.com/)。

常见问题.md

@@ -0,0 +1,81 @@
+**问题**：有没有办法章节用“第一章，第一节，（一）”这种？
+
+**答案**：你可以修改模板中对于章节的设置，利用 `ctex` 宏集的 `\zhnumber` 命令可以把计数器的数字形式转为中文。
+
+
+
+**问题**：3.07 版本的 cls 的 `natbib` 加了`numbers` 编译完了没变化，群主设置了不可更改了？
+
+**答案**：3.07 中在 `gbt7714` 宏包使用时，加入了 `authoryear` 选项，这个使得 `natbib` 设置了 `numbers` 也无法生效。3.08 版本中，模板增加了 `numbers` 和 `authoryear` 文献选项，你可以参考前文设置说明。
+
+
+
+**问题**：大佬，我想把正文字体改为亮色，背景色改为黑灰色。
+
+**答案**：页面颜色可以使用 `\pagecolor` 命令设置，文本命令可以参考[这里](https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color)进行设置。
+
+
+
+**问题**：`! LaTeX Error: Unknown option scheme=plain for package ctex.`
+
+**答案**：你用的 CTeX 套装吧？这个里面的 `ctex` 宏包已经是已经是 10 年前的了，与本模板使用的 `ctex` 宏集有很大区别。不建议 CTeX 套装了，请卸载并安装 TeX Live 2019。
+
+
+
+**问题**：我该使用什么版本？
+
+**答案**：请务必使用[最新正式发行版](https://github.com/ElegantLaTeX/ElegantBook/releases)，发行版间不定期可能会有更新（修复 bug 或者改进之类），如果你在使用过程中没有遇到问题，不需要每次更新[最新版](https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip)，但是在发行版更新之后，请尽可能使用最新版（发行版）！最新发行版可以在 Github 或者 TeX Live 2019 内获取。
+
+
+
+**问题**：我该使用什么编辑器？
+
+**答案**：你可以使用 TeX Live 2019 自带的编辑器 TeXworks 或者使用 TeXstudio，TeXworks 的自动补全，你可以参考我们的总结 [TeXworks 自动补全](https://github.com/EthanDeng/texworks-autocomplete)。推荐使用 TeX Live 2019 + TeXstudio。我自己用 VS Code 和 Sublime Text，相关的配置说明，请参考 [LaTeX 编译环境配置：Visual Studio Code 配置简介](https://github.com/EthanDeng/vscode-latex) 和 [Sublime Text 搭建 \LaTeX{} 编写环境](https://github.com/EthanDeng/sublime-text-latex)。
+
+
+
+**问题**：您好，我们想用您的 ElegantBook 模板写一本书。关于机器学习的教材，希望获得您的授权，谢谢您的宝贵时间。
+
+**答案**：模板的使用修改都是自由的，你们声明模板来源以及模板地址（Github 地址）即可，其他未尽事宜按照开源协议 LPPL-1.3c。做好之后，如果方便的话，可以给我们一个链接，我把你们的教材放在 ElegantLaTeX 用户作品集里。
+
+
+
+**问题**：我想要原来的封面！
+
+**答案**：我们计划在未来版本加入封面选择，让用户可以选择旧版封面。
+
+
+
+**问题**：我想修改中文字体！
+
+**答案**：首先，我们强烈建议你不要去修改字体！如果你一定坚持修改字体，请在 `newtxtext` 宏包加载前加入中文字体设置（`xeCJK` 宏包）。如果你选择自定义字体，请设置好 `\kaishu`，`\heiti` 等命令，否则会报错。如果你看不懂我现在说的，请停止你的字体自定义行为。
+
+
+
+**问题**：请问交叉引用是什么？
+
+**答案**：本群和本模板适合有一定 LaTeX 基础的用户使用，新手请先学习 LaTeX 的基础，理解各种概念，否则你将寸步难行。
+
+
+
+**问题**：定义等环境中无法使用加粗命令么？
+
+**答案**：是这样的，默认中文并没加粗命令，如果你想在定义等环境中使用加粗命令，请使用 `\heiti` 等字体命令，而不要使用 `\textbf`。或者，你可以将 `\textbf` 重新定义为 `\heiti`。英文模式不存在这个问题。
+
+
+
+**问题**：代码高亮环境能用其他语言吗？
+
+**答案**：可以的，ElegantBook 模板用的是 `listings` 宏包，你可以在环境之后加上语言，全局语言修改请使用 `\lstset` 命令，更多信息请参考宏包文档。
+
+
+
+**问题**：群主，什么时候出 Beamer 的模板（主题），ElegantSlide 或者 ElegantBeamer？
+
+**答案**：这个问题问的人比较多，我这里给个明确的答案。由于 Beamer 中有一个很优秀的主题 [Metropolis](https://github.com/matze/mtheme)。我觉得在我们找到非常好的创意之前不会发布正式的 Beamer 主题，如果你非常希望得到 ElegantLaTeX “官方”的主题，请在用户 QQ 群内下载我们测试主题 PreElegantSlide（未来不一定按照这个制作）。正式版制作计划在 2020 年之后。
+
+
+
+**问题**：群主好棒，想嫁！
+
+**答案**：我取向正常！

更新说明.md

@@ -0,0 +1,17 @@
+此次更新主要涉及：
+
+1. 修复 `\part` 命令；
+2. 增加 pad 模式；
+3. 增加 mtpro2 宏包选项支持；
+4. 修改参考文献默认为 numbers 格式；
+5. 增加章节介绍 introduction 环境；
+6. 增加章节习题 problemset 环境；
+7. 增加旁注，`\elegantpar` 命令（测试）；
+8. 减少公式前后距离；
+9. `\equote` 改为 `\extrainfo`，并且多行显示；
+10. 完善文档，增加致谢等部分。
+
+
+
+**注意**：由于新版本进行了重构，3.x 版本并不兼容 2.x 版本，并且在 3.06 版本更新过封面，如果你想把 3.06 版本（包括 2.x 版本）之前的文件转为最新版本兼容的文件，请仔细查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。今后不再回答关于 2.x 版本的问题。
+

最小示例.md

@@ -1,20 +1,17 @@
 安装之后即可使用，下面是一个示例：
 
 ```tex
-\documentclass{elegantbook}
+\documentclass[lang=cn,11pt]{elegantbook}
-
 % title info
 \title{Title}
 \subtitle{Subtitle is here}
-
 % bio info
 \author{Your Name}
 \institute{XXX University}
 \date{\today}
-
 % extra info
 \version{1.00}
-\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}
 
@@ -24,16 +21,11 @@
 \tableofcontents
 \mainmatter
 \hypersetup{pageanchor=true}
-
 % add preface chapter here if needed
 \chapter{Example Chapter Title}
 The content of chapter one.
 
 \bibliography{reference}
-\appendix
-
-\chapter{Appendix Chapter Title}
-The content of appendix 1.
 
 \end{document}
 ```

添加序章.md

@@ -1,8 +1,9 @@
 如果你想在第一章前面添加序章，不改变原本章节序号，你可以在第一章内容前面使用
 
 ```tex
-\chapter*{序章}
+\chapter*{Introduction}
-\addcontentsline{toc}{chapter}{序章}
+\addcontentsline{toc}{chapter}{Introduction} 
-\markboth{序章}{}
+\markboth{Introduction}{} 
-序章的内容。
+The content of introduction.
 ```
+

用户作品计划.md

@@ -0,0 +1 @@
+ElegantLaTeX 系列模板从创立至今已经有 8 年了，我们的模板也受到了很多用户的喜爱，在此，为了促进模板用户之间的交流，了解用户需求，完善本模板，我们将建立一个区域专门展示用户的文档，包括但不限于 Github 和官网等。如果你愿意将自己的作品展示出来，请邮件或者其他方式联系我们。如果自己代码已经传到 Github 或者 Gitee 等网站，可以提供对应网址。

章后习题.md

@@ -0,0 +1,24 @@
+前面我们介绍了例题和练习两个环境，这里我们再加一个，章后习题（problemset）环境，用于在每一章结尾，显示本章的练习。使用方法如下
+
+```tex
+\begin{problemset}
+	\item exercise 1
+	\item exercise 2
+	\item exercise 3
+\end{problemset}
+```
+
+效果如下：
+
+![](./problemset.png)
+
+**注**    如果你想把 problemset 环境的的标题改为其他文字，你可以修改这个环境的可选参数。
+
+```tex
+\begin{problemset}[Hello World]
+	\item ...
+\end{problemset}
+```
+
+
+

章节摘要.md

@@ -0,0 +1,26 @@
+模板新增了一个章节摘要环境（introduction），使用示例
+
+```tex
+\begin{introduction}
+	\item Definition of Theorem
+	\item Ask for help
+	\item Optimization Problem
+	\item Property of Cauchy Series
+	\item Angle of Corner
+\end{introduction}
+```
+
+效果如下：
+
+![](./introduction.png)
+
+**注**    环境的标题文字可以通过这个环境的可选参数进行修改，修改方法为：
+
+```tex
+\begin{introduction}[Brief Introduction]
+...
+\end{introduction}
+```
+
+
+

编译方式.md

@@ -1,35 +0,0 @@
-本模板基于基础的 book 文类，所以 book 的选项对于本模板也是有效的。默认编码为 UTF-8，推荐使用 TeX Live 编译。本文编写环境为 Win10 (64bit) + TeX Live 2018，支持 `PDFLaTeX` 以及 `XeLaTeX` 编译。
-
-## 选择 `PDFLaTeX` 编译
-
-如果你使用 `PDFLaTeX` 编译，默认的 Computer Modern 字体被换成了 newtx 系列字体，默认的字体字号是 12 pt。关于字体设置的宏包主要用到了：
-
-+ `newtxtext` 用于文档正文字体，类似于 Times New Roman 字体。
-+ `newtxmath` 用于数学字体，搭配 `newtxtext` 非常合适。
-+ `FiraMono` 用于打字机字体，并使用了 `scale=0.7` 选项。
-+ `ctex` 用于中文字体设置，并使用了 `scheme=plain` 选项。
-
-一次完整的编译：`PDFLaTeX` -> `BibTeX` -> `PDFLaTeX`*2。
-
-
-## 选择 `XeLaTeX` 编译
-
-如果你选择 `XeLaTeX` 编译的话，那么设置字体的宏包为 `fontspec` 和 `xeCJK`。由于模板中使用的字体是 Windows 中的字体，所以如果你使用其他操作系统，比如 Linux 或者 Mac OS，那么你需要把所用字体替换为你系统中的字体。设置字体的命令：
-
-```tex
-\RequirePackage{fontenc}
-\RequirePackage[no-math]{fontspec}
-\setmainfont{Times New Roman}[NFSSFamily=ntxtlf]
-\setsansfont{Arial}
-%\setmonofont[Scale=0.7]{Courier New}
-\RequirePackage{xeCJK}
-\RequirePackage{xunicode}
-\setCJKmainfont[BoldFont={SimHei},ItalicFont={KaiTi}]{SimSun}
-\setCJKsansfont[BoldFont={SimHei},ItalicFont={KaiTi}]{KaiTi}
-\setCJKmonofont[BoldFont={SimHei},ItalicFont={KaiTi},Scale=0.7]{Microsoft YaHei}
-\XeTeXlinebreaklocale ”zh”
-\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
-\RequirePackage{newtxmath}
-```
-
-一次完整的编译：`XeLaTeX` -> `BibTeX` -> `XeLaTeX`*2。

致谢.md

@@ -0,0 +1,28 @@
+### 致谢
+
+2019 年 5 月 20 日，ElegantBook 模板在 Github 上的 Star 数达到了 100，并且 21 日上了 Github TeX 语言的[日趋势榜单](https://github.com/trending/tex?since=daily)。这对于 ElegantLaTeX 系列模板都是一个里程碑！
+
+在此特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。LaTeX 工作室网站上有很多精彩的帖子和精致的模板，欢迎大家去挖掘里面的宝藏。这也是我所见到的国内最全面的 LaTeX 相关的网站。
+
+特别感谢 [muzimuzhi](https://github.com/muzimuzhi) 对于模板的完善。
+
+如果你喜欢我们的模板，你可以在 Github 上收藏我们的模板。
+
+![](https://raw.githubusercontent.com/wiki/izinngo/public/image/star.png)
+
+之前我们模板从未发布过捐赠/打赏信息，近期有用户反映他们对我们模板非常喜爱，想打赏没有支付码，不禁感叹，这世道变了啊，还有主动打赏的，那么我们就”勉为其难”地发布我们的打赏二维码吧！
+
+​	![](https://raw.githubusercontent.com/wiki/izinngo/public/image/donate.jpg)
+
+赞赏费用的使用解释权归 ElegantLaTeX 所有，并且不接受监督，请自愿理性打赏，10 元以上的赞赏，我们将列入捐赠榜，谢谢各位金主！
+
+
+| 捐赠者   | 金额 |  时间  | 渠道 |
+| :------:   | :----:   | :----: | :------:   |
+| Lerh   | 10 RMB |   2019/5/15   | 微信 |
+| 越过地平线  | 10 RMB |   2019/5/15   | 微信 |
+| 大熊      | 10 RMB |   2019/5/27   | 微信 |
+
+
+再次感谢大家对于模板的喜爱！
+

装饰物.md

@@ -0,0 +1,9 @@
+本模板为章节后的装饰物（base）添加了隐藏选项，有 show 和 hide 两个选项。
+
+```tex
+\documentclass[hide]{elegantbook} %or
+\documentclass[base=hide]{elegantbook}
+```
+
+
+

设备选项.md

@@ -0,0 +1,7 @@
+最早我们在 ElegantNote 模板中加入了设备选项（device），后来，我们觉得这个设备选项的设置可以应用到 ElegantBook 中，而且 Book 一般内容比较多，如果在 iPad 上看无需切边，放大，那用户的阅读体验将会得到巨大提升。你可以使用下面的选项将版面设置为 iPad 设备模式。
+
+```tex
+\documentclass[pad]{elegantbook} %or
+\documentclass[device=pad]{elegantbook}
+```
+

语言模式.md

@@ -3,8 +3,7 @@
 ```tex
 \documentclass[cn]{elegantbook}
 \documentclass[lang=cn]{elegantbook}
-\documentclass[en]{elegantbook}
-\documentclass[lang=en]{elegantbook}
 ```
 
-__注：__ 不管选用中文环境（`lang=cn`）还是英文环境（`lang=en`）均可输入中文。另外如果在笔记中使用了抄录环境（lstlisting），并且其中包括了中文，请务必使用 `XeLaTeX` 编译。
+__注：__ 只有中文环境（lang=cn）才可以输入中文。另外如果抄录环境（lstlisting）中有中文字符，请务必使用 XeLaTeX 编译。
+

颜色主题.md

@@ -1,15 +1,16 @@
-本模板内置 4 组颜色主题，分别为 green（默认）、cyan、blue、plain，另外还
+本模板内置 5 组颜色主题，分别为 green、cyan、blue（默认）、gray、black，另外还有一个自定义的选项 `nocolor`。调用颜色主题 green 的方法为
-有一个自定义的选项 `nocolor`。调用颜色主题 green 的方法为
 
 ```tex
 \documentclass[green]{elegantbook} %or
 \documentclass[color=green]{elegantbook}
 ```
 
-其中 plain 主题为全灰色。如果需要自定义颜色的话请选择 `nocolor` 选项或者使用 `color=none`，然后在导言区定义 main、second、third 颜色，具体方法如下：
+如果需要自定义颜色的话请选择 `nocolor` 选项或者使用 `color=none`，然后在导言区定义 structurecolor、main、second、third 颜色，具体方法如下：
 
 ```tex
+\definecolor{structurecolor}{RGB}{0,0,0}
 \definecolor{main}{RGB}{70,70,70}
 \definecolor{second}{RGB}{115,45,2}
 \definecolor{third}{RGB}{0,80,80}
 ```
+