विकिपुस्तक:साँचा विवरण

विकिपुस्तक से
Jump to navigation Jump to search

साँचे मीडियाविकि के शक्तिशाली और उपयोगी फ़ीचर हैं। इनका उपयोग किसी जानकारी, प्रारूप (फ़ॉर्मेटिंग) अथवा सूचना इत्यादि को बारंबार अलग-अलग पन्नों पर प्रदर्शित करने के लिए किया जाता है। हालाँकि, ये बहुत ही उपयोगी साबित होते हैं, कई बार नए सदस्यों को साँचों के प्रयोग में कठिनाई आ सकती है। अनुभवी सदस्य भी कई बार भ्रमित हो सकते हैं कि किसी साँचा विशेष का प्रयोग करते समय उसमें क्या प्राचल (पैरामीटर) दिए जाने हैं और किस प्रकार उन्हें लिखा जाना होगा। अतः यह आवश्यक हो जाता है कि साँचों के साथ उनका एक विवरण पृष्ठ भी बनाया जाए जिसपर उस साँचे का परिचय, प्रयोग करने की विधि, उदाहरण और अन्य संबंधित साँचों की कड़ियाँ उपलब्ध हों।

साँचा विवरण को अंग्रेजी में (अंग्रेजी विकिपीडिया अथवा अंग्रेजी विकिपुस्तक जैसे प्रकल्पों पर) Template documentation अथवा Documentation कहा जाता है। यहाँ, हिंदी विकिपुस्तक पर, इन्हें /विव उपपृष्ठ के रूप में प्रत्येक संबंधित साँचे के लिए बनाया जाता है। अर्थात यदि कोई साँचा:क है तो उसका विवरण पन्ना साँचा:क/विव के नाम से बनाया जाता है। इस विवरण पन्ने पर सारी आवश्यक जानकारी लिख दी जाती है जो साँचा देखते समय सदस्यों को दिखाई पड़ती है।

क्या शामिल करें[सम्पादन]

एक अच्छे साँचा विवरण पृष्ठ में निम्नलिखित चीज़ें शामिल की जानी चाहिएँ:

  • साँचे का उद्देश्य क्या है? यह सबसे ऊपरी अनुभाग में संक्षिप्त और स्पष्ट रूप से लिखा होना चाहिए। इसके साथ ही साँचे के प्रयोग की कोई सीमा हो जैसे कि कोई साँचा केवल मुख्य नामस्थान में ही कार्य करता हो अन्यत्र नहीं, तो इस तरह की जानकारी भी लिखी जानी चाहिए। यहाँ आवश्यक सावधानी भी लिखी जानी चाहिए जिससे कि साँचे का कोई ग़लत तरीके से उपयोग न कर बैठे।
  • यदि साँचा कुछ प्राचल उपयोग करता है तो उपरोक्त परिचयात्मक खंड के ठीक नीचे नया अनुभाग बना कर प्राचलों का विवरण दिया जाना चाहिए।
  • प्रयोगविधि में यह बताया जाना चाहिए कि साँचे का प्रयोग कैसे करते हैं। प्राचलों को किस प्रकार लिखा जाना है और क्या लिखने पर परिणाम क्या होगा।
  • उदाहरण के अनुभाग में साँचों का प्रयोग करके दिखाया जाना चाहिए। यदि साँचे के प्रयोग से एक से अधिक क़िस्म के परिणाम हो सकते हैं तो लगभग प्रत्येक प्रमुख परिणाम को उदाहरण के रूप में प्रदर्शित करना उचित होगा।
  • कुछ साँचों में TemplateData का प्रयोग होता है जो कुछ इस तरह की सूचनाएँ होती हैं जिनका प्रयोग सदस्य तो नहीं करते परंतु मशीन द्वारा इनका पठन होता है। उदाहरण के लिए कई साँचों के प्रयोग की सुविधा विजुअल एडिटर में होती है जहाँ साँचे को चुनने पर उसके प्राचल एक फॉर्म के रूप में खुलकर आते हैं जिन्हें संपादक द्वारा भरा जाना होता है; इस तरह के फॉर्म इत्यादि की फारमेटिंग के लिए TemplateData का ही इस्तेमाल होता है।
  • अन्य नाम अनुभाग में उन सभी नामों की सूची दी जाती है जिनके द्वारा साँचे का प्रयोग हो सकता है। वस्तुतः ये अनुप्रेषण/पुनर्निर्देश होते हैं। जैसे साँचा {{Reply to}} का प्रयोग {{सुनिये}}, {{सुनो}} अथवा {{ping}} इत्यादि नामों से भी हो सकता है।
  • संबंधित साँचे अनुभाग में उन साँचों के नाम उपलब्ध कराये जा सकते हैं जो वर्तमान साँचे से मिलता जुलता काम करते हैं।
  • श्रेणियाँ सीधे साँचे में न जोड़ कर उसके विवरण पृष्ठ पर जोड़ी जाति हैं। इसी तरह इंटरविकि कड़ियाँ भी विवरण पन्ने पर जोड़ी जानी चाहियें, यदि साँचा विकिडेटा से नहीं जोड़ा जा रहा।

कैसे बनाएँ[सम्पादन]

सबसे पहले जिस साँचे का विवरण पृष्ठ बनाना हो उसमें लिखित कोड की अंतिम लाइन के बाद निम्नलिखित पाठ जोड़ें:

<noinclude>
{{Documentation}}
<!-- श्रेणियाँ इत्यादि साँचे के विवरण पृष्ठ पर जोड़ें, यहाँ नहीं। -->
</noinclude>

ध्यान दें कि शुरूआती <noinclude> को साँचे में लिखित कोड की अंतिम लाइन के अंत में तुरंत ही जोड़ना होता है। कोई नई लाइन, स्पेस अथवा अतिरिक्त लाइनें और स्पेस इत्यादि नहीं होना चाहिए।

इसके सहेजने पर साँचे के पन्ने पर विवरण पृष्ठ का क्षेत्र दिखाई पड़ने लगता है। मुख्य हेडिंग "साँचा विवरण" के आगे [बनाएँ] के नाम से वह कड़ी उपलब्ध हो जाती है जिसका अनुसरण करके /विव पन्ने पर पहुँचा जा सकता है (अगर यह पहले से नहीं बना)। कुछ आवश्यक फॉर्मेटिंग स्वतः पहले से ही लोड होती है। अब यहाँ साँचे का विवरण ऊपर के अनुभाग में बताई चीजों को शामिल करते हुए बनाया जा सकता है।

इन्हें भी देखें[सम्पादन]