Help:TemplateData/mr



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

TemplateData syntax allows users to write small bits of structured data to a template page, or to be transcluded into that template page (such as on a template documentation page). Once a template has this structured data, it can be displayed properly in the VisualEditor. While this may sound complex, it's actually very easy.



TemplateData editor
There is a built-in tool for editing TemplateData in a simpler way.

To use the TemplateData editor, go to the template's page (or its documentation subpage) and press the "Edit" button. That will give you a button that says "", just above the open editing window: Click this button to enter the GUI tool for editing TemplateData. The editor allows you to add one row per template parameter and to set the most common attributes. If the page you edited already contains a block of TemplateData, then the information already documented will automatically be shown when you open the correct page in the TemplateData editor. In the first box, you can add or update a short description of the template in plain text. After that, you can use the "Import parameters" and "Add parameters" buttons to document the names and attributes of the parameters that the template uses.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the pop-up menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove" button will delete the parameter's entry from TemplateData.

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.



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

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

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



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

ते अश्यासारखे साच्यात दर्शवेल: {       "description": "एका लेखाबद्दलचा, कॉमन्समधील वर्गाशी जोडणारा एक साचा", "params": { "1": {                       "label": "कॉमन्स वर्ग", "description": "कॉमन्सचा तो वर्ग जो आपणास जोडावयाचा आहे", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



वर्णन व प्राचले
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:



Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:



बहुविध प्राचले
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:



सारखी प्राचले
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.



Other tools

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), 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.
 * List of all templates with TemplateData on this wiki