diff options
author | Karl Berry <karl@freefriends.org> | 2020-02-10 22:11:37 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-02-10 22:11:37 +0000 |
commit | 3b5ef52b5110c41d0435ee83f597785ccf7f8e8e (patch) | |
tree | 971d7e798f2365bb227bb7e9950af7e578ccc029 /Master/texmf-dist/doc/latex | |
parent | 9630b626104b0296f335c2ec5dc860251ce097e0 (diff) |
elegantbook (10feb20)
git-svn-id: svn://tug.org/texlive/trunk@53747 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/README.md | 151 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.pdf | bin | 1294115 -> 1432024 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.tex | 832 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.pdf | bin | 1290888 -> 1276731 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.tex | 568 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/figure/logo-blue.png | bin | 0 -> 91664 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/image/cert.pdf | bin | 0 -> 103979 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/image/founder.png | bin | 0 -> 89052 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/image/star-history.png | bin | 20961 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/elegantbook/image/tlshell.png | bin | 222845 -> 129547 bytes |
10 files changed, 879 insertions, 672 deletions
diff --git a/Master/texmf-dist/doc/latex/elegantbook/README.md b/Master/texmf-dist/doc/latex/elegantbook/README.md index 507bd30321e..e0695d071f7 100644 --- a/Master/texmf-dist/doc/latex/elegantbook/README.md +++ b/Master/texmf-dist/doc/latex/elegantbook/README.md @@ -1,80 +1,145 @@ <!-- Author : Dongsheng Deng & Liam Huang--> <!-- Program Email: elegantlatex2e@gmail.com --> -# ElegantBook: An Elegant LaTeX Template for Books - [Homepage](https://elegantlatex.org/) | [Github](https://github.com/ElegantLaTeX/ElegantBook) | [CTAN](https://ctan.org/pkg/elegantbook) | [Download](https://github.com/ElegantLaTeX/ElegantBook/releases) | [Wiki](https://github.com/ElegantLaTeX/ElegantBook/wiki) | [Weibo](https://weibo.com/elegantlatex) -![License](https://img.shields.io/ctan/l/elegantbook.svg) -![CTAN Version](https://img.shields.io/ctan/v/elegantbook.svg) -![Github Version](https://img.shields.io/github/release/ElegantLaTeX/ElegantBook.svg) -![Repo Size](https://img.shields.io/github/repo-size/ElegantLaTeX/ElegantBook.svg) +![License](https://img.shields.io/ctan/l/elegantbook.svg) ![CTAN Version](https://img.shields.io/ctan/v/elegantbook.svg) ![Github Version](https://img.shields.io/github/release/ElegantLaTeX/ElegantBook.svg) ![Repo Size](https://img.shields.io/github/repo-size/ElegantLaTeX/ElegantBook.svg) + +--- -ElegantBook is designed for books. Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or contact us at elegantlatex2e@gmail.com. +# ElegantBook 优美的 LaTeX 书籍模板 -ElegantBook 是为 LaTeX 书籍写作而设计的模板,如果你有其他问题、建议或者报告 bug,可以提交 issues 或者给我们发邮件:elegantlatex2e@gmail.com。QQ 用户交流群:692108391,欢迎加入。 +ElegantBook 是为 LaTeX 书籍写作而设计的模板,由 [Dongsheng Deng](https://ddswhu.me/) 和 [Liam Huang](https://liam.page/) 创立,模板创立的初衷是方便我们自己做笔记 :smile:。如果你有其他问题、建议或者报告 bug,可以提交 issues 或者给我们发邮件:elegantlatex2e@gmail.com。QQ 用户交流群:692108391,欢迎加入。 ## 重要提示 -**Version Note** Users for 2.x, please refer to [Version Convert](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert). +**版本提醒:** 由于新版本进行了重构,并且 3.06 版本对于封面进行了改版,3.06 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.06 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。我们强烈建议你使用最新版。 -**版本提醒:** 由于新版本进行了重构,并且 3.6 版本对于封面进行了改版,3.6 以后的版本并不兼容之前版本,如果你想把之前版本的文件转为 3.6 以后的版本,请查看[跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert)。 +**重要提示**:ElegantLaTeX 项目 **不接受** 任何非作者预约提交(pull requests)! -**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,或者可以在遵循协议的情况下,克隆到自己仓库下进行修改**。 +2019 年 5 月 20 日,ElegantBook 模板在 Github 上的 Star 数达到了 100,这对于 ElegantLaTeX 系列模板是一个非常重要的里程碑!在此特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。LaTeX 工作室网站上有很多精彩的帖子和精致的模板,欢迎大家去挖掘里面的宝藏。这也是我所见到的国内最全面的 LaTeX 相关的网站。 +如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。 +## 捐赠 -## Acknowledgement 致谢 +如果您非常喜爱我们的模板或者我,你还可以选择捐赠以表达您对我们模板和我的支持。本模板自 3.08 版本发布了捐赠信息之后,收到了超过千元的捐赠(四舍五入就是一个亿),非常感谢! -The number of stars on Github for ElegantBook reached 100 on May 20, 2019. +![](https://github.com/ElegantLaTeX/ElegantBook/wiki/donate.jpg) -2019 年 5 月 20 日,ElegantBook 模板在 Github 上的 Star 数达到了 100,这对于 ElegantLaTeX 系列模板是一个非常重要的里程碑! +**赞赏费用的使用解释权归 ElegantLaTeX 所有,并且不接受监督,请自愿理性打赏**。10 元以上的赞赏,我们将列入捐赠榜,谢谢各位金主!(如果有遗漏,请务必联系我们,这对我们很重要) -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) 对于模板的完善。 +| 捐赠者 | 金额 | 时间 | 渠道 | +| :------: | :----: | :----: | :------: | +| Lerh | 10 RMB | 2019/05/15 | 微信 | +| 越过地平线 | 10 RMB | 2019/05/15 | 微信 | +| 银桑 | 20 RMB | 2019/05/27 | 微信 | +| *空 | 10 RMB | 2019/05/30 | 微信 | +| [latexstudio.net](http://www.latexstudio.net) | 666 RMB | 2019/06/05 | 支付宝 | +| Cassis | 11 RMB | 2019/06/30 | 微信 | +| *君 | 10 RMB | 2019/07/23 | 微信 | +| P*u | 50 RMB | 2019/07/30 | 微信 | +| *萌 | 19 RMB | 2019/08/28 | 微信 | +| 曲豆豆 | 10 RMB | 2019/08/28 | 微信 | +| 李博 | 100 RMB | 2019/10/06 | 微信 | +| Njustsll | 10 RMB | 2019/10/11 | 微信 | +| 刘志阔 | 99.99 RMB | 2019/10/15 | 支付宝 | +| *涛 | 16 RMB | 2019/10/17 | 微信 | +| 赤霓 | 12 RMB | 2019/10/17 | 支付宝 | +| 追寻原风景 | 10 RMB | 2019/10/28 | 微信 | +| 郭德良 | 88 RMB | 2019/11/03 | 微信 | +| 自强不息 | 20 RMB | 2019/11/04 | 支付宝 | +| 读书之虫 | 20 RMB | 2019/11/18 | 微信 | +| *等 | 10 RMB | 2019/11/18 | 微信 | +| *哲 | 20 RMB | 2019/11/18 | 微信 | +| 佚名 | 10 RMB | 2019/11/24 | 微信 | +| Jiye Qian | 66 RMB | 2019/12/04 | 微信 | +| * 阳 | 20 RMB | 2019/12/05 | 微信 | +| Catcher | 11 RMB | 2019/12/08 | 支付宝 | +| 希尔波特门徒 | 10 RMB | 2019/12/09 | 支付宝 | +| * 伟 | 10 RMB | 2019/12/09 | 微信 | +| Simon | 20 RMB | 2019/12/11 | 支付宝 | +| 流殇丶浅忆 | 66.60 RMB | 2019/12/18 | 支付宝 | +| 羽 | 10 RMB | 2019/12/20 | 支付宝 | +| * 琛 | 15 RMB | 2019/12/20 | 微信 | +| 随风 | 20 RMB | 2019/12/27 | 支付宝 | +| Ws | 23.30 RMB | 2019/12/28 | 微信 | -If you like our template, star on Github. -如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。 +再次感谢大家对于模板的喜爱! +## 协议 -## 捐赠 +本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。如果是衍生作品,请务必加入协议声明和模板信息(github、CTAN 地址)。 -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 版本发布了捐赠信息之后,收到了近千元的捐赠(四舍五入就是一个亿),非常感谢! ++ [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 模板。 -![](https://github.com/ElegantLaTeX/ElegantBook/wiki/donate.jpg) +------- -The explanation right of the tip usage belongs to ElegantLaTeX with no supervision. Feel free to tip us. Those who donate more than 10 RMB will be recorded in the Donation List. Thank all the tippers! +# ElegantBook: An Elegant LaTeX Template for Books -**赞赏费用的使用解释权归 ElegantLaTeX 所有,并且不接受监督,请自愿理性打赏**。10 元以上的赞赏,我们将列入捐赠榜,谢谢各位金主! +ElegantBook is designed for writing books, created by [Dongsheng Deng](https://ddswhu.me/) and [Liam Huang](https://liam.page/). Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or contact us at elegantlatex2e@gmail.com. -| 捐赠者/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 | +## Important Notes -Thank you all. +**Version Note**: Users for 2.x, please refer to [Version Convert](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert). We strongly recommend that you use the latest version. -再次感谢大家对于模板的喜爱! +**Important Info**: For some reasons, __unauthorial__ pull requests are **UNACCEPTABLE** since May 20, 2019. For those who want to help revise the templates, submit issues or clone to your own repository to modify under the LPPL-1.3c. -## License 协议 +## Acknowledgement -This work is released under the LaTeX Project Public License, v1.3c or later. +_News_: _The number of stars on Github for ElegantBook reached 100 on May 20, 2019_. -本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。如果是衍生作品,请务必加入协议声明和模板信息(github、CTAN 地址)。 +Thank ChinaTeX and [LaTeX Studio](http://www.latexstudio.net/) for their promotion. LaTeX studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on LaTeX in China. If you like our template, star on Github for supporting us. -## Derived Works 衍生与拓展开发 +## Donation -+ [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 模板。 +To express your love for our templates and/or our developers, please do not hesitate to tip us. Since last release of 3.08, we have received about a thousand RMB! (The emergence of a millionaire is on the way. Loading... ) + +![](https://github.com/ElegantLaTeX/ElegantBook/wiki/donate.jpg) + +The explanation right of the tip usage belongs to ElegantLaTeX with no supervision. Feel free to tip us. Those who donate more than 10 RMB will be recorded in the Donation List. Thank all the tippers! Thank you all. + + +| Tipper | Amount | Date | Channel | +| :--------------: | :----: | :-------: | :-----: | +| Lerh | 10 RMB | 2019/5/15 | Wechat | +| YueGuoDiPingXian | 10 RMB | 2019/5/15 | Wechat | +| YinSang | 20 RMB | 2019/5/27 | Wechat | +| * Kong | 10 RMB | 2019/05/30 | Wechat | +| [latexstudio.net](http://www.latexstudio.net) | 666 RMB | 2019/06/05 | Alipay | +| Cassis | 11 RMB | 2019/06/30 | Wechat | +| * Jun | 10 RMB | 2019/07/23 | Wechat | +| P*u | 50 RMB | 2019/07/30 | Wechat | +| * Meng | 19 RMB | 2019/08/28 | Wechat | +| QuDouDou | 10 RMB | 2019/08/28 | Wechat | +| LI Bo | 100 RMB | 2019/10/06 | Wechat | +| Njustsll | 10 RMB | 2019/10/11 | Wechat | +| LIU ZhiKuo | 99.99 RMB | 2019/10/15 | Alipay | +| * Tao | 16 RMB | 2019/10/17 | Wechat | +| ChiHong | 12 RMB | 2019/10/17 | Alipay | +| YuanFengJing | 10 RMB | 2019/10/28 | Wechat | +| GUO DeLiang | 88 RMB | 2019/11/03 | Wechat | +| ZiQiangBuXi | 20 RMB | 2019/11/03 | Alipay | +| DuShuZhiChong | 20 RMB | 2019/11/18 | Wechat | +| * Deng | 10 RMB | 2019/11/18 | Wechat | +| * Zhe | 20 RMB | 2019/11/18 | Wechat | + + +## License + +This work is released under the LaTeX Project Public License, v1.3c or later. + + +## Derivative Works + ++ [ElegantBookdown](https://github.com/XiangyunHuang/ElegantBookdown):[XiangyunHuang](https://github.com/XiangyunHuang) developed a Bookdown template based on ElegantBook. ++ [bookdownplus](https://github.com/pzhaonet/bookdownplus): maintained by [pzhaonet](https://github.com/pzhaonet). ++ [PanBook](https://github.com/annProg/PanBook):a markdown-based writing workflow Developed by [annProg](https://github.com/annProg). diff --git a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.pdf b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.pdf Binary files differindex e5d763c9b95..c4ffd83e54e 100644 --- a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.pdf +++ b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.pdf diff --git a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.tex b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.tex index beb8d3c08a9..7e2eeab542c 100644 --- a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.tex +++ b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-cn.tex @@ -1,45 +1,71 @@ -\documentclass[cn,11pt,twocol]{elegantbook} +\documentclass[cn,11pt,chinese]{elegantbook} \title{ElegantBook:优美的 \LaTeX{} 书籍模板} \subtitle{Elegant\LaTeX{} 经典之作} \author{Ethan Deng \& Liam Huang} \institute{Elegant\LaTeX{} Program} -\date{\today} -\version{3.09} +\date{February 10, 2020} +\version{3.10} +\bioinfo{自定义}{信息} \extrainfo{Victory won\rq t come to us unless we go to it. --- M. Moore} -\logo{logo.png} +\logo{logo-blue.png} \cover{cover.jpg} +% 本文档命令 +\usepackage{array} +\newcommand{\ccr}[1]{\makecell{{\color{#1}\rule{1cm}{1cm}}}} +% 修改目录深度 +\setcounter{tocdepth}{2} + \begin{document} \maketitle +\frontmatter -\tableofcontents +\chapter*{特别声明} +\markboth{Introduction}{前言} +在过去的 2019 年,\href{https://elegantlatex.org/}{Elegant\LaTeX{}} 系列模板均逐步上线 \href{https://github.com/ElegantLaTeX}{GitHub}、\href{https://ctan.org/pkg/elegantbook}{CTAN}、\href{https://www.overleaf.com/latex/templates/elegantbook-template/zpsrbmdsxrgy}{Overleaf} 以及 \href{https://gitee.com/ElegantLaTeX/ElegantBook}{Gitee} 上。截止到 2019 年底,ElegantNote、ElegantBook、ElegantPaper 三个模板在 GitHub 上的收藏数达到了 194、333 和 220,从 2019 年 5 月开启捐赠之后收到了用户 33 笔合计超过 1500 元的捐赠,用户群人数也超过了 400 人。这些数字的背后,反映出 Elegant\LaTeX{} 越来越受用户的喜爱,在此非常感谢大家。 -\mainmatter -\hypersetup{pageanchor=true} +但是,我想声明的是: -\chapter{Elegant\LaTeX{} 系列模板介绍} +\begin{center} + 由于某些原因,Elegant\LaTeX{} 项目 \underline{不再接受}\textbf{任何}非我本人预约的提交。 +\end{center} + +我是一个理想主义者,关于这个模板,我有自己的想法。我所关心的是,我周围的人能方便使用 \LaTeX{} 以及此模板,我自己会为自己的东西感到开心。如果维护模板让我不开心,那我就不会再维护了。诚然这个模板并不是完美的,但是相比 2.x 好很多了,这些改进离不开大家的反馈、China\TeX{} 和逐鹿人的鼓励以及支援人员的帮助! + +\underline{如果你无法认同我的想法,建议直接删除本模板。} + +\vskip 1.5cm +\begin{flushright} +Ethan Deng\\ +February 10, 2020 +\end{flushright} -Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote},\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook},\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成,分别用于排版笔记,书籍和工作论文。强烈推荐使用最新正式版本!本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎在 Github 上给我们提交 \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} 或者邮件联系我们。 +\tableofcontents +%\listofchanges + +\mainmatter +\chapter{Elegant\LaTeX{} 系列模板介绍} +Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote},\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook},\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成,分别用于排版笔记,书籍和工作论文。强烈推荐使用最新正式版本!本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎在 GitHub 上给我们提交 \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} 或者邮件联系我们。 -我们的联系方式: +我们的联系方式如下,建议加入用户 QQ 群提问,这样能更快获得准确的反馈,加群时请备注 \LaTeX{} 或者 Elegant\LaTeX{} 相关内容。 \begin{itemize} -\item 官网:\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 下载地址:\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{正式发行版},\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版} -\item 微博:ElegantLaTeX -\item 微信公众号:ElegantLaTeX -\item 用户 QQ 群:692108391 -\item 邮件:\email{elegantlatex2e@gmail.com} + \item 官网:\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 下载地址:\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{正式发行版},\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版} + \item 微博:Elegant\LaTeX{} + \item 微信公众号:Elegant\LaTeX{} + \item 用户 QQ 群:692108391 + \item 邮件:\email{elegantlatex2e@gmail.com} \end{itemize} @@ -47,84 +73,109 @@ Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模 此次更新主要有 \begin{enumerate} -\item 删除 \lstinline{\elegantpar} 命令; -\item 修复符号字体设置; -\item 增加双栏目录选项; -\item 修改脚注格式; -\item 其他。 + \item 增加数学字体选项 \lstinline{math},可选项为 \lstinline{newtx} 和 \lstinline{cm}。\\ + \textbf{重要提示}:原先通过 \lstinline{newtxmath} 宏包设置的数学字体改为 \LaTeX{} 默认数学字体,如果需要保持原来的字体,需要显式声明数学字体(\lstinline{math=newtx}); + \item 新增中文字体选项 \lstinline{chinesefont},可选项为 \lstinline{ctexfont}、\lstinline{founder} 和 \lstinline{nofont}。 + \item 将封面作者信息设置为可选,并且增加自定义信息命令 \lstinline{\bioinfo}; + \item 在说明文档中增加版本历史,新增 \lstinline{\datechange} 命令和 \lstinline{change} 环境; + \item 增加汉化章节选项 \lstinline{scheme},可选项为汉化 \lstinline{chinese}; + \item 由于 \lstinline{\lvert} 问题已经修复,重新调整 \lstinline{ctex} 宏包和 \lstinline{amsmath} 宏包位置。 + \item 修改页眉设置,去除了 \lstinline{\lastpage} 以避免 page anchor 问题,加入 \lstinline{\frontmatter}。 + \item 修改参考文献选项 \lstinline{cite},可选项为数字 \lstinline{number}、 作者-年份 \lstinline{authoryear} 以及上标 \lstinline{super}。 + \item 新增参考文献样式选项 \lstinline{bibstyle},并将英文模式下参考文献样式 \lstinline{apalike} 设置为默认值,中文仍然使用 \lstinline{gbt7714} 宏包设置。 \end{enumerate} \begin{note} -2.x 版本的用户请仔细查看\href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{跨版本转换}。 +如果你之前使用了本模板,在使用新版本时,需要删除文档中的 \lstinline|\hypersetup{pageanchor=true}|,并且在 \lstinline{\maketitle} 和 \lstinline{\tableofcontents} 之间添加 \lstinline{\frontmatter}。2.x 版本的用户请仔细查看\href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{跨版本转换}。 \end{note} \section{模板安装与更新} -你可以通过免安装的方式使用本模板,也可以通过安装模板的方式使用。 -免安装使用方法如下,从 Github 或者 CTAN 下载最新(正式)版文件,严格意义上只需要类文件 \lstinline{elegantbook.cls}。然后将模板文件放在你的工作目录下即可使用。这样使用的好处是,无需安装,简便;缺点是,当模板进行更新之后,你需要手动替换 \lstinline{cls} 文件。 +你可以通过免安装的方式使用本模板,包括在线使用和本地(文件夹内)使用两种方式,也可以通过 \TeX{} 发行版安装使用。 -如果你是 \TeX{} Live 2019 用户,我们非常推荐你直接进行安装和更新。你可以通过 \TeX{} Live 2019 自带的 \lstinline{tlshell}\footnote{也叫 \TeX{} Live Manager} 进行安装。安装非常简单,步骤如下,搜索并打开 \lstinline{tlshell},然后通过 \lstinline{File -> Load Default Repository} 加载远程仓库,如果你不想使用默认的仓库,你可以通过 \lstinline{Options} 下的菜单设置远程仓库。设置好仓库之后,等待仓库加载完毕,你可以在下面的搜索栏搜索 \lstinline{elegantbook},然后选择进行安装与更新。 +\subsection{在线使用模板} + +我们把三套模板全部上传到 \href{https://www.overleaf.com/}{Overleaf} 上了,网络便利的用户可以直接通过 Overleaf 在线使用我们的模板。使用 Overleaf 的好处是无需安装 \TeX{} Live 2019,可以随时随地访问自己的文件。查找模板,请在 Overleaf 模板库里面搜索 \lstinline{elegantlatex} 即可,你也可以直接访问\href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{搜索结果}。选择适当的模板之后,将其 \lstinline{Open as Template},即可把模板存到自己账户下,然后可以自由编辑以及与别人一起协作。更多关于 Overleaf 的介绍和使用,请参考 Overleaf 的\href{https://www.overleaf.com/learn}{官方文档}。 + +\begin{remark} +Overleaf 上,中文需要使用 \hologo{XeLaTeX} 进行编译,英文建议使用 \hologo{pdfLaTeX} 编译。 +\end{remark} + +\subsection{本地免安装使用} + + +\textbf{免安装}使用方法如下,从 GitHub 或者 CTAN 下载最新(正式)版文件,严格意义上只需要类文件 \lstinline{elegantbook.cls}。然后将模板文件放在你的工作目录下即可使用。这样使用的好处是,无需安装,简便;缺点是,当模板更新之后,你需要手动替换 \lstinline{cls} 文件。 + +\subsection{发行版安装使用} + +如果你是 \TeX{} Live 2019 用户,我们推荐你直接进行安装和更新。你可以通过 \TeX{} Live 2019 自带的 \lstinline{tlshell}\footnote{也叫 \TeX{} Live Manager} 进行安装。安装非常简单,步骤如下,搜索并打开 \lstinline{tlshell},然后通过 \lstinline{File -> Load Default Repository} 加载远程仓库,如果你不想使用默认的仓库,你可以通过 \lstinline{Options} 下的菜单设置远程仓库。设置好仓库之后,等待仓库加载完毕,你可以在下面的搜索栏搜索 \lstinline{elegantbook},然后选择进行安装与更新。 \begin{figure}[htbp] -\centering -\includegraphics[width=0.7\textwidth]{tlshell.png} -\caption{使用 \TeX{} Live Shell 安装 ElegantBook 模板} + \centering + \includegraphics[width=0.7\textwidth]{tlshell.png} + \caption{使用 \TeX{} Live Shell 安装 ElegantBook 模板} \end{figure} -如果你是 \TeX{} Live 2018 的用户,由于 2018 无法直接更新到 2019,所以你想更新的话,需要卸载 2018 重装 2019。如果你实在不想折腾,那么你仍然可以使用本模板。你可以手动安装模板,将 \lstinline{elegantbook.cls} 复制到你的 \TeX{} Live 目录下,默认安装目录为 \lstinline|C:\texlive\2019\texmf-dist\tex\latex\elegantbook|,然后通过命令行(管理员权限),运行 \lstinline{texhash} 即可。 +\subsection{更新问题} -啥?你是 C\TeX{} 用户?Sorry,本模板不提供支持。 +如果使用 \lstinline{tlshell} 无法更新模板,请使用命令行全部更新全部宏包或者使用免安装的方法使用本模板。 -更多关于 \TeX{} Live 2019 的安装使用以及 C\TeX{} 与 \TeX{} Live 的兼容、系统路径问题,请参考官方文档以及啸行的\href{https://github.com/OsbertWang/install_latex/releases}{一份简短的安装 \LaTeX{} 的介绍}。 +通过命令行(管理员权限)输入下面的命令对 tlmgr 自身和全部宏包进行更新。 -\section{在线使用模板} -我们把三套模板全部上传到 \href{https://www.overleaf.com/}{Overleaf} 上了,网络便利的用户可以直接通过 Overleaf 在线使用我们的模板。使用 Overleaf 的好处是无需安装 \TeX{} Live 2019,可以随时随地访问自己的文件。查找模板,请在 Overleaf 模板库里面搜索 \lstinline{elegantlatex} 即可,你也可以直接访问\href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{搜索结果}。选择适当的模板之后,将其 \lstinline{Open as Template},即可把模板存到自己账户下,然后可以自由编辑以及与别人一起协作。更多关于 Overleaf 的介绍和使用,请参考 Overleaf 的\href{https://www.overleaf.com/learn}{官方文档}。 +\begin{lstlisting} + tlmgr update --self + tlmgr update --all +\end{lstlisting} -\begin{remark} -Overleaf 上,中文需要使用 \lstinline{XeLaTeX} 进行编译,英文可以使用 \lstinline{PDFLaTeX} 与 \lstinline{XeLaTeX} 进行编译。 -\end{remark} +更多的内容请参考 \href{https://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \TeX{} distribution?} -\section{用户作品计划} -Elegant\LaTeX{} 系列模板从创立至今已经有 8 年了,我们的模板也受到了很多用户的喜爱,在此,为了促进模板用户之间的交流,了解用户需求,完善本模板,我们将建立一个区域专门展示用户的文档,包括但不限于 Github 和官网等。如果你愿意将自己的作品展示出来,请邮件或者其他方式联系我们。如果自己代码已经传到 Github 或者 Gitee 等网站,可以提供对应网址。 +\subsection{其他发行版本} + +如果你是 \TeX{} Live 2018 的用户,由于 2018 难以更新到 2019,建议卸载 2018 重装 2019。如果嫌麻烦,你可以手动安装模板,将 \lstinline{elegantbook.cls} 复制到你的 \TeX{} Live 目录下,默认安装目录为 \lstinline|C:\texlive\2019\texmf-dist\tex\latex\elegantbook|,然后通过命令行(管理员权限),运行 \lstinline{texhash} 即可。 + +由于宏包版本问题,本模板不支持 C\TeX{} 套装。更多关于 \TeX{} Live 2019 的安装使用以及 C\TeX{} 与 \TeX{} Live 的兼容、系统路径问题,请参考官方文档以及啸行的\href{https://github.com/OsbertWang/install_latex/releases}{一份简短的安装 \LaTeX{} 的介绍}。 -\centerline{\textcolor{red}{\bfseries 广告位招租!}} +\section{用户作品计划} + +Elegant\LaTeX{} 系列模板从创立至今已经有 9 年了,我们的模板也受到了很多用户的喜爱,在此,为了促进模板用户之间的交流,了解用户需求,完善本模板,我们将建立一个区域专门展示用户的文档,包括但不限于 GitHub 和官网等。如果你愿意将自己的作品展示出来,请邮件或者其他方式联系我们。如果自己代码已经传到 GitHub 或者 Gitee 等网站,可以提供对应网址。\href{https://github.com/ElegantLaTeX/Archive/tree/master/Collections}{用户文档中心}目前有下面一些作品: +\begin{enumerate} +\item 唐绍东:微积分笔记 +\item 曲豆豆:超甜微积分习题集 +\item 王世强:《化工数值计算与 MATLAB》复习指南 +\item 李晨迪:Fluid Mechanics Notes +\item 肖明顺:地球物理勘查常用规范汇编 +\item 白衣卿相:期末复习笔记-拓扑学摘要 +\end{enumerate} \section{关于提交} + 出于某些因素的考虑,Elegant\LaTeX{} 项目自 2019 年 5 月 20 日开始,\textbf{不再接受任何非作者预约性质的提交}(pull request)!如果你想改进模板,你可以给我们提交 issues,或者可以在遵循协议(LPPL-1.3c)的情况下,克隆到自己仓库下进行修改。 \section{协作人员招募} -招募 Elegant\LaTeX{} 的协作人员,没有工资。工作内容:翻译 Elegant\LaTeX{} 系列模板相关的文稿(中文->英文),维护模板的 wiki(主要涉及 Markdown 语法),如果有公众号文稿写作经历的话,也可以帮忙写微信稿。本公告长期有效。 -目前 ElegantLaTeX 共有 4 名协作人员,分别是 +招募 Elegant\LaTeX{} 的协作人员(志愿者),没有报酬。工作内容:翻译 Elegant\LaTeX{} 系列模板文档,维护模板的维基,如果有公众号文稿写作经历的话,也可以帮忙写微信稿。本公告长期有效。目前 Elegant\LaTeX{} 共有 4 名协作人员,在此感谢他们无私的奉献! \begin{itemize} - \item 官方文档翻译: \href{https://github.com/peggy2006xzyz}{YPY}; - \item Github 维基维护: \href{https://github.com/izinngo}{Ingo Zinngo}、\href{https://github.com/xiaohao890809}{追寻原风景}; - \item QQ 群管理员: \href{https://github.com/sikouhjw}{Sikouhjw}. + \item 官方文档翻译: \href{https://github.com/peggy2006xzyz}{YPY}; + \item GitHub 维基维护: \href{https://github.com/izinngo}{Ingo Zinngo}、\href{https://github.com/xiaohao890809}{追寻原风景}; + \item QQ 群管理、FAQ 整理: \href{https://github.com/sikouhjw}{Sikouhjw}. \end{itemize} -在此感谢他们无私的奉献! +另外,也感谢 \href{https://github.com/stone-zeng}{Xiangdong Zeng}、\href{https://github.com/latexers}{逐鹿人}等人帮忙群管理。 \section{致谢} -2019 年 5 月 20 日,ElegantBook 模板在 Github 上的收藏数(star)达到了 100\footnote{截止 2019 年 8 月 18 日 3.09 版本正式发布,star 数为 189。}。 +2019 年 5 月 20 日,ElegantBook 模板在 GitHub 上的收藏数(star)达到了 100\footnote{截止 3.10 版本正式发布,star 数为 374。}。在此特别感谢 China\TeX{} 以及 \href{http://www.latexstudio.net/}{\LaTeX{} 工作室}对于本系列模板的大力宣传与推广。\LaTeX{} 工作室网站上有很多精彩的帖子和精致的模板,欢迎大家去挖掘里面的宝藏,这也是国内最全面的 \LaTeX{} 相关的网站。 -在此特别感谢 China\TeX{} 以及 \href{http://www.latexstudio.net/}{\LaTeX{} 工作室}对于本系列模板的大力宣传与推广。\LaTeX{} 工作室网站上有很多精彩的帖子和精致的模板,欢迎大家去挖掘里面的宝藏。这也是国内最全面的 \LaTeX{} 相关的网站。也非常感谢 \href{https://github.com/muzimuzhi}{muzimuzhi} 对于模板的完善。 - -如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。 -\begin{figure}[htbp] -\centering -\includegraphics[width=\textwidth]{star.png} -\caption{一键三连求赞} -\end{figure} - -\begin{figure}[htbp] -\centering -\includegraphics[width=0.618\textwidth]{star-history.png} -\caption{Elegant\LaTeX{} 系列模板上线 Github 之后上每周 Star 数变化} -\end{figure} +如果你喜欢我们的模板,你可以在 GitHub 上收藏我们的模板。 +%\begin{figure}[htbp] +% \centering +% \includegraphics[width=\textwidth]{star.png} +% \caption{一键三连求赞} +%\end{figure} \section{捐赠} -如果您非常喜爱我们的模板或者我,你还可以选择捐赠以表达您对我们模板和我的支持。本模板自 3.08 版本发布了捐赠信息之后,收到了近千元的捐赠(四舍五入就是一个亿),非常感谢! + +如果您非常喜爱我们的模板或者我,你还可以选择捐赠\footnote{最好在捐赠时备注信息。}以表达您对我们模板和我的支持。本模板自 3.08 版本发布了捐赠信息之后,收到了超过 1500 元的捐赠(四舍五入就是一个亿),非常感谢! \begin{figure}[htbp] \centering @@ -133,28 +184,52 @@ Elegant\LaTeX{} 系列模板从创立至今已经有 8 年了,我们的模板 \textbf{赞赏费用的使用解释权归 Elegant\LaTeX{} 所有,并且不接受监督,请自愿理性打赏}。10 元以上的赞赏,我们将列入捐赠榜,谢谢各位金主! -\begin{table}[!htbp] +\begin{table}[!htb] \centering - \caption{捐赠榜} - \begin{tabular}{crcc} - \toprule - 捐赠者 & 金额 & 时间 & 渠道 \\ - \midrule - Lerh & 10 元 & 2019/05/15 & 微信 \\ - 越过地平线 & 10 元 & 2019/05/15 & 微信 \\ - 大熊 & 20 元 & 2019/05/27 & 微信 \\ - 佚名 & 10 元 & 2019/05/30 & 微信\\ - \href{http://www.latexstudio.net/}{latexstudio.net} & 666 元 & 2019/06/05 & 支付宝\\ - Cassis & 11 元 & 2019/06/30 & 微信\\ - 佚名 & 10 元 & 2019/07/23 & 微信\\ - \bottomrule + \caption{Elegant\LaTeX{} 系列模板捐赠榜} + \begin{tabular}{*{4}{>{\scriptsize}c}|*{4}{>{\scriptsize}c}} + \hline + \textbf{捐赠者} & \textbf{金额} & \textbf{时间} & \textbf{渠道} & \textbf{捐赠者} & \textbf{金额} & \textbf{时间} & \textbf{渠道} \\ + \hline + Lerh & 10 RMB & 2019/05/15 & 微信 & 越过地平线 & 10 RMB & 2019/05/15 & 微信 \\ + 银桑 & 20 RMB & 2019/05/27 & 微信 & *空 & 10 RMB & 2019/05/30 & 微信 \\ + latexstudio.net & 666 RMB & 2019/06/05 & 支付宝 & A*n & 40 RMB & 2019/06/15 & 微信 \\ + * 夏 & 22 RMB & 2019/06/15 & 微信 & * 倩 & 21 RMB & 2019/06/15 & 微信 \\ + Cassis & 11 RMB & 2019/06/30 & 微信 & *君 & 10 RMB & 2019/07/23 & 微信 \\ + P*u & 50 RMB & 2019/07/30 & 微信 & *萌 & 19 RMB & 2019/08/28 & 微信 \\ + 曲豆豆 & 10 RMB & 2019/08/28 & 微信 & 李博 & 100 RMB & 2019/10/06 & 微信 \\ + Njustsll & 10 RMB & 2019/10/11 & 微信 & 刘志阔 & 99.99 RMB & 2019/10/15 & 支付宝 \\ + * 韬 & 16 RMB & 2019/10/17 & 微信 & 赤霓 & 12 RMB & 2019/10/17 & 支付宝 \\ + 追寻原风景 & 10 RMB & 2019/10/28 & 微信 & 郭德良 & 88 RMB & 2019/11/03 & 微信 \\ + 自强不息 & 20 RMB & 2019/11/04 & 支付宝 & 读书之虫 & 20 RMB & 2019/11/18 & 微信 \\ + *等 & 10 RMB & 2019/11/18 & 微信 & *哲 & 20 RMB & 2019/11/18 & 微信 \\ + 佚名 & 10 RMB & 2019/11/24 & 微信 & Jiye Qian & 66 RMB & 2019/12/04 & 微信 \\ + * 阳 & 20 RMB & 2019/12/05 & 微信 & Catcher & 11 RMB & 2019/12/08 & 支付宝 \\ + 希尔波特门徒 & 10 RMB & 2019/12/09 & 支付宝 & * 伟 & 10 RMB & 2019/12/09 & 微信 \\ + Simon & 20 RMB & 2019/12/11 & 支付宝 & 流殇丶浅忆 & 66.60 RMB & 2019/12/18 & 支付宝 \\ + 羽 & 10 RMB & 2019/12/20 & 支付宝 & * 琛 & 15 RMB & 2019/12/20 & 微信 \\ + 随风 & 20 RMB & 2019/12/27 & 支付宝 & Ws & 23.30 RMB & 2019/12/28 & 微信 \\ + 初八 & 100 RMB & 2020/01/02 & 支付宝 & p*e & 20 RMB & 2020/01/03 & 微信 \\ + Shunmx & 100 RMB & 2020/01/03 & 微信 & hj & 10 RMB & 2020/01/03 & 微信 \\ + F*5 & 10 RMB & 2020/01/03 & 微信 & S*m & 20.20 RMB & 2020/01/03 & 微信 \\ + 二代青雉 & 13 RMB & 2020/01/14 & 支付宝 & *? & 66 RMB & 2020/01/15 & 微信 \\ + Mr. Xiong & 20 RMB & 2020/01/17 & 微信 & *博 & 15 RMB & 2020/01/18 & 微信 \\ + *者 & 10 RMB & 2020/02/02 & 微信 & Jackie & 88.80 RMB & 2020/02/09 & 微信 \\ + \hline \end{tabular}% + \label{tab:donation}% \end{table}% +另外,为了表示感谢,我们制作了捐赠纪念证,欢迎大家来信告知邮箱以及姓名(艺名),我们将通过邮件发送电子版纪念证。 + +\begin{figure}[!htbp] +\centering +\includegraphics[width=0.7\textwidth]{cert.pdf} +\end{figure} \chapter{ElegantBook 设置说明} -本模板基于基础的 book 文类,所以 book 的选项对于本模板也是有效的(纸张无效,因为模板有设备选项)。默认编码为 UTF-8,推荐使用 \TeX{} Live 编译。本文编写环境为 Win10 (64bit) + \TeX{} Live 2019,支持 \lstinline{PDFLaTeX} 以及 \lstinline{XeLaTeX} 编译。 +本模板基于基础的 book 文类,所以 book 的选项对于本模板也是有效的(纸张无效,因为模板有设备选项)。默认编码为 UTF-8,推荐使用 \TeX{} Live 编译。本文编写环境为 Win10 (64bit) + \TeX{} Live 2019,支持 \hologo{pdfLaTeX} 以及 \hologo{XeLaTeX} 编译。中文请尽量使用 \hologo{XeLaTeX} 编译。 \section{语言模式} 本模板内含两套语言环境,改变语言环境会改变图表标题的引导词(图,表),文章结构词(比如目录,参考文献等),以及定理环境中的引导词(比如定理,引理等)。不同语言模式的启用如下: @@ -164,7 +239,7 @@ Elegant\LaTeX{} 系列模板从创立至今已经有 8 年了,我们的模板 \end{lstlisting} \begin{remark} -只有中文环境(\lstinline{lang=cn})才可以输入中文。另外如果抄录环境(\lstinline{lstlisting})中有中文字符,请务必使用 \lstinline{XeLaTeX} 编译。 +只有中文环境(\lstinline{lang=cn})才可以输入中文。另外如果抄录环境(\lstinline{lstlisting})中有中文字符,请务必使用 \hologo{XeLaTeX} 编译。 \end{remark} \section{设备选项} @@ -175,6 +250,7 @@ Elegant\LaTeX{} 系列模板从创立至今已经有 8 年了,我们的模板 \end{lstlisting} \section{颜色主题} + 本模板内置 5 组颜色主题,分别为 \textcolor{structure1}{\lstinline{green}}\footnote{为原先默认主题。}、\textcolor{structure2}{\lstinline{cyan}}、\textcolor{structure3}{\lstinline{blue}}(默认)、\textcolor{structure4}{\lstinline{gray}}、\textcolor{structure5}{\lstinline{black}}。另外还有一个自定义的选项 \lstinline{nocolor}。调用颜色主题 \lstinline{green} 的方法为 \begin{lstlisting} \documentclass[green]{elegantbook} %or @@ -182,46 +258,43 @@ Elegant\LaTeX{} 系列模板从创立至今已经有 8 年了,我们的模板 \end{lstlisting} \begin{table}[htbp] -\caption{ElegantBook 模板中的颜色主题\label{tab:color thm}} -\centering -\begin{tabular}{ccccccc} -\toprule - & \textcolor{structure1}{green} - & \textcolor{structure2}{cyan} - & \textcolor{structure3}{blue} - & \textcolor{structure4}{gray} - & \textcolor{structure5}{black} - & 主要使用的环境\\ -\midrule -structure & \makecell{{\color{structure1}\rule{1cm}{1cm}}} - & \makecell{{\color{structure2}\rule{1cm}{1cm}}} - & \makecell{{\color{structure3}\rule{1cm}{1cm}}} - & \makecell{{\color{structure4}\rule{1cm}{1cm}}} - & \makecell{{\color{structure5}\rule{1cm}{1cm}}} - & chapter \ section \ subsection \\ - -main & \makecell{{\color{main1}\rule{1cm}{1cm}}} - & \makecell{{\color{main2}\rule{1cm}{1cm}}} - & \makecell{{\color{main3}\rule{1cm}{1cm}}} - & \makecell{{\color{main4}\rule{1cm}{1cm}}} - & \makecell{{\color{main5}\rule{1cm}{1cm}}} - & definition \ exercise \ problem \\ - -second & \makecell{{\color{second1}\rule{1cm}{1cm}}} - & \makecell{{\color{second2}\rule{1cm}{1cm}}} - & \makecell{{\color{second3}\rule{1cm}{1cm}}} - & \makecell{{\color{second4}\rule{1cm}{1cm}}} - & \makecell{{\color{second5}\rule{1cm}{1cm}}} - & theorem \ lemma \ corollary\\ - -third & \makecell{{\color{third1}\rule{1cm}{1cm}}} - & \makecell{{\color{third2}\rule{1cm}{1cm}}} - & \makecell{{\color{third3}\rule{1cm}{1cm}}} - & \makecell{{\color{third4}\rule{1cm}{1cm}}} - & \makecell{{\color{third5}\rule{1cm}{1cm}}} - & proposition\\ -\bottomrule -\end{tabular} + \caption{ElegantBook 模板中的颜色主题\label{tab:color thm}} + \centering + \begin{tabular}{ccccccc} + \toprule + & \textcolor{structure1}{green} + & \textcolor{structure2}{cyan} + & \textcolor{structure3}{blue} + & \textcolor{structure4}{gray} + & \textcolor{structure5}{black} + & 主要使用的环境\\ + \midrule + structure & \ccr{structure1} + & \ccr{structure2} + & \ccr{structure3} + & \ccr{structure4} + & \ccr{structure5} + & chapter \ section \ subsection \\ + main & \ccr{main1} + & \ccr{main2} + & \ccr{main3} + & \ccr{main4} + & \ccr{main5} + & definition \ exercise \ problem \\ + second & \ccr{second1} + & \ccr{second2} + & \ccr{second3} + & \ccr{second4} + & \ccr{second5} + & theorem \ lemma \ corollary\\ + third & \ccr{third1} + & \ccr{third2} + & \ccr{third3} + & \ccr{third4} + & \ccr{third5} + & proposition\\ + \bottomrule + \end{tabular} \end{table} 如果需要自定义颜色的话请选择 \lstinline{nocolor} 选项或者使用 \lstinline{color=none},然后在导言区定义 structurecolor、main、second、third 颜色,具体方法如下: @@ -232,8 +305,41 @@ third & \makecell{{\color{third1}\rule{1cm}{1cm}}} \definecolor{third}{RGB}{0,80,80} \end{lstlisting} +\section{封面} -\section{章标题显示风格} +\subsection{封面个性化} + +从 3.10 版本开始,封面更加弹性化,用户可以自行选择输出的内容,包括 \lstinline{\title} 在内的所有封面元素都可为空。目前封面的元素有 +\begin{itemize} + \item 标题:\lstinline{\title} + \item 副标题:\lstinline{\subtitle} + \item 作者:\lstinline{\author} + \item 机构:\lstinline{\institute} + \item 日期:\lstinline{\date} + \item 版本:\lstinline{\version} + \item 箴言:\lstinline{\extrainfo} + \item 封面图:\lstinline{\cover} + \item 徽标:\lstinline{\logo} +\end{itemize} + +另外,额外增加一个 \lstinline{\bioinfo} 命令,有两个选项,分别是信息标题以及信息内容。比如需要显示{\kaishu User Name:111520},则可以使用 +\begin{lstlisting} +\bioinfo{User Name}{115520} +\end{lstlisting} + +\subsection{封面图} + +本模板使用的封面图片来源于 \href{https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/}{pixabay.com}\footnote{感谢 China\TeX{} 提供免费图源网站,另外还推荐 \href{https://www.pexels.com/}{pexels.com}。},图片完全免费,可用于任何场景。封面图片的尺寸为 $1280 \times 1024$, 更换图片的时候请\textbf{严格}按照封面图片尺寸进行裁剪。推荐一个免费的在线图片裁剪网站 \href{https://www.fotor.com/cn}{fotor.com}。用户 QQ 群内有一些合适尺寸的封面,欢迎取用。 + +\subsection{徽标} + +本文用到的 Logo 比例为 1:1,也即正方形图片,在更换图片的时候请选择合适的图片进行替换。 + +\subsection{自定义封面} + +另外,如果需要使用自定义的封面,比如 Adobe illustrator 或者其他软件制作的 A4 PDF 文档,请把 \lstinline{\maketitle} 注释掉,然后借助 \lstinline{pdfpages} 宏包将自制封面插入即可。如果使用 \lstinline{titlepage} 环境,也是类似。如果需要 2.x 版本的封面,请参考 \href{https://github.com/EthanDeng/etitlepage}{etitlepage}。 + +\section{章标标题} 本模板内置 2 套\textit{章标题显示风格},包含 \lstinline{hang}(默认)与 \lstinline{display} 两种风格,区别在于章标题单行显示(\lstinline{hang})与双行显示(\lstinline{display}),本说明使用了 \lstinline{hang}。调用方式为 \begin{lstlisting} @@ -241,6 +347,12 @@ third & \makecell{{\color{third1}\rule{1cm}{1cm}}} \documentclass[titlestyle=hang]{elegantbook} \end{lstlisting} +在章标题内,章节编号默认是以数字显示,也即{\kaishu 第 1 章},{\kaishu 第 2 章}等等,如果想要把数字改为中文,可以使用 +\begin{lstlisting} +\documentclass[chinese]{elegantbook} %or +\documentclass[scheme=chinese]{elegantbook} +\end{lstlisting} + \section{数学环境简介} 在我们这个模板中,我们定义了两种不同的定理模式 \lstinline{mode},包括简单模式(\lstinline{simple})和炫彩模式(\lstinline{fancy}),默认为 \lstinline{fancy} 模式,不同模式的选择为 @@ -252,18 +364,19 @@ third & \makecell{{\color{third1}\rule{1cm}{1cm}}} 本模板定义了四大类环境 \begin{itemize} -\item \textit{定理类环境},包含标题和内容两部分,全部定理类环境的编号均以章节编号。根据格式的不同分为 3 种 - \begin{itemize} + \item \textit{定理类环境},包含标题和内容两部分,全部定理类环境的编号均以章节编号。根据格式的不同分为 3 种 + \begin{itemize} \item \textcolor{main}{\textbf{definition}} 环境,颜色为 \textcolor{main}{main}; \item \textcolor{second}{\textbf{theorem、lemma、corollary}} 环境,颜色为 \textcolor{second} {second}; \item \textcolor{third}{\textbf{proposition}} 环境,颜色为 \textcolor{third}{third}。 - \end{itemize} -\item \textit{示例类环境},有 \textbf{example、problem、exercise} 环境(对应于例、例题、练习),自动编号,编号以章节为单位,其中 \textbf{exercise} 有提示符。 -\item \textit{提示类环境},有 \textbf{note} 环境,特点是:无编号,有引导符。 -\item \textit{结论类环境},有 \textbf{conclusion、assumption、property,remark、solution} 环境\footnote{本模板还添加了一个 result 选项,用于隐藏 \lstinline{solution} 和 \lstinline{proof} 环境,默认为显示(\lstinline{result=answer}),隐藏使用 \lstinline{result=noanswer}。},三者均以粗体的引导词为开头,和普通段落格式一致。 + \end{itemize} + \item \textit{示例类环境},有 \textbf{example、problem、exercise} 环境(对应于例、例题、练习),自动编号,编号以章节为单位,其中 \textbf{exercise} 有提示符。 + \item \textit{提示类环境},有 \textbf{note} 环境,特点是:无编号,有引导符。 + \item \textit{结论类环境},有 \textbf{conclusion、assumption、property,remark、solution} 环境\footnote{本模板还添加了一个 result 选项,用于隐藏 \lstinline{solution} 和 \lstinline{proof} 环境,默认为显示(\lstinline{result=answer}),隐藏使用 \lstinline{result=noanswer}。},三者均以粗体的引导词为开头,和普通段落格式一致。 \end{itemize} \subsection{定理类环境的使用} + 由于本模板使用了 \lstinline{tcolorbox} 宏包来定制定理类环境,所以和普通的定理环境的使用有些许区别,定理的使用方法如下: \begin{lstlisting} \begin{theorem}{theorem name}{label} @@ -294,6 +407,7 @@ The content of theorem. \subsection{其他环境的使用} + 其他三种环境没有选项,可以直接使用,比如 \lstinline{example} 环境的使用方法与效果: \begin{lstlisting} \begin{example} @@ -301,62 +415,51 @@ The content of theorem. \end{example} \end{lstlisting} -\begin{example} -This is the content of example environment. -\end{example} - - 这几个都是同一类环境,区别在于 \begin{itemize} - \item 示例环境(example)、练习(exercise)与例题(problem)章节自动编号; - \item 注意(note),练习(exercise)环境有提醒引导符; - \item 结论(conclusion)等环境都是普通段落环境,引导词加粗。 + \item 示例环境(example)、练习(exercise)与例题(problem)章节自动编号; + \item 注意(note),练习(exercise)环境有提醒引导符; + \item 结论(conclusion)等环境都是普通段落环境,引导词加粗。 \end{itemize} \section{装饰物} -本模板为章节后和页面下方的装饰物(base)添加了隐藏选项,有 \lstinline{show} 和 \lstinline{hide} 两个选项。 +本模板为章节后和页面下方的装饰物(base)添加了隐藏选项,有 \lstinline{show}(默认) 和 \lstinline{hide} 两个选项。 \begin{lstlisting} \documentclass[hide]{elegantbook} %or \documentclass[base=hide]{elegantbook} \end{lstlisting} -\section{封面和徽标} - -本模板使用的封面图片来源于 \href{https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/}{pixabay.com}\footnote{感谢 China\TeX{} 提供免费图源网站,另外还推荐 \href{https://www.pexels.com/}{pexels.com}。},图片完全免费,可用于任何场景。封面图片的尺寸为 $1280 \times 1024$, 更换图片的时候请\textbf{严格}按照封面图片尺寸进行裁剪。推荐一个免费的在线图片裁剪网站 \href{https://www.fotor.com/cn}{fotor.com}。用户 QQ 群内有一些合适尺寸的封面,欢迎取用。 - -本文用到的 Logo 比例为 1:1,也即正方形图片,在更换图片的时候请选择合适的图片进行替换。 - \section{列表环境} 本模板借助于 \lstinline{tikz} 定制了 \lstinline{itemize} 和 \lstinline{enumerate} 环境,其中 \lstinline{itemize} 环境修改了 3 层嵌套,而 \lstinline{enumerate} 环境修改了 4 层嵌套(仅改变颜色)。示例如下\\[2ex] \begin{minipage}[b]{0.49\textwidth} -\begin{itemize} - \item first item of nesti; - \item second item of nesti; - \begin{itemize} - \item first item of nestii; - \item second item of nestii; + \begin{itemize} + \item first item of nesti; + \item second item of nesti; \begin{itemize} - \item first item of nestiii; - \item second item of nestiii. - \end{itemize} - \end{itemize} -\end{itemize} + \item first item of nestii; + \item second item of nestii; + \begin{itemize} + \item first item of nestiii; + \item second item of nestiii. + \end{itemize} + \end{itemize} + \end{itemize} \end{minipage} \begin{minipage}[b]{0.49\textwidth} -\begin{enumerate} - \item first item of nesti; - \item second item of nesti; - \begin{enumerate} - \item first item of nestii; - \item second item of nestii; + \begin{enumerate} + \item first item of nesti; + \item second item of nesti; \begin{enumerate} - \item first item of nestiii; - \item second item of nestiii. - \end{enumerate} - \end{enumerate} -\end{enumerate} + \item first item of nestii; + \item second item of nestii; + \begin{enumerate} + \item first item of nestiii; + \item second item of nestiii. + \end{enumerate} + \end{enumerate} + \end{enumerate} \end{minipage} \section{参考文献} @@ -369,42 +472,60 @@ This is the content of example environment. \nocite{*} %include all the bibitems \end{lstlisting} -本模板还添加了 \lstinline{cite=numbers} 、\lstinline{cite=super} 和 \lstinline{cite=authoryear} 三个参考文献选项,用于设置参考文献格式的设置,默认为 \lstinline{numbers}。据我们所知,理工科类一般使用数字形式 \lstinline{numbers} 或者上标形式 \lstinline{super},而文科类使用作者--年份 \lstinline{authoryear} 比较多,所以我们将 \lstinline{numbers} 作为默认格式。如果需要改为 \lstinline{cite=super} 或者 \lstinline{authoryear} ,可以使用 +本模板还添加了 \lstinline{cite=numbers} 、\lstinline{cite=super} 和 \lstinline{cite=authoryear} 三个参考文献选项,用于设置参考文献格式的设置,默认为 \lstinline{numbers}。据我们所知,理工科类一般使用数字形式 \lstinline{numbers} 或者上标形式 \lstinline{super},而文科类使用作者-年份 \lstinline{authoryear} 比较多,所以我们将 \lstinline{numbers} 作为默认格式。如果需要改为 \lstinline{cite=super} 或者 \lstinline{authoryear} ,可以使用 \begin{lstlisting} -\documentclass[cite=super]{elegantbook} % set cite for super style ref style +\documentclass[cite=super]{elegantbook} % set super style ref style \documentclass[super]{elegantbook} -\documentclass[cite=authoryear]{elegantbook} % set cite for author year ref style +\documentclass[cite=authoryear]{elegantbook} % set author year ref style \documentclass[authoryear]{elegantbook} \end{lstlisting} +为了方便文献样式修改,模板引入了 \lstinline{bibstyle} 选项,默认为 apalike,更多的选择可以参考 \href{https://www.overleaf.com/learn/latex/Bibtex_bibliography_styles}{\hologo{BibTeX} Bibliography Styles}。用法为 +\begin{lstlisting} + \documentclass[bibstyle=apalike]{elegantbook} +\end{lstlisting} + \section{添加序章} 如果你想在第一章前面添序章,不改变原本章节序号,可以在第一章内容前面使用 \begin{lstlisting} \chapter*{Introduction} -\addcontentsline{toc}{chapter}{Introduction} -\markboth{Introduction}{} +\markboth{Introduction}{Introduction} The content of introduction. \end{lstlisting} +\section{目录选项与深度} +本模板添加了一个目录选项 \lstinline{toc},可以设置目录为单栏(\lstinline{onecol})和双栏(\lstinline{twocol})显示,比如双栏显示可以使用 +\begin{lstlisting} +\documentclass[twocol]{elegantbook} +\documentclass[toc=twocol]{elegantbook} +\end{lstlisting} + +默认本模板目录深度为 1,你可以在导言区使用 +\begin{lstlisting} +\setcounter{tocdepth}{2} +\end{lstlisting} +将其修改为 2 级目录(章与节)显示。 + + \section{章节摘要} 模板新增了一个章节摘要环境(introduction),使用示例 \begin{lstlisting} \begin{introduction} - \item Definition of Theorem - \item Ask for help - \item Optimization Problem - \item Property of Cauchy Series - \item Angle of Corner + \item Definition of Theorem + \item Ask for help + \item Optimization Problem + \item Property of Cauchy Series + \item Angle of Corner \end{introduction} \end{lstlisting} 效果如下: \begin{introduction} - \item Definition of Theorem - \item Ask for help - \item Optimization Problem - \item Property of Cauchy Series - \item Angle of Corner + \item Definition of Theorem + \item Ask for help + \item Optimization Problem + \item Property of Cauchy Series + \item Angle of Corner \end{introduction} 环境的标题文字可以通过这个环境的可选参数进行修改,修改方法为: @@ -419,26 +540,34 @@ The content of introduction. \begin{lstlisting} \begin{problemset} - \item exercise 1 - \item exercise 2 - \item exercise 3 + \item exercise 1 + \item exercise 2 + \item exercise 3 \end{problemset} \end{lstlisting} 效果如下: \begin{problemset} - \item exercise 1 - \item exercise 2 - \item exercise 3 + \item exercise 1 + \item exercise 2 + \item exercise 3 + \item 测试数学公式 + \begin{equation} + a^2+b^2=c_{2_{i}} (1,2) [1,23] + \end{equation} \end{problemset} \begin{remark} 如果你想把 \lstinline{problemset} 环境的标题改为其他文字,你可以类似于 introduction 环境修改 problemset 的可选参数。另外,目前这个环境会自动出现在目录中,但是不会出现在页眉页脚信息中(待解决)。 \end{remark} +\begin{solution} +如果你想把 \lstinline{problemset} 环境的标题改为其他文字,你可以类似于 introduction 环境修改 problemset 的可选参数。另外,目前这个环境会自动出现在目录中,但是不会出现在页眉页脚信息中(待解决)。 +\end{solution} \section{旁注} + 在 3.08 版本中,我们引入了 旁注设置选项 \lstinline{marginpar=margintrue} 以及测试命令 \lstinline{\elegantpar} ,但是由此带来一堆问题。我们决定在 3.09 版本中将其删除,并且,在旁注命令得到大幅度优化之前,不会将此命令再次引入书籍模板中。对此造成各位用户的不方便,非常抱歉!不过我们保留了 \lstinline{marginpar} 这个选项,你可以使用 \lstinline{marginpar=margintrue} 获得保留右侧旁注的版面设计。然后使用系统自带的 \lstinline{\marginpar} 或者 \lstinline{marginnote} 宏包的 \lstinline{\marginnote} 命令。 \begin{remark} @@ -450,9 +579,9 @@ The content of introduction. % equation \marginpar{ - \begin{equation} - a^2 + b^2 = c^2 - \end{equation} + \begin{equation} + a^2 + b^2 = c^2 + \end{equation} } \end{lstlisting} @@ -461,45 +590,70 @@ The content of introduction. \begin{lstlisting} % graph with centerline command \marginpar{ - \centerline{ - \includegraphics[width=0.2\textwidth]{logo.png} - } - \captionof{figure}{your figure caption} + \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} + \begin{center} + \includegraphics[width=0.2\textwidth]{logo.png} + \captionof{figure}{your figure caption} + \end{center} } \end{lstlisting} \end{remark} -\section{连字符} -由于模板使用了 \lstinline{newtx} 系列字体宏包,所以在使用本模板的时候,需要注意下连字符的问题。 + +\chapter{字体选项} +字体选项独立成章的原因是,我们希望本模板的用户关心模板使用的字体,知晓自己使用的字体以及遇到字体相关的问题能更加便捷地找到答案。 + +\textcolor{red}{\bfseries 重要提示}:从 3.10 版本更新之后,沿用至今的 newtx 系列字体被重新更改为 cm 字体。并且新增中文字体(\lstinline{chinesefont})选项。 + +\section{数学字体选项} + +本模板定义了一个数学字体选项(\lstinline{math}),可选项有三个: +\begin{enumerate} + \item \lstinline{math=cm}(默认),使用 \LaTeX{} 默认数学字体(推荐,无需声明); + \item \lstinline{math=newtx},使用 \lstinline{newtxmath} 设置数学字体(潜在问题比较多)。 + \item \lstinline{math=mtpro2},使用 \lstinline{mtpro2} 宏包设置数学字体,要求用户已经成功安装此宏包。 +\end{enumerate} + +\section{使用 newtx 系列字体} + +如果需要使用原先版本的 \lstinline{newtx} 系列字体,可以通过显示声明数学字体: + +\begin{lstlisting} +\documentclass[math=newtx]{elegantbook} +\end{lstlisting} + +\subsection{连字符} + +如果使用 \lstinline{newtx} 系列字体宏包,需要注意下连字符的问题。 \begin{equation} - \int_{R^q} f(x,y) dy.\emph{of\kern0pt f} + \int_{R^q} f(x,y) dy.\emph{of\kern0pt f} \end{equation} 的代码为 \begin{lstlisting} \begin{equation} - \int_{R^q} f(x,y) dy.\emph{of \kern0pt f} + \int_{R^q} f(x,y) dy.\emph{of \kern0pt f} \end{equation} \end{lstlisting} -\section{符号字体} -在 3.08 版本中,用户反馈模板在和 \lstinline{yhmath} 以及 \lstinline{esvect} 等宏包搭配使用的时候会出现报错: +\subsection{宏包冲突} + +另外在 3.08 版本中,有用户反馈模板在和 \lstinline{yhmath} 以及 \lstinline{esvect} 等宏包搭配使用的时候会出现报错: \begin{lstlisting} LaTeX Error: Too many symbol fonts declared. \end{lstlisting} -原因是模板重新定义了数学字体,达到了 {\heiti 最多 16 个数学字体} 的上限,在调用其他宏包的时候,无法新增数学字体。为了减少调用非常用宏包,在此给出如何调用 \lstinline{yhmath} 以及 \lstinline{esvect} 宏包的方法。 +原因是在使用 \lstinline{newtxmath} 宏包时,重新定义了数学字体用于大型操作符,达到了 {\heiti 最多 16 个数学字体} 的上限,在调用其他宏包的时候,无法新增数学字体。为了减少调用非常用宏包,在此给出如何调用 \lstinline{yhmath} 以及 \lstinline{esvect} 宏包的方法。 -请在 \lstinline{elegantbook.cls} 内搜索 \lstinline{yhmath} 或者 \lstinline{esvect},将你所需要的宏包加载语句取消注释即可。 +请在 \lstinline{elegantbook.cls} 内搜索 \lstinline{yhmath} 或者 \lstinline{esvect},将你所需要的宏包加载语句\textit{取消注释}即可。 \begin{lstlisting} %%% use yhmath pkg, uncomment following code % \let\oldwidering\widering @@ -511,16 +665,53 @@ LaTeX Error: % \RequirePackage{esvect} \end{lstlisting} +\section{中文字体选项} +模板从 3.10 版本提供中文字体选项 \lstinline{chinesefont},可选项有 +\begin{enumerate} +\item \lstinline{ctexfont}:默认选项,使用 \lstinline{ctex} 宏包根据系统自行选择字体,可能存在字体缺失的问题,更多内容参考 \lstinline{ctex} 宏包\href{https://ctan.org/pkg/ctex}{官方文档}\footnote{可以使用命令提示符,输入 \lstinline{texdoc ctex} 调出本地 \lstinline{ctex} 宏包文档}。 +\item \lstinline{founder}:方正字体选项,调用 \lstinline{ctex} 宏包并且使用 \lstinline{fontset=none} 选项,然后设置字体为方正四款免费字体,方正字体下载注意事项见后文。 +\item \lstinline{nofont}:调用 \lstinline{ctex} 宏包并且使用 \lstinline{fontset=none} 选项,不设定中文字体,用户可以自行设置中文字体,具体见后文。 +\end{enumerate} + +\begin{remark} + 使用 \lstinline{founder} 选项或者 \lstinline{nofont} 时,必须使用 \hologo{XeLaTeX} 进行编译。 +\end{remark} + +\subsection{方正字体选项} +由于使用 \lstinline{ctex} 宏包默认调用系统已有的字体,部分系统字体缺失严重,因此,用户希望能够使用其它字体,我们推荐使用方正字体。方正的{\songti 方正书宋}、{\heiti 方正黑体}、{\kaishu 方正楷体}、{\fangsong 方正仿宋}四款字体均可免费试用,且可用于商业用途。 + +用户可以自行从\href{http://www.foundertype.com/}{方正字体官网}下载此四款字体,在下载的时候请\textbf{务必}注意选择 GBK 字符集 +\begin{figure}[!htb] +\centering +\includegraphics[width=0.9\textwidth]{founder.png} +\end{figure} +也可以使用 \href{https://www.latexstudio.net/}{\LaTeX{} 工作室}提供的\href{https://pan.baidu.com/s/1BgbQM7LoinY7m8yeP25Y7Q}{方正字体,提取码为:njy9} 进行安装。安装时,{\kaishu Win 10 用户请右键选择为全部用户安装,否则会找不到字体。} + +\subsection{其他中文字体} +如果你想完全自定义字体\footnote{这里仍然以方正字体为例。},你可以选择 \lstinline{chinesefont=nofont},然后在导言区设置 +\begin{lstlisting} +\setCJKmainfont[BoldFont={FZHei-B01},ItalicFont={FZKai-Z03}]{FZShuSong-Z01} +\setCJKsansfont[BoldFont={FZHei-B01},ItalicFont={FZHei-B01}]{FZHei-B01} +\setCJKmonofont[BoldFont={FZHei-B01},ItalicFont={FZHei-B01}]{FZFangSong-Z02} +\setCJKfamilyfont{zhsong}{FZShuSong-Z01} +\setCJKfamilyfont{zhhei}{FZHei-B01} +\setCJKfamilyfont{zhkai}{FZKai-Z03} +\setCJKfamilyfont{zhfs}{FZFangSong-Z02} +\newcommand*{\songti}{\CJKfamily{zhsong}} +\newcommand*{\heiti}{\CJKfamily{zhhei}} +\newcommand*{\kaishu}{\CJKfamily{zhkai}} +\newcommand*{\fangsong}{\CJKfamily{zhfs}} +\end{lstlisting} \chapter{ElegantBook 写作示例} \begin{introduction} -\item 积分定义~\ref{def:int} -\item Fubini 定理~\ref{thm:fubi} -\item 最优性原理~\ref{pro:max} -\item 柯西列性质~\ref{property:cauchy} -\item 韦达定理 + \item 积分定义~\ref{def:int} + \item Fubini 定理~\ref{thm:fubi} + \item 最优性原理~\ref{pro:max} + \item 柯西列性质~\ref{property:cauchy} + \item 韦达定理 \end{introduction} \section{Lebesgue 积分} @@ -534,7 +725,7 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 我们将通过三个步骤定义可测函数的积分。首先定义非负简单函数的积分。以下设 $E$ 是 $\mathcal{R}^n$ 中的可测集。 -\begin{definition}{可积性}{int} +\begin{definition}{可积性}{int} 设 $ f(x)=\sum\limits_{i=1}^{k} a_i \chi_{A_i}(x)$ 是 $E$ 上的非负简单函数,其中 $\{A_1,A_2,\ldots,A_k\}$ 是 $E$ 上的一个可测分割,$a_1,a_2,\ldots,a_k$ 是非负实数。定义 $f$ 在 $E$ 上的积分为 $\int_{a}^b f(x)$ \begin{equation} \label{inter} @@ -543,7 +734,6 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 一般情况下 $0 \leq \int_{E} f dx \leq \infty$。若 $\int_{E} f dx < \infty$,则称 $f$ 在 $E$ 上可积。 \end{definition} - 一个自然的问题是,Lebesgue 积分与我们所熟悉的 Riemann 积分有什么联系和区别?在 4.4 在我们将详细讨论 Riemann 积分与 Lebesgue 积分的关系。这里只看一个简单的例子。设 $D(x)$ 是区间 $[0,1]$ 上的 Dirichlet 函数。即 $D(x)=\chi_{Q_0}(x)$,其中 $Q_0$ 表示 $[0,1]$ 中的有理数的全体。根据非负简单函数积分的定义,$D(x)$ 在 $[0,1]$ 上的 Lebesgue 积分为 \begin{equation} \label{inter2} @@ -552,7 +742,6 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 即 $D(x)$ 在 $[0,1]$ 上是 Lebesgue 可积的并且积分值为零。但 $D(x)$ 在 $[0,1]$ 上不是 Riemann 可积的。 - 有界变差函数是与单调函数有密切联系的一类函数。有界变差函数可以表示为两个单调递增函数之差。与单调函数一样,有界变差函数几乎处处可导。与单调函数不同,有界变差函数类对线性运算是封闭的,它们构成一线空间。练习题 \ref{exer:43} 是一个性质的证明。 \begin{exercise}\label{exer:43} @@ -564,21 +753,13 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 是 $\mathcal{R}^1$ 上的连续函数。 \end{exercise} -\begin{problem} -即 $D(x)$ 在 $[0,1]$ 上是 Lebesgue 可积的并且积分值为零。但 $D(x)$ 在 $[0,1]$ 上不是 Riemann 可积的。 -\end{problem} - -\begin{example} +\begin{solution} 即 $D(x)$ 在 $[0,1]$ 上是 Lebesgue 可积的并且积分值为零。但 $D(x)$ 在 $[0,1]$ 上不是 Riemann 可积的。 -\end{example} +\end{solution} \begin{proof} -测试证明环境 -\end{proof} - -\begin{solution} 即 $D(x)$ 在 $[0,1]$ 上是 Lebesgue 可积的并且积分值为零。但 $D(x)$ 在 $[0,1]$ 上不是 Riemann 可积的。 -\end{solution} +\end{proof} \begin{theorem}{Fubini 定理}{fubi} (1)若 $f(x,y)$ 是 $\mathcal{R}^p\times\mathcal{R}^q$ 上的非负可测函数,则对几乎处处的 $x\in \mathcal{R}^p$,$f(x,y)$ 作为 $y$ 的函数是 $\mathcal{R}^q$ 上的非负可测函数,$g(x)=\int_{\mathcal{R}^q}f(x,y) dy$ 是 $\mathcal{R}^p$ 上的非负可测函数。并且 @@ -586,6 +767,7 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \label{eq:461} \int_{\mathcal{R}^p\times\mathcal{R}^q} f(x,y) dxdy=\int_{\mathcal{R}^p}\left(\int_{\mathcal{R}^q}f(x,y)dy\right)dx. \end{equation} + (2)若 $f(x,y)$ 是 $\mathcal{R}^p\times\mathcal{R}^q$ 上的可积函数,则对几乎处处的 $x\in\mathcal{R}^p$,$f(x,y)$ 作为 $y$ 的函数是 $\mathcal{R}^q$ 上的可积函数,并且 $g(x)=\int_{\mathcal{R}^q}f(x,y) dy$ 是 $\mathcal{R}^p$ 上的可积函数。而且~\ref{eq:461} 成立。 \end{theorem} @@ -602,9 +784,9 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 我们知道最小二乘法可以用来处理一组数据,可以从一组测定的数据中寻求变量之间的依赖关系,这种函数关系称为经验公式。本课题将介绍最小二乘法的精确定义及如何寻求点与点之间近似成线性关系时的经验公式。假定实验测得变量之间的 $n$ 个数据,则在平面上,可以得到 $n$ 个点,这种图形称为 “散点图”,从图中可以粗略看出这些点大致散落在某直线近旁, 我们认为其近似为一线性函数,下面介绍求解步骤。 \begin{figure}[htbp] - \centering - \includegraphics[width=0.6\textwidth]{scatter.pdf} - \caption{散点图示例 $\hat{y}=a+bx$ \label{fig:scatter}} + \centering + \includegraphics[width=0.6\textwidth]{scatter.pdf} + \caption{散点图示例 $\hat{y}=a+bx$ \label{fig:scatter}} \end{figure} 以最简单的一元线性模型来解释最小二乘法。什么是一元线性模型呢?监督学习中,如果预测的变量是离散的,我们称其为分类(如决策树,支持向量机等),如果预测的变量是连续的,我们称其为回归。回归分析中,如果只包括一个自变量和一个因变量,且二者的关系可用一条直线近似表示,这种回归分析称为一元线性回归分析。如果回归分析中包括两个或两个以上的自变量,且因变量和自变量之间是线性关系,则称为多元线性回归分析。对于二维空间线性是一条直线;对于三维空间线性是一个平面,对于多维空间线性是一个超平面。 @@ -629,132 +811,71 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \chapter{常见问题集} -\begin{custom}{问题} -有没有办法章节用“第一章,第一节,(一)”这种? -\end{custom} - -\begin{solution} -你可以修改模板中对于章节的设置,利用 ctex 宏集的 \lstinline{\zhnumber} 命令可以把计数器的数字形式转为中文。 -\end{solution} - - -\begin{custom}{问题} -3.07 版本的 cls 的 natbib 加了numbers 编译完了没变化,群主设置了不可更改了? -\end{custom} - -\begin{solution} -3.07 中在 \lstinline{gbt7714} 宏包使用时,加入了 \lstinline{authoryear} 选项,这个使得 \lstinline{natbib} 设置了 \lstinline{numbers} 也无法生效。3.08 和 3.09 版本中,模板新增加了 \lstinline{numbers} 、\lstinline{super} 和 \lstinline{authoryear} 文献选项,你可以参考前文设置说明。 -\end{solution} - -\begin{custom}{问题} -大佬,我想把正文字体改为亮色,背景色改为黑灰色。 -\end{custom} - -\begin{solution} -页面颜色可以使用 \lstinline{\pagecolor} 命令设置,文本命令可以参考\href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{这里}进行设置。 -\end{solution} - -\begin{custom}{问题} -\lstinline[breaklines]{Package ctex Error: CTeX fontset `Mac' is unavailable.} -\end{custom} - -\begin{solution} -在 Mac 系统下,中文编译请使用 \lstinline{XeLaTeX}。 -\end{solution} - -\begin{custom}{问题} -\lstinline{! LaTeX Error: Unknown option `scheme=plain' for package `ctex'.} -\end{custom} - -\begin{solution} -你用的 C\TeX{} 套装吧?这个里面的 \lstinline{ctex} 宏包已经是已经是 10 年前的了,与本模板使用的 \lstinline{ctex} 宏集有很大区别。不建议 C\TeX{} 套装了,请卸载并安装 \TeX{} Live 2019。 -\end{solution} - -\begin{custom}{问题} -我该使用什么版本? -\end{custom} - -\begin{solution} -请务必使用\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{最新正式发行版},发行版间不定期可能会有更新(修复 bug 或者改进之类),如果你在使用过程中没有遇到问题,不需要每次更新\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版},但是在发行版更新之后,请尽可能使用最新版(发行版)!最新发行版可以在 Github 或者 \TeX{} Live 2019 内获取。 -\end{solution} - - -\begin{custom}{问题} -我该使用什么编辑器? -\end{custom} - -\begin{solution} -你可以使用 \TeX{} Live 2019 自带的编辑器 \TeX{}works 或者使用 \TeX{}studio,\TeX works 的自动补全,你可以参考我们的总结 \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX works 自动补全}。推荐使用 \TeX{} Live 2019 + \TeX Studio。我自己用 VS Code 和 Sublime Text,相关的配置说明,请参考 \href{https://github.com/EthanDeng/vscode-latex}{\LaTeX{} 编译环境配置:Visual Studio Code 配置简介} 和 \href{https://github.com/EthanDeng/sublime-text-latex}{Sublime Text 搭建 \LaTeX{} 编写环境}。 -\end{solution} - - -\begin{custom}{问题} -您好,我们想用您的 ElegantBook 模板写一本书。关于机器学习的教材,希望获得您的授权,谢谢您的宝贵时间。 -\end{custom} - -\begin{solution} -模板的使用修改都是自由的,你们声明模板来源以及模板地址(github 地址)即可,其他未尽事宜按照开源协议 LPPL-1.3c。做好之后,如果方便的话,可以给我们一个链接,我把你们的教材放在 ElegantLaTeX 用户作品集里。 -\end{solution} - -\begin{custom}{问题} -我想要原来的封面! -\end{custom} - -\begin{solution} -我们计划在未来版本加入封面选择,让用户可以选择旧版封面。 -\end{solution} - -\begin{custom}{问题} -我想修改中文字体! -\end{custom} - -\begin{solution} -首先,我们{\heiti 强烈建议你不要去修改字体}!如果你一定坚持修改字体,请在 \lstinline{newtxtext} 宏包加载前加入中文字体设置(\lstinline{xeCJK} 宏包)。 - -如果你选择自定义字体,请设置好 \lstinline{\kaishu},\lstinline{\heiti} 等命令,否则会报错。如果你看不懂我现在说的,请停止你的字体自定义行为。 -\end{solution} - -\begin{custom}{问题} -请问交叉引用是什么? -\end{custom} - -\begin{solution} -本群和本模板适合有一定 \LaTeX{} 基础的用户使用,新手请先学习 \LaTeX{} 的基础,理解各种概念,否则你将寸步难行。 -\end{solution} - -\begin{custom}{问题} -定义等环境中无法使用加粗命令么? -\end{custom} - -\begin{solution} -是这样的,默认中文并没加粗命令,如果你想在定义等环境中使用加粗命令,请使用 \lstinline{\heiti} 等字体命令,而不要使用 \lstinline{\textbf}。或者,你可以将 \lstinline{\textbf} 重新定义为 \lstinline{\heiti}。英文模式不存在这个问题。 -\end{solution} +我们根据用户社区反馈整理了下面一些常见的问题,用户在遇到问题时,应当首先查阅本手册和本部分的常见的问题。 + +\begin{enumerate}[itemsep=1.5ex] + \item \question{有没有办法章节用“第一章,第一节,(一)”这种?} + 见前文介绍,可以使用 \lstinline{scheme=chinese} 设置。 + \item \question{3.07 版本的 cls 的 natbib 加了numbers 编译完了没变化,群主设置了不可更改了?} + 之前在 3.07 版本中在引入 \lstinline{gbt7714} 宏包时,加入了 \lstinline{authoryear} 选项,这个使得 \lstinline{natbib} 设置了 \lstinline{numbers} 也无法生效。3.08 和 3.09 版本中,模板新增加了 \lstinline{numbers} 、\lstinline{super} 和 \lstinline{authoryear} 文献选项,你可以参考前文设置说明。 + \item \question{大佬,我想把正文字体改为亮色,背景色改为黑灰色。} + 页面颜色可以使用 \lstinline{\pagecolor} 命令设置,文本命令可以参考\href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{这里}进行设置。 + \item \question{\lstinline[breaklines]{Package ctex Error: CTeX fontset `Mac' is unavailable.}} + 在 Mac 系统下,中文编译请使用 \hologo{XeLaTeX}。 + \item \question{\lstinline{! LaTeX Error: Unknown option `scheme=plain' for package `ctex'.}} + 你用的 C\TeX{} 套装吧?这个里面的 \lstinline{ctex} 宏包已经是已经是 10 年前的了,与本模板使用的 \lstinline{ctex} 宏集有很大区别。不建议 C\TeX{} 套装了,请卸载并安装 \TeX{} Live 2019。 + \item \question{我该使用什么版本?} + 请务必使用\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{最新正式发行版},发行版间不定期可能会有更新(修复 bug 或者改进之类),如果你在使用过程中没有遇到问题,不需要每次更新\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版},但是在发行版更新之后,请尽可能使用最新版(发行版)!最新发行版可以在 GitHub 或者 \TeX{} Live 2019 内获取。 + \item \question{我该使用什么编辑器?} + 你可以使用 \TeX{} Live 2019 自带的编辑器 \TeX{}works 或者使用 \TeX{}studio,\TeX works 的自动补全,你可以参考我们的总结 \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX works 自动补全}。推荐使用 \TeX{} Live 2019 + \TeX{}studio。我自己用 VS Code 和 Sublime Text,相关的配置说明,请参考 \href{https://github.com/EthanDeng/vscode-latex}{\LaTeX{} 编译环境配置:Visual Studio Code 配置简介} 和 \href{https://github.com/EthanDeng/sublime-text-latex}{Sublime Text 搭建 \LaTeX{} 编写环境}。 + \item \question{您好,我们想用您的 ElegantBook 模板写一本书。关于机器学习的教材,希望获得您的授权,谢谢您的宝贵时间。} + 模板的使用修改都是自由的,你们声明模板来源以及模板地址(GitHub 地址)即可,其他未尽事宜按照开源协议 LPPL-1.3c。做好之后,如果方便的话,可以给我们一个链接,我把你们的教材放在 Elegant\LaTeX{} 用户作品集里。 + \item \question{请问交叉引用是什么?} + 本群和本模板适合有一定 \LaTeX{} 基础的用户使用,新手请先学习 \LaTeX{} 的基础,理解各种概念,否则你将寸步难行。 + \item \question{定义等环境中无法使用加粗命令么?} + 是这样的,默认中文并没加粗命令,如果你想在定义等环境中使用加粗命令,请使用 \lstinline{\heiti} 等字体命令,而不要使用 \lstinline{\textbf}。或者,你可以将 \lstinline|\textbf| 重新定义为 \lstinline|\heiti|。英文模式不存在这个问题。 + \item \question{代码高亮环境能用其他语言吗?} + 可以的,ElegantBook 模板用的是 \lstinline{listings} 宏包,你可以在环境(\lstinline{lstlisting})之后加上语言(比如 Python 使用 \lstinline{language=Python} 选项),全局语言修改请使用 \lstinline{lsset} 命令,更多信息请参考宏包文档。 + \item \question{群主,什么时候出 Beamer 的模板(主题),ElegantSlide 或者 ElegantBeamer?} + 由于 Beamer 中有一个很优秀的主题 \href{https://github.com/matze/mtheme}{Metropolis}。在找到非常好的创意之前不会发布正式的 Beamer 主题,如果你非常希望得到 Elegant\LaTeX{} “官方”的主题,请在用户 QQ 群内下载测试主题 PreElegantSlide。正式版制作计划在今年或者明年。 +\end{enumerate} -\begin{custom}{问题} -代码高亮环境能用其他语言吗? -\end{custom} +\chapter{版本更新历史} -\begin{solution} -可以的,ElegantBook 模板用的是 \lstinline{listings} 宏包,你可以在环境(\lstinline{lstlisting})之后加上语言(比如 Python 使用 \lstinline{language=Python} 选项),全局语言修改请使用 \lstinline{\lstset} 命令,更多信息请参考宏包文档。 -\end{solution} +根据用户的反馈,我们不断修正和完善模板。截止到此次更新,ElegantBook 模板在 GitHub 上有将近 100 次提交,正式发行版本(release)有 16 次。 +\datechange{2020/02/10}{版本 3.10 正式发布} -\begin{custom}{问题} -群主,什么时候出 Beamer 的模板(主题),ElegantSlide 或者 ElegantBeamer? -\end{custom} +\begin{change} + \item 增加数学字体选项 \lstinline{math},可选项为 \lstinline{newtx} 和 \lstinline{cm}。\\ + \textbf{重要提示}:原先通过 \lstinline{newtxmath} 宏包设置的数学字体改为 \LaTeX{} 默认数学字体,如果需要保持原来的字体,需要显式声明数学字体(\lstinline{math=newtx}); + \item 新增中文字体选项 \lstinline{chinesefont},可选项为 \lstinline{ctexfont}、\lstinline{founder} 和 \lstinline{nofont}。 + \item 将封面作者信息设置为可选,并且增加自定义信息命令 \lstinline{\bioinfo}; + \item 在说明文档中增加版本历史,新增 \lstinline{\datechange} 命令和 \lstinline{change} 环境; + \item 增加汉化章节选项 \lstinline{scheme},可选项为汉化 \lstinline{chinese}; + \item 由于 \lstinline{\lvert} 问题已经修复,重新调整 \lstinline{ctex} 宏包和 \lstinline{amsmath} 宏包位置。 + \item 修改页眉设置,去除了 \lstinline{\lastpage} 以避免 page anchor 问题,加入 \lstinline{\frontmatter}。 + \item 修改参考文献选项 \lstinline{cite},可选项为数字 \lstinline{number}、 作者-年份 \lstinline{authoryear} 以及上标 \lstinline{super}。 + \item 新增参考文献样式选项 \lstinline{bibstyle},并将英文模式下参考文献样式 \lstinline{apalike} 设置为默认值,中文仍然使用 \lstinline{gbt7714} 宏包设置。 +\end{change} -\begin{solution} -这个问题问的人比较多,我这里给个明确的答案。由于 Beamer 中有一个很优秀的主题 \href{https://github.com/matze/mtheme}{Metropolis}。我觉得在我们找到非常好的创意之前不会发布正式的 Beamer 主题,如果你非常希望得到 Elegant\LaTeX{} “官方”的主题,请在用户 QQ 群内下载我们测试主题 PreElegantSlide(未来不一定按照这个制作)。正式版制作计划在 2020 年之后。 -\end{solution} +\datechange{2019/08/18}{版本 3.09 正式发布} +\begin{change} + \item 由于 \lstinline{\elegantpar} 存在一些问题,暂时性删除 \lstinline{\elegantpar} 命令,并提示用户改用 \lstinline{\marginnote} 和 \lstinline{\marginpar} 旁注/边注命令。 + \item 积分操作符统一更改为 \lstinline{esint} 宏包设置; + \item 新增目录选项 \lstinline{toc},可选项为单栏 \lstinline{onecol} 和双栏 \lstinline{twocol}; + \item 手动增加参考文献选项 \lstinline{cite},可选项为上标形式 \lstinline{super}; + \item 修正章节习题(\lstinline{problemset})环境。 +\end{change} \nocite{*} - \bibliography{reference} - \appendix + \chapter{基本数学工具} + 本附录包括了计量经济学中用到的一些基本数学,我们扼要论述了求和算子的各种性质,研究了线性和某些非线性方程的性质,并复习了比例和百分数。我们还介绍了一些在应用计量经济学中常见的特殊函数,包括二次函数和自然对数,前 4 节只要求基本的代数技巧,第 5 节则对微分学进行了简要回顾;虽然要理解本书的大部分内容,微积分并非必需,但在一些章末附录和第 3 篇某些高深专题中,我们还是用到了微积分。 \section{求和算子与描述统计量} @@ -765,37 +886,6 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \sum_{i=1}^n x_i \equiv x_1 + x_2 +\cdots + x_n \end{equation} -\chapter{最小示例} - -\begin{lstlisting} -\documentclass[lang=cn,11pt]{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} diff --git a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.pdf b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.pdf Binary files differindex ddd962011aa..f0d48639fc6 100644 --- a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.pdf +++ b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.pdf diff --git a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.tex b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.tex index 1976c97a390..e38d5ea75d0 100644 --- a/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.tex +++ b/Master/texmf-dist/doc/latex/elegantbook/elegantbook-en.tex @@ -1,146 +1,182 @@ -\documentclass[fancy,11pt,twocol]{elegantbook} +\documentclass[lang=en,11pt]{elegantbook} \title{An Elegant \LaTeX{} Template for Books} \subtitle{Classic Elegant\LaTeX{} Template} \author{Ethan Deng \& Liam Huang} \institute{Elegant\LaTeX{} Program} -\date{\today} -\version{3.09} +\date{February 10, 2020} +\version{3.10} +\bioinfo{Bio}{Information} \extrainfo{Victory won\rq t come to us unless we go to it. } -\logo{logo.png} +\logo{logo-blue.png} \cover{cover.jpg} \begin{document} \maketitle + +\frontmatter \tableofcontents -\clearpage -\thispagestyle{empty} -\mainmatter -\hypersetup{pageanchor=true} +\mainmatter \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 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} + \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: Elegant\LaTeX{} + \item Wechat: Elegant\LaTeX{} + \item QQ: 692108391 + \item Email: \email{elegantlatex2e@gmail.com} \end{itemize} \section{ElegantBook Updates} What\rq s new in this version: \begin{enumerate} - \item Remove \lstinline|\elegantpar|; - \item Fix math symbol font settings; - \item Introduce option \lstinline|twocol| for toc; - \item Revise footnote layout; - \item Other modifications. + \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{enumerate} + \begin{note} - Users for 2.x, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{conversion}. + If you are using previous version, please delete \lstinline|\hypersetup{pageanchor=true}| and add \lstinline{\frontmatter} after \lstinline{\maketitle} and before \lstinline{\tableofcontents}. Users for 2.x, please refer to \href{https://github.com/ElegantLaTeX/ElegantBook/wiki/convert}{conversion}. \end{note} \section{Installation and Update} -Both portable version and installation package are available for this template. +Both portable version and installation package are available for this template, online usage is optional as well. + +\subsection{To Use Templates Online} +Visit \href{https://www.overleaf.com/}{Overleaf} to use our template online anywhere and anytime without local installation. To find our template, search \lstinline{elegantlatex} in the \lstinline{templates} or simply visit \href{https://www.overleaf.com/latex/templates?addsearch=elegantlatex}{search result}, choose the template you prefer and \lstinline{Open as Template} to own a copy yourself to edit freely. To learn more about Overleaf, please refer to \href{https://www.overleaf.com/learn}{Documentation}. + +\begin{remark} + On Overleaf, please use \hologo{XeLaTeX} to compile articles in Chinese and \hologo{pdfLaTeX} to compile articles in English. +\end{remark} +\subsection{To Use Portable Version} For portable version, simply download lastest ElegantBook-master from Github or CTAN (to be more accurate, download \lstinline{elegantbook.cls}) and save the file(s) under your working directory. This way of installation is simple and convenient, but you have to manually update \lstinline{cls} now and then. +\subsection{To Use Local Installation Version} If you are a \TeX{} Live 2019 user, using the \lstinline{tlshell}\footnote{namely, \TeX{} Live Manager} of \TeX{} Live 2019 direct installation package is strongly recommended. Simply search and open \lstinline{tlshell}, click on \lstinline{File -> Load Default Repository} or customize repository by \lstinline{Options}. Wait till the repository loads successfully, search \lstinline{elegantbook} by name, installation and update is just a click away. \begin{figure}[htbp] - \centering - \includegraphics[width=0.7\textwidth]{tlshell.png} - \caption{Use \TeX{} Live Shell to Install ElegantBook Template} + \centering + \includegraphics[width=0.7\textwidth]{tlshell.png} + \caption{Use \TeX{} Live Shell to Install ElegantBook Template} \end{figure} +\subsection{Update Templates} +If you fail to update templates using \lstinline{tlshell}, please use cmd to update all the packages or switch to portable version instead. + +Use the following commands(administrator privileges) to update: +\begin{lstlisting} +tlmgr update --self +tlmgr update --all +\end{lstlisting} + +To learn more, please refer to \href{https://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \TeX{} distribution?} + +\subsection{Other Release Versions} If you are a \TeX{} Live 2018 user and would like to update to \TeX{} Live 2019, the official solution is to uninstall 2018. If you want to save the bother of uninstallation and installation, please copy \lstinline{elegantbook.cls} to the installation directory of \TeX{} Live 2018 (default: \lstinline|C:\texlive\2018\texmf-dist\tex\latex\elegantbook| ), run \lstinline{texhash} in cmd. 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!}} +Eight years have passed since the found of Elegant\LaTeX{} Program. It\rq s an honor that our templates are preferred by a lot of users. Hence, in order to promote more interactions among our users and know more about what you need, we are planning to provide a platform to display selected works of our users on Github or our homepage. If you want to show us your work(s), contact us via Email or other ways. Or if you have upload your work(s) on Github or Gitee etc., share the URL(s) with us. You can visit current available works \href{https://github.com/ElegantLaTeX/Archive/tree/master/Collections}{here}. \section{About Pull Request} -For some reasons, pull request is unacceptable since May 20, 2019. For those who want to help revise the templates, submit issues or clone to your own repository to modify under the constriction of LPPL-1.3c. +For some reasons, pull requests will NOT by accepted since May 20, 2019. For those who want to help improve the templates, submit issues or clone to your own repository to modify under LPPL-1.3c. \section{Recruit Support Members} -Recruit Support Members for Elegant\LaTeX{} to translate template OGs(Chinese -> English), maintain wiki entries using Markdown, update Wechat articles. No deadline for this recruitment. +Recruit support members for Elegant\LaTeX{} to translate template OGs, 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}. + \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 \& FAQ Maintainer: \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!}. +BTW, thank \href{https://github.com/stone-zeng}{Xiangdong Zeng}, \href{https://github.com/latexers}{Zhuluren}, etc. for their help. -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. +\section{Acknowledgement} +The number of stars on Github for ElegantBook reached 100 on May 20, 2019\footnote{372 stars by February 8, 2020!}.Thank China\TeX{} and \href{http://www.latexstudio.net/}{\LaTeX{} studio} for their promotion. \LaTeX{} studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on \LaTeX{} in China. 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} +To express your love for our templates and/or our developers, please do not hesitate to tip us. Since last release of 3.08, we have received about 1,500 RMB! (The emergence of a millionaire is on the way. Loading... ) +\begin{figure}[!htb] + \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}% +\begin{table}[!htb] + \centering + \caption{Donation List} + \begin{tabular}{*{4}{>{\scriptsize}c}|*{4}{>{\scriptsize}c}} + \toprule + \textbf{Tipper} & \textbf{Amount} & \textbf{Date} & \textbf{Channel} & \textbf{Tipper} & \textbf{Amount} & \textbf{Date} & \textbf{Channel} \\ + \midrule + Lerh & 10 RMB & 2019/05/15 & Wechat & yueguodipingxian & 10 RMB & 2019/05/15 & Wechat \\ + yinsang & 20 RMB & 2019/05/27 & Wechat & *kong & 10 RMB & 2019/05/30 & Wechat \\ + latexstudio.net & 666 RMB & 2019/06/05 & Alipay & A*n & 40 RMB & 2019/06/15 & Wechat \\ + * xia & 22 RMB & 2019/06/15 & Wechat & * qian & 21 RMB & 2019/06/15 & Wechat \\ + Cassis & 11 RMB & 2019/06/30 & Wechat & * jun & 10 RMB & 2019/07/23 & Wechat \\ + P*u & 50 RMB & 2019/07/30 & Wechat & * meng & 19 RMB & 2019/08/28 & Wechat \\ + Qu Doudou & 10 RMB & 2019/08/28 & Wechat & Li Bo & 100 RMB & 2019/10/06 & Wechat \\ + Njustsll & 10 RMB & 2019/10/11 & Wechat & Liu Zhikuo & 99.99 RMB & 2019/10/15 & Alipay \\ + * tao & 16 RMB & 2019/10/17 & Wechat & Chini & 12 RMB & 2019/10/17 & Alipay \\ + yuanfengjing & 10 RMB & 2019/10/28 & Wechat & Guo Deliang & 88 RMB & 2019/11/03 & Wechat \\ + ziqiangbuxi & 20 RMB & 2019/11/04 & Alipay & dushuzhichong & 20 RMB & 2019/11/18 & Wechat \\ + * deng & 10 RMB & 2019/11/18 & Wechat & * zhe & 20 RMB & 2019/11/18 & Wechat \\ + anonymous & 10 RMB & 2019/11/24 & Wechat & Jiye Qian & 66 RMB & 2019/12/04 & Wechat \\ + * yang & 20 RMB & 2019/12/05 & Wechat & Catcher & 11 RMB & 2019/12/08 & Alipay \\ + xierbotementu & 10 RMB & 2019/12/09 & Alipay & * wei & 10 RMB & 2019/12/09 & Wechat \\ + Simon & 20 RMB & 2019/12/11 & Alipay & liushangqianyi & 66.60 RMB & 2019/12/18 & Alipay \\ + yu & 10 RMB & 2019/12/20 & Alipay & *chen & 15 RMB & 2019/12/20 & Wechat \\ + suifeng & 20 RMB & 2019/12/27 & Alipay & Ws & 23.30 RMB & 2019/12/28 & Wechat \\ + chuba & 100 RMB & 2020/01/02 & Alipay & p*e & 20 RMB & 2020/01/03 & Wechat \\ + Shunmx & 100 RMB & 2020/01/03 & Wechat & hj & 10 RMB & 2020/01/03 & Wechat \\ + F*5 & 10 RMB & 2020/01/03 & Wechat & S*m & 20.20 RMB & 2020/01/03 & Wechat \\ + erdaiqingzhi & 13 RMB & 2020/01/14 & Alipay & *? & 66 RMB & 2020/01/15 & Wechat \\ + Mr. Xiong & 20 RMB & 2020/01/17 & Wechat & *bo & 15 RMB & 2020/01/18 & Wechat \\ + *zhe & 10 RMB & 2020/02/02 & Wechat & Jackie & 88.80 RMB & 2020/02/09 & Wechat \\ + \bottomrule + \end{tabular}% + \label{tab:donation}% \end{table}% +BTW, we provide Certificate of Donation for those who donated, tippers please leave your name(nickname) and email address for us to send the certificates. + +\begin{figure}[!htb] + \centering + \includegraphics[width=0.7\textwidth]{cert.pdf} +\end{figure} + \chapter{ElegantBook Settings} -This template is based on the Standard \LaTeX{} book class, so the options of book class work as well (Note that the option of papersize has no effect due to \lstinline{device} option). The default encoding is UTF-8 while \TeX{} Live is recommended. The test environment is Win10 + \TeX{} Live 2019, either \lstinline{PDFLaTeX} or \lstinline{XeLaTeX} works fine. +This template is based on the Standard \LaTeX{} book class, so the options of book class work as well (Note that the option of papersize has no effect due to \lstinline{device} option). The default encoding is UTF-8 while \TeX{} Live is recommended. The test environment is Win10 + \TeX{} Live 2019, either \hologo{pdfLaTeX} or \lstinline{XeLaTeX} works fine. \lstinline{XeLaTeX} is preferred for Chinese articles. \section{Languages} We defined one option named \lstinline{lang} which has two alternative values, \lstinline{lang=en} (default) and \lstinline{lang=cn}. Different values will alter the captions of figure/table, abstract name, refname, etc. You can use this option as @@ -150,11 +186,11 @@ We defined one option named \lstinline{lang} which has two alternative values, \ \end{lstlisting} \begin{remark} -Chinese Characters are acceptable whenever \lstinline{lang=en} or \lstinline{lang=cn}. If you would like to include Chinese characters under (\lstinline{lstlisting}) environment, please use \lstinline{XeLaTeX} to compile. +Chinese Characters are acceptable whenever \lstinline{lang=en} or \lstinline{lang=cn}. If you would like to include Chinese characters under (\lstinline{lstlisting}) environment, please use \hologo{XeLaTeX} to compile. \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} @@ -173,37 +209,37 @@ This template contains 5 color themes, i.e. \textcolor{structure1}{\lstinline{gr \centering \begin{tabular}{ccccccc} \toprule - & \textcolor{structure1}{green} - & \textcolor{structure2}{cyan} - & \textcolor{structure3}{blue} - & \textcolor{structure4}{gray} - & \textcolor{structure5}{black} - & Main Environments\\ + & \textcolor{structure1}{green} + & \textcolor{structure2}{cyan} + & \textcolor{structure3}{blue} + & \textcolor{structure4}{gray} + & \textcolor{structure5}{black} + & Main Environments\\ \midrule structure & \makecell{{\color{structure1}\rule{1cm}{1cm}}} - & \makecell{{\color{structure2}\rule{1cm}{1cm}}} - & \makecell{{\color{structure3}\rule{1cm}{1cm}}} - & \makecell{{\color{structure4}\rule{1cm}{1cm}}} - & \makecell{{\color{structure5}\rule{1cm}{1cm}}} - & chapter section subsection \\ + & \makecell{{\color{structure2}\rule{1cm}{1cm}}} + & \makecell{{\color{structure3}\rule{1cm}{1cm}}} + & \makecell{{\color{structure4}\rule{1cm}{1cm}}} + & \makecell{{\color{structure5}\rule{1cm}{1cm}}} + & chapter section subsection \\ main & \makecell{{\color{main1}\rule{1cm}{1cm}}} - & \makecell{{\color{main2}\rule{1cm}{1cm}}} - & \makecell{{\color{main3}\rule{1cm}{1cm}}} - & \makecell{{\color{main4}\rule{1cm}{1cm}}} - & \makecell{{\color{main5}\rule{1cm}{1cm}}} - & definition exercise problem \\ + & \makecell{{\color{main2}\rule{1cm}{1cm}}} + & \makecell{{\color{main3}\rule{1cm}{1cm}}} + & \makecell{{\color{main4}\rule{1cm}{1cm}}} + & \makecell{{\color{main5}\rule{1cm}{1cm}}} + & definition exercise problem \\ second & \makecell{{\color{second1}\rule{1cm}{1cm}}} - & \makecell{{\color{second2}\rule{1cm}{1cm}}} - & \makecell{{\color{second3}\rule{1cm}{1cm}}} - & \makecell{{\color{second4}\rule{1cm}{1cm}}} - & \makecell{{\color{second5}\rule{1cm}{1cm}}} - & theorem lemma corollary\\ + & \makecell{{\color{second2}\rule{1cm}{1cm}}} + & \makecell{{\color{second3}\rule{1cm}{1cm}}} + & \makecell{{\color{second4}\rule{1cm}{1cm}}} + & \makecell{{\color{second5}\rule{1cm}{1cm}}} + & theorem lemma corollary\\ third & \makecell{{\color{third1}\rule{1cm}{1cm}}} - & \makecell{{\color{third2}\rule{1cm}{1cm}}} - & \makecell{{\color{third3}\rule{1cm}{1cm}}} - & \makecell{{\color{third4}\rule{1cm}{1cm}}} - & \makecell{{\color{third5}\rule{1cm}{1cm}}} - & proposition\\ + & \makecell{{\color{third2}\rule{1cm}{1cm}}} + & \makecell{{\color{third3}\rule{1cm}{1cm}}} + & \makecell{{\color{third4}\rule{1cm}{1cm}}} + & \makecell{{\color{third5}\rule{1cm}{1cm}}} + & proposition\\ \bottomrule \end{tabular} \end{table} @@ -216,16 +252,46 @@ 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} + +\subsection{Cover Image} +The cover image used in this template is from \href{https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/}{pixabay.com}. The image is completely free and can be used under any circumstance. The cover image size is $1280 \times 1024$. If you would like to change the cover, please crop it according to the size of the cover picture strictly. One free online image clipping site: \href{https://www.fotor.com/cn}{fotor.com}. Feel free to join our QQ Group to get more elegant covers. + +\subsection{Logo} +Aspect ratio of the logo is 1:1 in this guide, i.e. a square picture. To replace the logo, do remember to choose the appropriate picture. + +\subsection{Stylized Cover} +Want to use stylized cover?(For instance, A4-sized PDF designed by Adobe Illustrator) Please comment out \lstinline{\maketitle} and use \lstinline{pdfpages} to insert the cover. Similar for using \lstinline{titlepage}. If you would like to use the cover in version 2.x, please refer to \href{https://github.com/EthanDeng/etitlepage}{etitlepage}. \section{Chapter Title Display Styles} -This template contains 2 sets of \textit{title display styles},\lstinline{hang}(default) and \lstinline{display} style. For the former, chapter title is displayed on a single line (\lstinline{hang}). For the latter, chapter title is displayed on a double line (\lstinline{display}).In this guide, we use \lstinline{hang} . To change display style +This template contains 2 sets of \textit{title display styles},\lstinline{hang}(default) and \lstinline{display} style. For the former, chapter title is displayed on a single line (\lstinline{hang}). For the latter, chapter title is displayed on a double line (\lstinline{display}).In this guide, we use \lstinline{hang} . To change display style, use: \begin{lstlisting} \documentclass[hang]{elegantbook} %or \documentclass[titlestyle=hang]{elegantbook} \end{lstlisting} -\section{Theorem Class Environments} + +\section{Introduction of Math Environments} We defined two sets of theorem modes, \lstinline{simple} style and \lstinline{fancy} style (default). You may change to \lstinline{simple} mode by \begin{lstlisting} @@ -244,7 +310,7 @@ In this template, we defined four different theorem class environments \end{itemize} \item \textit{Example Environments}, including \textbf{example, exercise, problem} environment, auto numbering corresponding to chapter. \item \textit{Proof Environment}, including \textbf{proof, note} environment containing introductory symbol (\textbf{note} environment) or ending symbol (\textbf{proof} environment). -\item \textit{Conclusion Environments}, including \textbf{conclusion, assumption, property, remark, solution}\footnote{We also define an option \lstinline{result}, which can hide the \lstinline{solution} and \lstinline{proof} environments. You can switch between \lstinline{result=answer} and \lstinline{result=noanswer}} environment, all of which begin with boldfaced words, with format consistent with normal paragraphs. +\item \textit{Conclusion Environments}, including \textbf{conclusion, assumption, property, remark and solution}\footnote{We also define an option \lstinline{result}, which can hide the \lstinline{solution} and \lstinline{proof} environments. You can switch between \lstinline{result=answer} and \lstinline{result=noanswer}.} environments, all of which begin with boldfaced words, with format consistent with normal paragraphs. \end{itemize} \subsection{Theorem Class Environments} @@ -296,7 +362,7 @@ These are all similar environments with slight differences lies in: \begin{itemize} \item Example, exercise, problem environments number within chapter; \item Note begins with introductory symbol and proof ends with ending symbol; - \item Conclusion environment and so on are normal paragraph environments with boldfaced introductory words. + \item Conclusion and other environments are normal paragraph environments with boldfaced introductory words. \end{itemize} \section{Base Hide Option} @@ -307,12 +373,6 @@ Hiding the end-of-chapter and end-of-page base is optional, simply type in: \end{lstlisting} -\section{Cover and Logo} - -The cover image used in this template is from \href{https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/}{pixabay.com}\footnote{Thank China\TeX{} for providing free image source, \href{https://www.pexels.com/}{pexels.com} is strongly recommended.}. The image is completely free and can be used under any circumstance. The cover image size is $1280 \times 1024$. If you would like to change the cover, please crop it according to the size of the cover picture strictly. One free online image clipping site: \href{https://www.fotor.com/cn}{fotor.com}. Feel free to join our QQ Group to get more elegant covers. - -Aspect ratio of the logo is 1:1 in this guide, i.e. a square picture. To replace the logo, do remember to choose the appropriate picture. - \section{List Environments} This template uses \lstinline{tikz} to customize the list environments, with \lstinline{itemize} environment customized to the third depth and \lstinline{enumerate} environment customized to fourth depth. The effect is as follows\\[2ex] \begin{minipage}[b]{0.49\textwidth} @@ -362,34 +422,52 @@ Three more options \lstinline{cite=numbers}, \lstinline{cite=super} and \lstinli \documentclass[authoryear]{elegantbook} \end{lstlisting} +To change the bibliography style, this version introduces \lstinline{bibstyle} with default option apalike, for more options, refer to \href{https://www.overleaf.com/learn/latex/Bibtex_bibliography_styles}{\hologo{BibTeX} Bibliography Styles}. Type in +\begin{lstlisting} +\documentclass[bibstyle=apalike]{elegantbook} +\end{lstlisting} + \section{Preface} If you want to add a preface before the first chapter with the number of chapter unchanged, please add the preface in the following way: \begin{lstlisting} -\chapter*{Preface} -\addcontentsline{toc}{chapter}{Preface} -\markboth{Preface}{} -The content of Preface. +\chapter*{Introduction} +\markboth{Introduction}{Introduction} +The content of introduction. +\end{lstlisting} + +\section{Content Option and Depth} +This version adds an option for content \lstinline{toc}, you can choose either one column(\lstinline{onecol}) or two columns(\lstinline{twocol}). For two columns: +\begin{lstlisting} +\documentclass[twocol]{elegantbook} +\documentclass[toc=twocol]{elegantbook} \end{lstlisting} +Default content depth is 1, use +\begin{lstlisting} +\setcounter{tocdepth}{2} +\end{lstlisting} +to make it 2. + + \section{Introduction Environment} -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 - \item Ask for help - \item Optimization Problem - \item Property of Cauchy Series - \item Angle of Corner + \item Definition of Theorem + \item Ask for help + \item Optimization Problem + \item Property of Cauchy Series + \item Angle of Corner \end{introduction} \end{lstlisting} -you will get: +And you will get: \begin{introduction} - \item Definition of Theorem - \item Ask for help - \item Optimization Problem - \item Property of Cauchy Series - \item Angle of Corner + \item Definition of Theorem + \item Ask for help + \item Optimization Problem + \item Property of Cauchy Series + \item Angle of Corner \end{introduction} You can change the title of this environment by modifying the optional argument of this environment: @@ -403,26 +481,33 @@ You can change the title of this environment by modifying the optional argument The environment \lstinline{problemset} is used at the end of each chapter to display corresponding exercises. Just type in the following sentences: \begin{lstlisting} \begin{problemset} - \item exercise 1 - \item exercise 2 - \item exercise 3 + \item exercise 1 + \item exercise 2 + \item exercise 3 \end{problemset} \end{lstlisting} And you will get: \begin{problemset} - \item exercise 1 - \item exercise 2 - \item exercise 3 + \item exercise 1 + \item exercise 2 + \item exercise 3 + \item math equation test: + \begin{equation} + a^2+b^2=c_{2_{i}} (1,2) [1,23] + \end{equation} \end{problemset} \begin{remark} -If you want to customize the title of \lstinline{problemset}, please change the optional argument like in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer. +If you want to customize the title of \lstinline{problemset}, please change the optional argument like in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer(to be fixed). \end{remark} +\begin{solution} + If you want to customize the title of \lstinline{problemset}, please change the optional argument like in introduction environment. In this version the \lstinline{problemset} environment automatically appears in the table of contents but not in the header or footer(to be fixed). +\end{solution} + \section{Margin Notes} In 3.08, we introduced \lstinline{marginpar=margintrue} and \lstinline{\elegantpar} (Beta) with piles of bugs. Hence we decide to remove them in 3.09 and will suspend the options till revolutionary optimization. Sorry for all the bugs! However, we retain the option \lstinline{marginpar} for users to get margin motes by activating \lstinline{marginpar=margintrue} and using \lstinline{\marginpar} or \lstinline{marginnote} packages. \begin{remark} - Note that text and equation are both available in the margin notes. \begin{lstlisting} % text @@ -431,7 +516,7 @@ Note that text and equation are both available in the margin notes. % equation \marginpar{ \begin{equation} - a^2 + b^2 = c^2 + a^2 + b^2 = c^2 \end{equation} } \end{lstlisting} @@ -441,24 +526,45 @@ For tables and figures, note that floating environment is not allowed. You have \begin{lstlisting} % graph with centerline command \marginpar{ - \centerline{ - \includegraphics[width=0.2\textwidth]{logo.png} - } - \captionof{figure}{your figure caption} + \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} + \begin{center} + \includegraphics[width=0.2\textwidth]{logo.png} + \captionof{figure}{your figure caption} + \end{center} } \end{lstlisting} \end{remark} -\section{Hyphens} +\chapter{Fonts} +Leave one chapter to introduce fonts to help users to solve font problems conveniently. + +\textcolor{red}{\bfseries Alert} After v3.10, newtx is reset to cm and \lstinline{chinesefont} option is added. + +\section{Math Fonts} +This template defines a new command(\lstinline{math}), with three options: +\begin{enumerate} + \item \lstinline{math=cm}(default), use \LaTeX{} default math font (recommended). + \item \lstinline{math=newtx}, use \lstinline{newtxmath} math font (may bring about bugs). + \item \lstinline{math=mtpro2}, use \lstinline{mtpro2} package to set math font. +\end{enumerate} + +\section{Use newtx fonts} +If you use \lstinline{newtx} fonts, type in: + +\begin{lstlisting} +\documentclass[math=newtx]{elegantbook} +\end{lstlisting} + + +\subsection{Hyphens} Since the template uses \lstinline{newtx}, please pay attention to the hyphens. For instance, \begin{equation} \int_{R^q} f(x,y) dy.\emph{of\kern0pt f} @@ -479,6 +585,7 @@ 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 @@ -536,9 +643,9 @@ Let $z$ be some element of $xH \cap yH$. Then $z = xa$ for some $a \in H$, and \end{proof} \begin{figure}[htbp] - \centering - \includegraphics[width=0.6\textwidth]{scatter.pdf} - \caption{Matplotlib: Scatter Plot Example\label{fig:scatter}} + \centering + \includegraphics[width=0.6\textwidth]{scatter.pdf} + \caption{Matplotlib: Scatter Plot Example\label{fig:scatter}} \end{figure} Regression analysis is a powerful statistical method that allows you to examine the relationship between two or more variables of interest. While there are many types of regression analysis, at their core they all examine the influence of one or more independent variables on a dependent variable. The process of performing a regression allows you to confidently determine which factors matter most, which factors can be ignored, and how these factors influence each other. @@ -571,99 +678,76 @@ Let's continue using our application training example. In this case, we'd want t \lipsum[1-2] \begin{itemize} - \item Routing and resource discovery; - \begin{itemize} - \item Language Models - \item Vector Space Models - \end{itemize} - \item Resilient and scalable computer networks; - \item Distributed storage and search. + \item Routing and resource discovery; + \begin{itemize} + \item Language Models + \item Vector Space Models + \end{itemize} + \item Resilient and scalable computer networks; + \item Distributed storage and search. \end{itemize} \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 slope of the line $5x - 5y = 7$. + \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 slope of the line $5x - 5y = 7$. \end{problemset} \chapter{FAQ} +We list some FAQs for users to refer to: +\begin{enumerate} + \item \question{Why option numbers for natbib fail to take effect in v3.07?} + In v3.07, when \lstinline{gbt7714} is introduced, option \lstinline{authoryear} is incompatible with \lstinline{natbib}. In v3.08 and 3.09, \lstinline{numbers}, \lstinline{numbers}, \lstinline{super} and \lstinline{authoryear} are introduced. + \item \question{I want to customize font and background color.} + Please use \lstinline{pagecolor} to change background color, refer to \href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{this} to customize font. + \item \question{Which version should I choose?} + Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2019. + \item \question{Which editor should I choose?} + You can use \TeX{} Live 2019 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2019 + \TeX{}studio is strongly recommended. I myself use VS Code and Sublime Text. Related configurations can be found at \href{https://github.com/EthanDeng/vscode-latex}{vscode-latex} and \href{https://github.com/EthanDeng/sublime-text-latex}{sublime-text-latex}. + \item \question{Hello, we want to use ElegantBook to write a book about machine learning and would like your authorization.} + Feel free to use our templates by pointing out our copyright. For other issues, please refer to LPPL-1.3c. If you want to show us your work, share the URL with us afterwards. + \item \question{What is cross reference?} + This template is aimed at who are not a complete beginner for \LaTeX{}. Please learn more about \LaTeX{} before using this template. + \item \question{Is the language for code highlighting optional?} + Yes, \lstinline{listings} package is used in ElegantBook, hence language is optional(e.g. \lstinline{language=Python}). For global setting, use \lstinline{lstset}. For more information, please refer to package documentations. + \item \question{When will Beamer template (ElegantSlide or ElegantBeamer) forthcoming?} + Since there is an excellent theme \href{https://github.com/matze/mtheme}{Metropolis}, a Beta theme PreElegantSlide is available in QQ group. Feel free to download. A formal version is forthcoming in this year or next year. +\end{enumerate} -\begin{custom}{Question} - I want to customize font and background color. -\end{custom} - -\begin{solution} - Please use \lstinline{\pagecolor} to change background color, refer to \href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{this} to customize font. -\end{solution} - - -\begin{custom}{Question} - \lstinline[breaklines]{Package ctex Error: CTeX fontset `Mac' is unavailable.} -\end{custom} - -\begin{solution} - Under Mac, please use \lstinline{XeLaTeX} for Chinese documents. -\end{solution} - -\begin{custom}{Question} - Which version should I choose? -\end{custom} - -\begin{solution} - Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2019. -\end{solution} - - -\begin{custom}{Question} - Which editor should I choose? -\end{custom} - -\begin{solution} - You can use \TeX{} Live 2019 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2019 + \TeX{}studio is strongly recommended. I myself use VS Code and Sublime Text. Related configurations can be found at \href{https://github.com/EthanDeng/vscode-latex}{vscode-latex} and \href{https://github.com/EthanDeng/sublime-text-latex}{sublime-text-latex}. -\end{solution} - - -\begin{custom}{Question} - Hello, we want to use ElegantBook to write a book about machine learning and would like your authorization. -\end{custom} - -\begin{solution} - 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} +\chapter{Version History} +We revised our templates now and then. This section shows the version story of ElegantBook. We have nearly 100 submits and 16 releases on GitHub since uploaded. -\begin{solution} - This template is aimed at who are not a complete beginner for \LaTeX{}. Please learn more about \LaTeX{} before using this template. -\end{solution} +\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} -\begin{custom}{Question} - Is the language for code highlighting optional? -\end{custom} +\datechange{2019/08/18}{release of v3.09} -\begin{solution} - Yes, \lstinline{listings} package is used in ElegantBook, hence language is optional(e.g. \lstinline{language=Python}). For global setting, use \lstinline{\lstset}. For more information, please refer to package documentations. -\end{solution} +\begin{change} + \item Remove \lstinline{\elegantpar} temporary and remind users to use \lstinline{\marginnote} and \lstinline{\marginpar} instead. + \item Use \lstinline{esint} to display integral operator. + \item Add new command \lstinline{toc}, with options \lstinline{onecol} and \lstinline{twocol}. + \item Add new option \lstinline{cite} \lstinline{super} for superscript-displayed citation. + \item Revise \lstinline{problemset}. +\end{change} -\nocite{en1,en2,en3} +\nocite{en1,en2,en3} \bibliography{reference} - \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. @@ -676,36 +760,4 @@ 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} +\end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/elegantbook/figure/logo-blue.png b/Master/texmf-dist/doc/latex/elegantbook/figure/logo-blue.png Binary files differnew file mode 100644 index 00000000000..5b6db8397e2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/elegantbook/figure/logo-blue.png diff --git a/Master/texmf-dist/doc/latex/elegantbook/image/cert.pdf b/Master/texmf-dist/doc/latex/elegantbook/image/cert.pdf Binary files differnew file mode 100644 index 00000000000..0ff3e5029cf --- /dev/null +++ b/Master/texmf-dist/doc/latex/elegantbook/image/cert.pdf diff --git a/Master/texmf-dist/doc/latex/elegantbook/image/founder.png b/Master/texmf-dist/doc/latex/elegantbook/image/founder.png Binary files differnew file mode 100644 index 00000000000..7f68e73c6a2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/elegantbook/image/founder.png diff --git a/Master/texmf-dist/doc/latex/elegantbook/image/star-history.png b/Master/texmf-dist/doc/latex/elegantbook/image/star-history.png Binary files differdeleted file mode 100644 index b47076d1b9d..00000000000 --- a/Master/texmf-dist/doc/latex/elegantbook/image/star-history.png +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/elegantbook/image/tlshell.png b/Master/texmf-dist/doc/latex/elegantbook/image/tlshell.png Binary files differindex 6cf1c3ad5c0..6df5fd988c7 100644 --- a/Master/texmf-dist/doc/latex/elegantbook/image/tlshell.png +++ b/Master/texmf-dist/doc/latex/elegantbook/image/tlshell.png |