diff --git a/_Sidebar.md b/_Sidebar.md index a628011..35d6687 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,15 +1,18 @@ ## 中文版本 -* [模板介绍](https://github.com/ElegantLaTeX/ElegantNote/wiki/介绍) +* [模板介绍](https://github.com/ElegantLaTeX/ElegantBook/wiki/介绍) * 模板使用 - * [安装说明](https://github.com/ElegantLaTeX/ElegantNote/wiki/安装) - * [护眼模式](https://github.com/ElegantLaTeX/ElegantNote/wiki/护眼模式) - * [设备选择](https://github.com/ElegantLaTeX/ElegantNote/wiki/设备选择) - * [颜色主题](https://github.com/ElegantLaTeX/ElegantNote/wiki/颜色主题) - * [语言模式](https://github.com/ElegantLaTeX/ElegantNote/wiki/语言模式) - * [编译方式](https://github.com/ElegantLaTeX/ElegantNote/wiki/编译方式) - * [定理类环境](https://github.com/ElegantLaTeX/ElegantNote/wiki/定理类环境) -* [示例](https://github.com/ElegantLaTeX/ElegantNote/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/最小示例) * 作者 * [Github](https://github.com/EthanDeng) * [个人主页](https://ddswhu.me/) @@ -17,26 +20,26 @@ ## English Version -* [Introduction](https://github.com/ElegantLaTeX/ElegantNote/wiki/Introduction) +* [Introduction](https://github.com/ElegantLaTeX/ElegantBook/wiki/Introduction) * Features Overview - * [Installation](https://github.com/ElegantLaTeX/ElegantNote/wiki/Installation) - * [Good for Eye Mode](https://github.com/ElegantLaTeX/ElegantNote/wiki/GoodforEyeMode) - * [Device Options](https://github.com/ElegantLaTeX/ElegantNote/wiki/DeviceOptions) - * [Color Themes](https://github.com/ElegantLaTeX/ElegantNote/wiki/ColorThemes) - * [Languages](https://github.com/ElegantLaTeX/ElegantNote/wiki/Languages) - * [Compilation Methods](https://github.com/ElegantLaTeX/ElegantNote/wiki/CompilationMethods) - * [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantNote/wiki/TheoremClassEnvironments) -* [Minimal Example](https://github.com/ElegantLaTeX/ElegantNote/wiki/MinimalExample) + * [Installation](https://github.com/ElegantLaTeX/ElegantBook/wiki/Installation) + * [Good for Eye Mode](https://github.com/ElegantLaTeX/ElegantBook/wiki/GoodforEyeMode) + * [Device Options](https://github.com/ElegantLaTeX/ElegantBook/wiki/DeviceOptions) + * [Color Themes](https://github.com/ElegantLaTeX/ElegantBook/wiki/ColorThemes) + * [Languages](https://github.com/ElegantLaTeX/ElegantBook/wiki/Languages) + * [Compilation Methods](https://github.com/ElegantLaTeX/ElegantBook/wiki/CompilationMethods) + * [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantBook/wiki/TheoremClassEnvironments) +* [Minimal Example](https://github.com/ElegantLaTeX/ElegantBook/wiki/MinimalExample) * Author * [Github](https://github.com/EthanDeng) * [Homepage](https://ddswhu.me/) ## Links/相关链接 -* [Github](https://github.com/ElegantLaTeX/ElegantNote) +* [Github](https://github.com/ElegantLaTeX/ElegantBook) * [CTAN](https://ctan.org/pkg/elegantnote) * [Email](mailto:elegantlatex2e@gmail.com) -* [Issues](https://github.com/ElegantLaTeX/ElegantNote/issues/new) -* [Pull Request](https://github.com/ElegantLaTeX/ElegantNote/compare) +* [Issues](https://github.com/ElegantLaTeX/ElegantBook/issues/new) +* [Pull Request](https://github.com/ElegantLaTeX/ElegantBook/compare) * [ElegantLaTeX](https://elegantlatex.org/) diff --git a/item.png b/item.png new file mode 100644 index 0000000..7067c51 Binary files /dev/null and b/item.png differ diff --git a/介绍.md b/介绍.md index 8e993a4..c723c61 100644 --- a/介绍.md +++ b/介绍.md @@ -1,14 +1,20 @@ -此模板设计的初衷是为了记录笔记,在 2013 年开始构想,初版我们设计了非常美观的定理环境,并设计了 3 套不同的颜色主题。但我们发现在实际记笔记的时候,过多的定理区块使得整个文章并不是非常美观,所以我们把 ElegantNote 更新为 ElegantBook 模板,在后面被用户熟知。而 ElegantNote 的设计自此停止。 +值此版本发行之际,我们 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。 -2018 年,在被一些用户“催更”之后,ElegantBook 迎来重大更新,原先浮动的定理环境用 `tcolorbox` 全部改写。时至今日,ElegantBook 版本为 3.05。之后,我们便想把 ElegantNote 也彻底更新下,放弃 ElegantBook 的定理环境设计,改用更为紧凑,更加朴素的定理环境,设计更适合笔记记录和笔记阅读的 LaTeX 模板。 +最新版本下载地址:[Github:ElegantBook/releases](https://github.com/ElegantLaTeX/ElegantBook/releases)。本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎联系我们。 -在一些朋友的建议和启发下,我们基于标准的 LaTeX 文类 article 重新设计了新版 ElegantNote 模板,在此特别感谢!新模板的特色有: +## ElegantBook 更新说明 -+ 添加护眼模式,颜色为绿豆沙颜色,默认为白色背景; -+ 适配不同设备,包括 Pad(默认),Kindle,PC(双页),通用(A4); -+ 5 套颜色主题,分别是:green(默认),cyan,blue,sakura,black; -+ 语言模式支持:中文(默认),英文; -+ 支持 `PDFLaTeX` 和 `XeLaTeX` 编译; -+ 更加美观的图表标题格式,列表环境,数学字体等。 +在这几年间,我们收到了很多用户的反馈,主要的问题涉及到字体安装,编码支持,定理浮动,定理跨页,交叉引用等等。我们思前想后,原先让用户安装字体以追求视觉上的美观并不完美,用户陷入了巨大的麻烦,这违背了我们的模板初衷。因此我们在新版中删除了这部分,用户无需安装任何字体。让我们来看下此次 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. 美化列表环境。 diff --git a/列表环境.md b/列表环境.md new file mode 100644 index 0000000..997422c --- /dev/null +++ b/列表环境.md @@ -0,0 +1,5 @@ +本模板借助于 `tikz` 定制了 `itemize` 和 `enumerate` 环境,其中 `itemize` 环境修改 +了 3 层嵌套,而 `enumerate` 环境修改了 4 层嵌套(仅改变颜色)。示例如下 + +![](item.png) + diff --git a/参考文献.md b/参考文献.md new file mode 100644 index 0000000..724ba5c --- /dev/null +++ b/参考文献.md @@ -0,0 +1,7 @@ +此模板使用了 `BibTeX` 来生成参考文献,默认使用的文献样式(bib style)是 `aer`。参考文献示例:Chen et al. (2018) 使用了中国一个大型的 P2P 平台(人人贷)的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。 + +你可以在谷歌学术,Mendeley,Endnote 中获得文献条目(bib item),然后把它们添加到 `reference.bib` 中。在文中引用的时候,引用它们的键值(bib key)即可。注意需要在编译的过程中添加 `BibTeX` 编译。如果你想在参考文献中添加未引用的文献,可以使用 + +```tex +\nocite{EINAV2010,Havrylchyk2018} +``` diff --git a/定理类环境.md b/定理类环境.md index 3e048e0..dd8b392 100644 --- a/定理类环境.md +++ b/定理类环境.md @@ -1,8 +1,50 @@ -此模板采用了 `amsthm` 中的定理样式,使用了 4 类定理样式,所包含的环境分别为 +在我们这个模板中,定义了四大类环境 -+ __定理类__:theorem,lemma,proposition,corollary; -+ __定义类__:definition,conjecture,example; -+ __备注类__:remark,note,case; -+ __证明类__:proof。 ++ __定理类环境__:包含标题和内容两部分,全部定理类环境的编号均以章节编号。根据格式的不同分为 3 种 + + definition 环境,颜色为 main; + + theorem、lemma、corollary 环境,颜色为 second; + + proposition 环境,颜色为 third。 ++ __示例类环境__:有 example、exercise、problem 环境(对应于例,练习,例题),自动编号,编号以章节为单位。 ++ __证明类环境__:,有 proof、note 环境,特点是,有引导符或者结尾符,note 环境有引导符号,proof 环境有证明完毕符号。 ++ __结论类环境__:有 conclusion、assumption、property,remark、solution 环境,三者均以粗体的引导词为开头,和普通段落格式一致。 __评论:__ 在选用 `lang=cn` 时,定理类环境的引导词全部会改为中文。 + +## 定理类环境的使用 + +由于本模板使用了 tcolorbox 宏包来定制定理类环境,所以和普通的定理环境的使用有些许区别,定理的使用方法如下: + +```tex +\begin{theorem}{}{