略語と記号の一覧

glossaries-extra の簡単な例と、それで十分なときの手作りの一覧。

略語と記号の一覧

長い文書には略語が増えていき、その扱いには厳しい慣習があります。略語は初出で正式名称を書き、以降は略語を使います。学位論文では、前付けに略語の一覧が必要になるのが普通です。これを手作業で管理すると、決まった形で失敗します。2 つの章を入れ替えると初出の位置が動き、突然「ML」が「machine learning (ML)」より 3 ページも前に現れるのです。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} は「machine learning (ML)」と出力し、以降はすべて「ML」だけを出力します。パッケージはソース上の位置ではなく使われた順序を追跡するので、構成を入れ替えても、展開は初出の位置に付いてきます。\printglossaries は、集めた略語の一覧を置いた場所に出力します。通常は目次の後です。関連するコマンドが、この周辺の文法を担います。複数形には \glspl、文頭の大文字には \Gls を使います。

落とし穴はビルドです。LaTeX の実行と実行の間に、エントリーの整列と整形のために makeglossaries というヘルパーを動かす必要があります。動かさないと、\printglossaries は何も出力しません。完全な latexmk の構成なら自動で処理されます。もっと単純なパイプラインでは処理されないこともあり、glossaries-extra にはそのための代替手段があります。一覧がどうしても表示されないときは、文書のバグを疑う前に、まずヘルパーが動いていないことを疑ってください。

手作りする方法

記号の単純な一覧なら、手で管理する description 環境で十分なことがよくあります。

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

各 \item[...] は、角括弧の引数を太字のラベルとして出力し、続けて説明を置きます。これはまさに記法の一覧にふさわしい形です。初出の追跡はありませんが、記号の一覧にはそれが要ることはまれです。記号は、数式の中で最初に現れる場所で定義されるからです。

正直なところ、規模に合わせてツールを選ぶのが一番です。略語が 5 つの論文なら、手作業のほうが楽です。40 個ある 200 ページの学位論文ではそうはいかず、そこではパッケージの設定の手間が何倍にもなって報われます。description 環境の詳細は、リストのレッスンで扱っています。

長編 に戻る