Patrick/ElegantBook
1
0
Fork 0
mirror of https://github.com/ElegantLaTeX/ElegantBook.git synced 2026-01-26 12:24:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

chinese version

EthanDeng
2019-02-28 22:07:43 +08:00
parent 64b1d91ab6
commit 04b4028a47
15 changed files with 166 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
_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/ElegantBook/wiki/安装)
* [护眼模式](https://github.com/ElegantLaTeX/ElegantNote/wiki/护眼模式) * [编译方式](https://github.com/ElegantLaTeX/ElegantBook/wiki/编译方式)
* [设备选择](https://github.com/ElegantLaTeX/ElegantNote/wiki/设备选择) * [语言模式](https://github.com/ElegantLaTeX/ElegantBook/wiki/语言模式)
* [颜色主题](https://github.com/ElegantLaTeX/ElegantNote/wiki/颜色主题) * [颜色主题](https://github.com/ElegantLaTeX/ElegantBook/wiki/颜色主题)
* [语言模式](https://github.com/ElegantLaTeX/ElegantNote/wiki/语言模式) * [显示风格](https://github.com/ElegantLaTeX/ElegantBook/wiki/显示风格)
* [编译方式](https://github.com/ElegantLaTeX/ElegantNote/wiki/编译方式) * [定理类环境](https://github.com/ElegantLaTeX/ElegantBook/wiki/定理类环境)
* [定理类环境](https://github.com/ElegantLaTeX/ElegantNote/wiki/定理类环境) * [封面徽标](https://github.com/ElegantLaTeX/ElegantBook/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/最小示例)
* 作者 * 作者
* [Github](https://github.com/EthanDeng) * [Github](https://github.com/EthanDeng)
* [个人主页](https://ddswhu.me/) * [个人主页](https://ddswhu.me/)
@@ -17,26 +20,26 @@
## English Version ## English Version
* [Introduction](https://github.com/ElegantLaTeX/ElegantNote/wiki/Introduction) * [Introduction](https://github.com/ElegantLaTeX/ElegantBook/wiki/Introduction)
* Features Overview * Features Overview
* [Installation](https://github.com/ElegantLaTeX/ElegantNote/wiki/Installation) * [Installation](https://github.com/ElegantLaTeX/ElegantBook/wiki/Installation)
* [Good for Eye Mode](https://github.com/ElegantLaTeX/ElegantNote/wiki/GoodforEyeMode) * [Good for Eye Mode](https://github.com/ElegantLaTeX/ElegantBook/wiki/GoodforEyeMode)
* [Device Options](https://github.com/ElegantLaTeX/ElegantNote/wiki/DeviceOptions) * [Device Options](https://github.com/ElegantLaTeX/ElegantBook/wiki/DeviceOptions)
* [Color Themes](https://github.com/ElegantLaTeX/ElegantNote/wiki/ColorThemes) * [Color Themes](https://github.com/ElegantLaTeX/ElegantBook/wiki/ColorThemes)
* [Languages](https://github.com/ElegantLaTeX/ElegantNote/wiki/Languages) * [Languages](https://github.com/ElegantLaTeX/ElegantBook/wiki/Languages)
* [Compilation Methods](https://github.com/ElegantLaTeX/ElegantNote/wiki/CompilationMethods) * [Compilation Methods](https://github.com/ElegantLaTeX/ElegantBook/wiki/CompilationMethods)
* [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantNote/wiki/TheoremClassEnvironments) * [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantBook/wiki/TheoremClassEnvironments)
* [Minimal Example](https://github.com/ElegantLaTeX/ElegantNote/wiki/MinimalExample) * [Minimal Example](https://github.com/ElegantLaTeX/ElegantBook/wiki/MinimalExample)
* Author * Author
* [Github](https://github.com/EthanDeng) * [Github](https://github.com/EthanDeng)
* [Homepage](https://ddswhu.me/) * [Homepage](https://ddswhu.me/)
## Links/相关链接 ## Links/相关链接
* [Github](https://github.com/ElegantLaTeX/ElegantNote) * [Github](https://github.com/ElegantLaTeX/ElegantBook)
* [CTAN](https://ctan.org/pkg/elegantnote) * [CTAN](https://ctan.org/pkg/elegantnote)
* [Email](mailto:elegantlatex2e@gmail.com) * [Email](mailto:elegantlatex2e@gmail.com)
* [Issues](https://github.com/ElegantLaTeX/ElegantNote/issues/new) * [Issues](https://github.com/ElegantLaTeX/ElegantBook/issues/new)
* [Pull Request](https://github.com/ElegantLaTeX/ElegantNote/compare) * [Pull Request](https://github.com/ElegantLaTeX/ElegantBook/compare)
* [ElegantLaTeX](https://elegantlatex.org/) * [ElegantLaTeX](https://elegantlatex.org/)

BIN
item.png Normal file

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 57 KiB

26
介绍.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 更新说明
+ 添加护眼模式，颜色为绿豆沙颜色，默认为白色背景； 在这几年间，我们收到了很多用户的反馈，主要的问题涉及到字体安装，编码支持，定理浮动，定理跨页，交叉引用等等。我们思前想后，原先让用户安装字体以追求视觉上的美观并不完美，用户陷入了巨大的麻烦，这违背了我们的模板初衷。因此我们在新版中删除了这部分，用户无需安装任何字体。让我们来看下此次 ElegantBook 模板 3.x 更新的主要内容有：
+ 适配不同设备，包括 Pad（默认），Kindle，PC（双页），通用（A4）；
+ 5 套颜色主题，分别是：green（默认），cyan，blue，sakura，black；
+ 语言模式支持：中文（默认），英文；
+ 支持 `PDFLaTeX` 和 `XeLaTeX` 编译；
+ 更加美观的图表标题格式，列表环境，数学字体等。
____ 1. 删除了自定义字体设置，改用 `ctex` 宏包或者系统默认字体；
2. 模板拆分为中英文模式（`lang=cn/en`）；
3. `PDFLaTeX` 与 `XeLaTeX` 支持；
4. 使用 `tcolorbox` 宏包改写定理类环境，可跨页；
5. 定理类环境名字更新，修复定理环境交叉引用；
6. 颜色名字更新，统一链接颜色；
7. 重新绘制 ElegantLaTeX 的 Logo；
8. 更新封面与装饰物，删除水印；
9. 修正附录相关内容；
10. 增加灰色主题 `color=plain`；
11. 增加代码高亮；
12. 美化列表环境。

5
列表环境.md Normal file

@@ -0,0 +1,5 @@
本模板借助于 `tikz` 定制了 `itemize` 和 `enumerate` 环境，其中 `itemize` 环境修改
了 3 层嵌套，而 `enumerate` 环境修改了 4 层嵌套（仅改变颜色）。示例如下
![](item.png)

7
参考文献.md Normal file

@@ -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}
```

52
定理类环境.md

@@ -1,8 +1,50 @@
此模板采用了 `amsthm` 中的定理样式，使用了 4 类定理样式，所包含的环境分别为 在我们这个模板中，定义了四大类环境
+ __定理类__：theorem，lemma，proposition，corollary； + __定理类环境__：包含标题和内容两部分，全部定理类环境的编号均以章节编号。根据格式的不同分为 3 种
+ __定义类__：definition，conjecture，example； + definition 环境，颜色为 main；
+ __备注类__：remark，note，case； + theorem、lemma、corollary 环境，颜色为 second；
+ __证明类__：proof。 + proposition 环境，颜色为 third。
+ __示例类环境__：有 example、exercise、problem 环境（对应于例，练习，例题），自动编号，编号以章节为单位。
+ __证明类环境__：，有 proof、note 环境，特点是，有引导符或者结尾符，note 环境有引导符号，proof 环境有证明完毕符号。
+ __结论类环境__：有 conclusion、assumption、property，remark、solution 环境，三者均以粗体的引导词为开头，和普通段落格式一致。
__评论：__ 在选用 `lang=cn` 时，定理类环境的引导词全部会改为中文。 __评论：__ 在选用 `lang=cn` 时，定理类环境的引导词全部会改为中文。
## 定理类环境的使用
由于本模板使用了 tcolorbox 宏包来定制定理类环境，所以和普通的定理环境的使用有些许区别，定理的使用方法如下：
```tex
\begin{theorem}{<theorem name>}{<label>}
The content of theorem.
\end{theorem}
```
第一个必选项 `<theorem name>` 是定理的名字，第二个必选项 `<label>` 是交叉引
用时所用到的标签，交叉引用的方法为 `\ref{thm:label}`。请注意，交叉引用时必
须加上前缀 `thm`:。其他相同用法的定理类环境有：
| 环境名 | 标签名 | 前缀 | 交叉引用 | |
|-------------|--------|------|-------------------|---|
| definition | label | def | `\ref{def:label}` | |
| theorem | label | thm | `\ref{thm:label}` | |
| lemma | label | lem | `\ref{lem:label}` | |
| corrlary | label | cor | `\ref{cor:label}` | |
| proposition | label | pro | `\ref{pro:label}` | |
## 其他数学环境的使用
其他三种数学环境因为没有选项，可以直接使用，比如 example 环境
```tex
\begin{example}
This is the content of example environment.
\end{example}
```
这几个都是同一类环境，区别在于
+ 示例环境（`example`）、练习（`exercise`）与例题（`problem`）章节自动编号；
+ 注意（`note`）环境有提醒引导符，证明（`proof`）环境有证明结束符；
+ 结论（`conclusion`）等环境都是普通段落环境，引导词加粗。

8
封面徽标.md Normal file

@@ -0,0 +1,8 @@
本模板使用的封面图片来源于 [pixabay.com](https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/)<sup>[1](#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/)。

7
护眼模式.md

@@ -1,7 +0,0 @@
本模板增加了护眼模式，默认为不开启，开启的方法如下：
```tex
\documentclass[geye]{elegantnote} % 或者
\documentclass[mode=geye]{elegantnote}
```
__评论：__ 此次更新只添加了护眼模式（绿豆沙色背景），如果您有希望增加其他颜色，可以在 [Github/ElegantNote](https://github.com/ElegantLaTeX/ElegantNote) 创建 [issues](https://github.com/ElegantLaTeX/ElegantNote/issues/new) 或者提交 [pull request](https://github.com/ElegantLaTeX/ElegantNote/compare)。

7
显示风格.md Normal file

@@ -0,0 +1,7 @@
本模板内置 2 套章标题显示风格，包含 `hang`（默认）与 `display` 两种风格，区
别在于章标题单行显示（`hang`）与双行显示（`display`），本说明使用了 `hang`。调用方式为
```tex
\documentclass[hang]{elegantbook} %or
\documentclass[titlestyle=hang]{elegantbook}
```

33
最小示例.md

@@ -1,20 +1,39 @@
安装之后即可使用，下面是一个示例： 安装之后即可使用，下面是一个示例：
```tex ```tex
\documentclass[geye,green,pad,cn]{elegantnote} \documentclass{elegantbook}
\title{一个笔记示例} % title info
\author{ddswhu} \title{Title}
\institute{Elegant\LaTeX{} 项目组} \subtitle{Subtitle is here}
% bio info
\author{Your Name}
\institute{XXX University}
\date{\today}
% extra info
\version{1.00} \version{1.00}
\date{2019 年 2 月 3 日} \equote{Victory won\rq t come to us unless we go to it. --- M. Moore}
\logo{logo.png}
\cover{cover.jpg}
\begin{document} \begin{document}
\maketitle \maketitle
\tableofcontents
\mainmatter
\hypersetup{pageanchor=true}
\section{介绍} % 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} \end{document}
``` ```

8
添加序章.md Normal file

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

2
编译方式.md

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

19
设备选择.md

@@ -1,19 +0,0 @@
为了让笔记方便在不同设备上阅读，免去切边，缩放等操作，本模板适配不同的屏幕大小，分别为 Pad，Kindle，PC，A4。不同屏幕的选择为
```tex
\documentclass[device=pad]{elegantnote}
\documentclass[device=kindle]{elegantnote}
\documentclass[device=pc]{elegantnote}
\documentclass[device=normal]{elegantnote}
```
__注：__ 也可以采取直接赋值的方法选择屏幕，比如：
```tex
\documentclass[pad]{elegantnote}
\documentclass[kindle]{elegantnote}
\documentclass[pc]{elegantnote}
\documentclass[normal]{elegantnote}
```
__注：__ 如果想要得到普通的 A4 纸张大小的 PDF，需要选择 `device=normal`，而不是选择 `device=pc`，因为 `device=pc` 实际上设置的是电脑双页模式。

10
语言模式.md

@@ -1,10 +1,10 @@
本模板内含两套语言环境，改变语言环境会改变图表标题的引导词（图，表），文章结构词（比如目录，参考文献等），以及定理环境中的引导词（比如定理，引理等）。不同语言模式的启用如下： 本模板内含两套语言环境，改变语言环境会改变图表标题的引导词（图，表），文章结构词（比如目录，参考文献等），以及定理环境中的引导词（比如定理，引理等）。不同语言模式的启用如下：
```tex ```tex
\documentclass[cn]{elegantnote} % 中文模式 \documentclass[cn]{elegantbook}
\documentclass[lang=cn]{elegantnote} \documentclass[lang=cn]{elegantbook}
\documentclass[en]{elegantnote} % 英文模式 \documentclass[en]{elegantbook}
\documentclass[lang=en]{elegantnote} \documentclass[lang=en]{elegantbook}
``` ```
__注：__ 不管选用中文环境还是英文环境均可输入中文。另外如果在笔记中使用了抄录环境（`lstlisting`），并且其中包括了中文，请务必使用 `XeLaTeX` 编译。本说明文档也只能通过 `XeLaTeX` 编译。 __注：__ 不管选用中文环境（`lang=cn`）还是英文环境（`lang=en`）均可输入中文。另外如果在笔记中使用了抄录环境（lstlisting），并且其中包括了中文，请务必使用 `XeLaTeX` 编译。

20
颜色主题.md

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