Help:Templates/hi

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

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

साँचे का सबसे सरल प्रयोग कुछ इस प्रकार है। अगर आप "Template:Welcome" नामक एक पृष्ठ बनाते हैं जिसकी सामग्री है:

नमस्ते! आपका विकि पर स्वागत है।

आपने अपना पहला साँचा बना लिया है! अगर आप यह कोड कहीं डालते हैं:

जब वह पृष्ठ खोला जाता है,  की जगह टेक्स्ट "नमस्ते! आपका विकि पर स्वागत है।" दिखेगा। साँचे को दूसरे पृष्ठ पर "ट्रांसक्लूड" कर दिया गया है, यानी उसे उस पृष्ठ पर एकीकृत कर दिया गया है।

उसके बाद आप पृष्ठ पर किसी भी जगह पर  जोड़कर सदस्य का स्वागत कर सकते हैं। मान लीजिए 100 पृष्ठों पर इसका इस्तेमाल किया जाता है। अगर आप साँचे की सामग्री को इससे बदल दें:

नमस्कार! इस निराले विकि पर आपका स्वागत है।

और उन 100 में से किसी भी पृष्ठ पर जाएँ जहाँ साँचे का प्रयोग किया गया है, आप मूल टेक्स्ट की जगह नया टेक्स्ट देखेंगे। इस तरह से आपने 100 पृष्ठों को संपादित किए बिना उनकी सामग्री को बदल दिया है, क्योंकि साँचे को उन पृष्ठों पर ट्रांसक्लूड किया जा रहा है।

यह बुनियादी क्रियाविधि है। ट्रांसक्लूशन की प्रक्रिया में कई चरण हैं जो इस क्रियाविधि और साथ में साँचों को काफ़ी उपयोगी बनाते हैं।

प्रयोग
साँचों को इन तरीकों से दूसरे पृष्ठों पर जोड़ा जा सकता है:


 * — जैसा ऊपर दर्शाया गया है, इस कड़ी को Template:Name के तब की वर्तमान सामग्री से बदल दिया जाएगा जब पृष्ठ को लोड किया गया हो। पृष्ठ के स्रोत में कड़ी नहीं बदलेगी।
 * - जब इस साँचे की कड़ी को जोड़ा जाता है, इसे हमेशा के लिए Template:Name के तब की वर्तमान सामग्री से बदल दिया जाएगा जब कड़ी को सहेजा गया हो। पृष्ठ के स्रोत में कड़ी नहीं बदलेगी: साँचे की कड़ी की जगह Template:Name की सामग्री को सब्सटिट्यूट कर दिया जाएगा। सामग्री अब उस पृष्ठ का हिस्सा बन जाएगी, और अब इसे मूल पृष्ठ से अलग, सम्पादित किया जा सकेगा। ध्यान दें: स्रोत साँचे पर बाद में बदलाव उस पृष्ठ पर नहीं दिखेंगे जिसपर साँचे की कड़ी जोड़ी गई थी।
 * - इससे ट्रांसक्लूशन को तोड़े बिना सब्सटिट्यूशन का इस्तेमाल किया जा सकता है। w:Help:Substitution देखें।
 * साँचे को एक ऐसे रूप में जोड़ देता है जिससे सामग्री वाले पृष्ठ को प्राप्त करने पर वह रॉ विकि सिनटैक्स के रूप में दिखाई पड़ता है (जैसा दिखता है)।

यहाँ तक कि, एक साधारण विकि पृष्ठ का भी साँचे की तरह इस्तेमाल किया जा सकता है। ऐसा करने के लिए बस इसका नामस्थान जोड़ दें, यानी:


 * code> जोड़ेगा
 * जोड़ेगा
 * जोड़ेगा
 * अपने आप को  की सामग्री से बदल देगा

अगर ऐसा कोई नामस्थान नहीं है, पूरे शीर्षक को ही साँचा मान लिया जाता है:


 * जोड़ेगा

पैरामीटर्स
ट्रांसक्लूशन की कार्यक्षमता को बढ़ाने के लिए मीडियाविकि पर साँचों को ट्रांसक्लूड करते समय पैरामीटर्स जोड़ने की सुविधा उपलब्ध है। पैरामीटर्स की मदद से साँचों पर अलग-अलग सामग्री या फिर बदलता स्वभाव जोड़ा जा सकता है।

मान लीजिए आप दूसरे सदस्यों के वार्ता पृष्ठों पर धन्यवाद वाला एक संदेश छोड़ना चाहते हैं, जैसे:

धन्यवाद के इस संदेश पर एक कारण होगा (इस मामले में "अपने सभी कार्यों") और एक हस्ताक्षर होगा ("मैं")। आपका लक्ष्य है कि किसी भी सदस्य के लिए किसी भी सदस्य को, किसी भी कारण से धन्यवाद देना संभव होना चाहिए।

