頭字語と記号のリスト

長い文書には略語が蓄積され、その略語に関する規則は厳格です。頭字語は最初に使用するときは完全に表記され、その後は省略されます。通常、論文の前付には略語のリストが必要です。それを手動で維持すると、予想通りの方法で失敗します。 2 つの章を並べ替えると、最初の使用箇所が移動し、突然「機械学習 (ML)」の 3 ページ前に「ML」が表示されます。 「glossaries-extra」パッケージは、最初の使用を追跡します。

自動化されたルート

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

acronym オプションは頭字語のサポートを有効にし、\makeglossaries はコンパイル中にエントリを収集する機構をオンにします。各 \newacronym は 3 つの引数を取ります: テキストに入力するキー、短い形式、および長い形式です。それらすべてをプリアンブルまたは \input で別のファイルに定義して、それらが 1 か所に存在するようにします。

本文には、頭字語自体を入力することはありません。

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

ドキュメント内の最初の \gls{ml} は「機械学習 (ML)」を出力し、それ以降のすべての\gls{ml} は単に「ML」を出力します。パッケージはソース内での位置ではなく使用状況を追跡するため、拡張は再構築によって移動される最初の使用状況に従います。 \printglossaries は、収集した略語のリストをどこに配置しても (通常は目次の後に) 印刷します。関連コマンドは、これに関する文法をカバーしています。複数形の場合は \glspl、文頭の大文字の場合は \Gls です。

問題はビルドです。 LaTeX パスの間に、makeglossaries ヘルパーを実行してエントリを並べ替え、書式設定する必要があります。そうしないと、\printglossaries は黙って何も生成しません。完全な latexmk セットアップでは、これが自動的に処理されます。より単純なパイプラインはそうではない可能性があり、glossaries-extra はそれらのフォールバックを提供します。リストが頑なに表示されない場合は、ドキュメント内のバグよりもはるかに先に、ヘルパーの実行が欠落していることが最初に疑われます。

手作りのルート

シンボルの単純なリストの場合、多くの場合、手作業で管理された「説明」環境で十分です。

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

各 \item[...] は、括弧引数を太字のラベルとして出力し、それに続く説明を付けます。これはまさに記法リストの形です。初回使用の追跡はありませんが、シンボル リストが必要になることはほとんどありません。記号は、計算の中で最初に出現する場所に関係なく定義されます。

正直なアドバイスは、ツールをスケールに合わせることです。頭字語が 5 つ含まれている用紙は、手作業で管理するのが容易です。 40 ページある 200 ページの論文はそうではありません。そこではパッケージのセットアップ費用が何倍もかかります。 リストのレッスン では、「説明」環境について詳しく説明します。