पाठ १६

प्रलेखीकरण तथा और सहायता प्राप्त करना

यह पाठ LaTeX-संबंधित सॉफ्टवेर और पैकेजों के लिए प्रमुख प्रलेखन (documentation) स्रोतों को प्रस्तुत करता है, और यह भी बताता है कि जब आप किसी समस्या में हों तो सहायता कैसे प्राप्त करें।

किसी पैकेज या क्लास की डॉक्युमेंटेशन प्राप्त करने के कई तरीके हैं।

texdoc

यदि आपने कोई TeX वितरण (जैसे TeX Live या MiKTeX) स्थापित किया है और स्थापना के समय डॉक्युमेंटेशन को भी शामिल किया है, तो आप texdoc नामक कमांड लाइन टूल की सहायता से उस डॉक्युमेंटेशन को स्थानीय रूप से देख सकते हैं। उदाहरण के लिए:

texdoc < pkg >

यह कमांड <_pkg_> के लिए उपलब्ध डॉक्यूमेंट को खोलेगी। यह टूल आपके द्वारा दिए गए नाम से संबंधित सभी डाक्यूमेंट्स को खोजेगा और जो उसे सबसे उपयुक्त लगेगा, उसे खोल देगा। यदि आप सभी उपयुक्त परिणामों की सूची देखना चाहते हैं और उनमे से किसी एक को चुनना चाहते हैं, तो निम्नलिखित कमांड का प्रयोग करें:

texdoc -l < pkg >

texdoc.org

यह एक वेबसाइट है जो texdoc की तरह ही कार्य करती है। इसमें आप उस डॉक्युमेंटेशन को खोज सकते हैं जो वहाँ उपलब्ध है, ठीक वैसे ही जैसे आप texdoc -l कमांड से करते हैं, और फिर परिणामों में से किसी एक को चुन सकते हैं।

CTAN

CTAN का पूरा नाम है Comprehensive TeX Archive Network। अधिकतर LaTeX पैकेज इसी प्लेटफार्म पर प्रकाशित किए जाते हैं। आप वेबसाइट पर किसी भी पैकेज को खोजकर उसकी डॉक्युमेंटेशन तक पहुँच सकते हैं। आमतौर पर पैकेज इस पते पर संग्रहित रहते हैं: ctan.org/pkg/<पैकेज-का-नाम> यहाँ आप उस पैकेज की README फ़ाइल और अन्य दस्तावेज़ पढ़ सकते हैं जो CTAN पर संग्रहित होते हैं।

LaTeX पर पुस्तकें

LaTeX सीखने के लिए कई पुस्तकें उपलब्ध हैं जो आपकी मदद कर सकती हैं। यदि आप एक प्रारंभिक स्तर के उपयोगकर्ता हैं, तो एक क्रमबद्ध शुरुआती मार्गदर्शिका से आपको बहुत लाभ होगा, क्योंकि उसमें वह विवरण होता है जो यहाँ संक्षेप में दिया गया है। इसके अतिरिक्त, आप एक ऐसी संदर्भ-पुस्तक भी रखना चाहेंगे जिसमें अधिक जानकारी और सिफारिशें हों।

LaTeX टीम ने पुस्तकों की एक सूची साझा की है, जिनमें से अधिकतर उनके सदस्यों द्वारा लिखी गई हैं। इन पुस्तकों में सबसे उल्लेखनीय हैं:

LaTeX सीखने के उद्देश्य से लिखी गई अन्य उपयोगी पुस्तकों में शामिल हैं:

सहायता प्राप्त करना (Getting Help)

LaTeX से संबंधित प्रश्न पूछने के लिए कई ऑनलाइन मंच उपलब्ध हैं। आज के समय में सबसे लोकप्रिय मंचों में से एक है TeX - LaTeX StackExchange। जब भी आप कोई प्रश्न पूछें, तो सबसे पहले अपना उदाहरण स्पष्ट रूप से तैयार करना सबसे अच्छा होता है, जिसे सामान्यतः ‘मिनिमल वर्किंग एग्ज़ाम्पल (MWE)’ कहा जाता है। इसका मतलब यह नहीं कि कोड सही तरीके से चल रहा है (यदि ऐसा होता तो आप सवाल नहीं पूछते!), बल्कि इसका तात्पर्य है कि आपने उसे यथासंभव स्पष्ट, स्वतंत्र और संक्षिप्त बनाया है। “संक्षिप्त” का अर्थ है कि उदाहरण में केवल उतना ही कोड हो, जितना समस्या को दर्शाने के लिए आवश्यक है।

मिनिमल वर्किंग एग्ज़ाम्पल (MWE) कैसे दें?

आप MWE कैसे बनाएँ? सामान्यतः सबसे सरल तरीका यह है कि आप ऐसे शुरू करें:

\documentclass{article}
\usepackage[T1]{fontenc}
\begin{document}
Text
\end{document}

और उसमें एक-एक करके पंक्तियाँ जोड़ते जाएँ जब तक कि वह समस्या उत्पन्न न हो जाए। आप चाहें तो अपने वास्तविक फाइल को छोटा करने (कट डाउन करने) की कोशिश भी कर सकते हैं, लेकिन यह प्रक्रिया समय लेने वाली हो सकती है।

यदि आपको पृष्ठ विभाजन (page breaking) और अन्य प्रभावों को दिखाने के लिए अधिक पाठ (text) की आवश्यकता हो, तो आप lipsum जैसे पैकेज का उपयोग कर सकते हैं। यह पैकेज अर्थहीन अनुच्छेद (nonsense paragraphs) उत्पन्न करता है, जिससे आपकी परीक्षण फाइल छोटी बनी रहती है।

लॉग फाइल

एक महत्वपूर्ण फाइल जो आपको उपलब्ध रखनी चाहिए, वह है आपकी लॉग फाइल। यह फाइल हर बार LaTeX चलाने पर स्वतः बनती है, और इसका नाम आपकी इनपुट फाइल के समान होता है, लेकिन इसका अंत .log से होता है।

आपके डेस्कटॉप इंटरफेस के अनुसार, यह पता लगाने के लिए कि कौन-सी फाइल है, आपको ‘एक्सटेंशन दिखाना’ (show extensions) सक्षम करना पड़ सकता है।

लॉग फाइल में आप हमेशा पूरी त्रुटि (error) संदेशों को देख सकते हैं। LaTeX के त्रुटि संदेश उपयोगकर्ता की सहायता करने का प्रयास करते हैं, लेकिन ये वर्ड प्रोसेसर (जैसे MS Word) के संदेशों जैसे नहीं होते।

कुछ संपादक (editors) त्रुटि (error) के 'पूर्ण' पाठ को देखना कठिन बना देते हैं, जिससे महत्वपूर्ण विवरण छिप सकते हैं।

यदि आपको कोई समस्या है, तो अनुभवी LaTeX उपयोगकर्ता अक्सर आपकी लॉग फाइल की एक प्रति माँगेंगे।

आगे और जानकारी के लिए

अंत में, हम छोटे उदाहरणों की एक गैलरी प्रस्तुत करते हैं, जिसमें विभिन्न विषय क्षेत्रों के उदाहरण दिए गए हैं जो इस परिचय में शामिल नहीं हैं, साथ ही उन क्षेत्रों में प्रयुक्त विभिन्न LaTeX पैकेज भी दर्शाए गए हैं।