संक्षिप्त रूपों और प्रतीकों की सूची

glossaries-extra की रूपरेखा, या जहाँ वही काफ़ी हो वहाँ हाथ से बनाई सूची।

संक्षिप्त रूपों और प्रतीकों की सूची

लंबे दस्तावेज़ों में संक्षिप्त रूप जमा होते जाते हैं, और उनके इर्द-गिर्द के नियम सख़्त हैं। संक्षिप्त रूप (acronym) पहली बार आने पर पूरा खोलकर लिखा जाता है, उसके बाद छोटा रूप चलता है, और शोध-प्रबंध में आम तौर पर शुरुआती पृष्ठों में संक्षिप्त रूपों की सूची चाहिए होती है। इसे हाथ से सँभालने पर एक अनुमानित गड़बड़ी होती है। आप दो अध्यायों का क्रम बदलते हैं, पहला उपयोग खिसक जाता है, और अचानक “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)” छापता है, और बाद का हर \gls{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 एन्वायरनमेंट की ज़्यादा जानकारी सूचियों वाले पाठ में है।

लंबे दस्तावेज़ पर वापस जाएँ