33 Commits

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

3
.gitignore vendored
View File

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

View File

@@ -1,41 +1,25 @@
<!-- 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) |
# ElegantBook
![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)
[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 书籍模板 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。
如果你有其他问题、建议或者报告 bug可以提交 issues 或者给我们发邮件elegantlatex2e@gmail.com。最近我们新建了一个 QQ 用户交流群Q 群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.
**注意:** 由于新版本进行了重构,并且 3.6 版本对于封面进行了改版3.6 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.6 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。
**重要提示出于某些因素的考虑ElegantLaTeX 项目自 2019 年 5 月 20 日开始不再接受任何非作者预约性质的提交pull request)!如果你想改进模板,你可以给我们提交 issue或者可以在遵循协议的情况下克隆到自己仓库下进行修改**
**本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!为了保证之前版本的用户仍然能查到说明文档,本说明文档仍然保留过去的信息。**
**Caution: This template will no longer be maintained since January 1st, 2023.**
## 致谢 Acknowledgement
特别感谢 [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.
## 协议 License
本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。
如果是衍生作品请务必加入协议声明和模板信息github、CTAN 地址)。
# License
This work is released under the LaTeX Project Public License, v1.3c or later.
## 衍生品 Derivative Works
+ [ElegantBookdown](https://github.com/XiangyunHuang/ElegantBookdown)[XiangyunHuang](https://github.com/XiangyunHuang) 开发并维护的基于 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 模板。
本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。

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

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

File diff suppressed because it is too large Load Diff

View File

@@ -1,103 +1,160 @@
\documentclass[11pt]{elegantbook}
\documentclass[fancy,blue,11pt]{elegantbook}
\title{An Elegant \LaTeX{} Template for Books}
\subtitle{Classic Elegant\LaTeX{} Template}
\author{Ethan Deng, Liam Huang, syvshc, sikouhjw \& Osbert Wang}
\author{Ethan Deng \& Liam Huang}
\institute{Elegant\LaTeX{} Program}
\date{Dec. 31, 2022}
\version{4.5}
\bioinfo{Bio}{Information}
\date{\today}
\version{3.08}
\extrainfo{\textcolor{red}{\bfseries Caution: This template will no longer be maintained since January 1st, 2023.}}
\extrainfo{Victory won\rq t come to us unless we go to it. }
\logo{logo-blue.png}
\logo{logo.png}
\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}
\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}.
Contact Infos:
\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 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 QQ: 692108391
\item Email: \email{elegantlatex2e@gmail.com}
\end{itemize}
\section{Online Usage}
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}.
\section{ElegantBook Updates}
What\rq s new in this version:
\begin{enumerate}
\item Fix \lstinline|\part|.
\item Introduce pad mode.
\item Support mtpro2 package.
\item Revise default format of references to numbers.
\item Include environment for chapter introduction.
\item Include environment for problem set.
\item Include margin note using \lstinline{\elegantpar} (beta).
\item Reduce line spacing for equations.
\item Turn \lstinline{\equote} into \lstinline{\extrainfo}, with multi-line display.
\item Polish documentation by including acknowledgement, etc.
\end{enumerate}
\begin{note}
Since the latest version has witnessed huge reconstruction (with cover change in version 3.06), 3.x is backward incompatible with 2.x. For those who would like to convert documents compiled with earlier version (3.06 or 2.x) to be compatible with latest version, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{conversion}. Questions about version 2.x will not be answered henceforth.
\end{note}
\section{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.
\section{Installation and Update}
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}
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}
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.
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/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.
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{}.
For more details about the installation and usage of \TeX{} Live 2019, the compatibility of C\TeX{} and \TeX{} Live, installation directory, etc., please refer to OG (Official Guide).
\section{Online Usage of Templates}
Considering the online usage of the templates, all the templates are available on Overleaf. Those who enjoy smooth network may feel free to use the templates without \TeX{} Live and to visit your documents anywhere anytime. Search \lstinline{elegantlatex} on Overleaf or visit \href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{search result}, choose the one you prefer and save it to your account, then you can edit yourself or corporate with others if you like. For more infomation about Overleaf, please refer to Overleaf OG.
\section{User\rq s Selected Works Plan}
Eight years have passed since the found of Elegant\LaTeX{} Program. It\rq s an honor that our templates are preferred by a lot of users. Hence, in order to promote more interactions among our users and know more about what you need, we are planning to provide a platform to display selected works of our users on Github or our homepage. If you want to show us your work(s), contact us via Email or other ways. Or if you have upload your work(s) on Github or Gitee etc., share the URL(s) with us.
\section{About Pull Request}
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.
Thank our best support members for their selfless work!
\begin{itemize}
\item OG Translator: \href{https://github.com/peggy2006xzyz}{YPY};
\item Wiki Maintainer: \href{https://github.com/izinngo}{Ingo Zinngo};
\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 and was included in the \href{https://github.com/trending/tex?since=daily}{Trending} under the \TeX{} catagory. It is a remarkable moment for Elegant\LaTeX{} !!!
Thank China\TeX{} and \href{http://www.latexstudio.net/}{\LaTeX{} studio} for their promotion. \LaTeX{} studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on \LaTeX{} in China.
Thank muzimuzhi for the revision of the template.
If you like our template, star on Github.
\begin{figure}[htbp]
\centering
\includegraphics[width=\textwidth]{star.png}
\caption{Twinkle, Twinkle, Little Star}
\end{figure}
Recently some users have expressed their love for our templates and want to tip us. QR code for donation is now available.
\begin{figure}[htbp]
\centering
\includegraphics[width=0.5\textwidth]{donate.jpg}
\end{figure}
The explanation right of the tip usage belongs to Elegant\LaTeX{} with no supervision. Feel free to tip us. Those who donate more than 10 RMB will be recorded in the Donation List. Thank all the tippers!
\begin{table}[htbp]
\centering
\caption{Donation List}
\begin{tabular}{cccc}
\toprule
Tipper & Amount & Date & Channel \\
\midrule
Lerh & 10 RMB & 2019/5/15 & Wechat \\
Yueguodipingxian & 10 RMB & 2019/5/15 & Wechat \\
Dapeng & 20 RMB & 2019/5/27 & 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 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. The default encoding is UTF-8 while \TeX{} Live is recommended. The test environment is Win10 + \TeX{} Live 2019.
\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}
\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};
\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}
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}
\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}
\end{lstlisting}
\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}
\documentclass[green]{elegantbook} %or
\documentclass[color=green]{elegantbook}
@@ -152,52 +209,16 @@ 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, 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}
\documentclass[hang]{elegantbook} %or
\documentclass[titlestyle=hang]{elegantbook}
\end{lstlisting}
\section{Introduction of Math Environments}
\section{Theorem Class 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}
@@ -208,50 +229,26 @@ We defined two sets of theorem modes, \lstinline{simple} style and \lstinline{fa
In this template, we defined four different theorem class environments
\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}
\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}.
\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{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}
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}
\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:
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}
% name + label
\begin{theorem}{theorem name}{label}
The content of a theorem with name and label.
Use \ref{thm:label} to refer this theorem.
\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.
\begin{theorem}{<theorem name>}{<label>}
The content of theorem.
\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:
@@ -264,8 +261,6 @@ Other theorem class environments with the same usage includes:
\midrule
definition & label & def & \lstinline|\ref{def: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}| \\
corrlary & label & cor & \lstinline|\ref{cor:label}| \\
proposition & label & pro & \lstinline|\ref{pro:label}| \\
@@ -274,42 +269,6 @@ Other theorem class environments with the same usage includes:
\label{tab:theorem-class}%
\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}
The other three math environments can be called directly since there are no additional option for them, e.g. \lstinline{example}:
@@ -330,12 +289,25 @@ 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 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}
\section{Base Hide Option}
Hiding the end-of-chapter 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.befunky.com/create/crop-photo/}{befunky.com}.
Aspect ratio of the logo is 1:1 in this guide, i.e. a square picture. To replace the logo, do remember to choose the appropriate picture.
\section{List Environments}
This template uses \lstinline{tikz} to customize the list environments, with \lstinline{itemize} environment customized to the third depth and \lstinline{enumerate} environment customized to fourth depth. The effect is as follows\\[2ex]
This template uses \lstinline{tikz} to customize \lstinline{itemize} and \lstinline{enumerate} environments, with \lstinline{itemize} environment customized to the third depth and \lstinline{enumerate} environment customized to fourth depth. The effect is as follows\\[2ex]
\begin{minipage}[b]{0.49\textwidth}
\begin{itemize}
\item first item of nesti;
@@ -365,105 +337,34 @@ This template uses \lstinline{tikz} to customize the list environments, with \ls
\end{enumerate}
\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}
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.
In order to get the editors' auto-completion working, you need to add following code in your preamble:
\begin{lstlisting}
\addbibresource[location=local]{reference.bib}
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
\end{lstlisting}
Then include the print commands where you want to print the bibliography:
Two more options \lstinline{cite=numbers} and \lstinline{cite=authoryear} are available in this new version, with the default setting as \lstinline{numbers} since those major in science and technology use \lstinline{numbers} more often. For those who major in liberal arts want to use \lstinline{authoryear}, please type in:
\begin{lstlisting}
\printbibliography[heading=bibintoc, title=\ebibname]
\end{lstlisting}
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}
\documentclass[cite=authoryear]{elegantbook} %or
\documentclass[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*{Introduction}
\markboth{Introduction}{Introduction}
The content of introduction.
\chapter*{Preface}
\addcontentsline{toc}{chapter}{Preface}
\markboth{Preface}{}
The content of Preface.
\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
@@ -473,7 +374,7 @@ We create a introduction environment to display the structure of chapter. The ba
\item Angle of Corner
\end{introduction}
\end{lstlisting}
And you will get:
you will get:
\begin{introduction}
\item Definition of Theorem
\item Ask for help
@@ -482,14 +383,14 @@ And you will get:
\item Angle of Corner
\end{introduction}
You can change the title of this environment by modifying the optional argument of this environment:
You can change the title of this environment by modifying the optional argument of this environment
\begin{lstlisting}
\begin{introduction}[Brief Introduction]
...
\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}
@@ -503,59 +404,11 @@ 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(to be fixed).
If you want to customize the title of \lstinline{problemset}, please change the optional argument like introduction environment.
\end{remark}
\begin{solution}
If you want to customize the title of \lstinline{problemset}, please change the optional argument like in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer(to be fixed).
\end{solution}
\section{Margin Notes}
In 3.08, we introduced \lstinline{marginpar=margintrue} and \lstinline{\elegantpar} (Beta) with piles of bugs. Hence we decide to remove them in 3.09 and will suspend the options till revolutionary optimization. Sorry for all the bugs! However, we retain the option \lstinline{marginpar} for users to get margin motes by activating \lstinline{marginpar=margintrue} and using \lstinline{\marginpar} or \lstinline{marginnote} packages.
\begin{remark}
Note that text and equation are both available in the margin notes.
\begin{lstlisting}
% text
\marginpar{margin paragraph text}
% equation
\marginpar{
\begin{equation}
a^2 + b^2 = c^2
\end{equation}
}
\end{lstlisting}
For tables and figures, note that floating environment is not allowed. You have to use \lstinline{includegraphics} or \lstinline{table} and use \lstinline{\captionof} to name it. To get centralized figures or tables, use \lstinline{\centerline} or \lstinline{center}. To learn more, please refer to \href{https://tex.stackexchange.com/questions/5583/caption-of-figure-in-marginpar-and-caption-of-wrapfigure-in-margin}{Caption of Figure in Marginpar}.
\begin{lstlisting}
% graph with centerline command
\marginpar{
\centerline{
\includegraphics[width=0.2\textwidth]{logo.png}
}
\captionof{figure}{your figure caption}
}
% graph with center environment
\marginpar{
\begin{center}
\includegraphics[width=0.2\textwidth]{logo.png}
\captionof{figure}{your figure caption}
\end{center}
}
\end{lstlisting}
\end{remark}
\chapter{ElegantBook Writing Sample}
@@ -576,8 +429,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$.
\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$
\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 \}$
\end{definition}
\begin{note}
@@ -586,23 +439,14 @@ 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] \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$.
\end{theorem}
As theorem \ref{thm:lg} refered.
\lipsum[3]
\begin{theorem}{theorem name}{label text}
The content of theorem.
\end{theorem}
we can refer this theorem as \ref{thm:label text}.
\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}
@@ -612,7 +456,7 @@ Let $H$ be a finite subgroup of a group $G$. Then each left coset of $H$ in $G$
\begin{figure}[htbp]
\centering
\includegraphics[width=0.6\textwidth]{scatter.jpg}
\includegraphics[width=0.6\textwidth]{scatter.pdf}
\caption{Matplotlib: Scatter Plot Example\label{fig:scatter}}
\end{figure}
@@ -620,10 +464,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.
\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
@@ -643,7 +483,7 @@ and expand the ones already used\index{keywords!used}.
$R^2$ & 0.220 & 0.293 \\
\bottomrule
\multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\
\multicolumn{3}{l}{\scriptsize *** $p < 0.01$, ** $p<0.05$, * $p<0.1$} \\
\multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\
\end{tabular}%
\end{table}%
@@ -659,136 +499,102 @@ and expand the ones already used\index{keywords!used}.
\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{Margin Notes}
For version 3.08, we introduce margin note option and \lstinline{\elegantpar} (Beta). In this template, margin note option \lstinline{marginpar} is included. If \lstinline{marginpar=margintrue}, the width of both sides will reduce at least 1.5cm. If \lstinline{marginpar=marginfalse}, the width of sides will remain unchanged. Margin note option works under \lstinline{device=normal} only.
Margin note option can be activated using \lstinline{\marginpar} built in \LaTeX{} or \lstinline{\marginnote} command in \lstinline{marginnote}. For more information, refer to \href{https://en.wikibooks.org/wiki/LaTeX/Footnotes_and_Margin_Notes#Margin_Notes}{Margin Notes} or \LaTeX{} books.
\lstinline{\elegantpar} is introduced in this version. Note that TikZ overlay is used in this command, hence you have to compile three times to get the right display effect.
%\setlength{\marginparwidth}{2.5cm}
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et \elegantpar{dolore magna aliqua}{This is Beautiful the elegantpar Style for English Text}. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
\begin{equation}
E = m\elegantpar{c^{2}}{
\begin{equation*}E=mc^2\end{equation*}}
\end{equation}
\chapter{FAQ}
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 2022.
\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.}
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.
\item \question{What is cross reference?}
\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}
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.
\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.
\end{solution}
\datechange{2022/12/31}{release of v4.5.} \textcolor{red}{\bfseries Stop Maintenance}
\begin{custom}{Question}
Is the language for code highlighting optional?
\end{custom}
\begin{change}
\item Add new document option \lstinline|usesamecnt| for same thm counter for all theme environments;
\item Add 5-th optional parameter for \lstinline|elegantnewtheorem|.
\end{change}
\begin{solution}
Yes, \lstinline{listings} package is used in ElegantBook, hence language is optional. For global setting, use \lstinline{\lstset}. For more information, please refer to package documentations.
\end{solution}
\datechange{2022/08/15}{release of v4.4.}
\nocite{en1,en2,en3}
\bibliography{reference}
\begin{change}
\item Add custome theorem definition command \lstinline{\elegantnewtheorem};
\item Fix star environment(*) for inner environments (\href{https://github.com/ElegantLaTeX/ElegantBook/issues/167}{issue \#167});
\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}
\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
\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.
@@ -801,5 +607,36 @@ This appendix covers some of the basic mathematics used in econometrics. We brie
\sum_{i=1}^n x_i \equiv x_1 + x_2 +\cdots + x_n
\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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

BIN
figure/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

BIN
image/donate.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 111 KiB

BIN
image/scatter.pdf Normal file

Binary file not shown.

27
image/scatter.py Normal file
View 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.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

BIN
image/tlshell.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 218 KiB