Jump to content

Extension:TemplateData

From mediawiki.org
This page is a translated version of the page Extension:TemplateData and the translation is 96% complete.
Outdated translations are marked like this.
This extension comes with MediaWiki 1.35 and above. यानी कि आपको इसे दोबारा डाउनलोड करने की ज़रूरत नहीं। हालाँकि, आपको दूसरी विधियों का पालन करना होगा।
मीडियाविकि एक्सटेंशन मैन्युअल
TemplateData
प्रकाशन की स्थिति: स्थिर
कार्यान्वयन टैग , API
विवरण साँचों के बारे में जानकारी रखने, प्राप्त करने और दिखाऊ बनाने देता है
लेखक Timo Tijhof, Moriel Schottlender, James Forrester, Trevor Parscal, Bartosz Dziewoński, Marielle Volz, ...
नवीनतम संस्करण 0.1.2 (निरंतर अद्यतन)
संगतता नीति मीडियाविकि के साथ प्रकाशित स्नैपशॉट्स। Master में पीछे की तरफ से संगतता नहीं है।
MediaWiki >= 1.43
PHP 5.4
डेटाबेस बदलता है नहीं
लाइसेंस GNU साधारण सार्वजनिक लाइसेंस 2.0 या अधिक
डाउनलोड करें
  • $wgTemplateDataEditorNamespaces
  • $wgTemplateDataUseGUI
‎<templatedata>
Quarterly downloads 283 (Ranked 15th)
Public wikis using 6,971 (Ranked 24th)
TemplateData एक्सटेंशन को अनुवादित करें अगर यह translatewiki.net पर उपलब्ध है
मुद्दे अधूरे कार्य · बग की रिपोर्ट करें

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

स्थापना

  • फ़ाइलों को डाउनलोड करें और अपने extensions/ फ़ोल्डर के TemplateData नामक डिरेक्ट्री में डालें।
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData
  • अपने LocalSettings.php फ़ाइल के अंत में निम्न कोड जोड़ें:
    wfLoadExtension( 'TemplateData' );
    
  • Yes पूर्ण – अपने विकि पर Special:Version पर जाकर देखें कि एक्सटेंशन को सफलतापूर्वक स्थापित किया गया है कि नहीं।

डेटा को सम्पादित करना

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

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

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

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

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

