الاختصارات وقوائم الرموز

مخطط لاستخدام glossaries-extra، أو قائمة تُبنى يدويًا حين يكفي ذلك.

الاختصارات وقوائم الرموز

تتراكم الاختصارات في المستندات الطويلة، والأعراف المتبعة فيها صارمة. يُكتب الاختصار كاملًا عند أول استخدام، ثم يُستخدم مختصرًا بعد ذلك، وتحتاج الأطروحة عادةً إلى قائمة اختصارات في الصفحات التمهيدية. وصيانة ذلك يدويًا تفشل بطريقة متوقعة. تعيد ترتيب فصلين، فينتقل أول استخدام، وفجأة يظهر “ML” قبل “machine learning (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} في المستند يطبع “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[...] وسيطته بين القوسين المربعين تسمية غامقة يتبعها الشرح، وهذا بالضبط شكل قائمة الرموز. لا يوجد تتبع لأول استخدام، لكن قائمة الرموز نادرًا ما تحتاج إليه، فالرموز تُعرَّف حيث تظهر أول مرة في الرياضيات على أي حال.

النصيحة الصريحة هي أن تلائم الأداة الحجم. ورقة فيها خمسة اختصارات أسهل إدارةً باليد. أما أطروحة من 200 صفحة فيها أربعون اختصارًا فلا، وهناك تعوّض الحزمة كلفة إعدادها أضعافًا مضاعفة. ويتناول درس القوائم بيئة description بتفصيل أكبر.

العودة إلى المستندات الطويلة