33 Commits
v3.10 ... v3.08

Author SHA1 Message Date
EthanDeng
6f642ae8bf version 3.08 release 2019-05-28 22:31:22 +08:00
EthanDeng
807841afb1 version 3.08 2019-05-26 17:11:46 +08:00
EthanDeng
312aee23c0 remove mtpro2 2019-05-22 00:21:40 +08:00
EthanDeng
f2b772505e Merge branch 'master' of github.com:ElegantLaTeX/ElegantBook 2019-05-20 14:37:34 +08:00
EthanDeng
177453468b remove typo 2019-05-20 14:37:19 +08:00
Dongsheng Deng
0e5fd1f813 Merge pull request #27 from muzimuzhi/enumitem-duplicate
delete duplicate package loading
2019-05-20 14:31:27 +08:00
muzimuzhi
0b421561cf delete first inclusion of pkg caption 2019-05-19 17:32:08 +08:00
muzimuzhi
e4e166946b delete duplicate package loading 2019-05-19 17:22:36 +08:00
EthanDeng
0752a76fd5 fix math operator cmex font selectiong 2019-05-14 19:08:45 +08:00
EthanDeng
e4371c7bf3 renew partname 2019-05-11 16:18:54 +08:00
EthanDeng
77ac771ad1 typo 2019-05-09 19:20:50 +08:00
EthanDeng
5f024a8e5b change px to bp 2019-05-09 19:14:07 +08:00
EthanDeng
fbb6a6f124 remove pdf 2019-05-06 12:35:40 +08:00
EthanDeng
61d54173fb remove pdf 2019-05-06 12:35:14 +08:00
EthanDeng
7e0a8f1015 add device option pad 2019-05-06 12:32:11 +08:00
EthanDeng
f93ad428c0 add introduction environment 2019-05-05 09:56:16 +08:00
EthanDeng
0171d1836f remove the warnings 2019-04-26 00:04:24 +08:00
EthanDeng
fb33d093fb convert url 2019-04-22 16:42:23 +08:00
EthanDeng
2530dc26f4 add QQ Group info 2019-04-22 12:33:30 +08:00
EthanDeng
6575c773be space 2019-04-15 21:52:51 +08:00
EthanDeng
ef71af7bee elegantbook 3.07 2019-04-15 21:43:44 +08:00
EthanDeng
c9f9ddcfb8 elegantbook 3.07 2019-04-15 18:36:55 +08:00
EthanDeng
4733c40279 theorem modification complete 2019-04-15 01:45:30 +08:00
EthanDeng
8dd28f18c7 typo 2019-04-14 19:45:00 +08:00
EthanDeng
75e407bd63 add custom environment 2019-04-14 19:40:52 +08:00
EthanDeng
c1b4a2ad23 add convert method from elegantbook 2.x to elegantbook 3.x 2019-04-14 19:35:28 +08:00
EthanDeng
5772ce6253 remove medskip 2019-04-13 14:02:29 +08:00
EthanDeng
41fd2cb8df update 3.07(pending) 2019-04-12 12:22:07 +08:00
EthanDeng
f970cb422f change the logo/cover 2019-04-11 21:22:16 +08:00
EthanDeng
13d0d93a83 auto merge by git 2019-04-03 19:01:26 +08:00
EthanDeng
6a6c17519d Merge branch 'master' of github.com:ElegantLaTeX/ElegantBook 2019-04-03 18:58:41 +08:00
Dongsheng Deng
83735a3b70 Merge pull request #8 from muzimuzhi/patch-1
处理目录溢出的问题,fix #7
2019-04-03 17:36:56 +08:00
muzimuzhi
f7cfd8243a 处理目录溢出的问题,fix #7
调整插入 \restoregeometry 的位置
2019-04-03 17:33:40 +08:00
10 changed files with 1153 additions and 1649 deletions

2
.gitignore vendored
View File

@@ -11,10 +11,8 @@
*.cb *.cb
*.cb2 *.cb2
.*.lb .*.lb
clean.bat
elegant*-cn.pdf elegant*-cn.pdf
elegant*-en.pdf elegant*-en.pdf
*.dates
## Intermediate documents: ## Intermediate documents:
*.dvi *.dvi

146
README.md
View File

