diff --git a/elegantbook-cn.tex b/elegantbook-cn.tex index 830cc0a..853351a 100644 --- a/elegantbook-cn.tex +++ b/elegantbook-cn.tex @@ -1,15 +1,15 @@ -\documentclass[lang=cn,10pt, newtx]{elegantbook} +\documentclass[lang=cn,10pt,newtx]{elegantbook} \title{ElegantBook：优美的 \LaTeX{} 书籍模板} \subtitle{Elegant\LaTeX{} 经典之作} \author{Ethan Deng \& Liam Huang} \institute{Elegant\LaTeX{} Program} -\date{Aug, 12, 2022} +\date{Aug, 15, 2022} \version{4.4} \bioinfo{自定义}{信息} -\extrainfo{不要以为抹消过去，重新来过，即可发生什么改变。—— 比企谷八幡} +\extrainfo{要让一群人团结起来，需要的不是英明的领导，而是共同的敌人。—— 比企谷八幡} \setcounter{tocdepth}{3} @@ -24,6 +24,9 @@ % \definecolor{customcolor}{RGB}{32,178,170} % \colorlet{coverlinecolor}{customcolor} \usepackage{cprotect} + +\addbibresource[location=local]{reference.bib} + \begin{document} \maketitle @@ -35,9 +38,9 @@ \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} 或者邮件联系我们。 +Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote}，\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook}，\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成，分别用于排版笔记，书籍和工作论文。大版本改动较大，请关注版本信息，在未开始使用模板钱，建议直接选择最新正式版本！ -我们的联系方式如下，建议加入用户 QQ 群提问，这样能更快获得准确的反馈，加群时请备注 \LaTeX{} 或者 Elegant\LaTeX{} 相关内容。 +本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题，建议或者意见，欢迎在 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/} @@ -50,6 +53,11 @@ Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模 \item 邮件：\email{elegantlatex2e@gmail.com} \end{itemize} +\begin{quotation} + \textbf{注意：} 由于 ElegantLaTeX 的模板涉及宏包和设定比较多，不建议没有 \LaTeX{} 基础的用户使用。我们会通过 \href{https://space.bilibili.com/516479629}{B 站}进行直播或者交流分享会，录屏也将发布在该账户下，如果大家在模板的使用上有问题，可以观看视频、加群咨询或者查看模板自带的文档说明（如果安装了 TeX Live，可以使用在命令行提示符下运行 \lstinline{texdoc elegantbook} 命令获得模板的说明文档。 +\end{quotation} + + \section{模板安装与更新} 你可以通过免安装的方式使用本模板，包括在线使用和本地（文件夹内）使用两种方式，也可以通过 \TeX{} 发行版安装使用。 @@ -90,9 +98,19 @@ tlmgr update --self --all --reinstall-forcibly-removed \section{关于提交} -出于某些因素的考虑，Elegant\LaTeX{} 项目自 2019 年 5 月 20 日开始，\textbf{不再接受任何非作者预约性质的提交}（pull request）！如果你想改进模板，你可以给我们提交 issues，或者可以在遵循协议（LPPL-1.3c）的情况下，克隆到自己仓库下进行修改。 +由于精力有限，本人维护模板的时间并不多，考虑到模板的用户还挺多，本模板自 2022 年 8 月开始，开放特性提交（features pull requests）！不过在提交之前，请务必在 issue 区将问题、解决方式以及对应的示例（最简单的使用示例）写清楚，我们会根据 issue 的信息，接受合适的提交。 +\section{赞助} + +如果您非常喜爱我们的模板，你还可以选择赞助的方式支持这个项目，赞助主要用于网站域名和服务器的购买、QQ 用户群的维护以及对于管理员的奖励。赞赏费用的使用解释权归 ElegantLaTeX/EthanDeng 所有，不接受监督。 + +\begin{figure}[htbp] + \centering + \includegraphics[width=0.5\textwidth]{donate.jpg} +\end{figure} + + \chapter{ElegantBook 设置说明} 本模板基于基础的 book 文类，所以 book 的选项对于本模板也是有效的（纸张无效，因为模板有设备选项）。默认编码为 UTF-8，推荐使用 \TeX{} Live 编译。 @@ -558,7 +576,25 @@ Class elegantbook Warning: Because you didn't provide a prefix. \end{minipage} \section{参考文献} -文献部分，本模板调用了 biblatex 宏包，并提供了 biber（默认） 和 bibtex 两个后端选项，可以使用 \lstinline{bibend} 进行修改： + +\subsection{打印文献} + +之前我们将文献调用的命令放在模板里面，然后用户反馈 \lstinline{\cite} 命令无法自动补全，因此我们新版本将其拿到外面来，新版本打印参考文献的命令的方法是，在导言区（也即 \lstinline|\begin{document}| 之前），加入： + +\begin{lstlisting} + \lstinline|\addbibresource[location=local]{reference.bib}|。 +\end{lstlisting} + +然后再需要打印文献的地方使用： +\begin{lstlisting} + \printbibliography[heading=bibintoc, title=\ebibname] +\end{lstlisting} + +其中 \lstinline{reference.bib} 为参考文献存放的文件，需要放在项目文件夹下。 + +\subsection{修改文献格式} + +此外，本模板调用了 biblatex 宏包，并提供了 biber（默认） 和 bibtex 两个后端选项，可以使用 \lstinline{bibend} 进行修改： \begin{lstlisting} \documentclass[bibtex]{elegantbook} @@ -574,12 +610,13 @@ Class elegantbook Warning: Because you didn't provide a prefix. \documentclass[citestyle=gb7714-2015, bibstyle=gb7714-2015]{elegantbook} \end{lstlisting} -如果需要添加排序方式，可以在导言区加入 +如果需要添加排序方式，可以在导言区加入下面命令： \begin{lstlisting} \ExecuteBibliographyOptions{sorting=ynt} \end{lstlisting} -启用国标之后，可以加入 \lstinline{sorting=gb7714-2015}。 +如果使用的是国标，可以将 \lstinline{ynt} 改为 \lstinline{gb7714-2015}，使文献按照国标规定进行文献排序。 + \section{添加序章} @@ -928,7 +965,7 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 根据用户的反馈，我们不断修正和完善模板。由于 3.00 之前版本与现在版本差异非常大，在此不列出 3.00 之前的更新内容。 -\datechange{2022/08/12}{版本 4.4 正式发布。} +\datechange{2022/08/15}{版本 4.4 正式发布。} \begin{change} \item \textbf{重要改动}：提供了一个定义定理类环境的命令 \lstinline|\elegantnewtheorem|。 @@ -936,6 +973,8 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \item \textbf{重要改动}：在 \lstinline{scheme=chinese} 下将目录中的“第 1 章”修改为“第一章”； \item 将 TeX Gyre Termes 改为 TeX Gyre TermesX，使英文部分字形与 newtx 系列宏包更相近； \item 重写了内置定理类环境的实现方法，修复了一些 bug，由于修改部分较大，如果引入了新的 bug，请及时在 QQ 群或 \href{https://github.com/ElegantLaTeX}{Github} 上进行反馈； + \item 删除 Gitee 仓库地址，恢复 GitHub 提交（pull requests)； + \item 将参考文献命令添加到导言区，使编辑器能够对参考文献自动补全。 \end{change} \datechange{2022/04/09}{版本 4.3 正式发布。} @@ -1097,6 +1136,7 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \end{change} \nocite{*} + \printbibliography[heading=bibintoc, title=\ebibname] \appendix diff --git a/elegantbook-en.tex b/elegantbook-en.tex index b184215..bb4c3e5 100644 --- a/elegantbook-en.tex +++ b/elegantbook-en.tex @@ -19,6 +19,8 @@ \colorlet{coverlinecolor}{customcolor} \usepackage{cprotect} +\addbibresource[location=local]{reference.bib} % bib + \begin{document} \maketitle @@ -60,7 +62,7 @@ To learn more, please refer to \href{https://tex.stackexchange.com/questions/554 If you are a \TeX{} Live 2018/2019/2020/2021 user and would like to update, the official solution is to uninstall the previous version. If you want to save the bother of uninstallation and re-installation, please copy \lstinline{elegantbook.cls} to the installation directory of \TeX{} Live 2022 (default: \lstinline|C:\texlive\2022\texmf-dist\tex\latex\elegantbook| ), run \lstinline{texhash} in cmd. \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/Ubuntu 20.04/macOS + \TeX{} Live 2022/ Mac\TeX{} 2022, either \hologo{pdfLaTeX} or \hologo{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 environments are Win10/Ubuntu 20.04/macOS + \TeX{} Live 2022/ Mac\TeX{} 2022, either \hologo{pdfLaTeX} or \hologo{XeLaTeX} works fine for \lstinline{lang=en}. \section{Languages} We defined one option named \lstinline{lang} which has two basic values, \lstinline{lang=en} (default) , \lstinline{lang=cn}. Different values will alter the captions of figure/table, abstract name, refname, etc. You can use this option as @@ -379,13 +381,13 @@ If you use \lstinline{newtx} fonts, type in: When you are using \lstinline{newtx}, please pay attention to the hyphens. For instance, \begin{equation} -\int_{R^q} f(x,y) dy.\emph{of\kern0pt f} +\int_{R^q} f(x,y) dy.\emph{of\kern0pt f} \sin x \end{equation} The corresponding code is: \begin{lstlisting} \begin{equation} - \int_{R^q} f(x,y) dy.\emph{of \kern0pt f} + \int_{R^q} f(x,y) dy.\emph{of \kern0pt f} \sin x \end{equation} \end{lstlisting} @@ -415,6 +417,19 @@ This template uses biblatex to generate the bibliography, the default citestyle If you want to use biblatex, you must create a file named \lstinline{reference.bib}, add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to \lstinline{reference.bib} file, then cite the bibkey in the \lstinline{tex} file. The biber will automatically generate the bibliography for the reference you cited. +In order to get the editors' auto-completion working, you need to add following code in your preamble: + +\begin{lstlisting} + \addbibresource[location=local]{reference.bib} +\end{lstlisting} + +Then include the print commands where you want to print the bibliography: +\begin{lstlisting} + \printbibliography[heading=bibintoc, title=\ebibname] +\end{lstlisting} + + + To change the bibliography style, this version introduces two options: \lstinline{citestyle} and \lstinline{bibstyle}, please refer to \href{https://ctan.org/pkg/biblatex}{CTAN:biblatex} for more detail about these options. You can change your bibliography style as @@ -677,6 +692,20 @@ We list some FAQs for users to refer to: We revised our templates now and then. This section shows the version story of ElegantBook. +\datechange{2022/08/15}{release of v4.4.} + +\begin{change} + \item Add custome theorem definition command \lstinline{\elegantnewtheorem}; + \item Fix star environment(*) for inner environments (\href{https://github.com/ElegantLaTeX/ElegantBook/issues/167}{issue \#167}); + \item Change English fonts from TeX Gyre Termes to TeX Gyre TermesX; + \item Re-construct some theorem environments to enchance compatibility; + \item Remove Gitee repo due the privacy policy; + \item Re-open Github pull requests. +\end{change} + + + + \datechange{2022/04/09}{release of v4.3.} \begin{change} @@ -745,12 +774,12 @@ We revised our templates now and then. This section shows the version story of E \item Revise \lstinline{problemset}. \end{change} + \nocite{en2,en3} \printbibliography[heading=bibintoc, title=\ebibname] - \appendix -% \renewcommand\chaptername{\eappendix \thechapter} + \chapter{Mathematical Tools} diff --git a/elegantbook.cls b/elegantbook.cls index 2371f4c..93f4dd9 100644 --- a/elegantbook.cls +++ b/elegantbook.cls @@ -193,7 +193,7 @@ \ifdefstring{\ELEGANT@lang}{cn}{ \ifdefstring{\ELEGANT@chinesefont}{founder}{ - \RequirePackage[UTF8,scheme=plain,fontset=none]{ctex} + \RequirePackage[UTF8, scheme=plain, fontset=none]{ctex} \setCJKmainfont[BoldFont={FZHei-B01},ItalicFont={FZKai-Z03}]{FZShuSong-Z01} \setCJKsansfont[BoldFont={FZHei-B01}]{FZKai-Z03} \setCJKmonofont[BoldFont={FZHei-B01}]{FZFangSong-Z02} @@ -207,10 +207,14 @@ \newcommand*{\fangsong}{\CJKfamily{zhfs}}}{\relax} \ifdefstring{\ELEGANT@chinesefont}{nofont}{ - \RequirePackage[UTF8,scheme=plain,fontset=none]{ctex}}{\relax} + \RequirePackage[UTF8,scheme=plain,fontset=none]{ctex} + \xeCJKsetup{AutoFakeBold=true} + }{\relax} \ifdefstring{\ELEGANT@chinesefont}{ctexfont}{ - \RequirePackage[UTF8,scheme=plain]{ctex}}{\relax} + \RequirePackage[UTF8,scheme=plain]{ctex} + \xeCJKsetup{AutoFakeBold=true} + }{\relax} \AfterEndPreamble{ \setlength\parindent{2\ccwd}} @@ -1169,6 +1173,7 @@ }, } + \newenvironment{introduction}[1][\introductionname]{ \begin{tcolorbox}[introductionsty,title={#1}] \begin{multicols}{2} @@ -1357,7 +1362,7 @@ \begin{enumerate}[label=\small\protect\circled{\arabic*}]}{ \end{enumerate}} -\addbibresource[location=local]{reference.bib} + \renewcommand\tableofcontents{% \hypersetup{linktoc=all, linkcolor=black} diff --git a/image/donate.jpg b/image/donate.jpg new file mode 100644 index 0000000..60741ef Binary files /dev/null and b/image/donate.jpg differ