साँचें लिखना

From Template Wiki, a repository of MediaWiki templates.
This page is a translated version of the page Template writing and the translation is 100% complete.
Other languages:

क्योंकि साँचें अक्सर काफी कठिन हो सकते हैं और वे कई बाहरी कारकों पर भी निर्भर हो सकते हैं, यह पृष्ठ साँचें लिखने के लिए कुछ सुझाव पेश करता है।

कोड

  • साँचों को आत्मनिर्भर होना चाहिए और दूसरे साँचों को कॉल नहीं करना चाहिए (अगर अत्यंत आवश्यक न हो तो)।
  • अपने डिज़ाइन में CSS कॉल्स का उपयोग करने वाले साँचों पर ऐसा लिखा होना चाहिए। आम तौर पर CSS कॉल्स नहीं रखे जाते, अगर CSS क्लास मानक के रूप में मौजूद न हो तो।
  • आइकॉन्स के लिए यथासंभव वेक्टर आइकॉन्स का उपयोग करें। इनका एक अच्छा स्रोत है विकिमीडिया कॉमन्स का Category:Icons by subject। Miraheze विकियों पर Instant Commons सक्षम है, वरना आइकॉन्स के चित्रों को लोकल रूप से अपलोड करना पड़ता।

उपयोग

  • साँचों पक उपयोग और बदलाव के लिए निर्देश होने चाहिए। अगर वे किसी दूसरे साँचे पर निर्भर हैं, यह बात प्रलेखन में लिखी होनी चाहिए, और आवश्यक साँचों की कड़ियाँ भी होनी चाहिए।
  • साँचों के कोड को प्रलेखन के बिना भी पढ़ना और समझना आसान होना चाहिए।

वेरिएबल

  • इसे सबसे लचीला साँचा बनाने की कोई ज़रूरत नहीं - हर चीज़ को एक वेरिएबल न बनाएँ। जैसे बॉक्स का संरेखण: बस एक संरेखण चुनें और इसे साँचे पर लिख दें, या फिर उसे डिफॉल्ट विकल्प बना दें।

ख़ाका

एक प्रलेखन उपपृष्ठ (Template:templatename/doc) का उपयोग एक आम प्रथा बन गई है, मगर बात उतनी ही बेहतर होती है जितना बड़ा प्रलेखन हो, या फिर उसमें जितने ज़्यादा उदाहरण हो। छोटे प्रलेखनों वाले छोटे साँचों के लिए प्रलेखन साँचे के पृष्ठ पर ही लिखें। /doc उपपृष्ठ का इस्तेमाल करने पर आम तौर पर {{Documentation}} को जोड़ना पड़ता है, जो अपने आप दूसरे साँचे पर निर्भरता ला देता है।

जो साँचें पूरे नहीं हुए हैं, उन्हें {{Template:Under construction}} के ज़रिए :Category:Underconstruction templates में जोड़ा जाना चाहिए।

बाहरी कड़ियाँ