diff --git a/_Sidebar.md b/_Sidebar.md index 8ebac4e..7f62d06 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,17 +1,25 @@ ## 中文版本 * [模板介绍](https://github.com/ElegantLaTeX/ElegantBook/wiki/介绍) -* 模板使用 - * [安装说明](https://github.com/ElegantLaTeX/ElegantBook/wiki/安装) - * [编译方式](https://github.com/ElegantLaTeX/ElegantBook/wiki/编译方式) + * [安装与更新](https://github.com/ElegantLaTeX/ElegantBook/wiki/安装) + * [更新说明](https://github.com/ElegantLaTeX/ElegantBook/wiki/更新说明) + * [用户作品计划](https://github.com/ElegantLaTeX/ElegantBook/wiki/用户作品计划) + * [关于提交](https://github.com/ElegantLaTeX/ElegantBook/wiki/关于提交) + * [协作人员招募](https://github.com/ElegantLaTeX/ElegantBook/wiki/协作人员招募) + * [致谢](https://github.com/ElegantLaTeX/ElegantBook/wiki/致谢) +* [模板使用](https://github.com/ElegantLaTeX/ElegantBook/wiki/使用) * [语言模式](https://github.com/ElegantLaTeX/ElegantBook/wiki/语言模式) + * [设备选项](https://github.com/ElegantLaTeX/ElegantBook/wiki/设备选项) * [颜色主题](https://github.com/ElegantLaTeX/ElegantBook/wiki/颜色主题) * [显示风格](https://github.com/ElegantLaTeX/ElegantBook/wiki/显示风格) * [定理类环境](https://github.com/ElegantLaTeX/ElegantBook/wiki/定理类环境) + * [装饰物](https://github.com/ElegantLaTeX/ElegantBook/wiki/装饰物) * [封面徽标](https://github.com/ElegantLaTeX/ElegantBook/wiki/封面徽标) * [列表环境](https://github.com/ElegantLaTeX/ElegantBook/wiki/列表环境) * [参考文献](https://github.com/ElegantLaTeX/ElegantBook/wiki/参考文献) * [添加序章](https://github.com/ElegantLaTeX/ElegantBook/wiki/添加序章) + * [章节摘要](https://github.com/ElegantLaTeX/ElegantBook/wiki/章节摘要) + * [章后习题](https://github.com/ElegantLaTeX/ElegantBook/wiki/章后习题) * [示例](https://github.com/ElegantLaTeX/ElegantBook/wiki/最小示例) * [跨版本转换](https://github.com/ElegantLaTeX/ElegantBook/wiki/convert) * 作者 @@ -19,25 +27,32 @@ * [个人主页](https://ddswhu.me/) + ## English Version * [Introduction](https://github.com/ElegantLaTeX/ElegantBook/wiki/Introduction) * How To Use - * [Installation](https://github.com/ElegantLaTeX/ElegantBook/wiki/Installation) + * [Installation and Update](https://github.com/ElegantLaTeX/ElegantBook/wiki/Installation) * [Compilation Methods](https://github.com/ElegantLaTeX/ElegantBook/wiki/CompilationMethods) * [Languages](https://github.com/ElegantLaTeX/ElegantBook/wiki/Languages) * [Color Themes](https://github.com/ElegantLaTeX/ElegantBook/wiki/ColorThemes) - * [Languages](https://github.com/ElegantLaTeX/ElegantBook/wiki/Languages) * [Display Styles](https://github.com/ElegantLaTeX/ElegantBook/wiki/DisplayStyles) * [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantBook/wiki/TheoremClassEnvironments) * [Cover and Logo](https://github.com/ElegantLaTeX/ElegantBook/wiki/CoverLogo) * [Lists](https://github.com/ElegantLaTeX/ElegantBook/wiki/Lists) * [Bibliography](https://github.com/ElegantLaTeX/ElegantBook/wiki/Bibliography) * [Preface](https://github.com/ElegantLaTeX/ElegantBook/wiki/Preface) + * [Device Mode Option](https://github.com/ElegantLaTeX/ElegantBook/wiki/DeviceModeOption) + * [Base Hide Option](https://github.com/ElegantLaTeX/ElegantBook/wiki/BaseHideOption) * [Minimal Example](https://github.com/ElegantLaTeX/ElegantBook/wiki/MinimalExample) +* [Problem Set](https://github.com/ElegantLaTeX/ElegantBook/wiki/ProblemSet) * Author * [Github](https://github.com/EthanDeng) * [Homepage](https://ddswhu.me/) +* [User's Selected Works Plan](https://github.com/ElegantLaTeX/ElegantBook/wiki/UserSelectedWorksPlan) +* [About Pull Request](https://github.com/ElegantLaTeX/ElegantBook/wiki/AboutPullRequest) +* [Recruit Support Members](https://github.com/ElegantLaTeX/ElegantBook/wiki/RecruitSupportMembers) +* [Acknowledgement](https://github.com/ElegantLaTeX/ElegantBook/wiki/Acknowledgement) ## Links/相关链接 diff --git a/introduction.png b/introduction.png new file mode 100644 index 0000000..88ec814 Binary files /dev/null and b/introduction.png differ diff --git a/problemset.png b/problemset.png new file mode 100644 index 0000000..46688ec Binary files /dev/null and b/problemset.png differ diff --git a/介绍.md b/介绍.md index c723c61..0692310 100644 --- a/介绍.md +++ b/介绍.md @@ -1,20 +1,14 @@ -值此版本发行之际,我们 ElegantLaTeX 项目组向大家重新介绍一下我们的工作,我们致力于打造一系列美观、优雅、简便的模板方便用户使用。ElegantLaTeX 系列模板目前由 [ElegantNote](https://github.com/ElegantLaTeX/ElegantNote),[ElegantBook](https://github.com/ElegantLaTeX/ElegantBook),[ElegantPaper](https://github.com/ElegantLaTeX/ElegantPaper) 组成,分别用于排版笔记,书籍和工作论文。这些子项目的名词是一体的,请在使用这些名词的时候不要将其断开(如 Elegant Note 是不正确的写法)。并且,ElegantLaTeX Book 指的即是 ElegantBook。 +ElegantLaTeX 项目组向致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 [ElegantNote](https://github.com/ElegantLaTeX/ElegantNote), [ElegantBook](https://github.com/ElegantLaTeX/ElegantBook), [ElegantPaper](https://github.com/ElegantLaTeX/ElegantPaper) 组成,分别用于排版笔记,书籍和工作论文。强烈推荐使用最新正式版本!本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎在 Github 上给我们提交 [issue](https://github.com/ElegantLaTeX/ElegantBook/issues) 或者邮件联系我们。 -最新版本下载地址:[Github:ElegantBook/releases](https://github.com/ElegantLaTeX/ElegantBook/releases)。本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎联系我们。 +相关联系方式: -## ElegantBook 更新说明 +* 官网:[https://elegantlatex.org/](https://elegantlatex.org/) +* Github 网址:[https://github.com/ElegantLaTeX/](https://github.com/ElegantLaTeX/) +* CTAN 地址:[https://ctan.org/pkg/elegantbook](https://ctan.org/pkg/elegantbook) +* 文档 Wiki:[https://github.com/ElegantLaTeX/ElegantBook/wiki](https://github.com/ElegantLaTeX/ElegantBook/wiki) +* 下载地址:[正式发行版](https://github.com/ElegantLaTeX/ElegantBook/releases),[最新版](https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip) +* 微博:ElegantLaTeX +* 微信公众号:ElegantLaTeX +* 用户 QQ 群:692108391 +* 邮件:[elegantlatex2e@gmail.com](elegantlatex2e@gmail.com) -在这几年间,我们收到了很多用户的反馈,主要的问题涉及到字体安装,编码支持,定理浮动,定理跨页,交叉引用等等。我们思前想后,原先让用户安装字体以追求视觉上的美观并不完美,用户陷入了巨大的麻烦,这违背了我们的模板初衷。因此我们在新版中删除了这部分,用户无需安装任何字体。让我们来看下此次 ElegantBook 模板 3.x 更新的主要内容有: - -1. 删除了自定义字体设置,改用 `ctex` 宏包或者系统默认字体; -2. 模板拆分为中英文模式(`lang=cn/en`); -3. `PDFLaTeX` 与 `XeLaTeX` 支持; -4. 使用 `tcolorbox` 宏包改写定理类环境,可跨页; -5. 定理类环境名字更新,修复定理环境交叉引用; -6. 颜色名字更新,统一链接颜色; -7. 重新绘制 ElegantLaTeX 的 Logo; -8. 更新封面与装饰物,删除水印; -9. 修正附录相关内容; -10. 增加灰色主题 `color=plain`; -11. 增加代码高亮; -12. 美化列表环境。 diff --git a/使用.md b/使用.md new file mode 100644 index 0000000..0384fc9 --- /dev/null +++ b/使用.md @@ -0,0 +1,3 @@ +本模板基于基础的 book 文类,所以 book 的选项对于本模板也是有效的。默认编码为 UTF-8,推荐使用 TeX Live 编译。本文编写环境为 Win10 (64bit) + TeX Live 2019,支持 PDFLaTeX 以及 XeLaTeX 编译。 + + diff --git a/关于提交.md b/关于提交.md new file mode 100644 index 0000000..3062b20 --- /dev/null +++ b/关于提交.md @@ -0,0 +1,3 @@ +### 关于提交 + +出于某些因素的考虑,ElegantLaTeX 项目自 2019 年 5 月 20 日开始,**不再接受任何非作者预约性质的提交**(pull request)!如果你想改进模板,你可以给我们提交 issues,或者可以在遵循协议(LPPL-1.3c)的情况下,克隆到自己仓库下进行修改。 \ No newline at end of file diff --git a/协作人员招募.md b/协作人员招募.md new file mode 100644 index 0000000..389ad91 --- /dev/null +++ b/协作人员招募.md @@ -0,0 +1,10 @@ +### Support 招募 + +招募 ElegantLaTeX 的协作人员,没有工资。工作内容:翻译 ElegantLaTeX系列模板相关的文稿(中文 -> 英文),维护模板的 wiki(主要涉及 Markdown 语法),如果有文稿写作经历也可以帮忙写微信公众号推送。本公告长期有效。 + +感谢我们 ElegantLaTeX 的协作人员,感谢他们无私的工作! + +- 官方指南翻译: [YPY](https://github.com/peggy2006xzyz); +- Wiki 维护: [Ingo Zinngo](https://github.com/izinngo); +- QQ 群管理: [Sikouhjw](https://github.com/sikouhjw). + diff --git a/参考文献.md b/参考文献.md index 724ba5c..8a32b4b 100644 --- a/参考文献.md +++ b/参考文献.md @@ -1,7 +1,16 @@ -此模板使用了 `BibTeX` 来生成参考文献,默认使用的文献样式(bib style)是 `aer`。参考文献示例:Chen et al. (2018) 使用了中国一个大型的 P2P 平台(人人贷)的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。 +此模板使用了 BibTeX 来生成参考文献,在中文示例中,使用了 gbt7714 宏包。参考文献示例:[1-3] 使用了中国一个大型的 P2P 平台(人人贷)的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。 你可以在谷歌学术,Mendeley,Endnote 中获得文献条目(bib item),然后把它们添加到 `reference.bib` 中。在文中引用的时候,引用它们的键值(bib key)即可。注意需要在编译的过程中添加 `BibTeX` 编译。如果你想在参考文献中添加未引用的文献,可以使用 ```tex -\nocite{EINAV2010,Havrylchyk2018} +\nocite{EINAV2010,Havrylchyk2018} %or include some bibitems +\nocite{*} %include all the bibitems ``` + +本模板还添加了 `cite=numbers` 和 `cite=authoryear` 两个参考文献选项,用于设置参考文献格式的设置,默认为 numbers。据我们所知,理工科类一般使用 numbers,而文科类使用 authoryear 比较多,所以我们将 numbers 作为默认格式。如果需要改为 authoryear,可以使用 + +```tex +\documentclass[cite=authoryear]{elegantbook} %or +\documentclass[authoryear]{elegantbook} +``` + diff --git a/安装.md b/安装.md index 38a0910..b30ca44 100644 --- a/安装.md +++ b/安装.md @@ -1,35 +1,24 @@ -本节以 TeX Live 2018 为例,介绍如何通过命令行或者包管理工具安装模板(包)。 +本节介绍如何通过免安装或者安装模板(包)方式使用。 -## 命令行方式安装 +### 免安装方式安装 -以管理员权限打开命令行,在命令行输入下面命令即可安装 elegantbook 模板。 +从 Github 或者 CTAN 下载最新(正式)版文件,严格意义上只需要类文件 `elegantbook.cls`。然后将模板文件放在你的工作目录下即可使用。这样使用的好处是,无需安装,简便;缺点是,当模板进行更新之后,你需要手动替换。 -```shell -tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet -tlmgr install elegantbook -``` +### 安装模板方式安装 -升级和卸载分别使用 +如果你是 TeX Live 2019 用户,我们非常推荐你直接进行安装和更新。你可以通过 TeX Live 2019 自带的tlshell进行安装。安装非常简单,步骤如下,搜索并打开 tlshell,然后通过 `File -> Load Default Repository` 加载远程仓库,如果你不想使用默认的仓库,你可以通过 Options 下的菜单设置远程仓库。设置好仓库之后,等待仓库加载完毕,你可以在下面的搜索栏搜索 elegantbook,然后选择进行安装与更新。 -```shell -tlmgr update elegantbook -tlmgr uninstall elegantbook -``` +![](https://raw.githubusercontent.com/wiki/izinngo/public/image/tlshell.png) -## 包管理工具方式安装 +如果你是 TeX Live 2018 的用户,由于 2018 无法更新到 2019,所以你想更新的话,需要卸载 2018 重装 2019。如果你实在不想折腾,那么你仍然可以使用本模板,你可以手动安装模板,将elegantbook.cls复制到你的 TeXLive 目录下,默认安装目录为 `C:\texlive\2019\texmf-dist\tex\latex\elegantbook`,然后通过命令行(管理员权限),运行 texhash 即可。 -在 Windows 里面搜索 tlmgr,找到 TeX Live Manager 并打开: +啥?你是 CTeX 用户?Sorry,本模板不提供支持。 -![tlmgr](https://elegantlatex.org/image/tlmgr.png) +更多关于 TeX Live 2019 的安装使用以及 CTeX 与 TeX Live 的兼容、系统路径问题,请参考官方文档以及啸行的[一份简短的安装 LaTeX的介绍](https://github.com/OsbertWang/install_latex/releases)。 -然后通过菜单 `tlmgr` 选择 +### 在线使用模板 -```shell -Load standard net repository: http://mirror.ctan.org/systems/texlive/tlnet -``` +考虑到用户的在线合作需求,我们把三套模板全部上传到 [Overleaf](https://www.overleaf.com/) 上了,网络通畅的用户可以直接通过 Overleaf 在线使用我们的模板。这样的好处是无需安装 TeX Live 2019,可以随时随地访问自己的文件。查找模板,请在 Overleaf 模板库里面搜索 elegantlatex 即可,你也可以直接访问[搜索结果](https://www.overleaf.com/latex/templates?addsearch=elegantlatex)。选择适当的模板之后,将其Open as Template,即可把模板存到自己账户下,然后可以自由编辑以及与别人一起协作。更多关于 Overleaf 的介绍和使用,请参考 Overleaf 的[官方文档](https://www.overleaf.com/learn)。 -![tlmgr](https://elegantlatex.org/image/tlmgr-1.png) +**注**:Overleaf 上,中文需要使用 XeLaTeX 进行编译,英文可以使用 PDFLaTeX 与 XeLaTeX 进行编译。 -然后在匹配框内输入包的名字,比如 `elegantbook`,在搜索结果中勾选需要安装/更新/卸载的包: - -![tlmgr](https://elegantlatex.org/image/tlmgr-book.png) diff --git a/定理类环境.md b/定理类环境.md index b3a2eea..d0a7caa 100644 --- a/定理类环境.md +++ b/定理类环境.md @@ -1,3 +1,10 @@ +在我们这个模板中,我们定义了两种不同的定理模式(mode),包括简单模式(simple)和炫彩模式(fancy),默认为 fancy 模式,不同模式的选择为 + +```tex +\documentclass[simple]{elegantbook} %or +\documentclass[mode=simple]{elegantbook} +``` + 在我们这个模板中,定义了四大类环境 + __定理类环境__:包含标题和内容两部分,全部定理类环境的编号均以章节编号。根据格式的不同分为 3 种 @@ -8,25 +15,21 @@ + __证明类环境__:,有 proof、note 环境,特点是,有引导符或者结尾符,note 环境有引导符号,proof 环境有证明完毕符号。 + __结论类环境__:有 conclusion、assumption、property,remark、solution 环境,三者均以粗体的引导词为开头,和普通段落格式一致。 -__评论:__ 在选用 `lang=cn` 时,定理类环境的引导词全部会改为中文。 - -## 定理类环境的使用 +### 定理类环境的使用 由于本模板使用了 tcolorbox 宏包来定制定理类环境,所以和普通的定理环境的使用有些许区别,定理的使用方法如下: ```tex -\begin{theorem}{}{