कृपया {{#tag:templatedata}} का इस्तेमाल न करें क्योंकि इससे साँचा डेटा एडिटर का इस्तेमाल करना नामुमकिन हो जाता है।

प्रारूप

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

TemplateData वस्तु

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

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

→ For more details see: description

params Param वस्तुओं वाला वस्तु एक वस्तु जो साँचे के हर पैरामीटर के नाम को एक Param वस्तु से मानचित्रित करते हुए उस पैरामीटर के गुणधर्मों को वर्णित करता है।

→ For more details see: params

paramOrder पैरामीटर के नामों के स्ट्रिंग्स वाला ऐरे तार्किक क्रम जिसमें पैरामीटरों को दिखाया जाएगा। ऐरे में हर पैरामीटर की कुँजी सिर्फ एक ही बार आ सकती है। हर स्ट्रिंग को params वस्तु में एक मान्य कुँजी होना होगा।

→ For more details see: paramOrder

sets Set वस्तुओं
वाला ऐरे
एक ऐरे जिसमें सेट किए गए विनिर्देश होते हैं। एक सेट, पैरामीटरों का एक समूह होता है जिनका इस्तेमाल साथ में किया जाना चाहिए। डिफ़ॉल्ट है []। ध्यान रखें कि sets कार्यक्षमता अब भी विकास के अंतर्गत है।
format स्ट्रिंग, या तो inline या block साँचे की विकिटेक्स्ट प्रतिनिधि को कैसे फैलाया जाना चाहिए। डिफ़ॉल्ट है inline। दूसरे अनुकूलित प्रारूपों के लिए '#Custom_formats' देखें।
maps एक Maps वस्तु एक वस्तु जो साँचा डेटा के किसी तृतीय-पक्ष ग्राहक के सरलीकृत नाम (यानी Citoid, Special:MyLanguage/Wikidata, आदि) को किसी ऐसे वस्तु से मानचित्रित करता है जो ग्राहक पैरामीटर के नाम को साँचे के पैरामीटरों के एक या एकाधिक नामों से मानचित्रित कर देता है।

Param वस्तु

कुँजी प्रकार डिफ़ॉल्ट विवरण
label InterfaceText null पैरामीटर के लिए एक (बहुत) छोटा नाम। इसे 20 कैरेक्टर्स से नीचे रखें।

→ For more details see: label

description InterfaceText null पैरामीटर का एक संक्षिप्त विवरण, उन सदस्यों के लिए जो जानना चाहते हों कि सूची में से कौन-सा पैरामीटर चुनना है।

→ For more details see: description

required बूलियन false साँचे के काम करने के लिए पैरामीटर आवश्यक है या नहीं (अगर इस पैरामीटर को निर्दिष्ट करना होगा, तो इसे true पर सेट करें)।

→ For more details see: required

suggested बूलियन false साँचे को उपयोगी बनाने के लिए पैरामीटर को सुझाया जाएगा या नहीं (अगर इस पैरामीटर को निर्दिष्ट करना होगा, तो इसे true पर सेट करें)।

→ For more details see: suggested

deprecated बूलियन या स्ट्रिंग false पैरामीटर कालग्रस्त है या नहीं। यह वैल्यू अनुदेशों का एक स्ट्रिंग हो सकता है जिसमें सदस्यों को निर्देश दिए जाएँगे कि इसके बजाय क्या जोड़ा जा सकता है, या फिर यह सिर्फ true भी हो सकता है।

→ For more details see: deprecated

aliases स्ट्रिंग्स वाला ऐरे [] उपनामों की सूची। एक उपनाम किसी पैरामीटर के लिए वैकल्पिक नाम है जिसका इस्तेमाल प्राथमिक नाम के बजाय (साथ नहीं) किया जा सकता है। उपनामों को किसी अलग Parameter वस्तु में प्रलेखित नहीं किया जाता है। अगर उन्हें अधिक जानकारी की ज़रूरत होती है, उन्हें अपने गुणधर्मों में "कालग्रस्त" चिह्नित कर दिया जाना चाहिए।

→ For more details see: aliases

default InterfaceText null साँचे द्वारा उपयुक्त डिफ़ॉल्ट वैल्यू अगर पैरामीटर को कोई वैल्यू नहीं सौंपा जाता है, या फिर वैल्यू का विवरण।

→ For more details see: default

autovalue स्ट्रिंग null विकिटेक्स्ट में एक डायनामिक रूप से बनाया जाने वाला डिफ़ॉल्ट वैल्यू, जैसे आज का दिनांक या सम्पादित करने वाले सदस्य का नाम, जिसमें अक्सर {{subst:CURRENTYEAR}} जैसे विकिटेक्स्ट सब्सटिट्यूशन का इस्तेमाल होता है।

→ For more details see: autovalue

example InterfaceText null पैरामीटर के लिए एक उदाहरण टेक्स्ट, ताकि सदस्यों को उचित वैल्यू भरने में मदद मिले।

→ For more details see: example

type स्ट्रिंग "unknown" पैरामीटर का प्रकार, (नर्म) प्रकार के संकेतों के लिए। इनमें से एक:
स्ट्रिंग वैल्यू पैरामीटर का प्रकार
"unknown" अगर सेट नहीं किया जाता है तो कल्पित प्रकार

→ For more details see: value ‘unknown’

"number" कोई भी संख्यात्मक वैल्यू (दशमलव बिंदुओं या हज़ार-विभाजकों के बिना)

→ For more details see: value ‘number’

"string" कोई भी पाठेतर वैल्यू। लाइन-ब्रेक्स हो सकते हैं।

→ For more details see: value ‘string’

"line" छोटा टेक्स्ट फ़ील्ड - नामों, लेबल्स, और दूसरे संक्षिप्त-रूप फ़ील्ड्स के लिए। यह ऐसे टेक्स्ट होगा जिसमें लाइन-ब्रेक्स की अपेक्षा नहीं की जाती है।

→ For more details see: value ‘line’

"boolean" एक बूलियन वैल्यू (true के लिए '1', false के लिए '0', अज्ञात के लिए ''), तीन-वैल्यू तर्क देखें।

→ For more details see: value ‘boolean’

"date" ISO 8601 प्रारूप में दिनांक, जैसे "2014-05-09" या "2014-05-09T16:01:12Z"

→ For more details see: value ‘date’

"url" प्रोटोकॉल सहित एक URL, जैसे "http://www.example.org", "https://example.org", या "//example.org"।

→ For more details see: value ‘url’

"wiki-page-name" वर्तमान विकि पर किसी मान्य मीडियाविकि पृष्ठ का नाम। मौजूद होना ज़रूरत नहीं, लेकिन अगर नहीं होता है, तो इसे पृष्ठ का एक मान्य नाम होना होगा जिसे बनाया जा सकता है।

→ For more details see: value ‘wiki-page-name’

"wiki-file-name" वर्तमान विकि पर एक मान्य मीडियाविकि फ़ाइल का नाम। मौजूद होना ज़रूरत नहीं, लेकिन अगर नहीं होता है, तो इसे फ़ाइल एक मान्य नाम होना होगा जिसे अपलोड किया जा सकता है। इसमें नामस्थान मौजूद नहीं होना चाहिए (जैसे "File:Foo.svg" या "Bild:Foo.svg" की जगह "Foo.svg")।

→ For more details see: value ‘wiki-file-name’

"wiki-template-name" वर्तमान विकि पर किसी मान्य मीडियाविकि साँचे का नाम।

→ For more details see: value ‘wiki-template-name’

"wiki-user-name" वर्तमान विकि पर किसी मान्य मीडियाविकि सदस्य का नाम। मौजूद होना ज़रूरत नहीं, लेकिन अगर नहीं होता है, तो इसे किसी सदस्य का एक मान्य नाम होना होगा जिसे बनाया जा सकता है। इसमें नामस्थान मौजूद नहीं होना चाहिए (जैसे "User:Foo" या "Usario:Foo" की जगह "Foo")।

→ For more details see: value ‘wiki-user-name’

"content" विकिटेक्स्ट में पृष्ठ की सामग्री, जैसे टेक्स्ट स्टाइल, कड़ियाँ, चित्र, आदि।

→ For more details see: value ‘content’

"unbalanced-wikitext" रॉ विकिटेक्स्ट जिसे स्टैंडअलोन सामग्री नहीं मानी जानी चाहिए क्योंकि यह असंतुलित है - जैसे साँचें जो एक पूरा हिस्सा बनाने के लिए अधूरे विकिटेक्स्ट को इकट्ठा करते हैं, जैसे {{echo|before=<u>|after=</u>}}

→ For more details see: value ‘unbalanced-wikitext’

→ For more details see: type

inherits स्ट्रिंग कुछ नहीं
सब्सटिट्यूट किया जाता है
किसी दूसरे पैरामीटर के नाम की कुँजी (params वस्तु में एक मान्य कुँजी होनी होगी)। वर्तमान Parameter वस्तु सभी गुणधर्म निर्दिष्ट Parameter वस्तु से गुणधर्म प्राप्त करेगा, और लोकल गुणधर्म प्राप्त गुणधर्मों को ओवर्राइड कर जाएगा।

→ For more details see: inherits

suggestedvalues स्ट्रिंग्स वाला ऐरे [] एक वैकल्पिक पैरामीटर गुणधर्म। पैरामीटर वैल्यूओं की एक सूची बनाता है जिससे सदस्य उचित वैल्यू चुन सकते हैं। सुझावित वैल्यूओं को यथादृश्य सम्पादिका में कॉम्बो बॉक्स के रूप में दिखाने के लिए पैरामीटर के वैल्यू को इनमें से एक पर सेट करना होगा: content, line, string, number, unknown या unbalanced wikitext।

→ For more details see: suggestedvalues

Set वस्तु

कुँजी

वस्तु या आद्य प्रकार

विवरण

label InterfaceText पैरामीटर सेट के लिए एक (बहुत) छोटा नाम। इसे 20 कैरेक्टर्स से नीचे रखें।
params स्ट्रिंग्स का ऐरे एक या एकाधिक पैरामीटरों के नाम जिन्हें सेट में शामिल किया जाना चाहिए (हर कुँजी को params वस्तु में एक मान्य कुँजी होनी होगी)। एक पैरामीटर कई सेट्स में हो सकता है। हर पैरामीटर को किसी एक सेट में होने की ज़रूरत नहीं।

Maps वस्तु

Maps is a single data structure that goes multiple levels deep. It became common to call the second level a “map object”.

कुँजी प्रकार डिफ़ॉल्ट विवरण
ग्राहक का नाम वस्तु {} एक वस्तु जो ग्राहक के नाम को किसी ऐसे वस्तु से मानचित्रित करता है जो ग्राहक पैरामीटर के नाम को साँचे के पैरामीटरों के एक या एकाधिक नामों से मानचित्रित कर देता है।

साँचा पैरामीटरों के नामों को या तो एक स्ट्रिंग (एक नाम), स्ट्रिंग्स के एक ऐरे (कई नामों), या फिर स्ट्रिंग्स के ऐरेज़ के एक ऐरे (नामों के कई सेट्स) के रूप में परिभाषित किया जा सकता है; इनमें से हर स्ट्रिंग को उसी साँचे के TemplateData में कहीं और, params वस्तु में एक मान्य कुँजी होनी होगी।

साँचे का कोई विशिष्ट पैरामीटर कई नक्शों में हो सकता है, और इसका इस्तेमाल किसी नक्शे की कई कुँजियों के वैल्यूओं में किया जा सकता है, मगर साँचे के हर पैरामीटर का किसी एक नक्शे में होना आवश्यक नहीं।

अंग्रेज़ी विकिपीडिया के Template:Cite_news#TemplateData से एक संक्षिप्त उदाहरण में maps वस्तु की संरचना दिखाई जाती है।

{
	"proveit": {
		"main": "title",
		"textarea": [
			"quote"
		]
	},
	"citoid": {
		"title": "title",
		"url": "url",
		"publisher": "publisher",
		"publicationTitle": "work",
		"date": "date",
		"ISSN": [
			"issn"
		],
		"ISBN": [
			"isbn"
		],
		"contributor": "others",
		"author": [
			[
				"first",
				"last"
			],
			[
				"first2",
				"last2"
			],
			[
				"first9",
				"last9"
			]
		],
		"editor": [
			[
				"editor-first",
				"editor-last"
			]
		]
	}
}

InterfaceText (स्ट्रिंग या वस्तु)

विकि की सामग्री की भाषा में एक मुक्त-रूप सादा-टेक्स्ट स्ट्रिंग (यानी किसी विकिटेक्स्ट या HTML से रिक्त), या फिर एक वस्तु जो उन स्ट्रिंग्स को भाषा कोड के अनुसार उन कुँजियों को रखता हो।

सभी InterfacText फ़ील्ड्स का डिफ़ॉल्ट वैल्यू है null

स्ट्रिंग का प्रकार

अगर यह एक स्ट्रिंग होता है, इसमें लोकल विकि की सामग्री की भाषा में एक गैर-स्थानीयकृत स्ट्रिंग होना होगा।

वस्तु प्रकार

अगर यह एक वस्तु होता है, वस्तु में ऐसा मानचित्रण होना होगा:

कुँजी प्रकार विवरण
विकिपीडिया भाषा कोड स्ट्रिंग उस इंटरफ़ेस भाषा के उपयोगकर्ताओं के लिए स्थानीयकृत स्ट्रिंग।

वस्तु मानचित्रण का एक उदाहरण:

कुँजी वैल्यू
"en" "Welcome to Wikipedia"
"de" "Willkommen bei Wikipedia"
"fr" "Bienvenue sur Wikipédia"
"nl" "Welkom op Wikipedia"
"it" "Benvenuti su Wikipedia"
"es" "Bienvenidos a Wikipedia"
"ru" "Добро пожаловать в Википедию"

उदाहरण

एक उदाहरण TemplateData संरचना जैसा साँचा पृष्ठ पर विकिटेक्स्ट में निर्दिष्ट किया गया है।

<templatedata>
{
    "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": "{{subst:#time:Y-m-d}}"
        },
        "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"
            ]
        }
    }
}
</templatedata>

