From 759248d56c99c11171bada8a6a6cb4398c5ea1bf Mon Sep 17 00:00:00 2001 From: EthanDeng Date: Wed, 29 May 2019 23:37:42 +0800 Subject: [PATCH] version 3.08 --- AboutPullRequest.md | 1 + Acknowledgement.md | 22 ++++++++++++++++++ BaseHideOption.md | 9 ++++++++ Bibliography.md | 15 +++++++++--- ColorThemes.md | 12 ++++++---- CompilationMethods.md | 33 --------------------------- CoverLogo.md | 5 ++-- DeviceModeOption.md | 11 +++++++++ DisplayStyles.md | 2 +- FAQ.md | 44 ++++++++++++++++++++++++++++++++++++ HowToUse.md | 3 +++ Installation.md | 42 ++++++++++++---------------------- Introduction.md | 30 ++++++++++-------------- IntroductionEnvironment.md | 24 ++++++++++++++++++++ Languages.md | 7 +++--- Lists.md | 1 + MinimalExample.md | 12 ++-------- Preface.md | 2 +- ProblemSet.md | 22 ++++++++++++++++++ RecruitSupportMembers.md | 8 +++++++ TheoremClassEnvironments.md | 19 +++++++++++----- Updates.md | 16 +++++++++++++ UserSelectedWorksPlan.md | 1 + _Sidebar.md | 23 ++++++++++--------- donate.jpg | Bin 0 -> 23731 bytes introduction2.png | Bin 0 -> 21623 bytes problemset2.png | Bin 0 -> 16188 bytes star.png | Bin 0 -> 45992 bytes 致谢.md | 6 ++--- 29 files changed, 245 insertions(+), 125 deletions(-) create mode 100644 AboutPullRequest.md create mode 100644 Acknowledgement.md create mode 100644 BaseHideOption.md delete mode 100644 CompilationMethods.md create mode 100644 DeviceModeOption.md create mode 100644 FAQ.md create mode 100644 HowToUse.md create mode 100644 IntroductionEnvironment.md create mode 100644 ProblemSet.md create mode 100644 RecruitSupportMembers.md create mode 100644 Updates.md create mode 100644 UserSelectedWorksPlan.md create mode 100644 donate.jpg create mode 100644 introduction2.png create mode 100644 problemset2.png create mode 100644 star.png diff --git a/AboutPullRequest.md b/AboutPullRequest.md new file mode 100644 index 0000000..618f50b --- /dev/null +++ b/AboutPullRequest.md @@ -0,0 +1 @@ +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. \ No newline at end of file diff --git a/Acknowledgement.md b/Acknowledgement.md new file mode 100644 index 0000000..a7098de --- /dev/null +++ b/Acknowledgement.md @@ -0,0 +1,22 @@ +The number of stars on Github for ElegantBook reached 100 on May 20, 2019 and was included in the [Trending](https://github.com/trending/tex?since=daily) under the TeX category. It is a remarkable moment for ElegantLaTeX!!! + +Thank ChinaTeX and [LaTeX studio](http://www.latexstudio.net/) for their promotion. LaTeX studio offers tons of valuable posts and templates for discovery. It is the most comprehensive website on LaTeX in China. + +Thank [muzimuzhi](https://github.com/muzimuzhi) for the revision of the template. + +If you like our template, star on Github. + +![](./star.png) + +Recently some users have expressed their love for our templates and want to tip us. QR code for donation is now available. + +​ ![](./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! + +| Tipper | Amount | Date | Channel | +| :--------------: | :----: | :-------: | :-----: | +| Lerh | 10 RMB | 2019/5/15 | Wechat | +| Yueguodipingxian | 10 RMB | 2019/5/15 | Wechat | +| Daxiong | 20 RMB | 2019/5/27 | Wechat | + diff --git a/BaseHideOption.md b/BaseHideOption.md new file mode 100644 index 0000000..dd226ec --- /dev/null +++ b/BaseHideOption.md @@ -0,0 +1,9 @@ +Hiding the end-of-chapter base is optional, simply type in: + +```tex +\documentclass[hide]{elegantbook} %or +\documentclass[base=hide]{elegantbook} +``` + + + diff --git a/Bibliography.md b/Bibliography.md index 22fcf9b..8133c28 100644 --- a/Bibliography.md +++ b/Bibliography.md @@ -1,7 +1,16 @@ -This template uses `BibTeX` to generate the bibliography, the default bibliography style is `aer`. Let’s take a glance at the citation effect, Chen et al. (2018) use data from a major peer-to-peer lending marketplace in China to study whether female and male investors evaluate loan performance differently. +This template uses `BibTeX` to generate the bibliography, the default bibliography style is `aer`. -If you want to use BibTeX, you must create a file named `reference.bib`, and add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to `reference.bib` file, and cite the bibkey in the `tex` file. The `BibTeX` will automatically generate the bibliography for you for the reference you cited. If you want to add some noncited reference to the bibliography, you can use +If you want to use `BibTeX`, you must create a file named `reference.bib`, add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to `reference.bib` file, then cite the bib key in the `tex` file. The `BibTeX` will automatically generate the bibliography for the reference you cited. If you want to add some non-cited reference to the bibliography, you can use ```tex -\nocite{EINAV2010, Havrylchyk2018} +\nocite{EINAV2010,Havrylchyk2018} %or include some bibitems +\nocite{*} %include all the bibitems ``` + +Two more options `cite=numbers` and `cite=authoryear` are available in this new version, with the default setting as `numbers` since those major in science and technology use `numbers` more often. For those who major in liberal arts want to use `authoryear`, please type in: + +```tex +\documentclass[cite=authoryear]{elegantbook} %or +\documentclass[authoryear]{elegantbook} +``` + diff --git a/ColorThemes.md b/ColorThemes.md index 0c9e49e..ca1fb9b 100644 --- a/ColorThemes.md +++ b/ColorThemes.md @@ -1,14 +1,16 @@ -This template contains 4 color themes,they are green (default), cyan, blue, plain, and there is a customization color option `nocolor`. You can choose green with +This template contains 5 color themes, they are green, cyan, blue(default), gray, black , You can choose green with ```tex \documentclass[green]{elegantbook} %or \documentclass[color=green]{elegantbook} ``` -where plain theme is gray for all theorem class environments and paper structures. If you want to customize the colors, please select `nocolor` or use `color=none` , then define the main, second, and third colors in the preamble section as follows: +If you want to customize the colors, please select `nocolor` or use `color=none` and declare the structurecolor, main, second, and third colors in the preamble section as follows: ```tex -\definecolor{main}{RGB}{70,70,70} -\definecolor{second}{RGB}{115,45,2} -\definecolor{third}{RGB}{0,80,80} +\definecolor{structurecolor}{RGB}{60,113,183} +\definecolor{main}{RGB}{0,166,82}% +\definecolor{second}{RGB}{255,134,24}% +\definecolor{third}{RGB}{0,174,247}% ``` + diff --git a/CompilationMethods.md b/CompilationMethods.md deleted file mode 100644 index bb2bc6c..0000000 --- a/CompilationMethods.md +++ /dev/null @@ -1,33 +0,0 @@ -This template is based on the Standard LaTeX book class, so the options of book class also work. The default encoding is UTF-8, and TeX Live is recommended. The test environment is Win10 + TeX Live 2018. - -## Compile with `PDFLaTeX` - -If you choose PDFLaTeX to process your book, the default article font computer modern has changed to `newtx` series, and the default font size is set to 12pt. The fonts are settings with: - -+ `newtxtext` package for text fonts, similar to Times New Roman font. -+ `newtxmath` package for math fonts, close to `times` package. -+ `FiraMono` package for typewriter fonts, with option `scale=0.7`. -+ `ctex` package for Chinese fonts, with option `scheme=plain`. - -A full compilation chain： `PDFLaTe`X -> `BibTeX` -> `PDFLaTeX`*2. - -## Compile with `XeLaTeX` - -If you choose `XeLaTeX` to process your book, we use `fontspec` package and `xeCJK` package. we used fonts available in Windows, if you are using Linux or Mac OS, please substitute these fonts with that of your system. - -```tex -\RequirePackage{fontenc} -\RequirePackage[no-math]{fontspec} -\setmainfont{Times New Roman}[NFSSFamily=ntxtlf] -\setsansfont{Arial} -%\setmonofont[Scale=0.7]{Courier New} -\RequirePackage{xeCJK} -\RequirePackage{xunicode} -\setCJKmainfont[BoldFont={SimHei},ItalicFont={KaiTi}]{SimSun} -\setCJKsansfont[BoldFont={SimHei},ItalicFont={KaiTi}]{KaiTi} -\setCJKmonofont[BoldFont={SimHei},ItalicFont={KaiTi},Scale=0.7]{Microsoft YaHei} -\XeTeXlinebreaklocale "zh" -\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt -\RequirePackage{newtxmath} -``` -A full compilation chain： `XeLaTeX` -> `BibTeX` -> `XeLaTeX`*2. diff --git a/CoverLogo.md b/CoverLogo.md index c47134b..a90f677 100644 --- a/CoverLogo.md +++ b/CoverLogo.md @@ -1,5 +1,4 @@ -The cover image used in this template is from [pixabay.com](https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/)[1](#myfootnote1). The image is completely free and can be used in any circumstance. The cover image size is 1280*1024, when changing the cover, please crop it according to the size of the cover picture __strictly__. Here is a free online image clipping site: [befunky.com](https://www.befunky.com/create/crop-photo/). +The cover image used in this template is from [pixabay.com](https://pixabay.com/en/tea-time-poetry-coffee-reading-3240766/) (Thank ChinaTeX for providing free image source, [pexels.com](https://www.pexels.com/) is strongly recommended.). The image is completely free and can be used under any circumstance. The cover image size is 1280 X 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: [befunky.com](https://www.befunky.com/create/crop-photo/). -This Logo ratio is 1:1, that is square picture. In the replacement of the picture, please choose the appropriate picture to replace. +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. -1: Thank ChinaTeX for providing free image source site, and [pexels.com](https://www.pexels.com/) is also recommended. diff --git a/DeviceModeOption.md b/DeviceModeOption.md new file mode 100644 index 0000000..27c1666 --- /dev/null +++ b/DeviceModeOption.md @@ -0,0 +1,11 @@ +The option for device (`device`) was originally used in ElegantNote, now we include this option in ElegantBook as well. Activate iPad mode in the following way: + +```tex +\documentclass[pad]{elegantbook} %or +\documentclass[device=pad]{elegantbook} +``` + + + + + diff --git a/DisplayStyles.md b/DisplayStyles.md index 8678910..11d7671 100644 --- a/DisplayStyles.md +++ b/DisplayStyles.md @@ -1,4 +1,4 @@ -This template contains 2 sets of _title display styles_,which including `hang`(default) and display style, +This template contains 2 sets of _title display styles_, which including `hang` (default) and display style, The difference is that the chapter heading is displayed on a single line (`hang`) and on a double line (`display`) , and this guide uses `hang`. To change display style diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..52c05a0 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,44 @@ +**Question**: I want to customize font and background color. + +**Answer**: Please use `\pagecolor` to change background color, refer to [this](https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color) to customize font. + + + +**Question**: Which version should I choose? + +**Answer**: Please use [Latest Release](https://github.com/ElegantLaTeX/ElegantBook/releases) via Github or TeX Live 2019. + + + +**Question**: Which editor should I choose? + +**Answer**: You can use TeX Live 2019 built-in TeXworks or TeXstudio. You may refer to [TeX works autocomplete](https://github.com/EthanDeng/texworks-autocomplete). TeX Live 2019 + TeXstudio is strongly recommended. I myself use VS Code and Sublime Text. Related configurations can be found at [vscode-latex](https://github.com/EthanDeng/vscode-latex) and [sublime-text-latex}](https://github.com/EthanDeng/sublime-text-latex). + + + +**Question**: Hello, we want to use ElegantBook to write a book about machine learning and would like your authorization. + +**Answer**: 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. + + + +**Question**: I would like to use the former cover! + +**Answer**: Cover option is forthcoming. + + + +**Question**: What is cross reference? + +**Answer**: This template is aimed at who are not a complete beginner for LaTeX. Please learn more about LaTeX before using this template. + + + +**Question**: Is the language for code highlighting optional? + +**Answer**: Yes, `listings` package is used in ElegantBook, hence language is optional. For global setting, use `\lstset`. For more information, please refer to package documentations. + + + + + diff --git a/HowToUse.md b/HowToUse.md new file mode 100644 index 0000000..2678c8c --- /dev/null +++ b/HowToUse.md @@ -0,0 +1,3 @@ +This template is based on the Standard LaTeX book class, so the options of book class work as well. The default encoding is UTF-8 while TeX Live is recommended. The test environment is Win10 + TeX Live 2019. + + diff --git a/Installation.md b/Installation.md index 7016ad6..15edef0 100644 --- a/Installation.md +++ b/Installation.md @@ -1,38 +1,26 @@ -In this section, we will introduce the installation methods through cmd line or package manager of TeX Live 2018. +Both portable version and installation package are available for this template. -## Cmd Line Method +### Portable Version -Run command line as administrator, the installation commands is +For portable version, simply download lastest ElegantBook-master from Github or CTAN (to be more accurate, download 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 cls now and then. -```shell -tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet -tlmgr install elegantbook -``` +### Installation Method -If you want to update or uninstall package, you can use +If you are a TeX Live 2019 user, using the `tlshell` of TeX Live 2019 direct installation package is strongly recommended. Simply search and open `tlshell`, click on `File -> Load Default Repository` or customize repository by Options. Wait till the repository loads successfully, search elegantbook by name, installation and update is just a click away. -```shell -tlmgr update elegantbook -tlmgr uninstall elegantbook -``` +![](https://raw.githubusercontent.com/wiki/izinngo/public/image/tlshell.png) -## Package Mananger Method +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 `elegantbook.cls` to the installation directory of TeX Live 2018 (default: `C:\texlive\2018\texmf-dist\tex\latex\elegantbook` ), run `texhash` in cmd. -Search tlmgr in windows, and open TeX Live Manager, +Excuse me? You are a CTeX user? Sorry, this template is incompatible with CTeX. -![tlmgr](https://elegantlatex.org/image/tlmgr.png) +For more details about the installation and usage of TeX Live 2019, the compatibility of CTeX and TeX Live, installation directory, etc., please refer to OG (Official Guide). -click tlmgr and choose +### Online Usage of Templates -```shell -Load standard net repository: http://mirror.ctan.org/systems/texlive/tlnet -``` - -![tlmgr](https://elegantlatex.org/image/tlmgr-1.png) - -type the package name in the blank, and select the package you want to install/update/uninstall and click the action you wish. - -![tlmgr](https://elegantlatex.org/image/tlmgr-book.png) - -Complete. +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 `elegantlatex` on Overleaf or visit [search result](https://www.overleaf.com/latex/templates?addsearch=elegantlatex), +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 information about Overleaf, please refer to Overleaf OG. diff --git a/Introduction.md b/Introduction.md index 5487fa7..06e447e 100644 --- a/Introduction.md +++ b/Introduction.md @@ -1,22 +1,16 @@ -On the occasion of this release, we, ElegantLaTeX Program, want to reintroduce our work to you. We are committed to creating a series of beautiful, elegant, easy to use LaTeX templates for users. The ElegantLaTeX is currently composed of [ElegantNote](https://github.com/ElegantLaTeX/ElegantNote), [ElegantBook](https://github.com/ElegantLaTeX/ElegantBook), [ElegantPaper](https://github.com/ElegantLaTeX/ElegantPaper) for typesetting notes, books, and working papers respectively. +ElegantLaTeX Program developers are intended to provide you beautiful, elegant, user-friendly templates. Currently, the ElegantLaTeX is composed of [ElegantNote](https://github.com/ElegantLaTeX/ElegantNote), [ElegantBook](https://github.com/ElegantLaTeX/ElegantBook), [ElegantPaper](https://github.com/ElegantLaTeX/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 [issue](https://github.com/ElegantLaTeX/ElegantBook/issues) or email us. -The latest version is available on [Github:ElegantBook/releases](https://github.com/ElegantLaTeX/ElegantBook/releases). This guide describes some settings of this template and how to use it. If you have any other questions, suggestions or comments, please feel free to contact us. +Contact Infos: -## ElegantBook Updates - -Over these years, we’ve received a lot of feedback from users, with major issues related to font installation, coding support, theorem class environments floats, theorem cross-page, cross-references, and etc. We really think about these problems, it wasn’t elegant to let the user install the font for visual beauty since users got into a lot of trouble, which went against the concept of our template. So we’ve removed that from the new version, users don’t have to install any fonts. Let’s take a look at the ElegantBook template 3.x updates: - -1. Remove custom font settings and use the `ctex` package or system font instead; -2. Add English and Chinese modes（`lang=cn/en`); -3. `PDFLaTeX` and `XeLaTeX` Support; -4. Use the `tcolorbox` package to re-written the theorem class environments, which can span over pages; -5. Theorem class environments name updated, and cross-references fixed; -6. Color name updated, link color unified; -7. New ElegantLaTeX Logo; -8. New cover and decorations, remove the watermark; -9. Fix appendix; -10. Add gray theme: `color=plain`; -11. Add code highlighting; -12. Beautify the list environment. +* Homepage: [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) +* Download: [release](https://github.com/ElegantLaTeX/ElegantBook/releases), [latest version](https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip) +* Weibo：ElegantLaTeX +* Wechat: ElegantLaTeX +* QQ: 692108391 +* Email: [elegantlatex2e@gmail.com](elegantlatex2e@gmail.com) ____ + diff --git a/IntroductionEnvironment.md b/IntroductionEnvironment.md new file mode 100644 index 0000000..f3f2496 --- /dev/null +++ b/IntroductionEnvironment.md @@ -0,0 +1,24 @@ +We create a introduction environment to display the structure of chapter. The basic useage is as follows + +```latex +\begin{introduction} + \item Definition of Theorem + \item Ask for help + \item Optimization Problem + \item Property of Cauchy Series + \item Angle of Corner +\end{introduction} +``` + +you will get: + +![](./introduction2.png) + +You can change the title of this environment by modifying the optional argument of this environment. + +```latex +\begin{introduction}[Brief Introduction] +... +\end{introduction} +``` + diff --git a/Languages.md b/Languages.md index b89a400..4af778e 100644 --- a/Languages.md +++ b/Languages.md @@ -1,10 +1,9 @@ -We defined one option named `lang`, this option has two alternative values, `lang=en` (default) or `lang=cn`. `lang=cn` will make the caption of figure/table, abstract name, refname etc. Chinese, while `lang=en` will keep all these stuff English, as the default article class sets. You can use this option as +We defined one option named `lang`, this option has two alternative values, `lang=en` (default) or `lang=cn`. Different values will alter the captions of figure/table, abstract name, refname, etc. You can use this option as ```tex -\documentclass[cn]{elegantbook} \documentclass[lang=cn]{elegantbook} -\documentclass[en]{elegantbook} \documentclass[lang=en]{elegantbook} ``` -__Remark__: You can input Chinese Character in either `lang=en` or `lang=cn`. If you are using (lstlisting) environment, and it contains Chinese characters, please use `XeLaTeX`. +__Remark__: Chinese Characters are acceptable whenever `lang=en` or `lang=cn`. If you would like to include Chinese characters under (`lstlisting`) environment, please use `XeLaTeX` to compile. + diff --git a/Lists.md b/Lists.md index 79a27b1..f5d633b 100644 --- a/Lists.md +++ b/Lists.md @@ -1,3 +1,4 @@ This template uses tikz to customize `itemize` and `enumerate` environments, the `itemize` environment customized to the third depth, and `enumerate` environment customized to fourth depth. The effect is as follows ![](item.png) + diff --git a/MinimalExample.md b/MinimalExample.md index 08a27ac..13cb6b4 100644 --- a/MinimalExample.md +++ b/MinimalExample.md @@ -2,19 +2,16 @@ Here is a minimal example. ```tex \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} -\equote{Victory won\rq t come to us unless we go to it. --- M. Moore} +\extrainfo{Victory won\rq t come to us unless we go to it. --- M. Moore} \logo{logo.png} \cover{cover.jpg} @@ -24,16 +21,11 @@ Here is a minimal example. \tableofcontents \mainmatter \hypersetup{pageanchor=true} - % add preface chapter here if needed \chapter{Example Chapter Title} The content of chapter one. \bibliography{reference} -\appendix - -\chapter{Appendix Chapter Title} -The content of appendix 1. - \end{document} ``` + diff --git a/Preface.md b/Preface.md index f92fca3..844f0ee 100644 --- a/Preface.md +++ b/Preface.md @@ -1,4 +1,4 @@ -If you want to add a preface before the first chapter without changing the number of chapter, you can use it before the first chapter +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: ```tex \chapter*{Preface} diff --git a/ProblemSet.md b/ProblemSet.md new file mode 100644 index 0000000..b1cfa15 --- /dev/null +++ b/ProblemSet.md @@ -0,0 +1,22 @@ +The environment `problemset` is used at the end of each chapter to display corresponding exercises. Just type in the following sentences: + +```tex +\begin{problemset} + \item exercise 1 + \item exercise 2 + \item exercise 3 +\end{problemset} +``` + +And you will get: + +![](./problemset2.png) + +**Notice** If you want to customize the title of `probleset`, please change the optional argument like introduction environment. + +```tex +\begin{problemset}[Hello World] + \item ... +\end{problemset} +``` + diff --git a/RecruitSupportMembers.md b/RecruitSupportMembers.md new file mode 100644 index 0000000..677d9ec --- /dev/null +++ b/RecruitSupportMembers.md @@ -0,0 +1,8 @@ +Recruit Support Members for ElegantLaTeX to translate template OGs(Chinese -> English), maintain wiki entries using MarkDown, update Wechat articles. No deadline for this recruitment. + +Thank our best support members for their selfless work! + +* OG Translator: [YPY](https://github.com/peggy2006xzyz); +* Wiki Maintainer: [Ingo Zinngo](https://github.com/izinngo); +* QQ Group Manager: [Sikouhjw](https://github.com/sikouhjw). + diff --git a/TheoremClassEnvironments.md b/TheoremClassEnvironments.md index c46863a..0a7d8df 100644 --- a/TheoremClassEnvironments.md +++ b/TheoremClassEnvironments.md @@ -1,4 +1,11 @@ -In this template, we defined four categories of theorem class environments +We defined two sets of theorem modes, `simple` style and `fancy` style (default). You may change to `simple` mode by + +```tex +\documentclass[simple]{elegantbook} %or +\documentclass[mode=simple]{elegantbook} +``` + +In this template, we defined four different theorem class environments + __Theorem Environment__, including title and contents, numbering within chapter. There are three types depending on the format + definition environment, the color is main; @@ -8,29 +15,29 @@ In this template, we defined four categories of theorem class environments + __Proof Environment__, including proof, note environment, they contain introductory symbol (note environment) or ending symbol (proof environment). + __Conclusion Environments__, including conclusion, assumption, property, remark, solution environment, all of these begin with boldfaced words, and the contents are the same as a normal paragraph. -## Theorem Class Environments +### Theorem Class Environments The template uses the `tcolorbox` package to customize the theorem class environments, it is slightly different from the normal theorem environments. The usage is as follows: ```tex -\begin{theorem}{}{