首字母縮寫和符號清單

glossaries-extra 概覽,或在夠用時改用手工維護的清單。

首字母縮寫和符號清單

長文件會累積縮寫,並且圍繞它們的約定很嚴格。首字母縮寫在第一次使用時會完整拼寫,然後縮寫,論文通常需要在前面列出縮寫詞清單。手動維護會以可預見的方式失敗。你重新排序了兩章,第一個使用移動,突然“ML”出現在“機器學習 (ML)”之前三頁。 glossaries-extra 套件會追蹤你的首次使用情況。

自動路線

\usepackage[acronym]{glossaries-extra}
\makeglossaries
\newacronym{ml}{ML}{machine learning}

acronym 選項啟用首字母縮略詞支援,並且 \makeglossaries 開啟在編譯期間收集條目的機制。每個\newacronym都有三個參數:你將在文字中鍵入的鍵、短形式和長形式。在序言中或在\input的單獨檔案中定義所有它們,因此它們位於一個位置。

在正文中,你永遠不會輸入首字母縮寫本身:

\gls{ml} on first use expands; later uses stay short.
\printglossaries

文件中的第一個 \gls{ml} 列印“機器學習 (ML)”,後面的每個都只列印“ML”。由於套件追蹤使用情況而不是在來源中的位置,因此無論你的重組將其移動到何處,擴充都會跟隨第一次使用。 \printglossaries 會列印收集的縮寫清單,無論你將其放在何處,通常位於目錄之後。相關指令涵蓋了與此相關的語法:\glspl表示複數,\Gls表示大寫的句子開頭。

問題在於建構。在 LaTeX 傳遞之間,必須執行 makeglossaries 輔助程式來對條目進行排序和格式化,否則 \printglossaries 不會產生任何結果。完整的 Latexmk 設定會自動處理這個問題。更簡單的管道可能不會,而詞彙表額外為它們提供了後備。如果你的清單頑固地拒絕出現,則缺少的幫助程式執行是第一個嫌疑人,遠遠早於文件中的錯誤。

手工建造的路線

對於簡單的符號清單,手動維護的 description 環境通常就足夠了:

\section*{Notation}
\begin{description}
\item[$\eta$] learning rate
\item[$\theta$] model parameters
\end{description}

每個 \item[...] 將其括號參數列印為粗體標籤,後面接著說明,這正是符號清單的形狀。沒有首次使用追蹤,但符號清單幾乎不需要;無論如何,符號都是在數學中第一次出現的地方定義的。

誠實的建議是讓工具符合規模。只有五個首字母縮寫的論文用手動管理更容易。有四十個的 200 頁論文就不是了,在那種情況下套件的設定成本會被回報許多倍。清單課程 更詳細地介紹了 description 環境。

返回 長篇文件