diff --git a/README.md b/README.md index 81a32d5..f418568 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ - - + + -[Homepage](https://elegantlatex.org/) | [Github](https://github.com/ElegantLaTeX/ElegantBook) | [CTAN](https://ctan.org/pkg/elegantbook) | [Download](https://github.com/ElegantLaTeX/ElegantBook/releases) | +[Github](https://github.com/ElegantLaTeX/ElegantBook) | [CTAN](https://ctan.org/pkg/elegantbook) | [Download](https://github.com/ElegantLaTeX/ElegantBook/releases) | ![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) @@ -9,23 +9,20 @@ # ElegantBook: 优美的 LaTeX 书籍模板 An Elegant LaTeX Template for Books -ElegantBook 是为 LaTeX 书籍写作而设计的模板，由 [Ethan Deng](https://github.com/EthanDeng) 和 [Liam Huang](https://github.com/Liam0205) 创立，现在主要由 [Ethan Deng](https://github.com/EthanDeng)、[乙醇](https://github.com/syvshc)和[死抠](https://github.com/sikouhjw)维护。如果你有其他问题、建议或者报告 bug，可以提交 issues 或者加入我们的 QQ 用户交流群：692108391。 +ElegantBook 是为 LaTeX 书籍写作而设计的模板，由 [Ethan Deng](https://github.com/EthanDeng) 和 [Liam Huang](https://github.com/Liam0205) 创立，而后由 [Ethan Deng](https://github.com/EthanDeng)、[乙醇](https://github.com/syvshc)和[死抠](https://github.com/sikouhjw)维护。自2026年起，由[啸行](https://github.com/OsbertWang)负责维护和发行。如果你有其他问题、建议或者报告 bug，可以提交 issues 或者加入我们的 QQ 用户交流群：692108391。 -ElegantBook is designed for writing books, created by [Ethan Deng](https://github.com/EthanDeng) and [Liam Huang](https://github.com/Liam0205), and maintained by [Ethan Deng](https://github.com/EthanDeng), [syvshc](https://github.com/syvshc) and [sikouhjw](https://github.com/sikouhjw). Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or contact us at elegantlatex2e@gmail.com. +ElegantBook is a template designed for LaTeX book writing, created by [Ethan Deng](https://github.com/EthanDeng) and [Liam Huang](https://github.com/Liam0205), and later maintained by [Ethan Deng](https://github.com/EthanDeng), [ethanol](https://github.com/syvshc), and [sikouhjw](https://github.com/sikouhjw). Since 2026, [Osbert Wang](https://github.com/OsbertWang) has been responsible for its maintenance and distribution. If you have any questions, suggestions, or need to report bugs, feel free to submit issues or join our QQ user group: 692108391. +**本模板自 2023 年 1 月 1 日起停止维护，并不建议使用，但鉴于用户群体庞大，自 2026 年起重新发布。为保证之前版本的用户仍能查阅说明文档，本说明文档保留了过往信息。** -**本模板自 2023 年 1 月 1 日开始，不再维护，不建议使用本系列模板！为了保证之前版本的用户仍然能查到说明文档，本说明文档仍然保留过去的信息。** - -**Caution: This template will no longer be maintained since January 1st, 2023.** +**This template was discontinued as of January 1, 2023, and its use was not recommended. However, due to its large user base, it has been re-released since 2026. To ensure that users of previous versions can still access the documentation, this documentation retains past information.** ## 致谢 Acknowledgement - 特别感谢 [sikouhjw](https://github.com/sikouhjw) 和 [syvshc](https://github.com/syvshc) 长期以来对于 Github 上 issue 的快速回应，以及各个社区论坛对于 ElegantLaTeX 相关问题的回复。特别感谢 ChinaTeX 以及 [LaTeX 工作室](http://www.latexstudio.net/)对于本系列模板的大力宣传与推广。 Thank [sikouhjw](https://github.com/sikouhjw) and [syvshc](https://github.com/syvshc) for their quick response to Github issues and continuously support work for ElegantLaTeX community. Thank ChinaTeX and [LaTeX Studio](http://www.latexstudio.net/) for their promotion. - ## 协议 License 本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。 @@ -33,7 +30,6 @@ Thank [sikouhjw](https://github.com/sikouhjw) and [syvshc](https://github.com/sy This work is released under the LaTeX Project Public License, v1.3c or later. - ## 衍生品 Derivative Works + [ElegantBookdown](https://github.com/XiangyunHuang/ElegantBookdown)：[XiangyunHuang](https://github.com/XiangyunHuang) 开发并维护的基于 ElegantBook 的 Bookdown 模板。 diff --git a/elegantbook-cn.tex b/elegantbook-cn.tex index e289e77..7054797 100644 --- a/elegantbook-cn.tex +++ b/elegantbook-cn.tex @@ -5,11 +5,11 @@ \author{Ethan Deng \& Liam Huang \& syvshc \& sikouhjw \& Osbert Wang} \institute{Elegant\LaTeX{} Program} -\date{2022/12/31} -\version{4.5} +\date{2026/2/27} +\version{4.6} \bioinfo{自定义}{信息} -\extrainfo{注意：本模板自 2023 年 1 月 1 日开始，不再更新和维护！} +\extrainfo{\textcolor{red}{\bfseries 注意：本模板自2023年1月1日起停止维护。然而，鉴于用户群体庞大，自2026年起恢复维护并重新发布。}} \setcounter{tocdepth}{3} @@ -39,7 +39,7 @@ \chapter{Elegant\LaTeX{} 系列模板介绍} \begin{quotation} - \textbf{\textcolor{red}{本模板自 2023 年 1 月 1 日开始，不再维护，不建议使用本系列模板！为了保证之前版本的用户仍然能查到说明文档，本说明文档仍然保留过去的信息。}} + \textbf{\textcolor{red}{本模板自 2023 年 1 月 1 日起停止维护，并不建议使用，但鉴于用户群体庞大，自 2026 年起重新发布。为保证之前版本的用户仍能查阅说明文档，本说明文档保留了过往信息。}} \end{quotation} Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote}，\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook}，\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成，分别用于排版笔记，书籍和工作论文。大版本改动较大，请关注版本信息，在未开始使用模板前，建议直接选择最新正式版本！ @@ -47,7 +47,6 @@ 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/} \item CTAN 地址：\href{https://ctan.org/pkg/elegantbook}{https://ctan.org/pkg/elegantbook} \item 下载地址：\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{正式发行版}，\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版} @@ -72,9 +71,9 @@ Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模 本模板测试环境为 \begin{enumerate} - \item Win10 + \TeX{} Live 2022； - \item Ubuntu 20.04 + \TeX{} Live 2022； - \item macOS Monterey + Mac\TeX{} 2022。 + \item Win11 + \TeX{} Live 2025； + \item Ubuntu 22.04 + \TeX{} Live 2025； + \item macOS + Mac\TeX{} 2025。 \end{enumerate} \TeX Live/Mac\TeX{} 的安装请参考啸行的\href{https://github.com/OsbertWang/install-latex-guide-zh-cn/releases/}{一份简短的关于安装 \LaTeX{} 安装的介绍}。 @@ -943,11 +942,11 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \item \question{大佬，我想把正文字体改为亮色，背景色改为黑灰色。} 页面颜色可以使用 \lstinline{\pagecolor} 命令设置，文本命令可以参考\href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{这里}进行设置。 \item \question{\lstinline{! LaTeX Error: Unknown option 'scheme=plain' for package 'ctex'.}} - 你用的 C\TeX{} 套装吧？这个里面的 \lstinline{ctex} 宏包已经是已经是 10 年前的了，与本模板使用的 \lstinline{ctex} 宏集有很大区别。不建议 C\TeX{} 套装了，请卸载并安装 \TeX{} Live 2022。 + 你用的 C\TeX{} 套装吧？这个里面的 \lstinline{ctex} 宏包已经是已经是 10 年前的了，与本模板使用的 \lstinline{ctex} 宏集有很大区别。不建议 C\TeX{} 套装了，请卸载并安装 \TeX{} Live 2025。 \item \question{我该使用什么版本？} - 请务必使用\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{最新正式发行版}，发行版间不定期可能会有更新（修复 bug 或者改进之类），如果你在使用过程中没有遇到问题，不需要每次更新\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版}，但是在发行版更新之后，请尽可能使用最新版（发行版）！最新发行版可以在 GitHub 或者 \TeX{} Live 2021 内获取。 + 请务必使用\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{最新正式发行版}，发行版间不定期可能会有更新（修复 bug 或者改进之类），如果你在使用过程中没有遇到问题，不需要每次更新\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版}，但是在发行版更新之后，请尽可能使用最新版（发行版）！最新发行版可以在 GitHub 或者 \TeX{} Live 2025 内获取。 \item \question{我该使用什么编辑器？} - 你可以使用 \TeX{} Live 2021 自带的编辑器 \TeX{}works 或者使用 \TeX{}studio，\TeX works 的自动补全，你可以参考我们的总结 \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX works 自动补全}。推荐使用 \TeX{} Live 2021 + \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{} 编写环境}。 + 你可以使用 \TeX{} Live 2025 自带的编辑器 \TeX{}works 或者使用 \TeX{}studio，\TeX works 的自动补全，你可以参考我们的总结 \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX works 自动补全}。推荐使用 \TeX{} Live 2025 + \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{请问交叉引用是什么？} @@ -962,6 +961,14 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 根据用户的反馈，我们不断修正和完善模板。由于 3.00 之前版本与现在版本差异非常大，在此不列出 3.00 之前的更新内容。 +\datechange{2026/02/27}{发布 v4.6 版本} \textcolor{blue}{\bfseries 恢复维护} + +\begin{change} + \item 确认新维护者啸行并恢复维护。 + \item 鉴于用户群体庞大，模板重新发布。 + \item 更新以支持 \TeX{} Live 2025 及当前主流操作系统（Windows 11、Ubuntu 24.04 LTS、macOS）。 +\end{change} + \datechange{2022/12/31}{版本 4.5} \textcolor{red}{\bfseries 停止维护！} \datechange{2022/08/17}{版本 4.5 pre} diff --git a/elegantbook-en.tex b/elegantbook-en.tex index c581abc..bbc4a0e 100644 --- a/elegantbook-en.tex +++ b/elegantbook-en.tex @@ -5,11 +5,11 @@ \author{Ethan Deng, Liam Huang, syvshc, sikouhjw \& Osbert Wang} \institute{Elegant\LaTeX{} Program} -\date{Dec. 31, 2022} -\version{4.5} +\date{Feb. 27, 2026} +\version{4.6} \bioinfo{Bio}{Information} -\extrainfo{\textcolor{red}{\bfseries Caution: This template will no longer be maintained since January 1st, 2023.}} +\extrainfo{\textcolor{red}{\bfseries Caution: This template will no longer be maintained since January 1st, 2023. However, due to its large user base, maintenance has resumed and the template has been re-released as of 2026.}} \logo{logo-blue.png} \cover{cover.jpg} @@ -59,10 +59,13 @@ tlmgr update --all 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?} \section{Other Release Versions} -If you are a \TeX{} Live 2018/2019/2020/2021 user and would like to update, the official solution is to uninstall the previous version. If you want to save the bother of uninstallation and re-installation, please copy \lstinline{elegantbook.cls} to the installation directory of \TeX{} Live 2022 (default: \lstinline|C:\texlive\2022\texmf-dist\tex\latex\elegantbook| ), run \lstinline{texhash} in cmd. + +If you are using a \TeX{} Live version prior to 2025 and wish to update the template, the official solution is to uninstall the previous version. +If you want to save the trouble of uninstallation and re-installation, please copy \lstinline{elegantbook.cls} to the installation directory of your \TeX{} Live (default for \TeX{} Live 2025: \lstinline|C:\texlive\2025\texmf-dist\tex\latex\elegantbook|; replace "2025" with your actual version), and then run \lstinline{texhash} in the command prompt. \chapter{ElegantBook Settings} -This template is based on the Standard \LaTeX{} book class, so the options of book class work as well (Note that the option of papersize has no effect due to \lstinline{device} option). The default encoding is UTF-8 while \TeX{} Live is recommended. The test environments are Win10/Ubuntu 20.04/macOS + \TeX{} Live 2022/ Mac\TeX{} 2022, either \hologo{pdfLaTeX} or \hologo{XeLaTeX} works fine for \lstinline{lang=en}. + +This template is based on the Standard \LaTeX{} book class, so the options of book class work as well (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 Windows 10/11, Ubuntu 24.04 LTS, and macOS with \TeX{} Live 2025/ Mac\TeX{} 2025. Both \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 @@ -675,9 +678,9 @@ We list some FAQs for users to refer to: \item \question{I want to customize font and background color.} Please use \lstinline{pagecolor} to change background color, refer to \href{https://tex.stackexchange.com/questions/278544/xcolor-what-is-the-equivalent-of-default-text-color}{this} to customize font. \item \question{Which version should I choose?} - Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2022. + Please use \href{https://github.com/ElegantLaTeX/ElegantBook/releases}{Latest Release} via GitHub or \TeX{} Live 2025. \item \question{Which editor should I choose?} - You can use \TeX{} Live 2022 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2022 + \TeX{}studio is strongly recommended. Related configurations can be found at \href{https://github.com/EthanDeng/vscode-latex}{vscode-latex} and \href{https://github.com/EthanDeng/sublime-text-latex}{sublime-text-latex}. + You can use \TeX{} Live 2025 built-in \TeX works or \TeX Studio. You may refer to \href{https://github.com/EthanDeng/texworks-autocomplete}{\TeX{}works autocomplete}. \TeX{} Live 2025 + \TeX{}studio is strongly recommended. Related configurations can be found at \href{https://github.com/EthanDeng/vscode-latex}{vscode-latex} and \href{https://github.com/EthanDeng/sublime-text-latex}{sublime-text-latex}. \item \question{Hello, we want to use ElegantBook to write a book about machine learning and would like your authorization.} Feel free to use our templates by pointing out our copyright. For other issues, please refer to LPPL-1.3c. If you want to show us your work, you can share the URL with us afterwards. \item \question{What is cross reference?} @@ -691,6 +694,13 @@ We list some FAQs for users to refer to: \chapter{Version History} We revised our templates now and then. This section shows the version story of ElegantBook. +\datechange{2026/02/27}{release of v4.6} \textcolor{blue}{\bfseries Maintenance Resumed} + +\begin{change} + \item Maintenance resumed under new maintainer Osbert Wang. + \item Template re-released due to large user base. + \item Updated to support \TeX{} Live 2025 and current operating systems (Windows 11, Ubuntu 24.04 LTS, macOS). +\end{change} \datechange{2022/12/31}{release of v4.5.} \textcolor{red}{\bfseries Stop Maintenance} diff --git a/elegantbook.cls b/elegantbook.cls index 4fb3e3d..dbece0c 100644 --- a/elegantbook.cls +++ b/elegantbook.cls @@ -1,15 +1,13 @@ -%%%%%%%%%%%%%%%%%%%%%% -%% start of file `elegantbook.cls'. -%% Copyright 2013-2022 ElegantLaTeX (elegantlatex2e@gmail.com) -%% -%% This work may be distributed and/or modified freely -%% available at https://github.com/ElegantLaTeX/ElegantBook -% -%%%%%%%%%%%%%%%%%%%%% -% % !Mode:: "TeX:UTF-8" +% ----------------------------------------------------------------------------- +% Start of file `elegantbook.cls'. +% Copyright 2013-2022 ElegantLaTeX (elegantlatex2e@gmail.com) +% Copyright 2026- ElegantLaTeX (maintained by ranwang.osbert@outlook.com) +% This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, +% either version 1.3c of this license or (at your option) any later version. +% It is available at https://github.com/ElegantLaTeX/ElegantBook +% ----------------------------------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{elegantbook}[2022/12/31 v4.5 ElegantBook document class] - +\ProvidesClass{elegantbook}[2026/2/27 v4.6 ElegantBook document class] %%% \RequirePackage{kvoptions}