ताकि संदेश हर जगह समान दिखे, आप नामक एक साँचा बना सकते हैं। हालाँकि संदेश हर जगह समान दिखना चाहिए, इसकी सामग्री (जैसे कारण और हस्ताक्षर) अलग होगी। इसके लिए आपको इन्हें पैरामीटर्स के तौर पर पास करवाना होगा। अगर हम बॉक्स को प्रारूपित करने और चित्र को जोड़ने वाले तत्वों को निकाल दें, बुनियादी साँचा कुछ ऐसा दिखेगा:

और  के प्रयोग पर गौर करें। इससे साँचे का इस्तेमाल करते समय इसके अंदर पैरामीटर्स को पहचाना जा सकता है। ध्यान रखें कि साँच के अंदर हर पैरामीटर को तीन धनुकोष्ठकों से घेरा जाता है:  । हर साँचे के साधारण प्रयोग से अलग है।

किसी पृष्ठ पर साँचे का इस्तेमाल करते समय आप पैरामीटर्स में एक "पाइप" अक्षर से अलग करते हुए वैल्यू जोड़ेंगे। मीडियाविकि पर पैरामीटर्स तीन तरीकों से पास करवाए जा सकते हैं: गुमनाम, क्रमित, और नामित।



गुमनाम पैरामीटर्स
गुमनाम पैरामीटर्स में पास करवाने के लिए, उन पैरामीटर्स के वैल्यू क्रमशः पास करवाएँ:

इस मामले में  साँचा पैरामीटर्स   and   प्राप्त करता है, और अंजाम होता है:

जिस क्रम से गुमनाम पैरामीटर्स पास करवाए जाते हैं, वह साँचे के स्वभाव पर बड़ा प्रभाव डालता है। पैरामीटर्स के क्रम को पलट देने पर, यानी:

का अंजाम होगा:

Numbered parameters
To pass in parameters by number, identify each parameter when passing it:

This time, template  receives parameters   and , though they have been supplied in inverse order, and produces:


 * उदाहरण:

पैदा करता है

Named parameters
The third way of passing parameters is by name instead of numbers. In this case, the template contents would be changed to:

A little thank you... for. hugs,

Within the template, we use  and   to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

In this case, template  receives parameters   and   and produces:

Named parameters are case-sensitive, so:

produces:

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.



मूलभूत मान
If you transclude a template that expects parameters, but do not provide their arguments, in this way:

in the numbered parameters example above you would get the following:

Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

then  defines that if no argument is provided for parameter , then the value   will be used. Similarly,, defaults parameter   to value. Now, transcluding the template again without passing any argument results in the following:

Often default values are used to specify alternate names of parameters. For example, if you have, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Evaluation
Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a  containing , and a   containing  , and put   on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the  magic word that varies by user language.

Template calls starting with the magic word  or   are evaluated in a separate first pass that only happens at save time, along with ~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Recursion in templates
Including a template in itself won't throw MediaWiki into infinite recursion. MediaWiki will stop the recursion with the template's name in bold. For example, if the content of Template:Aaaa is, it'll display "a a Template loop detected:  Template:Aaaa z z".

Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example  can either be called   or. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.



If  is modified to recurse into   and   is an identical manual copy of   this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters
Since the syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.

Control template inclusion
By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the, and  tags.

Anything between and  will be seen only when the template's page is being viewed directly, but not when it is included in another page. This is useful when you want to include text or code in a template that you do not want to propagate to any pages which include it, such as:


 * Category links when categorizing the template itself
 * interlanguage links to similar templates in other languages
 * Explanatory text about how to use the template

Likewise, anything between and  will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:


 * Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the . To force the re-categorization of a particular page, open that page for editing and save it without changes.
 * Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside and  is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page. The focus is on what is inside these two tags.

Everything outside tags is discarded in the transclusion. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

Nesting of these tags is also possible.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. टिप्पणी की भी एक भूमिका है।

Organizing templates
For templates to be effective, users need to find them, and find out how to use them.

To find them, users can:
 * 1) Click ' > '
 * 2) In the ' list, choose Template and click '.

To give usage information, include an example like this one on the template page:

Usage
Welcome users:

Then, an editor can simply copy and paste the example to use the template.

Linking to a template
A template page can be linked to like any other wiki page. For example, the link Template:Navbar is generated using the wikicode.

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code  may be used to create the link Navbar.

This construct is commonly used when referring to templates in template documentation, on help pages, and on talk pages. The same effect can be achieved by using, but the tl approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element or as monospace type. If not (as on this wiki), another similarly named template may do so. See, for example, the "See also" section of our Template:Tl documentation.

Copying from one wiki to another
Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

MediaWiki code
If you have import rights (specifically importupload) on the new wiki:


 * 1) Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
 * 1) * Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
 * 1) * Select the box "".
 * 1) * Select the box "".
 * 1) * Click "".
 * 1) Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
 * 3) Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. Note that only page elements parsed in rendering the page get exported, so, for example, documentation subpages are not exported as part of this process. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well and also copy the code in the modules.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Extensions
An extension often used in templates is ParserFunctions. Visit page and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the extension. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having   in template code is a good sign for it. In case it's used, you need to install the extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
 * 1) If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.