105 Commits
v3.09 ... v4.2

Author SHA1 Message Date
EthanDeng
34e2225019 version 4.2 2022-03-07 17:18:48 +08:00
EthanDeng
91f5e46c94 update version id 2022-03-07 17:17:56 +08:00
EthanDeng
6a60b16e14 bug fix for newtx pkg update 2022-03-07 17:04:26 +08:00
Dongsheng Deng
909fb2c997 Merge pull request #178 from valdigleis/pt-branch
Add portuguese translation
2022-02-14 16:23:18 +08:00
valdigleis
c669c4a263 Add portuguese translation 2022-02-05 21:15:01 -03:00
Dongsheng Deng
53547c11e4 Merge pull request #177 from syvshc/hotfix
patch for newtx v1.7 or later
2022-01-15 10:00:34 +08:00
syvshc
093c73e4c9 patch for newtx v1.7 or later 2022-01-15 00:50:18 +08:00
EthanDeng
3d0f25cc6a update readme 2022-01-04 13:42:26 +08:00
EthanDeng
a7e5c032c5 update install latex site 2021-05-13 21:53:13 +08:00
EthanDeng
bf40203c9f modify md 2021-05-02 21:14:42 +08:00
EthanDeng
b518213c77 version 4.1 2021-05-02 21:02:32 +08:00
EthanDeng
71c0f9e1a5 fix confilct 2021-02-23 13:25:55 +08:00
EthanDeng
d40cb2c42e chapter section settings and fix header 2021-02-23 13:22:47 +08:00
EthanDeng
6c64e5900b fix confilct 2021-01-02 12:27:55 +08:00
EthanDeng
3bebe9697f fix fonts problem 2021-01-02 12:25:30 +08:00
EthanDeng
30a916c26c add spanish translation provided by Gustavo A. Corradi 2020-11-16 12:23:32 +08:00
EthanDeng
61ac6a08c4 update restart 2020-10-26 21:06:12 +08:00
EthanDeng
f123c6a83b update language translation 2020-09-02 12:29:44 +08:00
EthanDeng
e771b81dc8 update readme 2020-08-19 11:58:45 +08:00
Dongsheng Deng
f75907371d Merge pull request #116 from azzamsa/master
fix link typo
2020-08-19 12:04:08 +08:00
azzamsa
f192cf44fa fix link typo 2020-08-19 10:18:16 +07:00
EthanDeng
ce87722d38 update donation list 2020-08-13 12:14:20 +08:00
EthanDeng
01951eeb28 fix problemset header problem 2020-08-04 22:25:03 +08:00
EthanDeng
4e53474e6e primary of 4.0.5 2020-08-04 12:21:07 +08:00
EthanDeng
cf755a0387 hyperref toc clickable 2020-07-29 13:37:20 +08:00
EthanDeng
9092103354 update biblatex 2020-07-06 22:39:58 +08:00
EthanDeng
303d2e5c9d modify readme 2020-06-09 12:20:40 +08:00
EthanDeng
a8123170ca readme to chinese and english 2020-06-09 12:17:12 +08:00
EthanDeng
5d02e85f01 update version date number 2020-06-03 20:24:19 +08:00
EthanDeng
9ef6a5bf5a revert theorem usage to amsthm style 2020-06-03 20:22:15 +08:00
EthanDeng
d281e3e834 update english guide 2020-04-13 21:32:59 +08:00
EthanDeng
78fe2c7daf frozen 3.11 2020-04-12 13:43:33 +08:00
EthanDeng
ae7a9ae8f6 update 3.11 2020-04-12 12:00:13 +08:00
EthanDeng
c84f79922d frozen 3.x 2020-04-11 10:19:16 +08:00
EthanDeng
6ab10beda8 fix problem/example/exercise space 2020-03-21 00:23:42 +08:00
EthanDeng
09b71b9ab7 add lang=it 2020-03-19 13:14:30 +08:00
EthanDeng
6924603f5c version 3.10 2020-02-10 21:52:06 +08:00
EthanDeng
eecad6acf6 update guide 2020-02-10 10:15:50 +08:00
EthanDeng
8ca2077cb4 3.10 pre release 2020-02-08 20:06:27 +08:00
EthanDeng
083ef244ac remove medskip 2020-02-02 13:24:38 +08:00
EthanDeng
f8729c63a9 update titlepage 2020-02-02 12:44:08 +08:00
EthanDeng
c2a4b318ec pre release 3.10 2020-01-17 11:20:43 +08:00
EthanDeng
fa2cf2f5f1 renew environment name 2020-01-14 13:42:25 +08:00
EthanDeng
b6e1a2e8e3 remove last page and add bibstyle 2020-01-13 13:40:56 +08:00
EthanDeng
bd16ebc36e add axiom and postulate 2019-12-31 17:28:18 +08:00
EthanDeng
b756eb2966 update donation 2019-12-30 23:46:23 +08:00
EthanDeng
cf2dd78ad8 readme.md typo 2019-12-02 14:09:09 +08:00
EthanDeng
b62319de1f update options 2019-11-26 13:33:58 +08:00
EthanDeng
622b95d238 typo 2019-11-19 11:48:21 +08:00
EthanDeng
695157cd46 update donation list 2019-11-19 11:41:46 +08:00
EthanDeng
460a7f4b68 remove sb 2019-11-09 20:46:07 +08:00
EthanDeng
f34e05ff6d rearrange the order of readme.md 2019-11-09 18:48:17 +08:00
EthanDeng
07ec82321f renew readme 2019-11-09 18:24:37 +08:00
EthanDeng
1dbf0eca16 last 2019-11-09 17:59:41 +08:00
EthanDeng
0beebfc087 renew my name 2019-11-09 17:59:41 +08:00
EthanDeng
2450fad609 renew readme information 2019-11-09 17:59:41 +08:00
EthanDeng
870a8c28d2 fix part of indentation 2019-11-09 17:59:41 +08:00
EthanDeng
406f0a3d34 about lvert problem? 2019-11-09 17:59:41 +08:00
EthanDeng
a1d2dedc13 remove the ceshi 2019-11-09 17:59:41 +08:00
EthanDeng
ce8c1d582d remove pagestyles from titlesec pkg and set parindent for lang=cn 2019-11-09 17:59:41 +08:00
EthanDeng
b8c165a6b7 remove the negative space before section/subsection 2019-11-09 17:59:41 +08:00
EthanDeng
e9513f88da fix header odd/even 2019-11-09 17:59:41 +08:00
EthanDeng
9505ac286f remove the md image 2019-11-09 17:59:41 +08:00
EthanDeng
b5d556ec74 resize 2019-11-09 17:59:41 +08:00
EthanDeng
225d2416a5 version 3.09 release 2019-11-09 17:59:41 +08:00
EthanDeng
e8cc07a13e version 3.09 2019-11-09 17:59:41 +08:00
EthanDeng
a6830816e4 no error no warnings, SLEEP 2019-11-09 17:59:41 +08:00
EthanDeng
d03959f9d2 no error no warnings with font/symbol fixed 2019-11-09 17:59:41 +08:00
EthanDeng
4f324f2ca9 revert back to cmlargesymbols 2019-11-09 17:59:38 +08:00
EthanDeng
b50d464206 remove elegantpar 2019-11-09 17:59:19 +08:00
EthanDeng
3495afdd26 remove the elegantpar command 2019-11-09 17:59:19 +08:00
EthanDeng
56a1795834 donation 2019-11-09 17:59:19 +08:00
EthanDeng
c366c01998 wrong update 2019-11-09 17:59:19 +08:00
EthanDeng
c23d12e635 update new fix 2019-11-09 17:59:19 +08:00
EthanDeng
6d60bf404e add toc option 2019-11-09 17:59:19 +08:00
EthanDeng
531532c837 fix linewidth 2019-11-09 17:59:18 +08:00
EthanDeng
195e2634e3 remove space 2019-11-09 17:59:18 +08:00
EthanDeng
97a9668bd0 renew acknow 2019-11-09 17:59:18 +08:00
EthanDeng
2d7e2f7d70 renew acknow 2019-11-09 17:59:18 +08:00
EthanDeng
87f4d64810 version 3.08 release 2019-11-09 17:59:18 +08:00
EthanDeng
16bcf11414 version 3.08 2019-11-09 17:59:14 +08:00
EthanDeng
8c15cf9210 remove mtpro2 2019-11-09 17:57:50 +08:00
EthanDeng
6d336e113e remove typo 2019-11-09 17:57:50 +08:00
EthanDeng
1a831740e6 fix math operator cmex font selectiong 2019-11-09 17:57:50 +08:00
EthanDeng
4b2626d4f1 renew partname 2019-11-09 17:57:50 +08:00
EthanDeng
ada05e3415 typo 2019-11-09 17:57:50 +08:00
EthanDeng
fc1c639248 change px to bp 2019-11-09 17:57:50 +08:00
EthanDeng
ad68db6337 remove pdf 2019-11-09 17:57:50 +08:00
EthanDeng
39c6d631ae remove pdf 2019-11-09 17:57:50 +08:00
EthanDeng
91d5839af2 add device option pad 2019-11-09 17:57:50 +08:00
EthanDeng
6018efc5d6 add introduction environment 2019-11-09 17:57:50 +08:00
EthanDeng
824977a888 remove the warnings 2019-11-09 17:57:50 +08:00
EthanDeng
774825f729 convert url 2019-11-09 17:57:50 +08:00
EthanDeng
811acb3660 add QQ Group info 2019-11-09 17:57:50 +08:00
EthanDeng
6c077e8c2d space 2019-11-09 17:57:50 +08:00
EthanDeng
ebaae39f46 elegantbook 3.07 2019-11-09 17:57:49 +08:00
EthanDeng
e2a72bc70c elegantbook 3.07 2019-11-09 17:57:49 +08:00
EthanDeng
d9c7afb6ba theorem modification complete 2019-11-09 17:57:49 +08:00
EthanDeng
73486a8e88 typo 2019-11-09 17:57:49 +08:00
EthanDeng
ebd4909a8d add custom environment 2019-11-09 17:57:49 +08:00
EthanDeng
9865cbb9f6 add convert method from elegantbook 2.x to elegantbook 3.x 2019-11-09 17:57:49 +08:00
EthanDeng
8508d62b62 remove medskip 2019-11-09 17:57:49 +08:00
EthanDeng
99958b31cf update 3.07(pending) 2019-11-09 17:57:49 +08:00
EthanDeng
c6a2863ca1 change the logo/cover 2019-11-09 17:57:49 +08:00
EthanDeng
83732ec957 auto merge by git 2019-11-09 17:57:49 +08:00
17 changed files with 2701 additions and 2136 deletions