नीचे दिया गया है कि उपरोक्त उदाहरण को साँचे के पृष्ठ पर कैसे दिखाया जाएगा:

Label unsigned comments in a conversation.

Template parameters

ParameterDescriptionTypeStatus
User's nameuser 1

User name of person who forgot to sign their comment.

Userrequired
Datedate 2

Timestamp of when the comment was posted, in YYYY-MM-DD format.

Auto value
{{subst:#time:Y-m-d}}
Unknownsuggested
Yearyear

no description

Numberoptional
Monthmonth

no description

Numberoptional
Dayday

no description

Numberoptional
commentcomment

no description

Unknownoptional

API

स्वचालित निर्मित सहायता Special:ApiHelp/templatedata पर देखें। एक उदाहरण इन्वोकेशन (मानव-पठनीयता के लिए प्रारूपित) है:

यह Template:Cite web के लिए साँचा डेटा लौटाता है। इस साँचे का ‎<templatedata>...‎</templatedata> ब्लॉक इसके ट्रांसक्लूड किए गए प्रलेख पृष्ठ en:Template:Cite web/doc पर मौजूद है।

API से प्राप्त JSON में योग और बदलाव

किसी API HTTP get अनुरोध में प्रदत्त JSON उस JSON से काफ़ी अलग होता है जो ‎<templatedata>...‎</templatedata> ब्लॉक में परिभाषित किया जाता है। API अनुरोध के उत्तर में TemplateData एक्सटेंशन JSON वस्तु में निम्न बदलाव करता है:

  • दो लपेटने वाली वस्तुएँ जोड़ता है:
    1. एक Pages वस्तु जिसमें एक या एकाधित Page वस्तुएँ होती हैं
    2. एक संख्यात्मक कुँजी वाला वस्तु: एक Page वस्तु
  • मूल TemplateData वस्तु पर योग/बदलाव
    1. उस पृष्ठ के नाम के साथ title कुँजी जोड़ना जहाँ से डेटा का अनुरोध किया गया था (जैसे "Template:Cite web")।
    2. sets कुँजी जोड़ना
    3. उन सभी TemplateText के उदाहरणों को वर्तमान विकि के विकिपीडिया भाषा कोड के लिए एक कुँजी वाले वस्तुओं में बदलना जो सिर्फ स्ट्रिंग्स हैं
    4. सभी inherits कुँजियाँ हटाना।
      • Parameter से सभी गुणधर्मों को जोड़ना जहाँ से प्राप्त किए हुए गुणधर्म परिभाषित किए जाते हैं और जिन्हें प्राप्त करने वाले Parameter वस्तु में स्पष्ट परिभाषित कुँजियों द्वारा पदावनत नहीं किया जाता है।
    5. उस हर Parameter वस्तु में सभी कुँजियों के लिए डिफ़ॉल्ट वैल्यू जोड़ना जिन्हें स्पष्ट रूप से परिभाषित नहीं किया गया है और प्राप्त नहीं किया गया है।

API द्वारा प्रदत्त TemplateData JSON वस्तु में दिखाऊ बदलाव

लपेटने वाली वस्तुएँ जो API द्वारा प्रदत्त JSON में जोड़ा जाती हैं
ये साँचा पृष्ठ पर ‎<templatedata> टैग्स में लपेटे गए JSON वस्तुओं में परिभाषित नहीं किए जाते हैं।
JSON जड़
कुँजी प्रकार विवरण
pages Page वस्तु Page वस्तु (जिसमें एक कुँजी होती है जो है पृष्ठ क्रमांक)। अगर एक ही बार में कई पृष्ठों का अनुरोध किया जाता है, कई Page वस्तुएँ मौजूद होंगी।

Page वस्तु
कुँजी प्रकार विवरण
(पृष्ठ क्रमांक) TemplateData वस्तु TemplateData वस्तु जिसमें जानकारी का पेलोड है। यह कुँजी साँचा पृष्ठ के लिए एक स्थायी पृष्ठ क्रमांक है जहाँ से JSON डेटा का अनुरोध किया गया था।
TemplateData वस्तु (API द्वारा जोड़ी जाने वाली)
यह कुँजी JSON वस्तु के जड़ पर जोड़ी जाती है जिसे साँचे के पृष्ठ पर ‎<templatedata> टैग्स में लपेटा जाता है।
कुँजी प्रकार विवरण
title स्ट्रिंग साँचे के पृष्ठ का नाम (जैसे "Template:Cite web")।
यह कुँजी साँचे के पृष्ठ पर JSON संरचना में नहीं रखी जाती है। इसे API द्वारा प्रदान-कार्य के दौरान MediaWiki सॉफ़्टवेयर द्वारा संरचना में जोड़ा जाता है।
sets Set वस्तुओं वाला ऐरे एक ऐरे जिसमें सेट किए गए विनिर्देश होते हैं। एक सेट, पैरामीटरों का एक समूह होता है जिनका इस्तेमाल साथ में किया जाना चाहिए।
अगर यह साँचे के पृष्ठ पर मौजूद नहीं होता है, इसे API द्वारा प्रदत्त संरचना में एक खाली ऐरे के रूप में जोड़ दिया जाता है।
API से Parameter वस्तुएँ
कुँजी प्रकार विवरण
label InterfaceText अगर पहले से InterfaceText प्रारूप में नहीं होता है तो उसमें अनुवादित किया जाता है।
required बूलियन अगर परिभाषित नहीं होता है तो डिफ़ॉल्ट वैल्यू false जोड़ दिया जाता है।
description InterfaceText या null अगर स्ट्रिंग के रूप में परिभाषित किया जाता है, InterfaceText वस्तु में बदल दिया जाता है। अगर परिभाषित नहीं किया जाता है, कुँजी को null वैल्यू के साथ जोड़ दिया जाता है।
deprecated बूलियन या स्ट्रिंग अगर परिभाषित नहीं होता है तो डिफ़ॉल्ट वैल्यू false जोड़ दिया जाता है।
aliases स्ट्रिंग्स का ऐरे अगर परिभाषित नहीं किया जाता है, एक डिफ़ॉल्ट खाली ऐरे सौंपा जाता है (यानी [])।
default स्ट्रिंग अगर परिभाषित नहीं किया जाता है, "" का डिफ़ॉल्ट सौंपा जाता है।
type स्ट्रिंग अगर परिभाषित नहीं किया जाता है, "unknown" का डिफ़ॉल्ट सौंपा जाता है।
inherits (हटाया गया) यह कुँजी हटा दी जाती है और सभी प्राप्त कुँजियाँ जोड़ दी जाती हैं। वर्तमान पैरामीटर के लिए परिभाषित कुँजियों को प्राथमिकता दी जाती है और जिन कुँजियों को या तो वर्तमान पैरामीटर में या फिर उस पैरामीटर में परिभाषित नहीं किया जाता है जिससे गुणधर्म प्राप्त किए जाते हैं, उन्हें डिफ़ॉल्ट वैल्यू दे दिया जाता है।
InterfaceText (वस्तु या null):
एक वस्तु जिसमें भाषा कोड के अनुसार स्ट्रिंग्स रखे जाते हैं।
कुँजी वस्तु या
आद्य प्रकार
विवरण
वस्तु
(विकिपीडिया भाषआ कोड के अनुसार स्थानीयकृत स्ट्रिंग्स)
अगर साँचे के पृष्ठ के TemplateData फ़ील्ड में कोई स्ट्रिंग होता है, न कि स्थानीयकृत स्ट्रिंग्स वाला वस्तु, MediaWiki उसे एक InterfaceText वस्तु में अनुवादित कर देता है जिसमें स्रोत Wikipedia पर विकिपीडिया भाषा कोड की कुँजी के नाम को सौंपा जाने वाला स्ट्रिंग होता है सभी InterfaceText फ़ील्ड्स के लिए डिफ़ॉल्ट है null
(विकि भाषा कोड) स्ट्रिंग उस इंटरफ़ेस भाषा के उपयोगकर्ताओं के लिए स्थानीयकृत स्ट्रिंग।

API द्वारा प्रदत्त JSON वस्तु का उदाहरण

(उपरोक्त) उदाहरण अनुभाग में TemplateData संरचना के API अनुरोध का उत्तर कुछ ऐसा होगा:

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

वेरिएबल डिफ़ॉल्ट विवरण
$wgTemplateDataUseGUI true templatedata JSON को सम्पादित करने के लिए प्रयोगात्मक डायलॉग इंटरफ़ेस
$wgTemplateDataEditorNamespaces [ 10 ] The namespaces in which the template data editor appears when creating or editing a page. (टास्क T189989)

ये भी देखें