docs: 链接优先指向 🥑 疑难杂症 (bithesis.bitnp.net/faq)

- GitHub 的 issue、discussion 链接 → https://bithesis.bitnp.net/faq 链接

  ```diff
  - % 如果想要微调，详见 #407 (reply in thread) 。
  + % 如果想要微调，详见 https://bithesis.bitnp.net/faq/bib-sort.html#sortkey 。
  ```

- 手册 §7 常见问题和疑难解答 → https://bithesis.bitnp.net/faq 的目录

  `make doc`时会从 https://bithesis.bitnp.net/faq/index.tex 下载。

Resolves #586 (comment)

Relates-to: BITNP/BIThesis-wiki#475
Relates-to: BITNP/BIThesis-wiki@aec57e0

Author: YDX-2147483647

.gitignore

@@ -290,6 +290,9 @@ bithesis
 /tests/*/latexmkrc
 /handbook/latexmkrc
 
+# Generated by `make assets/faq.tex`
+/assets/faq.tex
+
 !templates/*.pdf
 overleaf
 *.zip

Makefile

@@ -25,7 +25,7 @@ endif
 
 .PHONY: all FORCE_MAKE
 
-$(PACKAGE).pdf: cls FORCE_MAKE
+$(PACKAGE).pdf: cls assets/faq.tex FORCE_MAKE
 	@$(LATEXMK) -xelatex $(PACKAGE).dtx
 
 $(CLSFILE): $(SOURCES)
@@ -37,6 +37,9 @@ cls: $(CLSFILE)
 .PHONY: doc
 doc: $(PACKAGE).pdf
 
+assets/faq.tex:
+	curl https://bithesis.bitnp.net/faq/index.tex -o assets/faq.tex
+
 .PHONY: viewdoc
 viewdoc: doc
 	$(LATEXMK) -pv $(PACKAGE).dtx
@@ -45,6 +48,7 @@ viewdoc: doc
 clean:
 	$(LATEXMK) -c $(PACKAGE).dtx
 	-rm -rf *.glo $(CLSFILE)
+	-rm assets/faq.tex
 
 .PHONY: clean-dist
 clean-dist:

README.md

@@ -45,7 +45,7 @@ BIThesis 是针对北京理工大学本科生毕业设计论文、研究生学
 > 本项目获得了[北京理工大学研究生院](https://grd.bit.edu.cn/xwgz/xwgz2/wjxz_xwgz/b117824.htm)、[北京理工大学教务部](https://jwb.bit.edu.cn/)和[北京理工大学计算机学院](https://cs.bit.edu.cn/) 的认可、背书与大力支持。详见：[致谢 - 官方赞助](https://bithesis.bitnp.net/guide/acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)。
 
 > [!WARNING]
-> 重要提示：建议 macOS 用户使用最新版的 [texlive 2023或以上版本](https://www.tug.org/mactex/mactex-download.html)，否则可能会遇到参考文献被查重的情况。详见 https://github.com/BITNP/BIThesis/issues/326
+> 重要提示：建议 macOS 用户更新到 [TeX Live / MacTeX 2023 或更新版本](https://www.tug.org/mactex/mactex-download.html)，否则[参考文献等可能会被错误查重](https://bithesis.bitnp.net/faq/false-duplicate.html)。
 
 <h2>特性</h2>
 

bithesis-doc.tex

@@ -249,7 +249,7 @@ \subsection{\BIThesisLaTeX 是如何发布的？}
     \href{https://github.com/BITNP/BIThesis/releases}{GitHub Releases}
     \footnote{最推荐使用此种方式}
   \item  Overleaf 发布：
-    \href{https://bithesis.bitnp.net}{Overleaf Templates}
+    \href{https://bithesis.bitnp.net/guide/preface.html#q-bithesis-都包含哪些模板}{Overleaf Templates}
 \end{itemize}
 其中，CTAN 上发布的是 bithesis 宏包，也就是 |*.cls| 组成的文件，
 它们可以通过 \TeX 发行版自带的包管理器 tlmgr 来更新。
@@ -292,7 +292,7 @@ \subsection{\BIThesis 宏包的安装和更新}
 
 \begin{itemize}
 \item Windows、Linux用户推荐安装 TeX Live 套装，
-  并更新宏包（Linux系统由于版权问题，未能预装宋体等 Windows 下的字体，需要手动安装；对于 WSL 用户，可参照\ref{sec:word-fonts}直接使用 Windows 下的字体）
+  并更新宏包（Linux系统由于版权问题，未能预装宋体等 Windows 下的字体，需要手动安装；对于 WSL 用户，可参照\href{https://bithesis.bitnp.net/faq/word-font.html}{疑难杂症：如何采用与 Word 相同的中文字体}直接使用 Windows 下的字体）
 \item OSX用户推荐安装 Mac TeX。
 \item 由于CTeX套装所含宏包比较陈旧，可能会导致编译无法通过，故不推荐安装。
   如果已安装 CTeX，\textbf{建议将其卸载}。
@@ -600,7 +600,7 @@ \subsubsection{封面选项} \label{sec:cover}
 
   配置此选项以在部分模板封面中使用“华文细黑”，保证与 Word 模板中的字体一致。
 
-  在 Windows 和 macOS 中，该字体已经安装；在 Linux 中一般需要用户自行安装（如果你是 WSL 用户，可参照\ref{sec:word-fonts}直接使用 Windows 下的字体）。
+  在 Windows 和 macOS 中，该字体已经安装；在 Linux 中一般需要用户自行安装（如果你是 WSL 用户，可参照\href{https://bithesis.bitnp.net/faq/word-font.html}{疑难杂症：如何采用与 Word 相同的中文字体}直接使用 Windows 下的字体）。
 \end{function}
 
 \begin{function}{cover/delimiter}
@@ -1260,7 +1260,7 @@ \subsubsection{攻读学位期间发表论文与研究成果清单选项}
 
   \item 在发表时间顺序上微调，把个别的提到最前——保留默认的 |true|，同时在 |*.bib| 文件中给个别项加上 |sortkey| 字段。
 
-    具体例子可参考\href{https://bithesis.bitnp.net/faq/bib-sort.html#sortkey}{疑难杂症}，详细解释可参考 \href{https://mirrors.ctan.org/macros/latex/contrib/biblatex-contrib/biblatex-gb7714-2015/biblatex-gb7714-2015.pdf}{biblatex-gb7714-2015 宏包手册（中文）}或 \href{https://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/biblatex.pdf}{biblatex 宏包手册（英文）}。
+    具体例子可参考\href{https://bithesis.bitnp.net/faq/bib-sort.html#sortkey}{疑难杂症：怎么调整「攻读学位期间发表论文与研究成果清单」的顺序}，详细解释可参考 \href{https://mirrors.ctan.org/macros/latex/contrib/biblatex-contrib/biblatex-gb7714-2015/biblatex-gb7714-2015.pdf}{biblatex-gb7714-2015 宏包手册（中文）}或 \href{https://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/biblatex.pdf}{biblatex 宏包手册（英文）}。
 \end{itemize}
 
 \textit{注意，如果编译后编号产生错误，
@@ -1322,7 +1322,7 @@ \subsubsection{其他配置}
   \textit{此选项一般不需要用户自行修改。}
 
   早期（2022年及以前）\BIThesisTemplates{UTE}需要设置 Arial 字体。
-  在 Windows 和 macOS 中，该字体已经安装；在 Linux 中需要用户自行安装（如果你是 WSL 用户，可参照\ref{sec:word-fonts}直接使用 Windows 下的字体）。
+  在 Windows 和 macOS 中，该字体已经安装；在 Linux 中需要用户自行安装（如果你是 WSL 用户，可参照\href{https://bithesis.bitnp.net/faq/word-font.html}{疑难杂症：如何采用与 Word 相同的中文字体}直接使用 Windows 下的字体）。
 \end{function}
 
 \begin{function}[added=2023-04-22, updated=2024-05-13]{misc/tabularFontSize}
@@ -1673,7 +1673,7 @@ \subsubsection{定理类环境}
 
   一系列预定义的数学环境。具体含义见表~\ref{tab:theorem}。
 
-  其中提供了算法环境 |algo|，但模板也适配了一些更专业的宏包，请参考 \ref{sec:algorithm}。
+  其中提供了算法环境 |algo|，但模板也适配了一些更专业的宏包，请参考\href{https://bithesis.bitnp.net/faq/algorithm.html}{疑难杂症：如何排版算法（伪代码）}。
 \end{function}
 
 \begin{table}[]
@@ -1898,125 +1898,9 @@ \subsection{后置部分}
 
 \section{常见问题和疑难解答}
 
-\subsection{如何排版算法（伪代码）？} \label{sec:algorithm}
+请参考\href{https://bithesis.bitnp.net/faq/}{在线文档的「疑难杂症」部分}，此处仅略作枚举。
 
-有以下三种互不兼容的方式。
-
-\begin{itemize}
-  \item |algorithm|+X 方式
-
-  引入 |algorithm| 宏包时，要加上选项 |chapter| 才能按学校要求分章编号，示例如下。
-
-\begin{bitsyntax}[emph={[1]chapter}]
-\usepackage[chapter]{algorithm}
-\usepackage{algorithmic} % 也可替换为 algpseudocode 或 algcompatible
-\end{bitsyntax}
-
-  使用示例请参考 \href{https://www.overleaf.com/learn/latex/Algorithms}{Algorithms - Overleaf 文档}。
-
-  \item |algorithm2e| 方式
-
-  引入宏包时，要加上选项 |algochapter| 才能按学校要求分章编号，示例如下。
-
-\begin{bitsyntax}[emph={[1]algochapter}]
-\usepackage[ruled, algochapter]{algorithm2e}
-\end{bitsyntax}
-
-  使用示例请参考 \href{https://www.overleaf.com/learn/latex/Algorithms#The_algorithm2e_package}{Algorithms - Overleaf 文档的 The |algorithm2e| package 一节}。
-
-  \item 使用模板提供的 |algo| 环境
-
-  这是表~\ref{tab:theorem}中的数学环境之一，不额外依赖宏包，但功能有限，基本只支持编号。
-\end{itemize}
-
-\subsection{为什么我的研究生模板开头有间隔的空白页？}
-
-根据《北京理工大学研究生学位论文撰写规范》，摘要前的页面需要单面打印，之后的内容需要双面打印。
-因此多出的空白页可以让你免于切换单、双面打印的烦恼——统一使用双面打印即可。
-
-或者，你可以关闭 |twoside| \ref{doc/function//twoside} 选项来去除这些空白。
-
-\subsection{如何修改数学公式的字体？}
-
-可以在导言区引入 \pkg{unicode-math} 宏包，
-并使用 |\setmathfont{XITS Math}| 修改数学环境下字体：
-
-\begin{latex}
-\usepackage{unicode-math}
-\unimathsetup{
-  math-style = ISO,
-  bold-style = ISO,
-}
-\setmathfont{XITSMath-Regular.otf}
-\end{latex}
-
-\textit{请事先安装 XITS 字体。}
-
-此外，如果使用 \TeX{} Gyre Pagella Math 等字面较大的字体，略微增加数学行距可能更美观：
-\begin{latex}
-\setmathfont{texgyrepagella-math.otf}
-\SetMathEnvironmentSinglespace{1.05}
-\end{latex}
-
-\textit{更多字体与使用方法请参考
-\href{https://ctan.org/pkg/unicode-math?lang=zh}{unicode-math 手册}和
-\href{https://ctan.org/pkg/zhlineskip}{zhlineskip 手册}。}
-
-\subsection{如何采用与 Word 相同的中文字体？} \label{sec:word-fonts}
-
-首先需要明确的是，我们所指的 Word 中的中文字体属于「中易字库」。
-
-对于 Windows 用户，一般无需修改设置，开箱即用。
-
-对于 Linux 和 macOS 用户，由于版权问题，系统中并不包含中易字库。
-因此，用户有两种选择：
-\begin{itemize}
- \item 手动在系统中安装中易字库
- （一般包括 SimSun、SimHei、KaiTi、FangSong 等）。
- \textbf{请注意，是 KaiTi 而不是 SimKai。}
- 并通过 |\documentclass[...,ctex={fontset=windows}]{bithesis}| 选项
- 强制使用中易字库。
- \item 在 Windows 系统下编译最终的 PDF 文件。
-\end{itemize}
-
-此外，对于 WSL 用户，你可以将 Windows 的字体目录软链接到 WSL 的字体目录，直接使用 Windows 下的字体文件。通过 WSL 的命令行按序执行：
-\begin{shell}[morekeywords={ln}]
-sudo ln -s /mnt/c/Windows/Fonts /usr/share/fonts/win-fonts
-fc-cache -fv # 刷新字体缓存
-\end{shell}
-之后通过 |\documentclass[...,ctex={fontset=windows}]{bithesis}| 选项
-强制使用中易字库即可。
-
-\subsection{列表项的间距过大该如何解决？}
-
-相比 Word，$\LaTeX$ 的列表项间距会比行间距更大一些。
-这样做在一个列表项中包含多行时，可以更好地区分不同的列表项。
-但是，如果你只是想要一个简单的列表，这种间距可能会显得过大。
-想要\textbf{临时}取消这种间距，可以在环境中添加选项 |nosep|：
-
-\begin{latex}
-\begin{itemize}[nosep]
-  \item 选项一
-  \item 选项二
-\end{itemize}
-\end{latex}
-
-想要\textbf{永久}取消这种间距，可以在导言区添加如下代码：
-
-\begin{latex}
-\setlist{nosep}
-\end{latex}
-
-详见：https://github.com/BITNP/BIThesis/issues/293
-
-\textit{以上功能由 \pkg{enumitem} 宏包支持。通过导入 \pkg{bithesis}
-，该宏包已经被自动导入。}
-
-\subsection{想要让某一个页面自动从奇数页开始}
-
-首先，请保证开启了 |twoside| 模式。
-然后，请在你想要奇数页排版的页面之前
-（|\chapter|之前）插入 |\cleardoublepage|。
+\input{assets/faq.tex}
 
 \section{\cls{bitreport.cls} 使用与配置}
 \label{sec:bitreport}

handbook/chapters/ch3-latex-syntax.tex

@@ -360,7 +360,7 @@ \subsection{将参考文献的内容与表现分离}
 
 \subsection{在正文中引用参考文献}
 
-\textit{如果想要按照章节分别管理参考文献，可以详见 biblatex 中关于refsection 的部分。简单来说，就是\href{https://github.com/BITNP/BIThesis/discussions/435}{使用 refsection 包裹一个章节的全部内容}即可。但由于我校论文要求并非采用章节管理，因此不做赘述。}
+\textit{如果想要按照章节分别管理参考文献，可以详见 biblatex 中关于refsection 的部分。简单来说，就是\href{https://bithesis.bitnp.net/faq/bib-split.html}{使用 refsection 包裹一个章节的全部内容}即可。但由于我校论文要求并非采用章节管理，因此不做赘述。}
 
 正文中引用参考文献时\cite{Jiang2005Size}，用\verb+\cite{key1,key2,key3...}+可以产生“上标引用的参考文献”，
 如\cite{Meta_CN,chen2007act,DPMG}。

handbook/main.tex

@@ -67,8 +67,7 @@
 \addbibresource{reference/main.bib}
 
 \usepackage{hyperref}
-% https://github.com/BITNP/BIThesis/discussions/400
-% https://static.latexstudio.net/wp-content/uploads/2018/03/swjtuthesis.pdf
+% https://bithesis.bitnp.net/faq/autoref-name.html
 \def\figureautorefname~#1\null{图~#1~\null}
 \def\chapterautorefname~#1\null{第~#1~章\null}
 \def\sectionautorefname~#1\null{第~#1~节\null}

templates/graduate-thesis/README.md

@@ -4,7 +4,8 @@
 
 此文件夹中包含了北京理工大学研究生学位论文的全部内容，有关模板的使用方法更为详细的介绍，请参考：[bithesis 使用手册][manual]。
 
-> :warning: 重要提示：建议 macOS 用户使用最新版的 [texlive 2023](https://www.tug.org/mactex/mactex-download.html)，否则可能会遇到参考文献被查重的情况。详见 https://github.com/BITNP/BIThesis/issues/326
+> [!WARNING]
+> 重要提示：建议 macOS 用户更新到 [TeX Live / MacTeX 2023 或更新版本](https://www.tug.org/mactex/mactex-download.html)，否则[参考文献等可能会被错误查重](https://bithesis.bitnp.net/faq/false-duplicate.html)。
 
 ## 特性
 

templates/graduate-thesis/misc/4_pub.tex

@@ -26,7 +26,7 @@
 
   % **默认情况下，这里的内容将按照学校要求，以发表时间排序。**
   % - 如果想要按照引用顺序排序，可以开启 `publications/sorting` 选项。
-  % - 如果想要微调，详见 https://github.com/BITNP/BIThesis/discussions/407#discussioncomment-8630685 。
+  % - 如果想要微调，详见 https://bithesis.bitnp.net/faq/bib-sort.html#sortkey 。
   % 更多信息请参考「bithesis.pdf」手册。
   \addpubs{myCiteKey,myCiteKey2,dummy:1,dummy:2}
 
@@ -50,7 +50,9 @@
   % 2. 若需继续细分，请在 pub.bib 的条目里记录“keywords = {…, …}”，然后在此用“keyword=…”筛选。
   % 3. 如果还有要求，可用notkeyword、subtype等筛选方法，请参考 biblatex 手册。
 
-  % 以下内容提供了一个可以同时和 \printbibliography 共存的自定义列表格式。
+  % 如果想绕过 pub.bib 直接记录项目（例如获奖），请参考以下内容，
+  % 定义一个能和 \printbibliography 共存的列表。
+  % https://bithesis.bitnp.net/faq/pub-manual.html
   % \zihao{5} % 字号改为五号
   % \renewcommand{\labelenumi}{[\theenumi]} % 编号改用中括号
   %

templates/graduate-thesis/reference/pub.bib

@@ -32,6 +32,7 @@
 % 再比如，若论文作者为「李四、张三、王五、赵六」（你是共同二作），则应该写成：
 % `author+an = {2:myself="\Author[][][共同二作]"}`
 % **\Author 的具体用法请参考手册**。
+% https://bithesis.bitnp.net/faq/bib-author.html
 
 % `annotation = {}` 一句用于指定条目的补充内容。
 

templates/paper-translation/main.tex

@@ -90,8 +90,8 @@
 % 参考文献引用文件位于 misc/ref.bib
 \addbibresource{misc/ref.bib}
 
-% 如果要按照计算机学院的要求，带有“北京理工大学”水印，请使用此 issue 提供的方法：
-% https://github.com/BITNP/BIThesis/issues/350#issuecomment-1565974141
+% 若要按计算机学院要求，添加“北京理工大学”水印，请参考
+% https://bithesis.bitnp.net/faq/watermark.html
 
 % 文档开始
 \begin{document}

templates/reading-report/README.md

@@ -4,7 +4,8 @@
 
 此文件夹中包含了北京理工大学读书报告模板的全部内容，有关模板的使用方法更为详细的介绍，请参考：[bithesis 使用手册][manual]。
 
-> :warning: 重要提示：建议 macOS 用户使用最新版的 [texlive 2023](https://www.tug.org/mactex/mactex-download.html)，否则可能会遇到参考文献被查重的情况。详见 https://github.com/BITNP/BIThesis/issues/326
+> [!WARNING]
+> 重要提示：建议 macOS 用户更新到 [TeX Live / MacTeX 2023 或更新版本](https://www.tug.org/mactex/mactex-download.html)，否则[参考文献等可能会被错误查重](https://bithesis.bitnp.net/faq/false-duplicate.html)。
 
 ## 特性
 

templates/reading-report/main.tex

@@ -67,9 +67,9 @@
   },
 }
 
-% 使用 listings 宏包进行代码块使用，并使用了预定义的样式，
-% 你也可以选用自己的喜欢的其他宏包，如 minted；
-% 然而由于 minted 依赖 Python 的 Pygments 库作为外部依赖，因此出于模板的简洁程度考虑，我们没有提供 minted 进行代码块书写的示例。
+% 这份模板提供了代码块示例，采用 listings 宏包及其预定义样式。
+% 使用代码块时，也可选用自己的喜欢的其他宏包，如 minted：https://bithesis.bitnp.net/faq/minted.html
+% 如果不需要，直接删除即可。
 \usepackage{listings}
 
 

templates/reading-report/misc/2_reference.tex

@@ -18,11 +18,13 @@
 % The Current Maintainer of this work is Feng Kaiyu.
 %
 % Compile with: xelatex -> biber -> xelatex -> xelatex
-%
-% 如无特殊需要，本页面无需更改
 
 \begin{bibprint}
 
+% \printbibliography[heading=none]
+% 正式使用时，请启用上方语句以输出所有的参考文献，并删除/注释下方示例内容。
+% 删除后仍可参考 https://bithesis.bitnp.net/faq/bib-entry.html 的在线版本。
+
 % -------------------------------- 示例内容（正式使用时请删除） ------------------------------------- %
 
 % 抑制多次调用 \printbibliography 的 warning，只有示例代码会需要此语句。
@@ -116,6 +118,4 @@
 
 \textcolor{blue}{关于参考文献的未尽事项可参考国家标准《信息与文献参考文献著录规则》（GB/T 7714—2015）}
 
-% 在使用时，请删除/注释上方示例内容，并启用下方语句以输出所有的参考文献
-% \printbibliography[heading=none]
 \end{bibprint}

templates/undergraduate-thesis-en/README.md

@@ -4,7 +4,8 @@
 
 此文件夹中包含了北京理工大学本科生毕业设计（论文）外文翻译的全部内容，有关模板的使用方法更为详细的介绍，请参考：[bithesis 使用手册][manual]。
 
-> :warning: 重要提示：建议 macOS 用户使用最新版的 [texlive 2023](https://www.tug.org/mactex/mactex-download.html)，否则可能会遇到参考文献被查重的情况。详见 https://github.com/BITNP/BIThesis/issues/326
+> [!WARNING]
+> 重要提示：建议 macOS 用户更新到 [TeX Live / MacTeX 2023 或更新版本](https://www.tug.org/mactex/mactex-download.html)，否则[参考文献等可能会被错误查重](https://bithesis.bitnp.net/faq/false-duplicate.html)。
 
 ## BITSetup 学院变体
 

templates/undergraduate-thesis-en/main.tex

@@ -74,9 +74,9 @@
   },
 }
 
-% 使用 listings 宏包进行代码块使用，并使用了预定义的样式，
-% 你也可以选用自己的喜欢的其他宏包，如 minted；
-% 然而由于 minted 依赖 Python 的 Pygments 库作为外部依赖，因此出于模板的简洁程度考虑，我们没有提供 minted 进行代码块书写的示例。
+% 这份模板提供了代码块示例，采用 listings 宏包及其预定义样式。
+% 使用代码块时，也可选用自己的喜欢的其他宏包，如 minted：https://bithesis.bitnp.net/faq/minted.html
+% 如果不需要，直接删除即可。
 \usepackage{listings}
 
 
@@ -97,8 +97,8 @@
 % 参考文献引用文件位于 misc/ref.bib
 \addbibresource{misc/ref.bib}
 
-% 如果要按照计算机学院的要求，带有“北京理工大学”水印，请使用此 issue 提供的方法：
-% https://github.com/BITNP/BIThesis/issues/350#issuecomment-1565974141
+% 若要按计算机学院要求，添加“北京理工大学”水印，请参考
+% https://bithesis.bitnp.net/faq/watermark.html
 
 % 文档开始
 \begin{document}

templates/undergraduate-thesis/README.md

@@ -4,7 +4,8 @@
 
 此文件夹中包含了北京理工大学毕业设计（论文）的全部内容，有关模板的使用方法更为详细的介绍，请参考：[bithesis 使用手册][manual]。
 
-> :warning: 重要提示：建议 macOS 用户使用最新版的 [texlive 2023](https://www.tug.org/mactex/mactex-download.html)，否则可能会遇到参考文献被查重的情况。详见 https://github.com/BITNP/BIThesis/issues/326
+> [!WARNING]
+> 重要提示：建议 macOS 用户更新到 [TeX Live / MacTeX 2023 或更新版本](https://www.tug.org/mactex/mactex-download.html)，否则[参考文献等可能会被错误查重](https://bithesis.bitnp.net/faq/false-duplicate.html)。
 
 ## 特性