एल्गोरिदम और सोर्स कोड लिस्टिंग
algorithm2e से एल्गोरिदम का खाका और listings से असली कोड।
एल्गोरिदम और सोर्स कोड लिस्टिंग
रिसर्च पेपर में कोड दो अलग रूपों में दिखाया जाता है, और LaTeX में दोनों के लिए अलग-अलग टूल हैं। स्यूडोकोड किसी एल्गोरिदम का आदर्श रूप में बनाया गया खाका है, जिसे कीवर्ड और गणित के साथ टाइपसेट किया जाता है; इसके लिए algorithm2e पैकेज है। सोर्स लिस्टिंग असली कोड होती है, जिसे मोनोस्पेस फ़ॉन्ट में ज्यों का त्यों छापा जाता है; इसे listings पैकेज संभालता है। ग़लत टूल चुनना ही आमतौर पर परेशानी की जड़ होता है, इसलिए दोनों को देख लेना काम आता है।
algorithm2e से स्यूडोकोड
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}पैकेज के विकल्प दिखावट तय करते हैं: ruled एल्गोरिदम के ऊपर और नीचे क्षैतिज रेखाएँ खींचता है और कैप्शन को ऊपर रखता है, जो वह परंपरा है जिसकी ज़्यादातर कॉन्फ़्रेंस और जर्नल अपेक्षा करते हैं; vlined हर ब्लॉक का दायरा बताने वाली एक छोटी खड़ी रेखा खींचता है, इसलिए ज़्यादा इंडेंटेशन के बिना भी नेस्टिंग पढ़ने में साफ़ रहती है। algorithm एनवायरनमेंट चित्र की तरह एक फ़्लोट है, इसलिए इसमें \caption होता है, जो इसे एक संख्या देता है ताकि \ref उसका हवाला दे सके।
अंदर, \While{condition}{body} लूप को इस तरह टाइपसेट करता है: मोटे अक्षरों में कीवर्ड, फिर शर्त, और फिर इंडेंट किया हुआ बॉडी ब्लॉक। \For, \If और \Return भी यही पैटर्न अपनाते हैं। हर स्टेटमेंट \; पर ख़त्म होता है, जो पंक्ति का समापन चिह्न छापता है और नई पंक्ति शुरू करता है। इसे भूल जाना शुरुआती लोगों की पुरानी ग़लती है: सारी पंक्तियाँ एक-दूसरे में मिल जाती हैं। यह साधारण LaTeX है, इसलिए $\theta$ जैसा गणित इनलाइन चलता है, और स्यूडोकोड इसीलिए है: अपडेट नियम को किसी ख़ास प्रोग्रामिंग भाषा के बजाय नोटेशन में बताना।
listings से असली कोड
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}lstlisting एनवायरनमेंट अपनी सामग्री को हूबहू दोहराता है: खाली जगह बनी रहती है और विशेष वर्ण जैसे हैं वैसे ही माने जाते हैं, इसलिए आप बिना कुछ एस्केप किए कोड पेस्ट कर सकते हैं। language=Python विकल्प उस भाषा के लिए कीवर्ड हाइलाइटिंग चालू करता है, और listings दर्जनों दूसरी भाषाएँ भी जानता है। डिफ़ॉल्ट रूप से आउटपुट सादा होता है। ज़्यादातर लोग प्रीएम्बल में एक बार \lstset{basicstyle=\ttfamily\small, numbers=left} जोड़ देते हैं, ताकि मोनोस्पेस फ़ॉन्ट सही आकार में और पंक्ति संख्याओं के साथ मिले। पेस्ट करने के बजाय फ़ाइल सीधे जोड़नी हो, तो \lstinputlisting[language=Python]{train.py} उसे डिस्क से पढ़ता है, जिससे पेपर असली सोर्स के साथ मेल में रहता है। रंगीन और ज़्यादा सटीक हाइलाइटिंग चाहिए, तो minted पैकेज बेहतर विकल्प है, पर इसके लिए एक बाहरी टूल और शेल एस्केप चाहिए।
दोनों में से चुनना
विचार समझाने के लिए पेपर के मुख्य भाग में स्यूडोकोड का उपयोग करें, और हूबहू लिस्टिंग वहाँ रखें जहाँ सटीक कोड मायने रखता है, जैसे परिशिष्ट या टूल का विवरण। एक आम ग़लती है lstlisting को [fragile] विकल्प के बिना Beamer फ़्रेम के अंदर रखना; इससे ऐसी त्रुटि आती है जिसका मतलब समझना मुश्किल होता है। यही सावधानी पहला Beamer डेक में भी दिखती है।