Extension:TemplateData/hi

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

स्थापना


डेटा को सम्पादित करना
TemplateData एक्सटेंशन किसी साँचा पृष्ठ के विकिटेक्स्ट में परिभाषित टैग की मदद से काम करता है (जिसे वैकल्पिक रूप से किसी दूसरे पृष्ठ से ट्रांसक्लूड भी किया जा सकता है)। इसे उन कई विकियों के साधारण लेआउट से मेल खाने के लिए बनाया गया है जो एक दूसरे पृष्ठ से साँचा प्रलेख को ट्रांसक्लूड करते हैं (मगर यह आवश्यक नहीं)। टैग की सामग्री को नीचे के वर्णित प्रारूप के साथ एक मान्य JSON होना होगा; ध्यान रखें कि सभी विवरणों को सादे टेक्स्ट में होना होगा (साँचा डेटा में विकिटेक्स्ट स्वीकृत नहीं)।

जब पृष्ठ पर एक ब्लॉक जोड़ दिया जाता है, तब पृष्ठ के सहेजने पर TemplateData एक्सटेंशन निम्न जाँच पूरे करता है:


 * 1) सामग्री को मान्य JSON होना होगा;
 * 2) JSON संरचना के अंदर हर आयटम को नीचे निर्दिष्ट अपेक्षित प्रकार का होना होगा (जैसे वस्तु, ऐरे, या एक आद्य); और
 * 3) जिन आयटम्स पर संभावित वैल्यूओं की एक निर्दिष्ट सूची हो (जैसे  ), JSON वस्तु के वैल्यू को इनमें से किसी एक वैल्यू से मेल खाना होगा।

अगर इनमें से कोई भी जाँच असफल रहती है, सर्वर को सहेजने नहीं दिया जाएगा और सम्पादन पृष्ठ के ऊपर एक त्रुटि संदेश दिखाई जाएगी।

autovalue आयटम्स के लिए बग 2700,  को किसी भी ऐसे साँचे में काम करने से रोक देता है जिसे  के अंदर जोड़ा गया हो, यहाँ तक कि  और  सहित। TemplateData ब्लॉक को ठीक से सहेजा जाएगा, मगर अंतिम विकिटेक्स्ट को साँचे का इस्तेमाल किए जाने पर ठीक से पार्स नहीं किया जाएगा।

ध्यान रखें कि आप के बदले   का इस्तेमाल नहीं कर सकते।

प्रारूप
नीचे का टेबल साँचा पृष्ठ पर परिभाषित  टैग्स में लपेटे JSON डेटा का एक दिखाऊ संस्करण है। आधिकारिक TemplateData रिपॉज़िटरी पर उपलब्ध हैं। नवीनतम संस्करण के लिए Specification.md देखें।



TemplateData वस्तु
TemplateData वस्तु एक JSON जड़ तत्व है जिसे साँचा पृष्ठ पर तत्व में लपेटा जाता है।



Param वस्तु


InterfaceText (string or object)
A free-form plain-text string (i.e. no wikitext or HTML) in the content-language of the wiki, or an object containing those strings keyed by language code.

The default value for all InterfaceText fields is.

String type
If it is a string, it must contain a non-localized string in the content language of the local wiki.

Object type
If it is an object, the object must have this mapping:

Example
An example TemplateData structure as specified within wikitext on a template page.

Below is how the above example would be displayed on the template page:

{   "description": "Label unsigned comments in a conversation.", "params": { "user": { "label": "User's name", "type": "wiki-user-name", "required": true, "description": "User name of person who forgot to sign their comment.", "aliases": ["1"] },       "date": { "label": "Date", "suggested": true, "description": { "en": "Timestamp of when the comment was posted, in YYYY-MM-DD format." },           "aliases": ["2"], "autovalue": "" },       "year": { "label": "Year", "type": "number" },       "month": { "label": "Month", "inherits": "year" },       "day": { "label": "Day", "inherits": "year" },       "comment": { "required": false }   },    "sets": [ {           "label": "Date", "params": ["year", "month", "day"] }   ],    "maps": { "ExampleConsumer": { "foo": "user", "bar": ["year", "month", "day"], "quux": [ "date", ["day", "month"], ["month", "year"], "year" ]       }    } }

API
See the generated help at Special:ApiHelp/templatedata. A sample invocation (formatted for human readability) is:

This returns the template data for Template:Cite web. The  block for this template is on its transcluded template documentation page, en:Template:Cite web/doc.

Additions and changes to JSON as received from the API
The JSON structure provided in response to an API HTTP get request is significantly different than that which is defined in the  block. In response to the API request, extension TemplateData makes the following changes to the JSON object:


 * Adds two wrapping objects:
 * An overall Pages Object containing one or more Page Objects
 * An object with a numeric key: a Page Object
 * Additions/changes to the actual TemplateData Object
 * Add the  key with the name of the page from which the data was requested (e.g. "Template:Cite web").
 * Add the  key
 * Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
 * Remove all  keys.
 * Add all properties from parameter from which an inheritance is defined which are not superseded by explicitly defined keys in the inheritor's Parameter Object.
 * Add default values for all keys in each Parameter Object which have not been explicitly defined or inherited.

Example of JSON object provided by API
The response to an API request for the TemplateData structure in the Example section (above) can be seen:
 * In HTML format: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * As delivered by the API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

कॉन्फ़िगरेशन


ये भी देखें

 * – user interface for selecting and inserting templates' wikitext, based on their TemplateData.
 * GitHub: jeblad/TemplateData – alternate version with some Lua functionality.
 * Translatable template
 * Wikibase/Maps_TemplateData