@@ -1,145 +1,25 @@
<!-- Author : Dongsheng Deng & Liam Huang--> <!-- Author : Dongsheng Deng & Liam Huang-->
<!-- Program Email: elegantlatex2e@gmail.com --> <!-- Program Email: elegantlatex2e@gmail.com -->
# ElegantBook
[Homepage](https://elegantlatex.org/) | [Github](https://github.com/ElegantLaTeX/ElegantBook) | [CTAN](https://ctan.org/pkg/elegantbook) | [Download](https://github.com/ElegantLaTeX/ElegantBook/releases) | [Wiki](https://github.com/ElegantLaTeX/ElegantBook/wiki) | [Weibo](https://weibo.com/elegantlatex) [Homepage](https://elegantlatex.org/) | [Github](https://github.com/ElegantLaTeX/ElegantBook) | [CTAN](https://ctan.org/pkg/elegantbook) | [Download](https://github.com/ElegantLaTeX/ElegantBook/releases) | [Wiki](https://github.com/ElegantLaTeX/ElegantBook/wiki) | [Weibo](https://weibo.com/elegantlatex)
![License](https://img.shields.io/ctan/l/elegantbook.svg) ![CTAN Version](https://img.shields.io/ctan/v/elegantbook.svg) ![Github Version](https://img.shields.io/github/release/ElegantLaTeX/ElegantBook.svg) ![Repo Size](https://img.shields.io/github/repo-size/ElegantLaTeX/ElegantBook.svg) ![License](https://img.shields.io/ctan/l/elegantbook.svg)
![CTAN Version](https://img.shields.io/ctan/v/elegantbook.svg)
![Github Version](https://img.shields.io/github/release/ElegantLaTeX/ElegantBook.svg)
![Repo Size](https://img.shields.io/github/repo-size/ElegantLaTeX/ElegantBook.svg)
--- ElegantBook is designed for books. Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or contact us at elegantlatex2e@gmail.com.
# ElegantBook 优美的 LaTeX 书籍模板 如果你有其他问题、建议或者报告 bug可以提交 issues 或者给我们发邮件elegantlatex2e@gmail.com。最近我们新建了一个 QQ 用户交流群Q 群692108391欢迎加入。
ElegantBook 是为 LaTeX 书籍写作而设计的模板,由 [Dongsheng Deng](https://ddswhu.me/) 和 [Liam Huang](https://liam.page/) 创立,模板创立的初衷是方便我们自己做笔记 :smile:。如果你有其他问题、建议或者报告 bug可以提交 issues 或者给我们发邮件elegantlatex2e@gmail.com。QQ 用户交流群692108391欢迎加入 **注意:** 由于新版本进行了重构,并且 3.6 版本对于封面进行了改版3.6 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.6 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)
## 重要提示 **重要提示出于某些因素的考虑ElegantLaTeX 项目自 2019 年 5 月 20 日开始不再接受任何非作者预约性质的提交pull request)!如果你想改进模板,你可以给我们提交 issue或者可以在遵循协议的情况下克隆到自己仓库下进行修改**
**版本提醒:** 由于新版本进行了重构,并且 3.06 版本对于封面进行了改版3.06 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.06 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。我们强烈建议你使用最新版。 # License
**重要提示**ElegantLaTeX 项目 **不接受** 任何非作者预约提交pull requests This work is released under the LaTeX Project Public License, v1.3c or later.
## 致谢 本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。
2019 年 5 月 20 日ElegantBook 模板在 Github 上的 Star 数达到了 100这对于 ElegantLaTeX 系列模板是一个非常重要的里程碑!在此特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。LaTeX 工作室网站上有很多精彩的帖子和精致的模板,欢迎大家去挖掘里面的宝藏。这也是我所见到的国内最全面的 LaTeX 相关的网站。
如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。
## 捐赠
如果您非常喜爱我们的模板或者我,你还可以选择捐赠以表达您对我们模板和我的支持。本模板自 3.08 版本发布了捐赠信息之后,收到了超过千元的捐赠(四舍五入就是一个亿),非常感谢!
![](https://github.com/ElegantLaTeX/ElegantBook/wiki/donate.jpg)
**赞赏费用的使用解释权归 ElegantLaTeX 所有,并且不接受监督,请自愿理性打赏**。10 元以上的赞赏,我们将列入捐赠榜,谢谢各位金主!(如果有遗漏,请务必联系我们,这对我们很重要)
| 捐赠者 | 金额 | 时间 | 渠道 |
| :------: | :----: | :----: | :------: |
| Lerh | 10 RMB | 2019/05/15 | 微信 |
| 越过地平线 | 10 RMB | 2019/05/15 | 微信 |
| 银桑 | 20 RMB | 2019/05/27 | 微信 |
| *空 | 10 RMB | 2019/05/30 | 微信 |
| [latexstudio.net](http://www.latexstudio.net) | 666 RMB | 2019/06/05 | 支付宝 |
| Cassis | 11 RMB | 2019/06/30 | 微信 |
| *君 | 10 RMB | 2019/07/23 | 微信 |
| P*u | 50 RMB | 2019/07/30 | 微信 |
| *萌 | 19 RMB | 2019/08/28 | 微信 |
| 曲豆豆 | 10 RMB | 2019/08/28 | 微信 |
| 李博 | 100 RMB | 2019/10/06 | 微信 |
| Njustsll | 10 RMB | 2019/10/11 | 微信 |
| 刘志阔 | 99.99 RMB | 2019/10/15 | 支付宝 |
| *涛 | 16 RMB | 2019/10/17 | 微信 |
| 赤霓 | 12 RMB | 2019/10/17 | 支付宝 |
| 追寻原风景 | 10 RMB | 2019/10/28 | 微信 |
| 郭德良 | 88 RMB | 2019/11/03 | 微信 |
| 自强不息 | 20 RMB | 2019/11/04 | 支付宝 |
| 读书之虫 | 20 RMB | 2019/11/18 | 微信 |
| *等 | 10 RMB | 2019/11/18 | 微信 |
| *哲 | 20 RMB | 2019/11/18 | 微信 |
| 佚名 | 10 RMB | 2019/11/24 | 微信 |
| Jiye Qian | 66 RMB | 2019/12/04 | 微信 |
| * 阳 | 20 RMB | 2019/12/05 | 微信 |
| Catcher | 11 RMB | 2019/12/08 | 支付宝 |
| 希尔波特门徒 | 10 RMB | 2019/12/09 | 支付宝 |
| * 伟 | 10 RMB | 2019/12/09 | 微信 |
| Simon | 20 RMB | 2019/12/11 | 支付宝 |
| 流殇丶浅忆 | 66.60 RMB | 2019/12/18 | 支付宝 |
| 羽 | 10 RMB | 2019/12/20 | 支付宝 |
| * 琛 | 15 RMB | 2019/12/20 | 微信 |
| 随风 | 20 RMB | 2019/12/27 | 支付宝 |
| Ws | 23.30 RMB | 2019/12/28 | 微信 |
再次感谢大家对于模板的喜爱!
## 协议
本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。如果是衍生作品请务必加入协议声明和模板信息github、CTAN 地址)。
## 衍生作
+ [ElegantBookdown](https://github.com/XiangyunHuang/ElegantBookdown)[XiangyunHuang](https://github.com/XiangyunHuang) 开发并维护的基于 ElegantBook 的 Bookdown 模板。
+ [bookdownplus](https://github.com/pzhaonet/bookdownplus):应网友要求,[pzhaonet](https://github.com/pzhaonet) 在 bookdownplus 收录了 ElegantPaper 模板,并为 Mac 做了字体适配。
+ [PanBook](https://github.com/annProg/PanBook)[annProg](https://github.com/annProg) 开发并维护的基于 Markdown 写作的工作流,收录了 ElegantBook 和 ElegantPaper 模板。
-------
# ElegantBook: An Elegant LaTeX Template for Books
ElegantBook is designed for writing books, created by [Dongsheng Deng](https://ddswhu.me/) and [Liam Huang](https://liam.page/). Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or contact us at elegantlatex2e@gmail.com.
## Important Notes
**Version Note**: Users for 2.x, please refer to [Version Convert](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert). We strongly recommend that you use the latest version.
**Important Info**: For some reasons, __unauthorial__ pull requests are **UNACCEPTABLE** since May 20, 2019. For those who want to help revise the templates, submit issues or clone to your own repository to modify under the LPPL-1.3c.
## Acknowledgement
_News_: _The number of stars on Github for ElegantBook reached 100 on May 20, 2019_.
Thank ChinaTeX and [LaTeX Studio](http://www.latexstudio.net/) for their promotion. LaTeX studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on LaTeX in China. If you like our template, star on Github for supporting us.
## Donation
To express your love for our templates and/or our developers, please do not hesitate to tip us. Since last release of 3.08, we have received about a thousand RMB! (The emergence of a millionaire is on the way. Loading... )
![](https://github.com/ElegantLaTeX/ElegantBook/wiki/donate.jpg)
The explanation right of the tip usage belongs to ElegantLaTeX with no supervision. Feel free to tip us. Those who donate more than 10 RMB will be recorded in the Donation List. Thank all the tippers! Thank you all.
| Tipper | Amount | Date | Channel |
| :--------------: | :----: | :-------: | :-----: |
| Lerh | 10 RMB | 2019/5/15 | Wechat |
| YueGuoDiPingXian | 10 RMB | 2019/5/15 | Wechat |
| YinSang | 20 RMB | 2019/5/27 | Wechat |
| * Kong | 10 RMB | 2019/05/30 | Wechat |
| [latexstudio.net](http://www.latexstudio.net) | 666 RMB | 2019/06/05 | Alipay |
| Cassis | 11 RMB | 2019/06/30 | Wechat |
| * Jun | 10 RMB | 2019/07/23 | Wechat |
| P*u | 50 RMB | 2019/07/30 | Wechat |
| * Meng | 19 RMB | 2019/08/28 | Wechat |
| QuDouDou | 10 RMB | 2019/08/28 | Wechat |
| LI Bo | 100 RMB | 2019/10/06 | Wechat |
| Njustsll | 10 RMB | 2019/10/11 | Wechat |
| LIU ZhiKuo | 99.99 RMB | 2019/10/15 | Alipay |
| * Tao | 16 RMB | 2019/10/17 | Wechat |
| ChiHong | 12 RMB | 2019/10/17 | Alipay |
| YuanFengJing | 10 RMB | 2019/10/28 | Wechat |
| GUO DeLiang | 88 RMB | 2019/11/03 | Wechat |
| ZiQiangBuXi | 20 RMB | 2019/11/03 | Alipay |
| DuShuZhiChong | 20 RMB | 2019/11/18 | Wechat |
| * Deng | 10 RMB | 2019/11/18 | Wechat |
| * Zhe | 20 RMB | 2019/11/18 | Wechat |
## License
This work is released under the LaTeX Project Public License, v1.3c or later.
## Derivative Works
+ [ElegantBookdown](https://github.com/XiangyunHuang/ElegantBookdown)[XiangyunHuang](https://github.com/XiangyunHuang) developed a Bookdown template based on ElegantBook.
+ [bookdownplus](https://github.com/pzhaonet/bookdownplus): maintained by [pzhaonet](https://github.com/pzhaonet).
+ [PanBook](https://github.com/annProg/PanBook)a markdown-based writing workflow Developed by [annProg](https://github.com/annProg).

5
delete-temp-files.bat Normal file
View File

@@ -0,0 +1,5 @@
@echo off
del /q *.aux *.bbl *.blg *.log *.out *.toc *.bcf *.xml *.synctex *.nlo *.nls *.bak *.ind *.idx *.ilg *.lof *.lot *.ent-x *.tmp *.ltx *.los *.lol *.loc *.listing *.gz *.userbak *.nav *.snm *.vrb *.synctex(busy)
del /q *.nav *.snm *.vrb *.fls *.xdv *.fdb_latexmk

File diff suppressed because it is too large Load Diff

View File

@@ -1,182 +1,139 @@
\documentclass[lang=en,11pt]{elegantbook} \documentclass[fancy,blue,11pt]{elegantbook}
\title{An Elegant \LaTeX{} Template for Books} \title{An Elegant \LaTeX{} Template for Books}
\subtitle{Classic Elegant\LaTeX{} Template} \subtitle{Classic Elegant\LaTeX{} Template}
\author{Ethan Deng \& Liam Huang} \author{Ethan Deng \& Liam Huang}
\institute{Elegant\LaTeX{} Program} \institute{Elegant\LaTeX{} Program}
\date{February 10, 2020} \date{\today}
\version{3.10} \version{3.08}
\bioinfo{Bio}{Information}
\extrainfo{Victory won\rq t come to us unless we go to it. } \extrainfo{Victory won\rq t come to us unless we go to it. }
\logo{logo-blue.png} \logo{logo.png}
\cover{cover.jpg} \cover{cover.jpg}
\begin{document} \begin{document}
\maketitle \maketitle
\frontmatter
\tableofcontents \tableofcontents
\clearpage
\thispagestyle{empty}
\mainmatter \mainmatter
\hypersetup{pageanchor=true}
\chapter{Elegant\LaTeX{} Templates} \chapter{Elegant\LaTeX{} Templates}
Elegant\LaTeX{} Program developers are intended to provide you beautiful, elegant, user-friendly templates. Currently, the Elegant\LaTeX{} is composed of \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote}, \href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook}, \href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper}, designed for typesetting notes, books, and working papers respectively. Latest releases are strongly recommended! This guide is aimed at briefly introducing the 101 of this template. For any other question, suggestion or comment, feel free to contact us on GitHub \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} or email us at \email{elegantlatex2e@gmail.com}. Elegant\LaTeX{} Program developers are intended to provide you beautiful, elegant, user-friendly templates. Currently, the Elegant\LaTeX{} is composed of \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote}, \href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook}, \href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper}, designed for typesetting notes, books, and working papers respectively. Latest releases are strongly recommended! This guide is aimed at briefly introducing the 101 of this template. For any other question, suggestion or comment, feel free to contact us on GitHub \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} or email us at \email{elegantlatex2e@gmail.com}.
Contact Infos: Contact Infos:
\begin{itemize} \begin{itemize}
\item Homepage: \href{https://elegantlatex.org/}{https://elegantlatex.org/} \item Homepage: \href{https://elegantlatex.org/}{https://elegantlatex.org/}
\item Github: \href{https://github.com/ElegantLaTeX/}{https://github.com/ElegantLaTeX/} \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 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 Wiki: \href{https://github.com/ElegantLaTeX/ElegantBook/wiki}{https://github.com/ElegantLaTeX/ElegantBook/wiki}
\item Download: \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{release}, \href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{latest version} \item Download: \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{release}, \href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{latest version}
\item Weibo: Elegant\LaTeX{} \item Weibo: ElegantLaTeX
\item Wechat: Elegant\LaTeX{} \item Wechat: ElegantLaTeX
\item QQ: 692108391 \item QQ: 692108391
\item Email: \email{elegantlatex2e@gmail.com} \item Email: \email{elegantlatex2e@gmail.com}
\end{itemize} \end{itemize}
\section{ElegantBook Updates} \section{ElegantBook Updates}
What\rq s new in this version: What\rq s new in this version:
\begin{enumerate} \begin{enumerate}
\item Introduce \lstinline{math} for math font, optional styles are \lstinline{newtx} and \lstinline{cm}.\\ \item Fix \lstinline|\part|.
\textbf{Notice}: The math font \lstinline{newtxmath} in previous versions is reset to default \LaTeX{} math font, to keep previous math font, please declare \lstinline{math=newtx}. \item Introduce pad mode.
\item Introduce \lstinline{chinesefont} option, with \lstinline{founder}, \lstinline{ctexfont} and \lstinline{nofont} available. \item Support mtpro2 package.
\item Turn author information on the cover optional and add customized command \lstinline{\bioinfo}. \item Revise default format of references to numbers.
\item Add version history with command \lstinline{\datechange} and environment \lstinline{change}. \item Include environment for chapter introduction.
\item Add Chinese chapter style \lstinline{scheme} with option \lstinline{chinese}. \item Include environment for problem set.
\item Since the bug raised by \lstinline{\lvert} is fixed, exchange package positions of \lstinline{ctex} and \lstinline{amsmath}. \item Include margin note using \lstinline{\elegantpar} (beta).
\item Drop \lstinline{\lastpage} from header to avoid page anchor bug and adding \lstinline{\frontmatter}. \item Reduce line spacing for equations.
\item Revise bibliography option \lstinline{cite} with optional styles \lstinline{numbers},\lstinline{authoryear} and \lstinline{super}. \item Turn \lstinline{\equote} into \lstinline{\extrainfo}, with multi-line display.
\item Introduce bibliography style option \lstinline{bibstyle}, with default bib style \lstinline{apalike} for English mode and \lstinline{gbt7714} package for Chinese mode. \item Polish documentation by including acknowledgement, etc.
\end{enumerate} \end{enumerate}
\begin{note} \begin{note}
If you are using previous version, please delete \lstinline|\hypersetup{pageanchor=true}| and add \lstinline{\frontmatter} after \lstinline{\maketitle} and before \lstinline{\tableofcontents}. Users for 2.x, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{conversion}. Since the latest version has witnessed huge reconstruction (with cover change in version 3.06), 3.x is backward incompatible with 2.x. For those who would like to convert documents compiled with earlier version (3.06 or 2.x) to be compatible with latest version, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{conversion}. Questions about version 2.x will not be answered henceforth.
\end{note} \end{note}
\section{Installation and Update} \section{Installation and Update}
Both portable version and installation package are available for this template, online usage is optional as well. Both portable version and installation package are available for this template.
\subsection{To Use Templates Online}
Visit \href{https://www.overleaf.com/}{Overleaf} to use our template online anywhere and anytime without local installation. To find our template, search \lstinline{elegantlatex} in the \lstinline{templates} or simply visit \href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{search result}, choose the template you prefer and \lstinline{Open as Template} to own a copy yourself to edit freely. To learn more about Overleaf, please refer to \href{https://www.overleaf.com/learn}{Documentation}.
\begin{remark}
On Overleaf, please use \hologo{XeLaTeX} to compile articles in Chinese and \hologo{pdfLaTeX} to compile articles in English.
\end{remark}
\subsection{To Use Portable Version}
For portable version, simply download lastest ElegantBook-master from Github or CTAN (to be more accurate, download \lstinline{elegantbook.cls}) and save the file(s) under your working directory. This way of installation is simple and convenient, but you have to manually update \lstinline{cls} now and then. For portable version, simply download lastest ElegantBook-master from Github or CTAN (to be more accurate, download \lstinline{elegantbook.cls}) and save the file(s) under your working directory. This way of installation is simple and convenient, but you have to manually update \lstinline{cls} now and then.
\subsection{To Use Local Installation Version}
If you are a \TeX{} Live 2019 user, using the \lstinline{tlshell}\footnote{namely, \TeX{} Live Manager} of \TeX{} Live 2019 direct installation package is strongly recommended. Simply search and open \lstinline{tlshell}, click on \lstinline{File -> Load Default Repository} or customize repository by \lstinline{Options}. Wait till the repository loads successfully, search \lstinline{elegantbook} by name, installation and update is just a click away. If you are a \TeX{} Live 2019 user, using the \lstinline{tlshell}\footnote{namely, \TeX{} Live Manager} of \TeX{} Live 2019 direct installation package is strongly recommended. Simply search and open \lstinline{tlshell}, click on \lstinline{File -> Load Default Repository} or customize repository by \lstinline{Options}. Wait till the repository loads successfully, search \lstinline{elegantbook} by name, installation and update is just a click away.
\begin{figure}[htbp] \begin{figure}[htbp]
\centering \centering
\includegraphics[width=0.7\textwidth]{tlshell.png} \includegraphics[width=0.7\textwidth]{tlshell.png}
\caption{Use \TeX{} Live Shell to Install ElegantBook Template} \caption{Use \TeX{} Live Shell to Install ElegantBook Template}
\end{figure} \end{figure}
\subsection{Update Templates}
If you fail to update templates using \lstinline{tlshell}, please use cmd to update all the packages or switch to portable version instead.
Use the following commands(administrator privileges) to update:
\begin{lstlisting}
tlmgr update --self
tlmgr update --all
\end{lstlisting}
To learn more, please refer to \href{https://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \TeX{} distribution?}
\subsection{Other Release Versions}
If you are a \TeX{} Live 2018 user and would like to update to \TeX{} Live 2019, the official solution is to uninstall 2018. If you want to save the bother of uninstallation and installation, please copy \lstinline{elegantbook.cls} to the installation directory of \TeX{} Live 2018 (default: \lstinline|C:\texlive\2018\texmf-dist\tex\latex\elegantbook| ), run \lstinline{texhash} in cmd. If you are a \TeX{} Live 2018 user and would like to update to \TeX{} Live 2019, the official solution is to uninstall 2018. If you want to save the bother of uninstallation and installation, please copy \lstinline{elegantbook.cls} to the installation directory of \TeX{} Live 2018 (default: \lstinline|C:\texlive\2018\texmf-dist\tex\latex\elegantbook| ), run \lstinline{texhash} in cmd.
Excuse me? You are a C\TeX{} user? Sorry, this template is incompatible with C\TeX{}. Excuse me? You are a C\TeX{} user? Sorry, this template is incompatible with C\TeX{}.
For more details about the installation and usage of \TeX{} Live 2019, the compatibility of C\TeX{} and \TeX{} Live, please refer to OG (Official Guide) and/or \href{https://github.com/OsbertWang/install_latex/releases}{Install LaTeX v5.1} by OsbertWang. For more details about the installation and usage of \TeX{} Live 2019, the compatibility of C\TeX{} and \TeX{} Live, installation directory, etc., please refer to OG (Official Guide).
\section{Online Usage of Templates}
Considering the online usage of the templates, all the templates are available on Overleaf. Those who enjoy smooth network may feel free to use the templates without \TeX{} Live and to visit your documents anywhere anytime. Search \lstinline{elegantlatex} on Overleaf or visit \href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{search result}, choose the one you prefer and save it to your account, then you can edit yourself or corporate with others if you like. For more infomation about Overleaf, please refer to Overleaf OG.
\section{User\rq s Selected Works Plan} \section{User\rq s Selected Works Plan}
Eight years have passed since the found of Elegant\LaTeX{} Program. It\rq s an honor that our templates are preferred by a lot of users. Hence, in order to promote more interactions among our users and know more about what you need, we are planning to provide a platform to display selected works of our users on Github or our homepage. If you want to show us your work(s), contact us via Email or other ways. Or if you have upload your work(s) on Github or Gitee etc., share the URL(s) with us. You can visit current available works \href{https://github.com/ElegantLaTeX/Archive/tree/master/Collections}{here}. Eight years have passed since the found of Elegant\LaTeX{} Program. It\rq s an honor that our templates are preferred by a lot of users. Hence, in order to promote more interactions among our users and know more about what you need, we are planning to provide a platform to display selected works of our users on Github or our homepage. If you want to show us your work(s), contact us via Email or other ways. Or if you have upload your work(s) on Github or Gitee etc., share the URL(s) with us.
\section{About Pull Request} \section{About Pull Request}
For some reasons, pull requests will NOT by accepted since May 20, 2019. For those who want to help improve the templates, submit issues or clone to your own repository to modify under LPPL-1.3c. For some reasons, pull request is unacceptable since May 20, 2019. For those who want to help revise the templates, submit issues or clone to your own repository to modify under the constriction of LPPL-1.3c.
\section{Recruit Support Members} \section{Recruit Support Members}
Recruit support members for Elegant\LaTeX{} to translate template OGs, maintain wiki entries using Markdown, update Wechat articles. No deadline for this recruitment. Recruit Support Members for Elegant\LaTeX{} to translate template OGs(Chinese -> English), maintain wiki entries using MarkDown, update Wechat articles. No deadline for this recruitment.
So far, Elegant\LaTeX{} has four Support Members: Thank our best support members for their selfless work!
\begin{itemize} \begin{itemize}
\item OG Translator: \href{https://github.com/peggy2006xzyz}{YPY}; \item OG Translator: \href{https://github.com/peggy2006xzyz}{YPY};
\item Wiki Maintainer: \href{https://github.com/izinngo}{Ingo Zinngo}, \href{https://github.com/xiaohao890809}{Xiaohao890809}; \item Wiki Maintainer: \href{https://github.com/izinngo}{Ingo Zinngo};
\item QQ Group Manager \& FAQ Maintainer: \href{https://github.com/sikouhjw}{Sikouhjw}. \item QQ Group Manager: \href{https://github.com/sikouhjw}{Sikouhjw}.
\end{itemize} \end{itemize}
BTW, thank \href{https://github.com/stone-zeng}{Xiangdong Zeng}, \href{https://github.com/latexers}{Zhuluren}, etc. for their help.
\section{Acknowledgement} \section{Acknowledgement}
The number of stars on Github for ElegantBook reached 100 on May 20, 2019\footnote{372 stars by February 8, 2020!}.Thank China\TeX{} and \href{http://www.latexstudio.net/}{\LaTeX{} studio} for their promotion. \LaTeX{} studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on \LaTeX{} in China. The number of stars on Github for ElegantBook reached 100 on May 20, 2019 and was included in the \href{https://github.com/trending/tex?since=daily}{Trending} under the \TeX{} catagory. It is a remarkable moment for Elegant\LaTeX{} !!!
Thank China\TeX{} and \href{http://www.latexstudio.net/}{\LaTeX{} studio} for their promotion. \LaTeX{} studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on \LaTeX{} in China.
Thank muzimuzhi for the revision of the template.
If you like our template, star on Github. If you like our template, star on Github.
\begin{figure}[htbp]
\section{Donation} \centering
To express your love for our templates and/or our developers, please do not hesitate to tip us. Since last release of 3.08, we have received about 1,500 RMB! (The emergence of a millionaire is on the way. Loading... ) \includegraphics[width=\textwidth]{star.png}
\begin{figure}[!htb] \caption{Twinkle, Twinkle, Little Star}
\centering \end{figure}
\includegraphics[width=0.45\textwidth]{donate.jpg} Recently some users have expressed their love for our templates and want to tip us. QR code for donation is now available.
\begin{figure}[htbp]
\centering
\includegraphics[width=0.5\textwidth]{donate.jpg}
\end{figure} \end{figure}
The explanation right of the tip usage belongs to Elegant\LaTeX{} with no supervision. Feel free to tip us. Those who donate more than 10 RMB will be recorded in the Donation List. Thank all the tippers! The explanation right of the tip usage belongs to Elegant\LaTeX{} with no supervision. Feel free to tip us. Those who donate more than 10 RMB will be recorded in the Donation List. Thank all the tippers!
\begin{table}[htbp]
\begin{table}[!htb] \centering
\centering \caption{Donation List}
\caption{Donation List} \begin{tabular}{cccc}
\begin{tabular}{*{4}{>{\scriptsize}c}|*{4}{>{\scriptsize}c}} \toprule
\toprule Tipper & Amount & Date & Channel \\
\textbf{Tipper} & \textbf{Amount} & \textbf{Date} & \textbf{Channel} & \textbf{Tipper} & \textbf{Amount} & \textbf{Date} & \textbf{Channel} \\ \midrule
\midrule Lerh & 10 RMB & 2019/5/15 & Wechat \\
Lerh & 10 RMB & 2019/05/15 & Wechat & yueguodipingxian & 10 RMB & 2019/05/15 & Wechat \\ Yueguodipingxian & 10 RMB & 2019/5/15 & Wechat \\
yinsang & 20 RMB & 2019/05/27 & Wechat & *kong & 10 RMB & 2019/05/30 & Wechat \\ Dapeng & 20 RMB & 2019/5/27 & Wechat\\
latexstudio.net & 666 RMB & 2019/06/05 & Alipay & A*n & 40 RMB & 2019/06/15 & Wechat \\ \bottomrule
* xia & 22 RMB & 2019/06/15 & Wechat & * qian & 21 RMB & 2019/06/15 & Wechat \\ \end{tabular}%
Cassis & 11 RMB & 2019/06/30 & Wechat & * jun & 10 RMB & 2019/07/23 & Wechat \\
P*u & 50 RMB & 2019/07/30 & Wechat & * meng & 19 RMB & 2019/08/28 & Wechat \\
Qu Doudou & 10 RMB & 2019/08/28 & Wechat & Li Bo & 100 RMB & 2019/10/06 & Wechat \\
Njustsll & 10 RMB & 2019/10/11 & Wechat & Liu Zhikuo & 99.99 RMB & 2019/10/15 & Alipay \\
* tao & 16 RMB & 2019/10/17 & Wechat & Chini & 12 RMB & 2019/10/17 & Alipay \\
yuanfengjing & 10 RMB & 2019/10/28 & Wechat & Guo Deliang & 88 RMB & 2019/11/03 & Wechat \\
ziqiangbuxi & 20 RMB & 2019/11/04 & Alipay & dushuzhichong & 20 RMB & 2019/11/18 & Wechat \\
* deng & 10 RMB & 2019/11/18 & Wechat & * zhe & 20 RMB & 2019/11/18 & Wechat \\
anonymous & 10 RMB & 2019/11/24 & Wechat & Jiye Qian & 66 RMB & 2019/12/04 & Wechat \\
* yang & 20 RMB & 2019/12/05 & Wechat & Catcher & 11 RMB & 2019/12/08 & Alipay \\
xierbotementu & 10 RMB & 2019/12/09 & Alipay & * wei & 10 RMB & 2019/12/09 & Wechat \\
Simon & 20 RMB & 2019/12/11 & Alipay & liushangqianyi & 66.60 RMB & 2019/12/18 & Alipay \\
yu & 10 RMB & 2019/12/20 & Alipay & *chen & 15 RMB & 2019/12/20 & Wechat \\
suifeng & 20 RMB & 2019/12/27 & Alipay & Ws & 23.30 RMB & 2019/12/28 & Wechat \\
chuba & 100 RMB & 2020/01/02 & Alipay & p*e & 20 RMB & 2020/01/03 & Wechat \\
Shunmx & 100 RMB & 2020/01/03 & Wechat & hj & 10 RMB & 2020/01/03 & Wechat \\
F*5 & 10 RMB & 2020/01/03 & Wechat & S*m & 20.20 RMB & 2020/01/03 & Wechat \\
erdaiqingzhi & 13 RMB & 2020/01/14 & Alipay & *? & 66 RMB & 2020/01/15 & Wechat \\
Mr. Xiong & 20 RMB & 2020/01/17 & Wechat & *bo & 15 RMB & 2020/01/18 & Wechat \\
*zhe & 10 RMB & 2020/02/02 & Wechat & Jackie & 88.80 RMB & 2020/02/09 & Wechat \\
\bottomrule
\end{tabular}%
\label{tab:donation}%
\end{table}% \end{table}%
BTW, we provide Certificate of Donation for those who donated, tippers please leave your name(nickname) and email address for us to send the certificates.
\begin{figure}[!htb]
\centering
\includegraphics[width=0.7\textwidth]{cert.pdf}
\end{figure}
\chapter{ElegantBook Settings} \chapter{ElegantBook Settings}
This template is based on the Standard \LaTeX{} book class, so the options of book class work as well (Note that the option of papersize has no effect due to \lstinline{device} option). The default encoding is UTF-8 while \TeX{} Live is recommended. The test environment is Win10 + \TeX{} Live 2019, either \hologo{pdfLaTeX} or \lstinline{XeLaTeX} works fine. \lstinline{XeLaTeX} is preferred for Chinese articles. This template is based on the Standard \LaTeX{} book class, so the options of book class work as well. The default encoding is UTF-8 while \TeX{} Live is recommended. The test environment is Win10 + \TeX{} Live 2019.
\section{Languages} \section{Languages}
We defined one option named \lstinline{lang} which has two alternative values, \lstinline{lang=en} (default) and \lstinline{lang=cn}. Different values will alter the captions of figure/table, abstract name, refname, etc. You can use this option as We defined one option named \lstinline{lang} which has two alternative values, \lstinline{lang=en} (default) and \lstinline{lang=cn}. Different values will alter the captions of figure/table, abstract name, refname, etc. You can use this option as
@@ -186,11 +143,11 @@ We defined one option named \lstinline{lang} which has two alternative values, \
\end{lstlisting} \end{lstlisting}
\begin{remark} \begin{remark}
Chinese Characters are acceptable whenever \lstinline{lang=en} or \lstinline{lang=cn}. If you would like to include Chinese characters under (\lstinline{lstlisting}) environment, please use \hologo{XeLaTeX} to compile. Chinese Characters are acceptable whenever \lstinline{lang=en} or \lstinline{lang=cn}. If you would like to include Chinese characters under (\lstinline{lstlisting}) environment, please use \lstinline{XeLaTeX} to compile.
\end{remark} \end{remark}
\section{Device Mode Option} \section{Device Mode Option}
The option for device (\lstinline{device}) was originally used in ElegantNote, now we include this option in ElegantBook\footnote{Pictures have to be modified accordingly.} as well. Activate iPad mode in the following way\footnote{Default size: normal, A4 paper.}: The option for device (\lstinline{device}) was originally used in ElegantNote, now we include this option in ElegantBook\footnote{Pictures have to be modified accordingly} as well. Activate iPad mode in the following way\footnote{Default size: normal, A4 paper}:
\begin{lstlisting} \begin{lstlisting}
\documentclass[pad]{elegantbook} %or \documentclass[pad]{elegantbook} %or
\documentclass[device=pad]{elegantbook} \documentclass[device=pad]{elegantbook}
@@ -209,37 +166,37 @@ This template contains 5 color themes, i.e. \textcolor{structure1}{\lstinline{gr
\centering \centering
\begin{tabular}{ccccccc} \begin{tabular}{ccccccc}
\toprule \toprule
& \textcolor{structure1}{green} & \textcolor{structure1}{green}
& \textcolor{structure2}{cyan} & \textcolor{structure2}{cyan}
& \textcolor{structure3}{blue} & \textcolor{structure3}{blue}
& \textcolor{structure4}{gray} & \textcolor{structure4}{gray}
& \textcolor{structure5}{black} & \textcolor{structure5}{black}
& Main Environments\\ & Main Environments\\
\midrule \midrule
structure & \makecell{{\color{structure1}\rule{1cm}{1cm}}} structure & \makecell{{\color{structure1}\rule{1cm}{1cm}}}
& \makecell{{\color{structure2}\rule{1cm}{1cm}}} & \makecell{{\color{structure2}\rule{1cm}{1cm}}}
& \makecell{{\color{structure3}\rule{1cm}{1cm}}} & \makecell{{\color{structure3}\rule{1cm}{1cm}}}
& \makecell{{\color{structure4}\rule{1cm}{1cm}}} & \makecell{{\color{structure4}\rule{1cm}{1cm}}}
& \makecell{{\color{structure5}\rule{1cm}{1cm}}} & \makecell{{\color{structure5}\rule{1cm}{1cm}}}
& chapter section subsection \\ & chapter section subsection \\
main & \makecell{{\color{main1}\rule{1cm}{1cm}}} main & \makecell{{\color{main1}\rule{1cm}{1cm}}}
& \makecell{{\color{main2}\rule{1cm}{1cm}}} & \makecell{{\color{main2}\rule{1cm}{1cm}}}
& \makecell{{\color{main3}\rule{1cm}{1cm}}} & \makecell{{\color{main3}\rule{1cm}{1cm}}}
& \makecell{{\color{main4}\rule{1cm}{1cm}}} & \makecell{{\color{main4}\rule{1cm}{1cm}}}
& \makecell{{\color{main5}\rule{1cm}{1cm}}} & \makecell{{\color{main5}\rule{1cm}{1cm}}}
& definition exercise problem \\ & definition exercise problem \\
second & \makecell{{\color{second1}\rule{1cm}{1cm}}} second & \makecell{{\color{second1}\rule{1cm}{1cm}}}
& \makecell{{\color{second2}\rule{1cm}{1cm}}} & \makecell{{\color{second2}\rule{1cm}{1cm}}}
& \makecell{{\color{second3}\rule{1cm}{1cm}}} & \makecell{{\color{second3}\rule{1cm}{1cm}}}
& \makecell{{\color{second4}\rule{1cm}{1cm}}} & \makecell{{\color{second4}\rule{1cm}{1cm}}}
& \makecell{{\color{second5}\rule{1cm}{1cm}}} & \makecell{{\color{second5}\rule{1cm}{1cm}}}
& theorem lemma corollary\\ & theorem lemma corollary\\
third & \makecell{{\color{third1}\rule{1cm}{1cm}}} third & \makecell{{\color{third1}\rule{1cm}{1cm}}}
& \makecell{{\color{third2}\rule{1cm}{1cm}}} & \makecell{{\color{third2}\rule{1cm}{1cm}}}
& \makecell{{\color{third3}\rule{1cm}{1cm}}} & \makecell{{\color{third3}\rule{1cm}{1cm}}}
& \makecell{{\color{third4}\rule{1cm}{1cm}}} & \makecell{{\color{third4}\rule{1cm}{1cm}}}
& \makecell{{\color{third5}\rule{1cm}{1cm}}} & \makecell{{\color{third5}\rule{1cm}{1cm}}}
& proposition\\ & proposition\\
\bottomrule \bottomrule
\end{tabular} \end{tabular}
\end{table} \end{table}
@@ -252,46 +209,16 @@ If you want to customize the colors, please select \lstinline{nocolor} or use \l
\definecolor{third}{RGB}{0,174,247}% \definecolor{third}{RGB}{0,174,247}%
\end{lstlisting} \end{lstlisting}
\section{Cover}
\subsection{Customized Cover}
From v3.10, customized cover is allowed, you can choose or hide any element as you prefer. Current optional elements are:
\begin{itemize}
\item title: \lstinline{\title}
\item subtitle: \lstinline{\subtitle}
\item author: \lstinline{\author}
\item institute: \lstinline{\institute}
\item date: \lstinline{\date}
\item version: \lstinline{\version}
\item extra information: \lstinline{\extrainfo}
\item cover image: \lstinline{\cover}
\item logo: \lstinline{\logo}
\end{itemize}
Besides, an extra command \lstinline{\bioinfo} is provided with two options--caption and content. For instance, if you want to display \lstinline{Username: 111520}, just type in
\begin{lstlisting}
\bioinfo{Username}{115520}
\end{lstlisting}
\subsection{Cover Image}
The cover image used in this template is from \href{https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/}{pixabay.com}. The image is completely free and can be used under any circumstance. The cover image size is $1280 \times 1024$. If you would like to change the cover, please crop it according to the size of the cover picture strictly. One free online image clipping site: \href{https://www.fotor.com/cn}{fotor.com}. Feel free to join our QQ Group to get more elegant covers.
\subsection{Logo}
Aspect ratio of the logo is 1:1 in this guide, i.e. a square picture. To replace the logo, do remember to choose the appropriate picture.
\subsection{Stylized Cover}
Want to use stylized cover?(For instance, A4-sized PDF designed by Adobe Illustrator) Please comment out \lstinline{\maketitle} and use \lstinline{pdfpages} to insert the cover. Similar for using \lstinline{titlepage}. If you would like to use the cover in version 2.x, please refer to \href{https://github.com/EthanDeng/etitlepage}{etitlepage}.
\section{Chapter Title Display Styles} \section{Chapter Title Display Styles}
This template contains 2 sets of \textit{title display styles},\lstinline{hang}(default) and \lstinline{display} style. For the former, chapter title is displayed on a single line (\lstinline{hang}). For the latter, chapter title is displayed on a double line (\lstinline{display}).In this guide, we use \lstinline{hang} . To change display style, use: This template contains 2 sets of \textit{title display styles},\lstinline{hang}(default) and \lstinline{display} style. For the former, chapter title is displayed on a single line (\lstinline{hang}). For the latter, chapter title is displayed on a double line (\lstinline{display}).In this guide, we use \lstinline{hang} . To change display style
\begin{lstlisting} \begin{lstlisting}
\documentclass[hang]{elegantbook} %or \documentclass[hang]{elegantbook} %or
\documentclass[titlestyle=hang]{elegantbook} \documentclass[titlestyle=hang]{elegantbook}
\end{lstlisting} \end{lstlisting}
\section{Theorem Class Environments}
\section{Introduction of Math Environments}
We defined two sets of theorem modes, \lstinline{simple} style and \lstinline{fancy} style (default). You may change to \lstinline{simple} mode by We defined two sets of theorem modes, \lstinline{simple} style and \lstinline{fancy} style (default). You may change to \lstinline{simple} mode by
\begin{lstlisting} \begin{lstlisting}
@@ -308,9 +235,9 @@ In this template, we defined four different theorem class environments
\item \textcolor{second}{\textbf{theorem, lemma, corollary}} environment, the color is \textcolor{second} {second}; \item \textcolor{second}{\textbf{theorem, lemma, corollary}} environment, the color is \textcolor{second} {second};
\item \textcolor{third}{\textbf{proposition}} environment, the color is \textcolor{third}{third}. \item \textcolor{third}{\textbf{proposition}} environment, the color is \textcolor{third}{third}.
\end{itemize} \end{itemize}
\item \textit{Example Environments}, including \textbf{example, exercise, problem} environment, auto numbering corresponding to chapter. \item \textit{Example Environments}, including \textbf{example, exercise, problem} environment, auto-numbering corresponding to chapter.
\item \textit{Proof Environment}, including \textbf{proof, note} environment containing introductory symbol (\textbf{note} environment) or ending symbol (\textbf{proof} environment). \item \textit{Proof Environment}, including \textbf{proof, note} environment containing introductory symbol (\textbf{note} environment) or ending symbol (\textbf{proof} environment).
\item \textit{Conclusion Environments}, including \textbf{conclusion, assumption, property, remark and solution}\footnote{We also define an option \lstinline{result}, which can hide the \lstinline{solution} and \lstinline{proof} environments. You can switch between \lstinline{result=answer} and \lstinline{result=noanswer}.} environments, all of which begin with boldfaced words, with format consistent with normal paragraphs. \item \textit{Conclusion Environments}, including \textbf{conclusion, assumption, property, remark, solution}\footnote{We also define an option \lstinline{result}, which can hide the \lstinline{solution} and \lstinline{proof} environments. You can switch between \lstinline{result=answer} and \lstinline{result=noanswer}} environment, all of which begin with boldfaced words, with format consistent with normal paragraphs.
\end{itemize} \end{itemize}
\subsection{Theorem Class Environments} \subsection{Theorem Class Environments}
@@ -362,19 +289,25 @@ These are all similar environments with slight differences lies in:
\begin{itemize} \begin{itemize}
\item Example, exercise, problem environments number within chapter; \item Example, exercise, problem environments number within chapter;
\item Note begins with introductory symbol and proof ends with ending symbol; \item Note begins with introductory symbol and proof ends with ending symbol;
\item Conclusion and other environments are normal paragraph environments with boldfaced introductory words. \item Conclusion environment and so on are normal paragraph environments with boldfaced introductory words.
\end{itemize} \end{itemize}
\section{Base Hide Option} \section{Base Hide Option}
Hiding the end-of-chapter and end-of-page base is optional, simply type in: Hiding the end-of-chapter base is optional, simply type in:
\begin{lstlisting} \begin{lstlisting}
\documentclass[hide]{elegantbook} %or \documentclass[hide]{elegantbook} %or
\documentclass[base=hide]{elegantbook} \documentclass[base=hide]{elegantbook}
\end{lstlisting} \end{lstlisting}
\section{Cover and Logo}
The cover image used in this template is from \href{https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/}{pixabay.com}\footnote{Thank China\TeX{} for providing free image source, \href{https://www.pexels.com/}{pexels.com} is strongly recommended.}. The image is completely free and can be used under any circumstance. The cover image size is $1280 \times 1024$. If you would like to change the cover, please crop it according to the size of the cover picture strictly.One free online image clipping site: \href{https://www.befunky.com/create/crop-photo/}{befunky.com}.
Aspect ratio of the logo is 1:1 in this guide, i.e. a square picture. To replace the logo, do remember to choose the appropriate picture.
\section{List Environments} \section{List Environments}
This template uses \lstinline{tikz} to customize the list environments, with \lstinline{itemize} environment customized to the third depth and \lstinline{enumerate} environment customized to fourth depth. The effect is as follows\\[2ex] This template uses \lstinline{tikz} to customize \lstinline{itemize} and \lstinline{enumerate} environments, with \lstinline{itemize} environment customized to the third depth and \lstinline{enumerate} environment customized to fourth depth. The effect is as follows\\[2ex]
\begin{minipage}[b]{0.49\textwidth} \begin{minipage}[b]{0.49\textwidth}
\begin{itemize} \begin{itemize}
\item first item of nesti; \item first item of nesti;
@@ -414,63 +347,43 @@ If you want to use \hologo{BibTeX}, you must create a file named \lstinline{refe
\nocite{*} %include all the bibitems \nocite{*} %include all the bibitems
\end{lstlisting} \end{lstlisting}
Three more options \lstinline{cite=numbers}, \lstinline{cite=super} and \lstinline{cite=authoryear} are available in this new version, with the default setting as \lstinline{numbers} since those major in science and technology use \lstinline{numbers} and/or \lstinline{cite=super} more often. For those who want to use \lstinline{cite=super} or \lstinline{authoryear}, please type in: Two more options \lstinline{cite=numbers} and \lstinline{cite=authoryear} are available in this new version, with the default setting as \lstinline{numbers} since those major in science and technology use \lstinline{numbers} more often. For those who major in liberal arts want to use \lstinline{authoryear}, please type in:
\begin{lstlisting} \begin{lstlisting}
\documentclass[cite=super]{elegantbook} % set cite for super style \documentclass[cite=authoryear]{elegantbook} %or
\documentclass[super]{elegantbook}
\documentclass[cite=authoryear]{elegantbook} % set cite for author-year style
\documentclass[authoryear]{elegantbook} \documentclass[authoryear]{elegantbook}
\end{lstlisting} \end{lstlisting}
To change the bibliography style, this version introduces \lstinline{bibstyle} with default option apalike, for more options, refer to \href{https://www.overleaf.com/learn/latex/Bibtex_bibliography_styles}{\hologo{BibTeX} Bibliography Styles}. Type in
\begin{lstlisting}
\documentclass[bibstyle=apalike]{elegantbook}
\end{lstlisting}
\section{Preface} \section{Preface}
If you want to add a preface before the first chapter with the number of chapter unchanged, please add the preface in the following way: If you want to add a preface before the first chapter with the number of chapter unchanged, please add the preface in the following way:
\begin{lstlisting} \begin{lstlisting}
\chapter*{Introduction} \chapter*{Preface}
\markboth{Introduction}{Introduction} \addcontentsline{toc}{chapter}{Preface}
The content of introduction. \markboth{Preface}{}
The content of Preface.
\end{lstlisting} \end{lstlisting}
\section{Content Option and Depth}
This version adds an option for content \lstinline{toc}, you can choose either one column(\lstinline{onecol}) or two columns(\lstinline{twocol}). For two columns:
\begin{lstlisting}
\documentclass[twocol]{elegantbook}
\documentclass[toc=twocol]{elegantbook}
\end{lstlisting}
Default content depth is 1, use
\begin{lstlisting}
\setcounter{tocdepth}{2}
\end{lstlisting}
to make it 2.
\section{Introduction Environment} \section{Introduction Environment}
We create a introduction environment to display the structure of chapter. The basic useage is as follows: We create a introduction environment to display the structure of chapter. The basic useage is as follows
\begin{lstlisting} \begin{lstlisting}
\begin{introduction} \begin{introduction}
\item Definition of Theorem \item Definition of Theorem
\item Ask for help \item Ask for help
\item Optimization Problem \item Optimization Problem
\item Property of Cauchy Series \item Property of Cauchy Series
\item Angle of Corner \item Angle of Corner
\end{introduction} \end{introduction}
\end{lstlisting} \end{lstlisting}
And you will get: you will get:
\begin{introduction} \begin{introduction}
\item Definition of Theorem \item Definition of Theorem
\item Ask for help \item Ask for help
\item Optimization Problem \item Optimization Problem
\item Property of Cauchy Series \item Property of Cauchy Series
\item Angle of Corner \item Angle of Corner
\end{introduction} \end{introduction}
You can change the title of this environment by modifying the optional argument of this environment: You can change the title of this environment by modifying the optional argument of this environment
\begin{lstlisting} \begin{lstlisting}
\begin{introduction}[Brief Introduction] \begin{introduction}[Brief Introduction]
... ...
@@ -481,122 +394,21 @@ You can change the title of this environment by modifying the optional argument
The environment \lstinline{problemset} is used at the end of each chapter to display corresponding exercises. Just type in the following sentences: The environment \lstinline{problemset} is used at the end of each chapter to display corresponding exercises. Just type in the following sentences:
\begin{lstlisting} \begin{lstlisting}
\begin{problemset} \begin{problemset}
\item exercise 1 \item exercise 1
\item exercise 2 \item exercise 2
\item exercise 3 \item exercise 3
\end{problemset} \end{problemset}
\end{lstlisting} \end{lstlisting}
And you will get: And you will get:
\begin{problemset} \begin{problemset}
\item exercise 1 \item exercise 1
\item exercise 2 \item exercise 2
\item exercise 3 \item exercise 3
\item math equation test:
\begin{equation}
a^2+b^2=c_{2_{i}} (1,2) [1,23]
\end{equation}
\end{problemset} \end{problemset}
\begin{remark} \begin{remark}
If you want to customize the title of \lstinline{problemset}, please change the optional argument like in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer(to be fixed). If you want to customize the title of \lstinline{problemset}, please change the optional argument like introduction environment.
\end{remark} \end{remark}
\begin{solution}
If you want to customize the title of \lstinline{problemset}, please change the optional argument like in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer(to be fixed).
\end{solution}
\section{Margin Notes}
In 3.08, we introduced \lstinline{marginpar=margintrue} and \lstinline{\elegantpar} (Beta) with piles of bugs. Hence we decide to remove them in 3.09 and will suspend the options till revolutionary optimization. Sorry for all the bugs! However, we retain the option \lstinline{marginpar} for users to get margin motes by activating \lstinline{marginpar=margintrue} and using \lstinline{\marginpar} or \lstinline{marginnote} packages.
\begin{remark}
Note that text and equation are both available in the margin notes.
\begin{lstlisting}
% text
\marginpar{margin paragraph text}
% equation
\marginpar{
\begin{equation}
a^2 + b^2 = c^2
\end{equation}
}
\end{lstlisting}
For tables and figures, note that floating environment is not allowed. You have to use \lstinline{includegraphics} or \lstinline{table} and use \lstinline{\captionof} to name it. To get centralized figures or tables, use \lstinline{\centerline} or \lstinline{center}. To learn more, please refer to \href{https://tex.stackexchange.com/questions/5583/caption-of-figure-in-marginpar-and-caption-of-wrapfigure-in-margin}{Caption of Figure in Marginpar}.
\begin{lstlisting}
% graph with centerline command
\marginpar{
\centerline{
\includegraphics[width=0.2\textwidth]{logo.png}
}
\captionof{figure}{your figure caption}
}
% graph with center environment
\marginpar{
\begin{center}
\includegraphics[width=0.2\textwidth]{logo.png}
\captionof{figure}{your figure caption}
\end{center}
}
\end{lstlisting}
\end{remark}
\chapter{Fonts}
Leave one chapter to introduce fonts to help users to solve font problems conveniently.
\textcolor{red}{\bfseries Alert} After v3.10, newtx is reset to cm and \lstinline{chinesefont} option is added.
\section{Math Fonts}
This template defines a new command(\lstinline{math}), with three options:
\begin{enumerate}
\item \lstinline{math=cm}(default), use \LaTeX{} default math font (recommended).
\item \lstinline{math=newtx}, use \lstinline{newtxmath} math font (may bring about bugs).
\item \lstinline{math=mtpro2}, use \lstinline{mtpro2} package to set math font.
\end{enumerate}
\section{Use newtx fonts}
If you use \lstinline{newtx} fonts, type in:
\begin{lstlisting}
\documentclass[math=newtx]{elegantbook}
\end{lstlisting}
\subsection{Hyphens}
Since the template uses \lstinline{newtx}, please pay attention to the hyphens. For instance,
\begin{equation}
\int_{R^q} f(x,y) dy.\emph{of\kern0pt f}
\end{equation}
The corresponding code is:
\begin{lstlisting}
\begin{equation}
\int_{R^q} f(x,y) dy.\emph{of \kern0pt f}
\end{equation}
\end{lstlisting}
\section{Symbol Fonts}
Feedback from some 3.08 users claims that error occurs when using our templates with \lstinline{yhmath}, \lstinline{esvect} and other packages.
\begin{lstlisting}
LaTeX Error:
Too many symbol fonts declared.
\end{lstlisting}
The reason is that the template redefines font for math so that no new math font is allowed to be added. To use \lstinline{yhmath} and/or \lstinline{esvect}, please locate \lstinline{yhmath} or \lstinline{esvect} in \lstinline{elegantbook.cls}, uncomment corresponding related code.
\begin{lstlisting}
%%% use yhmath pkg, uncomment following code
% \let\oldwidering\widering
% \let\widering\undefined
% \RequirePackage{yhmath}
% \let\widering\oldwidering
%%% use esvect pkg, uncomment following code
% \RequirePackage{esvect}
\end{lstlisting}
\chapter{ElegantBook Writing Sample} \chapter{ElegantBook Writing Sample}
@@ -618,7 +430,7 @@ The reason is that the template redefines font for math so that no new math font
We will define the integral of a measurable function in three steps. First, we define the integral of a nonnegative simple function. Let $E$ be the measurable set in $\mathcal{R}^N$. We will define the integral of a measurable function in three steps. First, we define the integral of a nonnegative simple function. Let $E$ be the measurable set in $\mathcal{R}^N$.
\begin{definition}{Left Coset}{} \begin{definition}{Left Coset}{}
Let $H$ be a subgroup of a group~$G$. A \emph{left coset} of $H$ in $G$ is a subset of $G$ that is of the form $xH$, where $x \in G$ and $xH = \{ xh : h \in H \}$. Similarly a \emph{right coset} of $H$ in $G$ is a subset of $G$ that is of the form $Hx$, where $Hx = \{ hx : h \in H \}$ $\hbar$ Let $H$ be a subgroup of a group~$G$. A \emph{left coset} of $H$ in $G$ is a subset of $G$ that is of the form $xH$, where $x \in G$ and $xH = \{ xh : h \in H \}$. Similarly a \emph{right coset} of $H$ in $G$ is a subset of $G$ that is of the form $Hx$, where $Hx = \{ hx : h \in H \}$
\end{definition} \end{definition}
\begin{note} \begin{note}
@@ -643,9 +455,9 @@ Let $z$ be some element of $xH \cap yH$. Then $z = xa$ for some $a \in H$, and
\end{proof} \end{proof}
\begin{figure}[htbp] \begin{figure}[htbp]
\centering \centering
\includegraphics[width=0.6\textwidth]{scatter.pdf} \includegraphics[width=0.6\textwidth]{scatter.pdf}
\caption{Matplotlib: Scatter Plot Example\label{fig:scatter}} \caption{Matplotlib: Scatter Plot Example\label{fig:scatter}}
\end{figure} \end{figure}
Regression analysis is a powerful statistical method that allows you to examine the relationship between two or more variables of interest. While there are many types of regression analysis, at their core they all examine the influence of one or more independent variables on a dependent variable. The process of performing a regression allows you to confidently determine which factors matter most, which factors can be ignored, and how these factors influence each other. Regression analysis is a powerful statistical method that allows you to examine the relationship between two or more variables of interest. While there are many types of regression analysis, at their core they all examine the influence of one or more independent variables on a dependent variable. The process of performing a regression allows you to confidently determine which factors matter most, which factors can be ignored, and how these factors influence each other.
@@ -678,76 +490,111 @@ Let's continue using our application training example. In this case, we'd want t
\lipsum[1-2] \lipsum[1-2]
\begin{itemize} \begin{itemize}
\item Routing and resource discovery; \item Routing and resource discovery;
\begin{itemize} \begin{itemize}
\item Language Models \item Language Models
\item Vector Space Models \item Vector Space Models
\end{itemize} \end{itemize}
\item Resilient and scalable computer networks; \item Resilient and scalable computer networks;
\item Distributed storage and search. \item Distributed storage and search.
\end{itemize} \end{itemize}
\begin{problemset} \begin{problemset}
\item Solve the equation $5(- 3x - 2) - (x - 3) = -4(4x + 5) + 13$. \item Solve the equation $5(- 3x - 2) - (x - 3) = -4(4x + 5) + 13$.
\item Find the distance between the points (-4 , -5) and (-1 , -1). \item Find the distance between the points (-4 , -5) and (-1 , -1).
\item Find the slope of the line $5x - 5y = 7$. \item Find the slope of the line $5x - 5y = 7$.
\end{problemset} \end{problemset}
\chapter{Margin Notes}
For version 3.08, we introduce margin note option and \lstinline{\elegantpar} (Beta). In this template, margin note option \lstinline{marginpar} is included. If \lstinline{marginpar=margintrue}, the width of both sides will reduce at least 1.5cm. If \lstinline{marginpar=marginfalse}, the width of sides will remain unchanged. Margin note option works under \lstinline{device=normal} only.
Margin note option can be activated using \lstinline{\marginpar} built in \LaTeX{} or \lstinline{\marginnote} command in \lstinline{marginnote}. For more information, refer to \href{https://en.wikibooks.org/wiki/LaTeX/Footnotes_and_Margin_Notes#Margin_Notes}{Margin Notes} or \LaTeX{} books.
\lstinline{\elegantpar} is introduced in this version. Note that TikZ overlay is used in this command, hence you have to compile three times to get the right display effect.
%\setlength{\marginparwidth}{2.5cm}
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et \elegantpar{dolore magna aliqua}{This is Beautiful the elegantpar Style for English Text}. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
\begin{equation}
E = m\elegantpar{c^{2}}{
\begin{equation*}E=mc^2\end{equation*}}
\end{equation}
\chapter{FAQ} \chapter{FAQ}
We list some FAQs for users to refer to:
\begin{enumerate}
\item \question{Why option numbers for natbib fail to take effect in v3.07?}
In v3.07, when \lstinline{gbt7714} is introduced, option \lstinline{authoryear} is incompatible with \lstinline{natbib}. In v3.08 and 3.09, \lstinline{numbers}, \lstinline{numbers}, \lstinline{super} and \lstinline{authoryear} are introduced.
\item \question{I want to customize font and background color.}
Please use \lstinline{pagecolor} to change background color, refer to \href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{this} to customize font.
\item \question{Which version should I choose?}
Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2019.
\item \question{Which editor should I choose?}
You can use \TeX{} Live 2019 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2019 + \TeX{}studio is strongly recommended. I myself use VS Code and Sublime Text. Related configurations can be found at \href{https://github.com/EthanDeng/vscode-latex}{vscode-latex} and \href{https://github.com/EthanDeng/sublime-text-latex}{sublime-text-latex}.
\item \question{Hello, we want to use ElegantBook to write a book about machine learning and would like your authorization.}
Feel free to use our templates by pointing out our copyright. For other issues, please refer to LPPL-1.3c. If you want to show us your work, share the URL with us afterwards.
\item \question{What is cross reference?}
This template is aimed at who are not a complete beginner for \LaTeX{}. Please learn more about \LaTeX{} before using this template.
\item \question{Is the language for code highlighting optional?}
Yes, \lstinline{listings} package is used in ElegantBook, hence language is optional(e.g. \lstinline{language=Python}). For global setting, use \lstinline{lstset}. For more information, please refer to package documentations.
\item \question{When will Beamer template (ElegantSlide or ElegantBeamer) forthcoming?}
Since there is an excellent theme \href{https://github.com/matze/mtheme}{Metropolis}, a Beta theme PreElegantSlide is available in QQ group. Feel free to download. A formal version is forthcoming in this year or next year.
\end{enumerate}
\chapter{Version History} \begin{custom}{Question}
We revised our templates now and then. This section shows the version story of ElegantBook. We have nearly 100 submits and 16 releases on GitHub since uploaded. I want to customize font and background color.
\end{custom}
\datechange{2020/02/10}{release of v3.10} \begin{solution}
Please use \lstinline{\pagecolor} to change background color, refer to \href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{this} to customize font.
\begin{change} \end{solution}
\item Introduce \lstinline{math} for math font, optional styles are \lstinline{newtx} and \lstinline{cm}.\\
\textbf{Notice}: The math font \lstinline{newtxmath} in previous versions is reset to default \LaTeX{} math font, to keep previous math font, please declare \lstinline{math=newtx}.
\item Introduce \lstinline{chinesefont} option, with \lstinline{founder}, \lstinline{ctexfont} and \lstinline{nofont} available.
\item Turn author information on the cover optional and add customized command \lstinline{\bioinfo}.
\item Add version history with command \lstinline{\datechange} and environment \lstinline{change}.
\item Add Chinese chapter style \lstinline{scheme} with option \lstinline{chinese}.
\item Since the bug raised by \lstinline{\lvert} is fixed, exchange package positions of \lstinline{ctex} and \lstinline{amsmath}.
\item Drop \lstinline{\lastpage} from header to avoid page anchor bug and adding \lstinline{\frontmatter}.
\item Revise bibliography option \lstinline{cite} with optional styles \lstinline{numbers},\lstinline{authoryear} and \lstinline{super}.
\item Introduce bibliography style option \lstinline{bibstyle}, with default bib style \lstinline{apalike} for English mode and \lstinline{gbt7714} package for Chinese mode.
\end{change}
\datechange{2019/08/18}{release of v3.09}
\begin{change}
\item Remove \lstinline{\elegantpar} temporary and remind users to use \lstinline{\marginnote} and \lstinline{\marginpar} instead.
\item Use \lstinline{esint} to display integral operator.
\item Add new command \lstinline{toc}, with options \lstinline{onecol} and \lstinline{twocol}.
\item Add new option \lstinline{cite} \lstinline{super} for superscript-displayed citation.
\item Revise \lstinline{problemset}.
\end{change}
\nocite{en1,en2,en3}
\begin{custom}{Question}
Which version should I choose?
\end{custom}
\begin{solution}
Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2019.
\end{solution}
\begin{custom}{Question}
Which editor should I choose?
\end{custom}
\begin{solution}
You can use \TeX{} Live 2019 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2019 + \TeX{}studio is strongly recommended. I myself use VS Code and Sublime Text. Related configurations can be found at \href{https://github.com/EthanDeng/vscode-latex}{vscode-latex} and \href{https://github.com/EthanDeng/sublime-text-latex}{sublime-text-latex}.
\end{solution}
\begin{custom}{Question}
Hello, we want to use ElegantBook to write a book about machine learning and would like your authorization.
\end{custom}
\begin{solution}
Feel free to use our templates by pointing out our copyright. For other issues, please refer to LPPL-1.3c. If you want to show us your work, share the URL with us afterwards.
\end{solution}
\begin{custom}{Question}
I would like to use the former cover!
\end{custom}
\begin{solution}
Cover option is forthcoming.
\end{solution}
\begin{custom}{Question}
What is cross reference?
\end{custom}
\begin{solution}
This template is aimed at who are not a complete beginner for \LaTeX{}. Please learn more about \LaTeX{} before using this template.
\end{solution}
\begin{custom}{Question}
Is the language for code highlighting optional?
\end{custom}
\begin{solution}
Yes, \lstinline{listings} package is used in ElegantBook, hence language is optional. For global setting, use \lstinline{\lstset}. For more information, please refer to package documentations.
\end{solution}
\nocite{en1,en2,en3}
\bibliography{reference} \bibliography{reference}
\appendix
\appendix
\chapter{Mathematical Tools} \chapter{Mathematical Tools}
This appendix covers some of the basic mathematics used in econometrics. We briefly discuss the properties of summation operators, study the properties of linear and some nonlinear equations, and review the ratios and percentages. We also introduce some special functions that are common in econometrics applications, including quadratic functions and natural logarithms. The first four sections require only basic algebraic techniques. The fifth section briefly reviews differential Calculus Although Calculus is not necessary to understand much of this book, it is used in some of the end-of-chapter appendices and in some of the more advanced topics in part 3. This appendix covers some of the basic mathematics used in econometrics. We briefly discuss the properties of summation operators, study the properties of linear and some nonlinear equations, and review the ratios and percentages. We also introduce some special functions that are common in econometrics applications, including quadratic functions and natural logarithms. The first four sections require only basic algebraic techniques. The fifth section briefly reviews differential Calculus Although Calculus is not necessary to understand much of this book, it is used in some of the end-of-chapter appendices and in some of the more advanced topics in part 3.
@@ -760,4 +607,36 @@ This appendix covers some of the basic mathematics used in econometrics. We brie
\sum_{i=1}^n x_i \equiv x_1 + x_2 +\cdots + x_n \sum_{i=1}^n x_i \equiv x_1 + x_2 +\cdots + x_n
\end{equation} \end{equation}
\end{document} \chapter{A Minimal Example}
\begin{lstlisting}[frame=single]
\documentclass{elegantbook}
% title info
\title{Title}
\subtitle{Subtitle is here}
% bio info
\author{Your Name}
\institute{XXX University}
\date{\today}
% extra info
\version{1.00}
\extrainfo{Victory won\rq t come to us unless we go to it. --- M. Moore}
\logo{logo.png}
\cover{cover.jpg}
\begin{document}
\maketitle
\tableofcontents
\mainmatter
\hypersetup{pageanchor=true}
% add preface chapter here if needed
\chapter{Example Chapter Title}
The content of chapter one.
\bibliography{reference}
\end{document}
\end{lstlisting}
\end{document}

File diff suppressed because it is too large Load Diff

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 218 KiB