Kısaltmalar ve sembol listeleri

glossaries-extra ile bir taslak ya da yeterli olduğunda elle hazırlanmış bir liste.

Kısaltmalar ve sembol listeleri

Uzun belgeler kısaltma biriktirir ve bunlarla ilgili kurallar katıdır. Bir kısaltma ilk kullanımda tam hâliyle yazılır, sonrasında kısaltılır; bir tez de genellikle ön sayfalarda bir kısaltmalar listesi ister. Bunu elle sürdürmek öngörülebilir biçimde başarısız olur. İki bölümün sırasını değiştirirsiniz, ilk kullanım yer değiştirir ve birden “ML”, “machine learning (ML)” ifadesinden üç sayfa önce görünür. glossaries-extra paketi ilk kullanımı sizin için izler.

Otomatik yol

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

acronym seçeneği kısaltma desteğini açar, \makeglossaries ise derleme sırasında girdileri toplayan mekanizmayı devreye alır. Her \newacronym üç argüman alır: metinde yazacağınız bir anahtar, kısa biçim ve uzun biçim. Hepsini önsözde ya da \input ile dahil ettiğiniz ayrı bir dosyada tanımlayın ki tek yerde dursunlar.

Gövdede kısaltmanın kendisini asla yazmazsınız:

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

Belgedeki ilk \gls{ml} “machine learning (ML)” basar, sonraki her biri yalnızca “ML” basar. Paket, kaynaktaki konumu değil kullanımı izlediği için, yeniden yapılandırmanız ilk kullanımı nereye taşırsa açılım da oraya gider. \printglossaries, toplanan kısaltmalar listesini yerleştirdiğiniz yere, genellikle içindekilerden sonra basar. İlgili komutlar bunun çevresindeki dilbilgisini kapsar: çoğullar için \glspl, cümle başında büyük harf için \Gls.

Takılma noktası derlemedir. LaTeX geçişleri arasında girdileri sıralayıp biçimlendirmek için makeglossaries yardımcısının çalışması gerekir; yoksa \printglossaries sessizce hiçbir şey üretmez. Tam latexmk kurulumları bunu otomatik halleder. Daha basit boru hatları halletmeyebilir ve glossaries-extra onlar için bir yedek sunar. Listeniz inatla görünmüyorsa, belgenizdeki bir hatadan çok önce ilk şüpheli, çalışmayan yardımcı geçişidir.

Elle hazırlanan yol

Basit bir sembol listesi için elle sürdürülen bir description ortamı çoğu zaman yeter:

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

Her \item[...], köşeli parantez argümanını kalın bir etiket olarak basar ve açıklama onu izler; bir gösterim listesinin biçimi tam olarak budur. İlk kullanım izleme yoktur, ama bir sembol listesi nadiren buna ihtiyaç duyar; semboller matematikte ilk göründükleri yerde zaten tanımlanır.

Dürüst tavsiye, aracı ölçeğe uydurmaktır. Beş kısaltmalı bir makaleyi elle yönetmek daha kolaydır. Kırk kısaltmalı 200 sayfalık bir tezde ise öyle değildir ve orada paket kurulum maliyetini kat kat çıkarır. Listeler dersi description ortamını daha ayrıntılı kapsar.

Uzun biçim bölümüne geri dön