Help:TemplateData/mr



साचामाहिती काय आहे?
$विस्तारक हे साचा व त्याच्या प्राचलांबद्दल माहिती साठविण्याचा मार्ग आहे,जेणेकरुनयथादृष्यसंपादक त्यास मिळवुन दर्शवु शकेल, साचा संपादकात त्याने, साचा संपादनास सुविधा होते.

सदस्याला साचा पानास, छोट्या तुकड्यांची बांधलेली माहिती लिहिण्यास किंवा साचा पानावर त्याचा आंतरविन्यास करण्यास (जसे, दस्तएवज पानावर), सोपे होते.एकदा जर साच्यास ही बांधलेली माहिती मिळाली, तर त्यास ती यथादृस्यसंपादकात योग्यपणे दर्शविता येते.जरी हे अवघड वाटत असेल पण ते फारच सोपे आहे.



साच्या माहितीची बांधणी
साच्याची माहितीबांधणी याचे JSON मानकात मूळ आहे, व ती बरीच सोपी आहे.याची नोंद घ्या कि साचामाहितीचे वर्णन हे साध्या मजकूरात हवे (विकिमजकूर किंवा दुवे ईत्यादी नकोत).

करण्यास सर्वात प्रथम गोष्ट अशी कि, खूणपताकांची जोडी साच्याच्या दस्तएवज उप-पानावर कोठेही टंका, जसे:

हे संचेतनास सांगते कि या दोन खूणपतांकांमधील प्रत्येक गोष्ट ही साचामाहिती आहे व त्यास साचा वापरतांना संदर्भांकित करावयास हवे.



उदाहरण
साचामाहितीतले वर्णन हे एक प्रमाणित लेआउट अनुसरते.आपण म्हणू कि आपल्यापाशी एखाद्या विषयाबाबत कॉमन्स वर्गाशी जोडणारा, एक "कॉमन्स" साचा आहे. तो एक अनिवार्य प्राचल घेतो:कॉमन्सवरील एका वर्गाचे नाव. साचा माहिती काहीशी अशी दिसेल:

This would display, in the template, like so: {       "description": "A template for linking to a commons category about an article", "params": { "1": {                       "label": "Commons category", "description": "The commons category you want to link to.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Description and parameters
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).



Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:



Multiple parameters
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:



Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.



Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.



Limitations and questions

 * Missing features — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change.
 * Current issues — A list of current bugs and feature requests is available in bugzilla.



Tools

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in English and French, and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.