update: documentation

RizhongLin · RizhongLin · commit ef44e116e119 · 2025-04-21T13:24:15.000+02:00
diff --git a/.github/workflows/ctan-package.yml b/.github/workflows/ctan-package.yml
@@ -125,7 +125,7 @@ jobs:
           cat > ctan/tongjithesis/tongjithesis.dtx << EOF
           % \iffalse meta-comment
           %
-          % Copyright (C) 2023-$CURRENT_YEAR TJ-CSCCG
+          % Copyright (C) 2022-$CURRENT_YEAR TJ-CSCCG
           % 
           % This file may be distributed and/or modified under the
           % conditions of the LaTeX Project Public License, either version 1.3
@@ -270,7 +270,12 @@ jobs:
           % \begin{description}
           %   \item[oneside] Formats the document for one-sided printing (default).
           %   \item[twoside] Formats the document for two-sided printing.
-          %   \item[draft] Enables draft mode.
+          %   \item[fullwidthstop=true|false] Controls whether Chinese full-width period (。) is replaced with 
+          %         Western-style period (．). Default is \texttt{false}.
+          %   \item[times=true|false] Controls whether to use Times New Roman font. Default is \texttt{false}.
+          %   \item[minted=true|false] Controls whether to use the minted package for code highlighting. 
+          %         Default is \texttt{true}.
+          %   \item[fontset=name] Sets the font set to use. Default is \texttt{fandol}.
           % \end{description}
           %
           % \subsection{Thesis Information Commands}
@@ -464,7 +469,13 @@ jobs:
           %!TEX program = xelatex
           %!TEX encoding = UTF-8
 
-          \documentclass[oneside]{tongjithesis}
+          \documentclass[
+            oneside,
+            fullwidthstop=false,
+            fontset=fandol,
+            times=false,
+            minted=true,
+          ]{tongjithesis}
 
           % Set thesis information
           \school{计算机科学与技术学院}
@@ -519,6 +530,34 @@ jobs:
           交通标志识别是自动驾驶系统的重要组成部分，它能够帮助车辆理解道路环境，遵守交通规则。
           准确、实时的交通标志识别对于提高自动驾驶安全性具有重要意义。
 
+          % 代码示例（使用 minted 或 listings，取决于 minted 选项）
+          \begin{listing}
+          \begin{minted}{python}
+          import torch
+          import torch.nn as nn
+          
+          class CNN(nn.Module):
+              def __init__(self, num_classes=43):
+                  super(CNN, self).__init__()
+                  self.conv1 = nn.Conv2d(3, 32, kernel_size=3, padding=1)
+                  self.relu = nn.ReLU()
+                  self.pool = nn.MaxPool2d(kernel_size=2, stride=2)
+                  self.fc = nn.Linear(32 * 16 * 16, num_classes)
+              
+              def forward(self, x):
+                  x = self.pool(self.relu(self.conv1(x)))
+                  x = x.view(x.size(0), -1)
+                  x = self.fc(x)
+                  return x
+          
+          # 创建模型实例
+          model = CNN()
+          print(model)
+          \end{minted}
+          \caption{用于交通标志识别的简化卷积神经网络模型}
+          \label{listing:cnn}
+          \end{listing}
+
           % ... More sections would go here ...
 
           \section{结论}
