Compare commits
53 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ae0d420e49 | ||
|
|
01e6a24a0b | ||
|
|
e906ec3586 | ||
|
|
fd709816b3 | ||
|
|
954f131754 | ||
|
|
66768a40a1 | ||
|
|
b3d038fc3e | ||
|
|
6bc99600ee | ||
|
|
2b34f39630 | ||
|
|
70567a1663 | ||
|
|
4118a1e4e5 | ||
|
|
72e63e3f0c | ||
|
|
64757b063e | ||
|
|
65244411b8 | ||
|
|
620939087f | ||
|
|
ed204e06ed | ||
|
|
9c8cdbef97 | ||
|
|
6e9eebf70f | ||
|
|
5357c7e0f0 | ||
|
|
46e892e098 | ||
|
|
6f642ae8bf | ||
|
|
807841afb1 | ||
|
|
312aee23c0 | ||
|
|
f2b772505e | ||
|
|
177453468b | ||
|
|
0e5fd1f813 | ||
|
|
0b421561cf | ||
|
|
e4e166946b | ||
|
|
0752a76fd5 | ||
|
|
e4371c7bf3 | ||
|
|
77ac771ad1 | ||
|
|
5f024a8e5b | ||
|
|
fbb6a6f124 | ||
|
|
61d54173fb | ||
|
|
7e0a8f1015 | ||
|
|
f93ad428c0 | ||
|
|
0171d1836f | ||
|
|
fb33d093fb | ||
|
|
2530dc26f4 | ||
|
|
6575c773be | ||
|
|
ef71af7bee | ||
|
|
c9f9ddcfb8 | ||
|
|
4733c40279 | ||
|
|
8dd28f18c7 | ||
|
|
75e407bd63 | ||
|
|
c1b4a2ad23 | ||
|
|
5772ce6253 | ||
|
|
41fd2cb8df | ||
|
|
f970cb422f | ||
|
|
13d0d93a83 | ||
|
|
6a6c17519d | ||
|
|
83735a3b70 | ||
|
|
f7cfd8243a |
3
.gitignore
vendored
@@ -11,11 +11,8 @@
|
|||||||
*.cb
|
*.cb
|
||||||
*.cb2
|
*.cb2
|
||||||
.*.lb
|
.*.lb
|
||||||
.DS_Store
|
|
||||||
clean.bat
|
|
||||||
elegant*-cn.pdf
|
elegant*-cn.pdf
|
||||||
elegant*-en.pdf
|
elegant*-en.pdf
|
||||||
*.dates
|
|
||||||
|
|
||||||
## Intermediate documents:
|
## Intermediate documents:
|
||||||
*.dvi
|
*.dvi
|
||||||
|
|||||||
69
README.md
@@ -1,36 +1,79 @@
|
|||||||
<!-- Author : Dongsheng Deng & Liam Huang-->
|
<!-- Author : Dongsheng Deng & Liam Huang-->
|
||||||
<!-- Program Email: elegantlatex2e@gmail.com -->
|
<!-- 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) |
|
# 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)
|
||||||
|
|
||||||
-------
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
# ElegantBook: 优美的 LaTeX 书籍模板 An Elegant LaTeX Template for Books
|
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 书籍写作而设计的模板,由 [Ethan Deng](https://github.com/EthanDeng) 和 [Liam Huang](https://github.com/Liam0205) 创立,现在主要由 [Ethan Deng](https://github.com/EthanDeng)、[乙醇](https://github.com/syvshc)和[死抠](https://github.com/sikouhjw)维护。如果你有其他问题、建议或者报告 bug,可以提交 issues 或者加入我们的 QQ 用户交流群:692108391。
|
ElegantBook 是为 LaTeX 书籍写作而设计的模板,如果你有其他问题、建议或者报告 bug,可以提交 issues 或者给我们发邮件:elegantlatex2e@gmail.com。QQ 用户交流群:692108391,欢迎加入。
|
||||||
|
|
||||||
ElegantBook is designed for writing books, created by [Ethan Deng](https://github.com/EthanDeng) and [Liam Huang](https://github.com/Liam0205), and maintained by [Ethan Deng](https://github.com/EthanDeng), [syvshc](https://github.com/syvshc) and [sikouhjw](https://github.com/sikouhjw). 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).
|
||||||
|
|
||||||
|
**版本提醒:** 由于新版本进行了重构,并且 3.6 版本对于封面进行了改版,3.6 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.6 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
**重要提示:出于某些因素的考虑,ElegantLaTeX 项目自 2019 年 5 月 20 日开始,不再接受任何非作者预约性质的提交(pull request)!如果你想改进模板,你可以给我们提交 issue,或者可以在遵循协议的情况下,克隆到自己仓库下进行修改**。
|
||||||
|
|
||||||
|
|
||||||
## 致谢 Acknowledgement
|
|
||||||
|
## 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 上收藏我们的模板。
|
||||||
|
|
||||||
|
|
||||||
特别感谢 [sikouhjw](https://github.com/sikouhjw) 和 [syvshc](https://github.com/syvshc) 长期以来对于 Github 上 issue 的快速回应,以及各个社区论坛对于 ElegantLaTeX 相关问题的回复。特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。
|
## 捐赠
|
||||||
|
|
||||||
Thank [sikouhjw](https://github.com/sikouhjw) and [syvshc](https://github.com/syvshc) for their quick response to Github issues and continuously support work for ElegantLaTeX community. Thank ChinaTeX and [LaTeX Studio](http://www.latexstudio.net/) for their promotion.
|
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 版本发布了捐赠信息之后,收到了近千元的捐赠(四舍五入就是一个亿),非常感谢!
|
||||||
|
|
||||||
## 协议 License
|

|
||||||
|
|
||||||
本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。
|
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!
|
||||||
如果是衍生作品,请务必加入协议声明和模板信息(github、CTAN 地址)。
|
|
||||||
|
**赞赏费用的使用解释权归 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 协议
|
||||||
|
|
||||||
This work is released under the LaTeX Project Public License, v1.3c or later.
|
This work is released under the LaTeX Project Public License, v1.3c or later.
|
||||||
|
|
||||||
|
本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。如果是衍生作品,请务必加入协议声明和模板信息(github、CTAN 地址)。
|
||||||
|
|
||||||
## 衍生品 Derivative Works
|
## Derived Works 衍生与拓展开发
|
||||||
|
|
||||||
+ [ElegantBookdown](https://github.com/XiangyunHuang/ElegantBookdown):[XiangyunHuang](https://github.com/XiangyunHuang) 开发并维护的基于 ElegantBook 的 Bookdown 模板。
|
+ [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 做了字体适配。
|
+ [bookdownplus](https://github.com/pzhaonet/bookdownplus):应网友要求,[pzhaonet](https://github.com/pzhaonet) 在 bookdownplus 收录了 ElegantPaper 模板,并为 Mac 做了字体适配。
|
||||||
|
|||||||
5
delete-temp-files.bat
Normal 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
|
||||||
1091
elegantbook-cn.tex
@@ -1,103 +1,167 @@
|
|||||||
\documentclass[11pt]{elegantbook}
|
\documentclass[fancy,11pt,twocol]{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{Aug 15, 2022}
|
\date{\today}
|
||||||
\version{4.4}
|
\version{3.09}
|
||||||
\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}
|
||||||
|
|
||||||
% modify the color in the middle of titlepage
|
|
||||||
\definecolor{customcolor}{RGB}{32,178,170}
|
|
||||||
\colorlet{coverlinecolor}{customcolor}
|
|
||||||
\usepackage{cprotect}
|
|
||||||
|
|
||||||
\addbibresource[location=local]{reference.bib} % bib
|
|
||||||
|
|
||||||
\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 GitHub: \href{https://github.com/ElegantLaTeX/}{https://github.com/ElegantLaTeX/}
|
\item Homepage: \href{https://elegantlatex.org/}{https://elegantlatex.org/}
|
||||||
|
\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 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: ElegantLaTeX
|
||||||
|
\item Wechat: ElegantLaTeX
|
||||||
|
\item QQ: 692108391
|
||||||
|
\item Email: \email{elegantlatex2e@gmail.com}
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
|
|
||||||
\section{Online Usage}
|
\section{ElegantBook Updates}
|
||||||
You can 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}.
|
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{Portable Version}
|
\section{Installation and Update}
|
||||||
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.
|
Both portable version and installation package are available for this template.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
\section{Update Templates}
|
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.
|
||||||
You can use cmd/terminal to update the tlmgr itself and all the packages, the commands are:
|
|
||||||
\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?}
|
\begin{figure}[htbp]
|
||||||
|
\centering
|
||||||
|
\includegraphics[width=0.7\textwidth]{tlshell.png}
|
||||||
|
\caption{Use \TeX{} Live Shell to Install ElegantBook Template}
|
||||||
|
\end{figure}
|
||||||
|
|
||||||
\section{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/2019/2020/2021 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 2022 (default: \lstinline|C:\texlive\2022\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{}.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
\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}
|
||||||
|
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!}}
|
||||||
|
|
||||||
|
\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.
|
||||||
|
|
||||||
|
\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}
|
\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 environments are Win10/Ubuntu 20.04/macOS + \TeX{} Live 2022/ Mac\TeX{} 2022, either \hologo{pdfLaTeX} or \hologo{XeLaTeX} works fine for \lstinline{lang=en}.
|
|
||||||
|
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.
|
||||||
|
|
||||||
\section{Languages}
|
\section{Languages}
|
||||||
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
|
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
|
||||||
|
|
||||||
\begin{lstlisting}
|
\begin{lstlisting}
|
||||||
\documentclass[en]{elegantbook}
|
\documentclass[en]{elegantbook}
|
||||||
\documentclass[lang=en]{elegantbook}
|
\documentclass[lang=en]{elegantbook}
|
||||||
\end{lstlisting}
|
\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};
|
|
||||||
\item Japanese translation \lstinline{lang=jp}, provided by \href{https://github.com/inusturbo}{inusturbo}, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/issues/172}{Japanese translation}.
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\begin{remark}
|
\begin{remark}
|
||||||
Chinese Characters are acceptable \textbf{ONLY} in \lstinline{lang=cn}.
|
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}
|
||||||
\end{lstlisting}
|
\end{lstlisting}
|
||||||
|
|
||||||
\section{Color Themes}
|
\section{Color Themes}
|
||||||
This template contains 5 color themes, i.e., \textcolor{structure1}{\lstinline{green}}\footnote{Original default theme.}, \textcolor{structure2}{\lstinline{cyan}}, \textcolor{structure3}{\lstinline{blue}}(default), \textcolor{structure4}{\lstinline{gray}}, \textcolor{structure5}{\lstinline{black}}. You can choose \lstinline{green} with
|
This template contains 5 color themes, i.e. \textcolor{structure1}{\lstinline{green}}\footnote{Original default theme.}, \textcolor{structure2}{\lstinline{cyan}}, \textcolor{structure3}{\lstinline{blue}}(default), \textcolor{structure4}{\lstinline{gray}}, \textcolor{structure5}{\lstinline{black}}. You can choose \lstinline{green} with
|
||||||
\begin{lstlisting}
|
\begin{lstlisting}
|
||||||
\documentclass[green]{elegantbook} %or
|
\documentclass[green]{elegantbook} %or
|
||||||
\documentclass[color=green]{elegantbook}
|
\documentclass[color=green]{elegantbook}
|
||||||
@@ -152,52 +216,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}
|
|
||||||
|
|
||||||
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}
|
\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}
|
||||||
@@ -208,107 +236,45 @@ We defined two sets of theorem modes, \lstinline{simple} style and \lstinline{fa
|
|||||||
In this template, we defined four different theorem class environments
|
In this template, we defined four different theorem class environments
|
||||||
|
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item \textit{Theorem Environments}, including title and content, numbering corresponding to chapter. Three types depending on the format:
|
\item \textit{Theorem Environment}, including title and content, numbering corresponding to chapter. Three types depending on the format:
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item \textcolor{main}{\textbf{definition}} environment, the color is \textcolor{main}{main};
|
\item \textcolor{main}{\textbf{definition}} environment, the color is \textcolor{main}{main};
|
||||||
\item \textcolor{second}{\textbf{theorem, lemma, corollary, axiom, postulate}} 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 Environment}, including \textbf{example, exercise, problem} environment, auto numbering according 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 Environment}, 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}
|
||||||
|
|
||||||
All of theorem environments have star versions: \textcolor{main}{\textbf{definition*}}, \textcolor{second}{\textbf{theorem*}}, \textcolor{second}{\textbf{lemma*}}, \textcolor{second}{\textbf{corollary*}}, \textcolor{second}{\textbf{axiom*}}, \textcolor{second}{\textbf{postulate*}}, \textcolor{third}{\textbf{proposition*}}. Environments with an asterisk are not numbered.
|
|
||||||
|
|
||||||
\subsection{Theorem Class Environments}
|
\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:
|
||||||
\subsubsection{\lstinline{fancy} mode}
|
|
||||||
|
|
||||||
In \lstinline{fancy} mode, 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{lstlisting}
|
||||||
% name + label
|
\begin{theorem}{<theorem name>}{<label>}
|
||||||
\begin{theorem}{theorem name}{label}
|
The content of theorem.
|
||||||
The content of a theorem with name and label.
|
\end{theorem}
|
||||||
Use \ref{thm:label} to refer this theorem.
|
\end{lstlisting}
|
||||||
\end{theorem}
|
|
||||||
% no name + label
|
|
||||||
\begin{theorem}{}{label no name}
|
|
||||||
The content of a theorem without name.
|
|
||||||
Use \ref{thm:label no name} to refer this theorem.
|
|
||||||
\end{theorem}
|
|
||||||
% name + no label
|
|
||||||
\begin{theorem}{theorem name}{}
|
|
||||||
The content of a theorem without label.
|
|
||||||
Can't refer this theorem.
|
|
||||||
The last {} can be removed.
|
|
||||||
\end{theorem}
|
|
||||||
% no name + no label
|
|
||||||
\begin{theorem}{}{}
|
|
||||||
The content of a theorem without name and label.
|
|
||||||
Can't refer this theorem.
|
|
||||||
Both of {} can be removed.
|
|
||||||
\end{theorem}
|
|
||||||
\end{lstlisting}
|
|
||||||
|
|
||||||
The first parameter \lstinline{theorem name} represents the name of the theorem. If the current theorem has no name, please use \lstinline|{}|\cprotect\footnote{Unless this theorem has neither no label, you should not omit this \verb|{}|.}, 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:}.
|
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:}.
|
||||||
|
|
||||||
Other theorem class environments with the same usage includes:
|
Other theorem class environments with the same usage includes:
|
||||||
|
|
||||||
\begin{table}[htbp]
|
\begin{table}[htbp]
|
||||||
\centering
|
\centering
|
||||||
\caption{Theorem Class Environments}
|
\caption{Theorem Class Environments}
|
||||||
\begin{tabular}{llll}
|
\begin{tabular}{llll}
|
||||||
\toprule
|
\toprule
|
||||||
Environment & Label text & Prefix & Cross-reference \\
|
Environment & Label text & Prefix & Cross-reference \\
|
||||||
\midrule
|
\midrule
|
||||||
definition & label & def & \lstinline|\ref{def:label}| \\
|
definition & label & def & \lstinline|\ref{def:label}| \\
|
||||||
theorem & label & thm & \lstinline|\ref{thm:label}| \\
|
theorem & label & thm & \lstinline|\ref{thm:label}| \\
|
||||||
postulate & label & pos & \lstinline|\ref{pos:label}| \\
|
|
||||||
axiom & label & axi & \lstinline|\ref{axi:label}|\\
|
|
||||||
lemma & label & lem & \lstinline|\ref{lem:label}| \\
|
lemma & label & lem & \lstinline|\ref{lem:label}| \\
|
||||||
corrlary & label & cor & \lstinline|\ref{cor:label}| \\
|
corrlary & label & cor & \lstinline|\ref{cor:label}| \\
|
||||||
proposition & label & pro & \lstinline|\ref{pro:label}| \\
|
proposition & label & pro & \lstinline|\ref{pro:label}| \\
|
||||||
\bottomrule
|
\bottomrule
|
||||||
\end{tabular}%
|
\end{tabular}%
|
||||||
\label{tab:theorem-class}%
|
\label{tab:theorem-class}%
|
||||||
\end{table}%
|
\end{table}%
|
||||||
|
|
||||||
From version 4.1, you can write your theorem environments as follows:
|
|
||||||
\begin{lstlisting}
|
|
||||||
\begin{theorem}[theorem name]\label{thm:theorem-label}
|
|
||||||
The content of theorem.
|
|
||||||
\end{theorem}
|
|
||||||
% or
|
|
||||||
\begin{theorem}\label{thm:theorem-without-name}
|
|
||||||
The content of theorem.
|
|
||||||
\end{theorem}
|
|
||||||
\end{lstlisting}
|
|
||||||
|
|
||||||
In this case, cross-reference don't have to be prefixed, i.e. the parameter of \lstinline{\ref} is the same as that of \lstinline{\label}.
|
|
||||||
|
|
||||||
\subsubsection{\lstinline{simple} mode}
|
|
||||||
|
|
||||||
In \lstinline{simple} mode, the template uses the \lstinline{amsthm} package to customize the theorem class environments. The usage is as follows:
|
|
||||||
|
|
||||||
\begin{lstlisting}
|
|
||||||
\begin{theorem}[theorem name]\label{thm:theorem-label}
|
|
||||||
The content of theorem.
|
|
||||||
\end{theorem}
|
|
||||||
% or
|
|
||||||
\begin{theorem}\label{thm:theorem-without-name}
|
|
||||||
The content of theorem without name.
|
|
||||||
\end{theorem}
|
|
||||||
\end{lstlisting}
|
|
||||||
|
|
||||||
\subsection{Counter for Theorem Environments}
|
|
||||||
|
|
||||||
You can use \lstinline{thmcnt} option to control the theorem counter/number display style for the theorem environments, the acceptable options are \lstinline{chapter} (default) and \lstinline{section}:
|
|
||||||
|
|
||||||
\begin{lstlisting}
|
|
||||||
\documentclass[section]{elegantbook} % turn the Theorem 4.1 to Theorem 4.1.1
|
|
||||||
\documentclass[thmcnt=section]{elegantbook}
|
|
||||||
\end{lstlisting}
|
|
||||||
|
|
||||||
|
|
||||||
\subsection{Other Customized Environments}
|
\subsection{Other Customized Environments}
|
||||||
@@ -330,9 +296,22 @@ 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}
|
||||||
|
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}
|
\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 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]
|
||||||
@@ -365,105 +344,36 @@ This template uses \lstinline{tikz} to customize the list environments, with \ls
|
|||||||
\end{enumerate}
|
\end{enumerate}
|
||||||
\end{minipage}
|
\end{minipage}
|
||||||
|
|
||||||
|
|
||||||
\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 use \lstinline{newtx} fonts, type in:
|
|
||||||
\begin{lstlisting}
|
|
||||||
\documentclass[math=newtx]{elegantbook}
|
|
||||||
\end{lstlisting}
|
|
||||||
|
|
||||||
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} \sin x
|
|
||||||
\end{equation}
|
|
||||||
|
|
||||||
The corresponding code is:
|
|
||||||
\begin{lstlisting}
|
|
||||||
\begin{equation}
|
|
||||||
\int_{R^q} f(x,y) dy.\emph{of \kern0pt f} \sin x
|
|
||||||
\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}
|
\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}.
|
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.
|
||||||
|
|
||||||
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.
|
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]
|
||||||
In order to get the editors' auto-completion working, you need to add following code in your preamble:
|
\nocite{EINAV2010,Havrylchyk2018} %or include some bibitems
|
||||||
|
\nocite{*} %include all the bibitems
|
||||||
\begin{lstlisting}
|
|
||||||
\addbibresource[location=local]{reference.bib}
|
|
||||||
\end{lstlisting}
|
\end{lstlisting}
|
||||||
|
|
||||||
Then include the print commands where you want to print the bibliography:
|
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:
|
||||||
\begin{lstlisting}
|
\begin{lstlisting}
|
||||||
\printbibliography[heading=bibintoc, title=\ebibname]
|
\documentclass[cite=super]{elegantbook} % set cite for super style
|
||||||
\end{lstlisting}
|
\documentclass[super]{elegantbook}
|
||||||
|
\documentclass[cite=authoryear]{elegantbook} % set cite for author-year style
|
||||||
|
\documentclass[authoryear]{elegantbook}
|
||||||
|
|
||||||
|
|
||||||
To change the bibliography style, this version introduces two options: \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}
|
|
||||||
|
|
||||||
We also add the \lstinline{bibend} option to this template, you can choose \lstinline{biber} (default) or \lstinline{bibtex} as you like, \lstinline{biber} is recommended.
|
|
||||||
|
|
||||||
\begin{lstlisting}
|
|
||||||
\documentclass[bibtex]{elegantbook} % or
|
|
||||||
\documentclass[bibend=bibtex]{elegantbook}
|
|
||||||
\end{lstlisting}
|
\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}
|
|
||||||
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}
|
\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
|
||||||
@@ -473,7 +383,7 @@ We create a introduction environment to display the structure of chapter. The ba
|
|||||||
\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
|
||||||
@@ -489,7 +399,7 @@ You can change the title of this environment by modifying the optional argument
|
|||||||
\end{introduction}
|
\end{introduction}
|
||||||
\end{lstlisting}
|
\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:
|
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}
|
||||||
@@ -503,23 +413,16 @@ And you will get:
|
|||||||
\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 in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer.
|
||||||
\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}
|
\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.
|
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}
|
\begin{remark}
|
||||||
|
|
||||||
Note that text and equation are both available in the margin notes.
|
Note that text and equation are both available in the margin notes.
|
||||||
\begin{lstlisting}
|
\begin{lstlisting}
|
||||||
% text
|
% text
|
||||||
@@ -555,6 +458,37 @@ For tables and figures, note that floating environment is not allowed. You have
|
|||||||
|
|
||||||
\end{remark}
|
\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}
|
\chapter{ElegantBook Writing Sample}
|
||||||
@@ -576,8 +510,8 @@ For tables and figures, note that floating environment is not allowed. You have
|
|||||||
|
|
||||||
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 \}$ $\hbar$
|
||||||
\end{definition}
|
\end{definition}
|
||||||
|
|
||||||
\begin{note}
|
\begin{note}
|
||||||
@@ -586,33 +520,24 @@ Note that a subgroup~$H$ of a group $G$ is itself a left coset of $H$ in $G$.
|
|||||||
|
|
||||||
\lipsum[2]
|
\lipsum[2]
|
||||||
|
|
||||||
\begin{theorem}[Lagrange's Theorem] \label{thm:lg}
|
\begin{theorem}{Lagrange's Theorem}{}
|
||||||
Let $G$ be a finite group, and let $H$ be a subgroup of $G$. Then the order of $H$ divides the order of $G$.
|
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}
|
\end{theorem}
|
||||||
|
|
||||||
As theorem \ref{thm:lg} refered.
|
|
||||||
|
|
||||||
\lipsum[3]
|
\lipsum[3]
|
||||||
|
|
||||||
|
|
||||||
\begin{theorem}{theorem name}{label text}
|
\begin{proposition}{Size of Left Coset}{}
|
||||||
The content of theorem.
|
|
||||||
\end{theorem}
|
|
||||||
|
|
||||||
we can refer this theorem as \ref{thm:label text}.
|
|
||||||
|
|
||||||
|
|
||||||
\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$.
|
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}
|
\end{proposition}
|
||||||
|
|
||||||
\begin{proof}
|
\begin{proof}
|
||||||
Let $z$ be some element of $xH \cap yH$. Then $z = xa$ for some $a \in H$, and $z = yb$ for some $b \in H$. If $h$ is any element of $H$ then $ah \in H$ and $a^{-1}h \in H$, since $H$ is a subgroup of $G$. But $zh = x(ah)$ and $xh = z(a^{-1}h)$ for all $h \in H$. Therefore $zH \subset xH$ and $xH \subset zH$, and thus $xH = zH$. Similarly $yH = zH$, and thus $xH = yH$, as required.
|
Let $z$ be some element of $xH \cap yH$. Then $z = xa$ for some $a \in H$, and $z = yb$ for some $b \in H$. If $h$ is any element of $H$ then $ah \in H$ and $a^{-1}h \in H$, since $H$ is a subgroup of $G$. But $zh = x(ah)$ and $xh = z(a^{-1}h)$ for all $h \in H$. Therefore $zH \subset xH$ and $xH \subset zH$, and thus $xH = zH$. Similarly $yH = zH$, and thus $xH = yH$, as required.
|
||||||
\end{proof}
|
\end{proof}
|
||||||
|
|
||||||
\begin{figure}[htbp]
|
\begin{figure}[htbp]
|
||||||
\centering
|
\centering
|
||||||
\includegraphics[width=0.6\textwidth]{scatter.jpg}
|
\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}
|
||||||
|
|
||||||
@@ -620,10 +545,6 @@ 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.
|
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]
|
\begin{table}[htbp]
|
||||||
\small
|
\small
|
||||||
@@ -659,128 +580,90 @@ and expand the ones already used\index{keywords!used}.
|
|||||||
\item Distributed storage and search.
|
\item Distributed storage and search.
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
%\problemset
|
|
||||||
\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{FAQ}
|
\chapter{FAQ}
|
||||||
We list some FAQs for users to refer to:
|
|
||||||
\begin{enumerate}
|
\begin{custom}{Question}
|
||||||
\item \question{Why option numbers for natbib fail to take effect in v3.07?}
|
I want to customize font and background color.
|
||||||
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.
|
\end{custom}
|
||||||
\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.
|
\begin{solution}
|
||||||
\item \question{Which version should I choose?}
|
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.
|
||||||
Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2022.
|
\end{solution}
|
||||||
\item \question{Which editor should I choose?}
|
|
||||||
You can use \TeX{} Live 2022 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2022 + \TeX{}studio is strongly recommended. 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.}
|
\begin{custom}{Question}
|
||||||
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, you can share the URL with us afterwards.
|
\lstinline[breaklines]{Package ctex Error: CTeX fontset `Mac' is unavailable.}
|
||||||
\item \question{What is cross reference?}
|
\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}
|
||||||
|
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.
|
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?}
|
\end{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.
|
|
||||||
\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.
|
|
||||||
|
|
||||||
|
|
||||||
\datechange{2022/08/15}{release of v4.4.}
|
\begin{custom}{Question}
|
||||||
|
Is the language for code highlighting optional?
|
||||||
|
\end{custom}
|
||||||
|
|
||||||
\begin{change}
|
\begin{solution}
|
||||||
\item Add custome theorem definition command \lstinline{\elegantnewtheorem};
|
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 Fix star environment(*) for inner environments (\href{https://github.com/ElegantLaTeX/ElegantBook/issues/167}{issue \#167});
|
\end{solution}
|
||||||
\item Change English fonts from TeX Gyre Termes to TeX Gyre TermesX;
|
|
||||||
\item Re-construct some theorem environments to enchance compatibility;
|
|
||||||
\item Remove Gitee repo due the privacy policy;
|
|
||||||
\item Re-open Github pull requests.
|
|
||||||
\end{change}
|
|
||||||
|
|
||||||
|
|
||||||
|
\nocite{en1,en2,en3}
|
||||||
|
\bibliography{reference}
|
||||||
|
|
||||||
|
|
||||||
\datechange{2022/04/09}{release of v4.3.}
|
|
||||||
|
|
||||||
\begin{change}
|
|
||||||
\item Remove part newtx settings, set TeX Gyre Termes/Heros fonts under \hologo{XeLaTeX}.
|
|
||||||
\item Fix Chinese fonts in the theorem environments.
|
|
||||||
\item Add theorem counter option, \lstinline{thmcnt=section}.
|
|
||||||
\item Add bib option \lstinline{bibend}, which can take value of biber and bibtex.
|
|
||||||
\item \textbf{! Warnings}: The multilingual option may cause some unexpected errors, you can report in this \href{https://github.com/ElegantLaTeX/ElegantBook/issues/170}{issue}.
|
|
||||||
\end{change}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\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}.
|
|
||||||
\end{change}
|
|
||||||
|
|
||||||
|
|
||||||
\datechange{2021/05/02}{release of v4.1.}
|
|
||||||
|
|
||||||
\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}.}
|
|
||||||
|
|
||||||
|
|
||||||
\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
|
\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.
|
||||||
@@ -793,5 +676,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}
|
||||||
|
|
||||||
|
\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}
|
\end{document}
|
||||||
1480
elegantbook.cls
|
Before Width: | Height: | Size: 90 KiB |
BIN
figure/logo.png
Normal file
|
After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 111 KiB |
BIN
image/scatter.pdf
Normal file
27
image/scatter.py
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# 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)
|
||||||
BIN
image/star-history.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
image/star.png
Normal file
|
After Width: | Height: | Size: 45 KiB |
BIN
image/tlshell.png
Normal file
|
After Width: | Height: | Size: 218 KiB |