2
.gitignore vendored
View File

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

34
README-CN.md Normal file
View File

@@ -0,0 +1,34 @@
<!-- Author : Dongsheng Deng & Liam Huang-->
<!-- Program Email: elegantlatex2e@gmail.com -->
[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)
---
# ElegantBook 优美的 LaTeX 书籍模板
ElegantBook 是为 LaTeX 书籍写作而设计的模板,由 [Dongsheng Deng](https://ddswhu.me/) 和 [Liam Huang](https://liam.page/) 创立,模板创立的初衷是方便我们自己做笔记 :smile:。如果你有其他问题、建议或者报告 bug可以提交 issues 或者给我们发邮件elegantlatex2e@gmail.com。QQ 用户交流群692108391欢迎加入。
## 重要提示
**重要提示**ElegantLaTeX 项目 **不接受** 任何非预授权的提交pull requests
## 致谢
特别感谢 [sikouhjw](https://github.com/sikouhjw) 长期以来对于 Github 上 issue 的快速回应,以及各个社区论坛对于 ElegantLaTeX 相关问题的回复。
特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。
如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。
## 协议
本模板发布遵循 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 模板。

View File

@@ -1,80 +1,34 @@
<!-- Author : Dongsheng Deng & Liam Huang-->
<!-- Program Email: elegantlatex2e@gmail.com -->
# ElegantBook: An Elegant LaTeX Template for Books
[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 用户交流群692108391欢迎加入。
# 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.
**Version Note** Users for 2.x, please refer to [Version Convert](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert).
## Important Notes
**版本提醒:** 由于新版本进行了重构,并且 3.6 版本对于封面进行了改版3.6 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.6 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。
For some reasons, __unauthorized__ 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.
**Important Info** 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.
## Acknowledgement
**重要提示出于某些因素的考虑ElegantLaTeX 项目自 2019 年 5 月 20 日开始不再接受任何非作者预约性质的提交pull request)!如果你想改进模板,你可以给我们提交 issue或者可以在遵循协议的情况下克隆到自己仓库下进行修改**
Thank [sikouhjw](https://github.com/sikouhjw) for his quick response to Github issues and continuously support work for ElegantLaTeX.
Thank ChinaTeX and [LaTeX Studio](http://www.latexstudio.net/) for their promotion.
## Acknowledgement 致谢
The number of stars on Github for ElegantBook reached 100 on May 20, 2019.
2019 年 5 月 20 日ElegantBook 模板在 Github 上的 Star 数达到了 100这对于 ElegantLaTeX 系列模板是一个非常重要的里程碑!
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. Thank [muzimuzhi](https://github.com/muzimuzhi) for the revision of the template.
在此特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。LaTeX 工作室网站上有很多精彩的帖子和精致的模板,欢迎大家去挖掘里面的宝藏。这也是我所见到的国内最全面的 LaTeX 相关的网站。特别感谢 [muzimuzhi](https://github.com/muzimuzhi) 对于模板的完善。
If you like our template, star on Github.
如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。
## 捐赠
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... )
如果您非常喜爱我们的模板或者我,你还可以选择捐赠以表达您对我们模板和我的支持。本模板自 3.08 版本发布了捐赠信息之后,收到了近千元的捐赠(四舍五入就是一个亿),非常感谢!
![](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!
**赞赏费用的使用解释权归 ElegantLaTeX 所有,并且不接受监督,请自愿理性打赏**。10 元以上的赞赏,我们将列入捐赠榜,谢谢各位金主!
| 捐赠者/Tipper | 金额/Amount | 时间/Date | 渠道/Channel |
| :------: | :----: | :----: | :------: |
| Lerh | 10 RMB | 2019/05/15 | 微信/Wechat |
| 越过地平线 | 10 RMB | 2019/05/15 | 微信/Wechat |
| 大熊 | 20 RMB | 2019/05/27 | 微信/Wechat |
| 佚名 | 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 |
| 佚名 | 10 RMB | 2019/07/23 | 微信/Wechat |
Thank you all.
再次感谢大家对于模板的喜爱!
## License 协议
## License
This work is released under the LaTeX Project Public License, v1.3c or later.
本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。如果是衍生作品请务必加入协议声明和模板信息github、CTAN 地址)。
## Derived Works 衍生与拓展开发
## Derivative Works
+ [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 模板。
+ [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).

View File

@@ -1,5 +0,0 @@
@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,26 +1,31 @@
\documentclass[fancy,11pt,twocol]{elegantbook}
\documentclass[11pt,fancy]{elegantbook}
\title{An Elegant \LaTeX{} Template for Books}
\subtitle{Classic Elegant\LaTeX{} Template}
\author{Ethan Deng \& Liam Huang}
\institute{Elegant\LaTeX{} Program}
\date{\today}
\version{3.09}
\date{March 8, 2022}
\version{4.2}
\bioinfo{Bio}{Information}
\extrainfo{Victory won\rq t come to us unless we go to it. }
\logo{logo.png}
\logo{logo-blue.png}
\cover{cover.jpg}
\definecolor{customcolor}{RGB}{32,178,170}
\colorlet{coverlinecolor}{customcolor}
\begin{document}
\maketitle
\frontmatter
\tableofcontents
\clearpage
\thispagestyle{empty}
\mainmatter
\hypersetup{pageanchor=true}
\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}.
@@ -28,133 +33,91 @@ Elegant\LaTeX{} Program developers are intended to provide you beautiful, elegan
Contact Infos:
\begin{itemize}
\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 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 Weibo: ElegantLaTeX
\item Wechat: ElegantLaTeX
\item Weibo: Elegant\LaTeX{}
\item Wechat: Elegant\LaTeX{}
\item QQ: 692108391
\item Email: \email{elegantlatex2e@gmail.com}
\end{itemize}
\section{ElegantBook Updates}
What\rq s new in this version:
\begin{enumerate}
\item Remove \lstinline|\elegantpar|;
\item Fix math symbol font settings;
\item Introduce option \lstinline|twocol| for toc;
\item Revise footnote layout;
\item Other modifications.
\end{enumerate}
\begin{note}
Users for 2.x, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{conversion}.
\end{note}
\section{ElegantBook Updates}
Version 4.2 is the \textit{temporary} version before v4.3 which will be released when \TeX Live 2022 is ready, we add quick bug fix caused by newtx package updates, and multilingual translation \lstinline{lang=jp}. What\rq s new in this version:
\begin{change}
\item Bug fix due to the update of newtx fonts;
\item Add `Chapter' in TOC, and redefine \lstinline{\chaptername} to unify the logic under different languages;
\item Add language option for Japanese, \lstinline{lang=jp}.
\item \textbf{! Warnings}: Due to this `urgent' fonts bug and TOC modification, the multilingual option may cause some unexpected errors, you can report in this \href{https://github.com/ElegantLaTeX/ElegantBook/issues/170}{issue}, I will fix it after the releases of \TeX{} Live 2022.
\end{change}
\section{Installation and Update}
Both portable version and installation package are available for this template.
Both portable version and installation package are available, online usage is optional as well.
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 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}.
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{remark}
On Overleaf, please use \hologo{XeLaTeX} to compile articles in Chinese and \hologo{pdfLaTeX} to compile articles in English.
\end{remark}
\begin{figure}[htbp]
\centering
\includegraphics[width=0.7\textwidth]{tlshell.png}
\caption{Use \TeX{} Live Shell to Install ElegantBook Template}
\end{figure}
\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.
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{}.
\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.
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.
Use the following commands(administrator privileges) to update:
\begin{lstlisting}
tlmgr update --self
tlmgr update --all
\end{lstlisting}
\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.
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?}
\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.
\centerline{\textcolor{red}{\bfseries Wanted!}}
\subsection{Other Release Versions}
If you are a \TeX{} Live 2018/2019/2020 user and would like to update, the official solution is to uninstall the previous version. If you want to save the bother of uninstallation and re-installation, please copy \lstinline{elegantbook.cls} to the installation directory of \TeX{} Live 2021 (default: \lstinline|C:\texlive\2021\texmf-dist\tex\latex\elegantbook| ), run \lstinline{texhash} in cmd.
\section{About Pull Request}
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.
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.
\section{Recruit Support Members}
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:
\begin{itemize}
\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 QQ Group Manager: \href{https://github.com/sikouhjw}{Sikouhjw}.
\end{itemize}
\section{Acknowledgement}
The number of stars on Github for ElegantBook reached 100 on May 20, 2019\footnote{189 stars by August 18, 2019!}.
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 \href{https://github.com/muzimuzhi}{muzimuzhi} for the revision of the template.
If you like our template, star on Github.
\begin{figure}[!ht]
\centering
\includegraphics[width=\textwidth]{star.png}
\caption{Twinkle, Twinkle, Little Star}
\end{figure}
\begin{figure}[!ht]
\centering
\includegraphics[width=0.618\textwidth]{star-history.png}
\caption{Github Star Trends for Elegant\LaTeX{} (by week)}
\end{figure}
\section{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... )
\begin{figure}[!htbp]
\centering
\includegraphics[width=0.45\textwidth]{donate.jpg}
\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!
\begin{table}[!h]
\centering
\caption{Donation List}
\begin{tabular}{cccc}
\toprule
Tipper & Amount & Date & Channel \\
\midrule
Lerh & 10 RMB & 2019/05/15 & Wechat \\
Yueguodipingxian & 10 RMB & 2019/05/15 & Wechat \\
Dapeng & 20 RMB & 2019/05/27 & Wechat\\
Anonymous & 10 RMB & 2019/05/30 & Wechat \\
\href{http://www.latexstudio.net/}{latexstudio.net} & 666 RMB & 2019/06/05 & Alipay \\
Cassis & 11 RMB & 2019/06/30 & Wechat \\
Anonymous & 10 RMB & 2019/07/23 & Wechat \\
\bottomrule
\end{tabular}%
\end{table}%
\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 \lstinline{PDFLaTeX} or \lstinline{XeLaTeX} works fine.
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 2021, either \hologo{pdfLaTeX} or \hologo{XeLaTeX} works fine. \hologo{XeLaTeX} is preferred for Chinese articles.
\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 basic values, \lstinline{lang=en} (default) , \lstinline{lang=cn}. Different values will alter the captions of figure/table, abstract name, refname, etc. You can use this option as
\begin{lstlisting}
\documentclass[en]{elegantbook}
\documentclass[lang=en]{elegantbook}
\end{lstlisting}
Besides the two basic language translation, our user provide more options, here is a short brief introduction to these translation. Since I am not familiar with these languages, I can't guarantee that the translations are correct, please comment on GitHub if you have some questions.
\begin{itemize}
\item Italian translation \lstinline{lang=it}, provided by \href{https://github.com/VincentMVV}{VincentMVV} , please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/85}{Italian translation};
\item French translation \lstinline{lang=fr}, provided by \href{https://github.com/abfek66}{abfek66} , please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/85}{Italian translation};
\item Dutch Translation \lstinline{lang=nl}, provided by \href{https://github.com/inktvis75}{inktvis75} , please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/108}{Dutch Translation};
\item Hungarian translation \lstinline{lang=hu}, provided by \href{https://github.com/palkotamas}{palkotamas}, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/111}{Hungarian translation};
\item Deutsch translation \lstinline{lang=de}, provided by Lisa, please refer to\href{https://github.com/ElegantLaTeX/ElegantBook/issues/113}{Deutsch translation};
\item Spanish translation \lstinline{lang=es}, provided by Gustavo A. Corradi, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/133}{Spanish translation};
\item Mongolian translation \lstinline{lang=mn}, provided by \href{https://github.com/Altantsooj}{Altantsooj}, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/137}{Mongolian translation}.
\end{itemize}
\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 \lstinline{XeLaTeX} to compile.
Chinese Characters are acceptable \textbf{ONLY} in \lstinline{lang=cn}.
\end{remark}
\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}
\documentclass[pad]{elegantbook} %or
\documentclass[device=pad]{elegantbook}
@@ -216,16 +179,52 @@ If you want to customize the colors, please select \lstinline{nocolor} or use \l
\definecolor{third}{RGB}{0,174,247}%
\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}
You can change the color of the horizontal bar of the cover by
\begin{lstlisting}
\definecolor{customcolor}{RGB}{32,178,170}
\colorlet{coverlinecolor}{customcolor}
\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}
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
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:
\begin{lstlisting}
\documentclass[hang]{elegantbook} %or
\documentclass[titlestyle=hang]{elegantbook}
\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
\begin{lstlisting}
@@ -244,19 +243,30 @@ In this template, we defined four different theorem class environments
\end{itemize}
\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{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.
\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.
\end{itemize}
\subsection{Theorem Class Environments}
Since the template uses the \lstinline{tcolorbox} package to customize the theorem class environments, it is slightly different from the normal theorem environments. The usage is as follows:
\begin{lstlisting}
\begin{theorem}{<theorem name>}{<label>}
\begin{theorem}{theorem name}{label text}
The content of theorem.
\end{theorem}
\end{lstlisting}
The first parameter \lstinline{<theorem name>} represents the name of the theorem, and the second parameter \lstinline{label} represents the label used in cross-reference with \verb|ref{thm:label}|. Note that cross-references must be prefixed with \lstinline{thm:}.
From version 4.1, you can write your theorem environments as follows:
\begin{lstlisting}
\begin{theorem}[theorem name]\label{thm:label text}
The content of theorem.
\end{theorem}
% or
\begin{theorem}
The content of theorem.
\end{theorem}
\end{lstlisting}
Other theorem class environments with the same usage includes:
\begin{table}[htbp]
@@ -296,22 +306,9 @@ These are all similar environments with slight differences lies in:
\begin{itemize}
\item Example, exercise, problem environments number within chapter;
\item Note begins with introductory symbol and proof ends with ending symbol;
\item Conclusion environment and so on are normal paragraph environments with boldfaced introductory words.
\item Conclusion and other environments are normal paragraph environments with boldfaced introductory words.
\end{itemize}
\section{Base Hide Option}
Hiding the end-of-chapter and end-of-page base is optional, simply type in:
\begin{lstlisting}
\documentclass[hide]{elegantbook} %or
\documentclass[base=hide]{elegantbook}
\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.fotor.com/cn}{fotor.com}. Feel free to join our QQ Group to get more elegant covers.
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}
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]
@@ -344,36 +341,84 @@ This template uses \lstinline{tikz} to customize the list environments, with \ls
\end{enumerate}
\end{minipage}
\section{Bibliography}
This template uses \hologo{BibTeX} to generate the bibliography, the default bibliography style is \lstinline{aer}. Let's take a glance at the citation effect. ~\cite{en1} use data from a major peer-to-peer lending marketplace in China to study whether female and male investors evaluate loan performance differently.
\section{Fonts}
\textcolor{red}{\bfseries Alert} After v3.10, newtx is reset to cm, together with other two options, the \lstinline{math} font option offers:
\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}
If you want to use \hologo{BibTeX}, you must create a file named \lstinline{reference.bib}, add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to \lstinline{reference.bib} file, then cite the bibkey in the \lstinline{tex} file. The Bib\TeX{} will automatically generate the bibliography for the reference you cited. If you want to add some noncited reference to the bibliography, you can use
\begin{lstlisting}[frame=single]
\nocite{EINAV2010,Havrylchyk2018} %or include some bibitems
\nocite{*} %include all the bibitems
If you use \lstinline{newtx} fonts, type in:
\begin{lstlisting}
\documentclass[math=newtx]{elegantbook}
\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:
When you are using \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}
\documentclass[cite=super]{elegantbook} % set cite for super style
\documentclass[super]{elegantbook}
\documentclass[cite=authoryear]{elegantbook} % set cite for author-year style
\documentclass[authoryear]{elegantbook}
\begin{equation}
\int_{R^q} f(x,y) dy.\emph{of \kern0pt f}
\end{equation}
\end{lstlisting}
\subsection{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}
\section{Bibliography}
This template uses biblatex to generate the bibliography, the default citestyle and bibliography style are both \lstinline{numeric}. Let's take a glance at the citation effect. ~\cite{en1} use data from a major peer-to-peer lending \cite{en3} marketplace in China to study whether female and male investors evaluate loan performance differently \parencite{en2}.
If you want to use biblatex, you must create a file named \lstinline{reference.bib}, add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to \lstinline{reference.bib} file, then cite the bibkey in the \lstinline{tex} file. The biber will automatically generate the bibliography for the reference you cited.
To change the bibliography style, this version introduces \lstinline{citestyle} and \lstinline{bibstyle}, please refer to \href{https://ctan.org/pkg/biblatex}{CTAN:biblatex} for more detail about these options. You can change your bibliography style as
\begin{lstlisting}
\documentclass[citestyle=numeric-comp, bibstyle=authoryear]{elegantbook}
\end{lstlisting}
\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:
\begin{lstlisting}
\chapter*{Preface}
\addcontentsline{toc}{chapter}{Preface}
\markboth{Preface}{}
The content of Preface.
\chapter*{Introduction}
\markboth{Introduction}{Introduction}
The content of introduction.
\end{lstlisting}
\section{Content Option and Depth}
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 to use \lstinline|\setcounter{tocdepth}{2}|.
\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{introduction}
\item Definition of Theorem
@@ -383,7 +428,7 @@ We create a introduction environment to display the structure of chapter. The ba
\item Angle of Corner
\end{introduction}
\end{lstlisting}
you will get:
And you will get:
\begin{introduction}
\item Definition of Theorem
\item Ask for help
@@ -399,7 +444,7 @@ You can change the title of this environment by modifying the optional argument
\end{introduction}
\end{lstlisting}
\section{Problem Set}
%\section{Problem Set}
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{problemset}
@@ -413,16 +458,23 @@ And you will get:
\item exercise 1
\item exercise 2
\item exercise 3
\item math equation test:
\begin{equation}
a^2+b^2=c_{2_{i}} (1,2) [1,23]
\end{equation}
\end{problemset}
\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.
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{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
@@ -458,37 +510,6 @@ For tables and figures, note that floating environment is not allowed. You have
\end{remark}
\section{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}
@@ -510,7 +531,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$.
\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$
\end{definition}
@@ -520,14 +541,15 @@ Note that a subgroup~$H$ of a group $G$ is itself a left coset of $H$ in $G$.
\lipsum[2]
\begin{theorem}{Lagrange's Theorem}{}
\begin{theorem}[Lagrange's Theorem] \label{thm:lg}
Let $G$ be a finite group, and let $H$ be a subgroup of $G$. Then the order of $H$ divides the order of $G$.
\end{theorem}
\ref{thm:lg}
\lipsum[3]
\begin{proposition}{Size of Left Coset}{}
\begin{proposition}[Size of Left Coset]
Let $H$ be a finite subgroup of a group $G$. Then each left coset of $H$ in $G$ has the same number of elements as $H$.
\end{proposition}
@@ -537,7 +559,7 @@ Let $z$ be some element of $xH \cap yH$. Then $z = xa$ for some $a \in H$, and
\begin{figure}[htbp]
\centering
\includegraphics[width=0.6\textwidth]{scatter.pdf}
\includegraphics[width=0.6\textwidth]{scatter.jpg}
\caption{Matplotlib: Scatter Plot Example\label{fig:scatter}}
\end{figure}
@@ -545,6 +567,10 @@ Regression analysis is a powerful statistical method that allows you to examine
Let's continue using our application training example. In this case, we'd want to measure the historical levels of satisfaction with the events from the past three years or so, as well as any information possible in regards to the independent variables.
\section{Second section}
This second section\index{S!section} may include some special word,
and expand the ones already used\index{keywords!used}.
\begin{table}[htbp]
\small
@@ -580,90 +606,102 @@ Let's continue using our application training example. In this case, we'd want t
\item Distributed storage and search.
\end{itemize}
%\problemset
\begin{problemset}
\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$.
\end{problemset}
\chapter{FAQ}
\begin{custom}{Question}
I want to customize font and background color.
\end{custom}
\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.
\end{solution}
\begin{custom}{Question}
\lstinline[breaklines]{Package ctex Error: CTeX fontset `Mac' is unavailable.}
\end{custom}
\begin{solution}
Under Mac, please use \lstinline{XeLaTeX} for Chinese documents.
\end{solution}
\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}
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 2021.
\item \question{Which editor should I choose?}
You can use \TeX{} Live 2021 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2021 + \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.
\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}
\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.
\end{solution}
\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}, no plan for Beamer theme.
\end{enumerate}
\chapter{Version History}
We revised our templates now and then. This section shows the version story of ElegantBook. We have nearly 100 submits and 17 releases on GitHub since uploaded.
\datechange{2022/03/08}{release of v4.2.}
\begin{change}
\item Bug fix due to the update of newtx fonts;
\item Add `Chapter' in TOC, and redefine \lstinline{\chaptername} to unify the logic under different languages;
\item Add language option for Japanese, \lstinline{lang=jp}.
\item \textbf{! Warnings}: Due to this `urgent' fonts bug and TOC modification, the multilingual option may cause some unexpected errors, you can report in this \href{https://github.com/ElegantLaTeX/ElegantBook/issues/170}{issue}, I will fix it after the releases of \TeX{} Live 2022.
\end{change}
\begin{custom}{Question}
Is the language for code highlighting optional?
\end{custom}
\datechange{2021/05/02}{release of v4.1.}
\begin{solution}
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.
\end{solution}
\begin{change}
\item \textbf{! Big Change}: Change the bibliography method from \hologo{BibTeX} to biblatex(with backend \lstinline{biber});
\item \textbf{! Big Change}: Add support for the default theorem writing method (with optional name and label);
\item Add left and right space;
\item Support hyperlink from the text of TOC;
\item Remove the \hologo{pdfLaTeX} compatiblity check for Chinese.
\item Add multilingual support, for french \lstinline{lang=fr}, dutch \lstinline{lang=nl}, Hungarian \lstinline{lang=hu}, Spanish \lstinline{lang=es}, Mongolian \lstinline{lang=mn} etc.
\end{change}
\datechange{2020/04/12}{release of v3.11, \textcolor{red}{\textbf{LAST} version of 3.x}.}
\nocite{en1,en2,en3}
\bibliography{reference}
\begin{change}
\item \textbf{! Fix}: Fix \lstinline{natbib option clash} problems caused by \lstinline{gbt7714} updates.
\item Remove \lstinline{base} decorations and its options since \lstinline{pgfornament} package is not included in \TeX{} Live 2020.
\item Fix spacing problem in some environments.
\item Introduce language option for Italian, \lstinline{lang=it}.
\end{change}
\datechange{2020/02/10}{release of v3.10}
\begin{change}
\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{en2,en3}
\printbibliography[heading=bibintoc, title=\ebibname]
\appendix
% \renewcommand\chaptername{\eappendix \thechapter}
\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.
@@ -676,36 +714,5 @@ 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
\end{equation}
\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

BIN
figure/logo-blue.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

BIN
image/cert.pdf Normal file

Binary file not shown.

BIN
image/founder.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

BIN
image/scatter.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

View File

@@ -1,27 +0,0 @@
# This file is the source file of the scatter.pdf
# source page: https://matplotlib.org/gallery/shapes_and_collections/scatter.html
import numpy as np
import matplotlib.pyplot as plt
# Fixing random state for reproducibility
np.random.seed(19680801)
N = 50
x = np.random.rand(N)
y = np.random.rand(N)
colors = np.random.rand(N)
area = (30 * np.random.rand(N))**2 # 0 to 15 point radii
ax = plt.subplot(111)
ax.scatter(x, y, s=area, c=colors, alpha=0.5)
# Hide the right and top spines
ax.spines['right'].set_visible(False)
ax.spines['top'].set_visible(False)
# Only show ticks on the left and bottom spines
ax.yaxis.set_ticks_position('left')
ax.xaxis.set_ticks_position('bottom')
plt.savefig('scatter.pdf', transparent=True)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 218 KiB