diff --git a/README-EN.md b/README-EN.md
@@ -50,22 +50,64 @@ The project is configured with GitHub Actions in `.github/workflows/*.yaml`. Pus
 
 We recommend installing TeX Live (Windows, Linux) or MacTeX (macOS) following the [official quick install guide](https://tug.org/texlive/quickinstall.html).
 
-#### Supporting Code Highlighting
+#### Document Class Options
 
-This template supports code highlighting by incorporating the `minted` package. The `minted` package requires Python support, so you need to install Python and use `pip` to install `Pygments`. Afterwards, add the Python path with `Pygments` installed to the environment variable `PATH`, or configure as follows to ensure $\LaTeX$ can correctly invoke the `minted` package.
+This template provides the following document class options, which can be configured in `main.tex`:
 
-<details><summary>Don't want to add this Python path to the environment variable `PATH`?</summary>
+```latex
+\documentclass[
+  oneside,           % One-sided printing (default), use twoside for double-sided printing
+  fullwidthstop=false, % Whether to replace Chinese period "。" with Western-style period "．", default is false
+  fontset=fandol,    % Font set to use, default is fandol
+  times=false,       % Whether to use Times New Roman font, default is false
+  minted=true,       % Whether to use the minted package for code highlighting, default is true
+]{tongjithesis}
+```
+
+##### Single/Double-Sided Printing Options
+
+- `oneside`: Single-sided printing (default)
+- `twoside`: Double-sided printing, adjusts page margins and binding line
+
+##### Font Options
+
+- `fontset=fandol`: Use Fandol font set (default)
+- `fontset=adobe`: Use Adobe font set (requires Adobe fonts installation)
+- `times=false`: Use default math font (default)
+- `times=true`: Use Times New Roman font
+
+##### Chinese Punctuation Options
+
+- `fullwidthstop=false`: Keep Chinese period "。" unchanged (default)
+- `fullwidthstop=true`: Replace Chinese period "。" with Western-style period "．"
 
-You can add a redirect to the Python path of the `minted` package in the `main.tex` file:
+##### Code Highlighting Options
+
+This template provides two code highlighting solutions:
+
+1. **`minted` package** (Python-based): Provides advanced syntax highlighting features, requires Python environment.
+   - Enable by setting `minted=true` (default) in `main.tex`
+   - Requires installation of Python and Pygments library (`pip install pygments`)
+   - You need to add Python to the system `PATH` environment variable, 
+     - or specify the Python path in `main.tex` (see below)
+   - Requires `-shell-escape` parameter during compilation (this template has added)
+
+2. **`listings` package** (pure LaTeX): Does not depend on external programs, can be used in any environment.
+   - Enable by setting `minted=false` in `main.tex`
+   - No additional program installation required
+
+If you do not want to install Python or encounter `minted`-related errors, you can change `minted=true` to `minted=false` in `main.tex`. When using `minted=false`, the template will automatically use the `listings` package to process all code, without requiring additional configuration.
+
+<details><summary>Using `minted` but don't want to add Python to the `PATH` environment variable?</summary>
+
+You can add a redirection to the Python path of the `minted` package in the `main.tex` file:
 
 ```latex
 \renewcommand{\MintedPython}{/path/to/your/python}
 ```
 
 </details>
 
-If you do not need code highlighting, please comment out the related content in the `minted` package.
-
 #### Building the Project
 
 Due to the complex file structure of this template, we do not recommend using commands like `latexmk` that come with TeX Live for compilation.
@@ -118,34 +160,16 @@ For detailed usage, see [tongji-undergrad-thesis-env](https://github.com/TJ-CSCC
 
 ### Other Features
 
-#### Double-Sided Printing
-
-If you need to use double-sided printing, simply change the first line in `main.tex` from
-
-```latex
-\documentclass[oneside]{tongjithesis}
-```
-
-to
-
-```latex
-\documentclass[twoside]{tongjithesis}
-```
-
-to enable it.
-
 #### Rendering Rare Characters
 
-Due to the default use of the Fandol font in this template, support for rare characters such as names and specific terms might not be adequate. We provide the Adobe font set in the [`fonts`](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/tree/fonts) branch of our GitHub repository. You can download and install these fonts, and then change the line in `style/tongjithesis.cls` from
-
-```latex
-\LoadClass[UTF8,a4paper,fontset=fandol]{ctexart}
-```
-
-to
+Due to the default use of the Fandol font in this template, support for rare characters such as names and specific terms might not be adequate. We provide the Adobe font set in the [`fonts`](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/tree/fonts) branch of our GitHub repository. You can download and install these fonts, and then use the `fontset=adobe` option in `main.tex` to use the Adobe font set:
 
 ```latex
-\LoadClass[UTF8,a4paper,fontset=adobe]{ctexart}
+\documentclass[
+  oneside,
+  fontset=adobe,
+  % other options...
+]{tongjithesis}
 ```
 
 This modification will switch the rendering in the document to use the Adobe font set, enhancing support for rare characters.
@@ -165,7 +189,7 @@ This project uses the [LPPL-1.3c license](https://www.latex-project.org/lppl/lpp
 
 ```text
 %% tongji-undergrad-thesis
-%% Copyright 2023 TJ-CSCCG
+%% Copyright 2022-2025 TJ-CSCCG
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3
@@ -189,6 +213,7 @@ This project uses the [LPPL-1.3c license](https://www.latex-project.org/lppl/lpp
 - Starting May 9, 2021, [ganler](https://github.com/ganler) enhanced the functionalities (project structure and platform compatibility) based on the original project and began maintaining it.
 - As of May 12, 2022, [skyleaworlder](https://github.com/skyleaworlder) started contributing to the project, integrated it into [TJ-CSCCG](http://github.com/TJ-CSCCG), and has continued to update and improve it. It has now become a comprehensive undergraduate thesis template.
 - From April 2023, [RizhongLin](https://github.com/RizhongLin) began contributing to and managing the project.
+- April 2025 update, implemented key-value based class options, supporting more flexible configuration.
 
 We deeply appreciate the efforts of these contributors, whose work has facilitated and assisted many students.
 
@@ -209,5 +234,5 @@ We have learned a lot from excellent open-source projects from top universities:
     f'jiawei#@$.edu'.replace('#', '6').replace('$', 'illinois'),
     f'jgli22@$.edu.cn'.replace('$', 'm.fudan'),
     f'rizhong.lin@$.%'.replace('$', 'epfl').replace('%', 'ch'),
-]
+][-1]
 ```
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 > [!NOTE]
 > 完整样例可见 [模板输出样例展示（完整版）](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/discussions/21)、[Release 页](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/releases) 中 "Assets" 下的 pdf 下载链接或 [Overleaf 模版 PDF](https://www.overleaf.com/latex/templates/tongji-university-undergraduate-thesis-template/tfvdvyggqybn.pdf)。
 
-以下依次展示 “封面”、“中文摘要”、“目录”、“主要内容”、“参考文献” 与 “谢辞”。
+以下依次展示 "封面"、"中文摘要"、"目录"、"主要内容"、"参考文献" 与 "谢辞"。
 
 <p align="center">
     <img src="https://media.githubusercontent.com/media/TJ-CSCCG/TJCS-Images/tongji-undergrad-thesis/preview/main_page-0001.jpg" width="30%">
@@ -50,44 +50,53 @@
 
 我们建议参照[官方快速安装指南](https://tug.org/texlive/quickinstall.html)安装 TeX Live（Windows、Linux）或 MacTeX（macOS）。
 
-#### 代码高亮选项
+#### 文档类选项
+
+本模板提供以下文档类选项，可以在 `main.tex` 中进行配置：
+
+```latex
+\documentclass[
+  oneside,           % 单面打印（默认），使用 twoside 可启用双面打印
+  fullwidthstop=false, % 是否将中文句号"。"替换为西文句号"．"，默认为false
+  fontset=fandol,    % 使用的字体集，默认为 fandol
+  times=false,       % 是否使用 Times New Roman 字体，默认为 false
+  minted=true,       % 是否使用 minted 包进行代码高亮，默认为 true
+]{tongjithesis}
+```
+
+##### 单双面打印选项
+
+- `oneside`：单面打印（默认）
+- `twoside`：双面打印，会调整页边距和装订线
+
+##### 字体选项
+
+- `fontset=fandol`：使用 Fandol 字体集（默认）
+- `fontset=adobe`：使用 Adobe 字体集（需要安装 Adobe 字体）
+- `times=false`：使用 `newtx` 包提供的字体（默认）
+- `times=true`：使用 Times New Roman 字体
+
+##### 中文标点选项
+
+- `fullwidthstop=false`：保持中文句号"。"不变（默认）
+- `fullwidthstop=true`：将中文句号"。"替换为西文句号"．"
+
+##### 代码高亮选项
 
 本模板提供两种代码高亮解决方案：
 
 1. **`minted` 包**（基于 Python）：提供高级的语法高亮功能，需要 Python 环境。
    - 通过在 `main.tex` 中设置 `minted=true`（默认）启用
    - 需要安装 Python 及 Pygments 库（`pip install pygments`）
-   - 编译时需添加 `-shell-escape` 参数
+   - 需要将 Python 添加到系统环境变量 `PATH` 中，
+     - 或者在 `main.tex` 中指定 Python 路径（见下文）
+   - 编译时需添加 `-shell-escape` 参数（本模板已添加）
 
 2. **`listings` 包**（纯 LaTeX）：不依赖外部程序，在任何环境都能使用。
    - 通过在 `main.tex` 中设置 `minted=false` 启用
    - 无需额外安装任何程序
 
-如果您不希望安装 Python 或遇到 `minted` 相关错误，可以在 `main.tex` 中将:
-
-```latex
-\documentclass[
-  oneside,
-  % fullwidthstop=true,
-  fontset=fandol,
-  % times=true,
-  minted=true,
-]{tongjithesis}
-```
-
-修改为:
-
-```latex
-\documentclass[
-  oneside,
-  % fullwidthstop=true,
-  fontset=fandol,
-  % times=true,
-  minted=false,
-]{tongjithesis}
-```
-
-使用 `minted=false` 时，模板将自动使用 `listings` 包处理所有代码，无需其他配置。
+如果您不希望安装 Python 或遇到 `minted` 相关错误，可以在 `main.tex` 中将 `minted=true` 修改为 `minted=false`。使用 `minted=false` 时，模板将自动使用 `listings` 包处理所有代码，无需其他配置。
 
 <details><summary>使用 `minted` 但不想将 Python 添加到环境变量 `PATH` 中？</summary>
 
@@ -151,37 +160,19 @@ make wordcount          # wordcount
 
 ### 其他功能
 
-#### 双面打印版
-
-如果您需要使用双面打印版，请在 `main.tex` 中将第 1 行的
-
-```latex
-\documentclass[oneside]{tongjithesis}
-```
-
-修改为
-
-```latex
-\documentclass[twoside]{tongjithesis}
-```
-
-即可。
-
 #### 渲染生僻字
 
-由于本模版默认使用 Fandol 字体，对于姓名、专有名词等生僻字的支持可能不够完善。我们在本模版 GitHub 仓库的 [`fonts`](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/tree/fonts) 分支中提供了 Adobe 字体集，您可以下载、安装这些字体，然后在 `style/tongjithesis.cls` 中将
+由于本模版默认使用 Fandol 字体，对于姓名、专有名词等生僻字的支持可能不够完善。我们在本模版 GitHub 仓库的 [`fonts`](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/tree/fonts) 分支中提供了 Adobe 字体集，您可以下载、安装这些字体，然后在 `main.tex` 中通过 `fontset=adobe` 选项来使用 Adobe 字体集：
 
 ```latex
-\LoadClass[UTF8,a4paper,fontset=fandol]{ctexart}
-```
-
-修改为
-
-```latex
-\LoadClass[UTF8,a4paper,fontset=adobe]{ctexart}
+\documentclass[
+  oneside,
+  fontset=adobe,
+  % 其他选项...
+]{tongjithesis}
 ```
 
-这样修改后，LaTeX 将使用 Adobe 字体集来渲染文档。您可以在模板文档的 1.2.1 小节 “测试生僻字” 中查看具体效果。
+这样修改后，LaTeX 将使用 Adobe 字体集来渲染文档。您可以在模板文档的 1.2.1 小节 "测试生僻字" 中查看具体效果。
 
 > [!WARNING]
 > 将 Adobe 字体文件放置在项目根目录下并在 `main.tex` 中指定字体路径的方式并不总是有效。因此，我们建议您将 Adobe 字体文件安装到系统字体目录中。
@@ -198,7 +189,7 @@ make wordcount          # wordcount
 
 ```text
 %% tongji-undergrad-thesis
-%% Copyright 2023 TJ-CSCCG
+%% Copyright 2022-2025 TJ-CSCCG
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3
@@ -222,6 +213,7 @@ make wordcount          # wordcount
 - 2021.05.09 起，[ganler](https://github.com/ganler) 以上述项目为基础，增强其功能（项目结构与平台适配）并开始维护新项目。
 - 2022.05.12 起，[skyleaworlder](https://github.com/skyleaworlder) 开始贡献本项目，并将其整合进 [TJ-CSCCG](http://github.com/TJ-CSCCG)，并持续对该项目进行更新和改进，目前已经成为一个完善的本科毕业论文模板。
 - 2023.04 起，[RizhongLin](https://github.com/RizhongLin) 开始贡献本项目，并负责项目的维护和更新。
+- 2025.04 更新，实现基于键值对的类选项，支持更灵活的配置。
 
 我们非常感谢以上贡献者的付出，他们的工作为更多同学提供了方便和帮助。
 
@@ -242,5 +234,5 @@ make wordcount          # wordcount
     f'jiawei#@$.edu'.replace('#', '6').replace('$', 'illinois'),
     f'jgli22@$.edu.cn'.replace('$', 'm.fudan'),
     f'rizhong.lin@$.%'.replace('$', 'epfl').replace('%', 'ch'),
-]
+][-1]
 ```
diff --git a/main.tex b/main.tex
@@ -65,10 +65,10 @@
 
 % B. 如果使用bibtex，取消下面的注释
 % B. If using bibtex, uncomment the lines below
-% \addcontentsline{toc}{section}{参考文献} % 将参考文献项加入目录
-% \bibliography{bib/note}
+% \addcontentsline{toc}{section}{参考文献}  % 将参考文献项加入目录
+% \bibliography{bib/note.bib}  % 指定参考文献数据库文件
 
 \clearpage
 \input{sections/ack}
 
-\end{document}
+\end{document}
diff --git a/sections/01_intro.tex b/sections/01_intro.tex
@@ -1,6 +1,6 @@
 \section{介绍}\label{sec:introduction}
 
-在本节（\cref{sec:introduction}）中，我们将讨论文档中常用的各种标题级别和字体样式。在文章中，标题是非常重要的组成部分之一，它可以帮助读者更好地理解文章的结构和内容。
+在本节中，我们将讨论文档中常用的各种标题级别和字体样式。在文章中，标题是非常重要的组成部分之一，它可以帮助读者更好地理解文章的结构和内容。
 
 \subsection{二级标题}
 
diff --git a/sections/02_math.tex b/sections/02_math.tex
@@ -1,6 +1,6 @@
 \section{数学}\label{sec:math}
 
-在本节（\cref{sec:math}）中，我们展示各种数学符号和环境的使用。
+在本节中，我们展示各种数学符号和环境的使用。
 
 \subsection{数字和单位}
 
diff --git a/style/tongjithesis.cfg b/style/tongjithesis.cfg
