Manual:Developing extensions/hi



हर एक्सटेंशन में तीन भाग होते हैं:


 * 1) सेटअप
 * 2) कार्यान्वयन
 * 3) स्थानीयकरण

एक मिनिमल एक्सटेंशन में यह संरचना मौजूद होगी:


 * MyExtension/extension.json
 * सेटअप के निर्देश का संग्रहण। फ़ाइल के नाम को 'extension.json' होना चाहिए। (मीडियाविकि 1.25 से पहले सेटअप के निर्देश एक्सटेंशन के अनुसार नामित एक  फ़ाइल में थे। कई एक्सटेंशन अभी भी इस PHP फ़ाइल में पीछे की ओर की संगतता शिम हैं।)


 * MyExtension/includes/ (or MyExtension/src/)
 * एक्सटेंशन के लिए PHP निष्पादन कोड रखता है।


 * MyExtension/resources/ (or MyExtension/modules/)
 * एक्सटेंशन के लिए क्लाइंट-मुखी जानकारी जैसे जावास्क्रिप्ट, CSS, LESS आदि रखता है।


 * MyExtension/i18n/*.json
 * एक्सटेंशन के लिए स्थानीयकरण की जानकारी रखता है।

जब आप एक एक्सटेंशन विकसित करेंगे, 'MyExtension' को आपके एक्सटेंशन के नाम से बदल दीजिएगा। उसकी डिरेक्ट्री और PHP फ़ाइल(ओं) के नाम 'अपर कैमल केस' में रखें; यह साधारण फ़ाइल नामकरण प्रथा है। ( आपके एक्सटेंशन के लिए शुरुआत की एक अच्छी जगह है।)

सेटअप
सेटअप का हिस्सा लिखने के दौरान आपका उद्देश्य है एक्सटेंशन को स्थापित करने में यथासंभव आसान बनाना, ताकि सदस्यों को बस LocalSettings.php पर यह पंक्ति जोड़नी पड़े:

अगर आप चाहते हैं कि सदस्य आपके एक्सटेंशन को कॉन्फ़िगर कर पाएँ, आपको कुछ कॉन्फ़िगरेशन पैरामीटरों को परिभाषित और प्रलेखित करना होगा, और आपके सदस्य का सेटअप कुछ ऐसा नज़र आएगा:

इस सरलता तक पहुँचने के लिए आपके सेटअप फ़ाइल को कई कार्य करने होंगे (जिन्हें निम्न अनुभागों में विस्तार से वर्णित किया गया है):


 * आपके एक्सटेंशन द्वारा उपयुक्त किसी भी मीडिया हैंडलर, पार्सर फ़ंक्शन, विशेष पृष्ठ, अनुकूलित XML टैग, और वेरिएबल को पंजीकृत करना।
 * आपके एक्सटेंशन के लिए परिभाषित किसी भी कॉन्फ़िगरेशन वेरिएबलों को परिभाषित और/या वैलिडेट करना।
 * स्वतः लोड करने के लिए आपके एक्सटेंशन द्वारा उपयुक्त क्लासों को तैयार करना।
 * यह तय करना कि आपके सेटअप का कौन-सा हिस्सा तुरंत किया जाना चाहिए और कौन-सा हिस्सा मीडियाविकि मूल के शुरू होने और कॉन्फ़िगर किए जाने के बाद किया जाना चाहिए।
 * आपके एक्सटेंशन द्वारा उपयुक्त किसी भी अतिरिक्त हुक को पंजीकृत करना।
 * आपके एक्सटेंशन द्वारा उपयुक्त किसी भी नए डेटाबेस टेबल को बनाना या जाँचना।
 * आपके एक्सटेंशन के लिए स्थानीयकरण सेटअप करना।



मीडियाविकि पर सुविधाएँ पंजीकृत करना
मीडियाविकि के  पृष्ठ पर सभी स्थापित एक्सटेंशनों को सूचीबद्ध किया जाता है। उदाहरणस्वरूप, आप Special:Version पर, इस विकि पर स्थापित सभी एक्सटेंशन देख सकते हैं।

ऐसा करने के लिए एक्सटेंशन की जानकारी extension.json पर जोड़ दें। एंट्री कुछ ऐसी दिखेगी:

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

उपरोक्त पंजीकरण के साथ, आपको अपनी सुविधा को मीडियाविकि पर "हुक" भी कराना होगा। उपरोक्त विधि सिर्फ Special:Version पृष्ठ को सेटअप करती है। आप यह काम किस तरह से करेंगे, यह आपके एक्सटेंशन के प्रकार पर निर्भर होगा। विस्तार के लिए कृपया हर प्रकार के एक्सटेंशन का प्रलेख देखें:



अपने एक्सटेंशन को कॉन्फ़िगर करने योग्य बनाना
अगर आप चाहते हैं कि सदस्य आपके एक्सटेंशन को कॉन्फ़िगर कर पाएँ, आपको एक या एकाधिक कॉन्फ़िगरेशन वेलिएबल्स प्रदान करने होंगे। उन वेरिएबलों को अनूठे नाम देना अच्छा होगा। उन्हें मीडियाविकि की नामकरण प्रथाओं का भी पालन करना होगा (जैसे ग्लोबल वेरिएबलों की शुरुआत $wg से होनी चाहिए)।

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

अपनी स्थापना की टिप्पणियों में हर कॉन्फ़िगरेशन वेरिएबल के लिए विस्तृत प्रलेख शामिल करना भी एक अच्छी प्रथा है।

यह रहा शुरुआत करने के लिए एक बॉइलर प्लेट का उदाहरण:

ध्यान रखें कि  को कॉल करने के बाद ग्लोबल वेरिएबल   मौजूद नहीं होता। अगर आप वेरिएबल को सेट करते हैं, मान लीजिए   पर, तब extension.json में निर्दिष्ट डिफ़ॉल्ट वैल्यू का इस्तेमाल नहीं किया जाएगा।

अनुकूलित एक्सटेंशनों के अंदर ग्लोबल वेरिएबलों के बारे में अधिक जानकारी के लिए देखें।



स्वतः लोडिंग के लिए क्लास तैयार करना
अगर आप अपने एक्सटेंशन को लागू करने के लिए क्लास का इस्तेमाल करते हैं, मीडियाविकि पर एक सरलीकृत तंत्र है जिससे PHP उस स्रोत फ़ाइल को आसानी से ढूँढ़ पाएगा जहाँ पर आपका क्लास स्थित है। ज़्यादातर मामलों में इस कारण आपको अपना  साधन लिखने की ज़रूरत नहीं पड़ेगी।

मीडियाविकि के स्वतः लोडिंग तंत्र का इस्तेमाल करने के लिए आपको फ़ील्ड में एंट्रियाँ जोड़नी होंगी। हर एंट्री की कुँजी क्लास का नाम होगी; वैल्यू उस फ़ाइल का नाम होगा जिसमें क्लास की परिभाषा मौजूद होगी। किसी साधारण एक-क्लास-वाले एक्सटेंशन के लिए क्लास को आम तौर पर एक्सटेंशन का नाम दिया जाता है, तो आपका स्वतः लोडिंग अनुभाग कुछ इस तरह का नज़र आएगा (एक्सटेंशन का नाम है 'MyExtension'):

फ़ाइल का नाम उस डिरेक्ट्री के सापेक्ष है जिसमें extension.json फ़ाइल मौजूद है।

अधिक जटिल एक्सटेंशनों के लिए namespaces का इस्तेमाल किया जा सकता है। विस्तार के लिए Manual:Extension.json/Schema#AutoloadNamespaces देखें।



अतिरिक्त हुक्स परिभाषित करना
देखें।



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

अगर आपके एक्सटेंशन को अपने डेटाबेस टेबल्स जोड़ने की ज़रूरत है, हुक का इस्तेमाल करें। उपयोग के बारे में अधिक जानकारी के लिए मैन्युअल पृष्ठ देखें।



स्थानीयकरण सेटअप करें
देखें:
 * स्थानीयकरण (संक्षिप्त)



लॉग्स जोड़ें
मीडियाविकि पर पारदर्शिता और सहयोग के लिए विकि पर सदस्यों द्वारा सभी कार्यों को ट्रैक किया जाता है। ऐसा करने के लिए देखें।



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

उदाहरणस्वरूप, एक्सटेंशन को विशिष्ट फ़ंक्शन्स के लिए  एक्सटेंशन की उपस्थिति की ज़रूरत होती है।

One way to specify this would be by using the  key in extension.json.

Otherwise, some ideas to figure this out:

This should work at least from 1.23 up to 1.35.

Localisation
If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

Store messages in &lt;language-key>.json
Store message definitions in a localisation JSON file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. Each key should begin with the lowercased extension name. An example you can find in the MobileFrontend extension. Here is an example of a minimal JSON file (in this case en.json):

en.json

Store message documentation in qqq.json
The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. A documentation of the example above can be:

qqq.json:

Load the localisation file
In your extension.json, define the location of your messages files (e.g. in directory i18n/):

Use wfMessage in PHP
In your setup and implementation code, replace each literal use of the message with a call to. In classes that implement (as well as some others such as subclasses of SpecialPage), you can use  instead. Example:

Use mw.message in JavaScript
It's possible to use i18n functions in JavaScript too. Look at for details.

Extension types
Extensions can be categorized based on the programming techniques used to achieve their effect. Most complex extensions will use more than one of these techniques:


 *  Subclassing:  MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
 *  – Subclasses of the class are used to build pages whose content is dynamically generated using a combination of the current system state, user input parameters, and database queries. Both reports and data entry forms can be generated. They are used for both reporting and administration purposes.
 *  – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class.
 *  – A technique for injecting custom PHP code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
 *  – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds Google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
 *  – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see  for more information.
 *  – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as  or   are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
 *  – .  Similar to tag extensions, parser functions process arguments and returns a value. Unlike tag extensions, the result of parser functions is wikitext.
 *  – you can add custom modules to MediaWiki's action API, that can be invoked by JavaScript, bots or third-party clients.
 *  – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new.

Support other core versions
There are two widespread conventions for supporting older versions of MediaWiki core:


 * Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
 * Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki need to use the  branch of the extension. (For extensions hosted on gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Extension maintainers should declare with the  parameter of the Extension template which convention they follow.

Publishing
To autocategorize and standardize the documentation of your existing extension, please see. To add your new extension to this Wiki:

Deploying and registering
If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. Consult.

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at.

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.

Help documentation
You should provide public domain help documentation for features provided by your extension. is a good example. You should give users a link to the documentation via the function.

Providing support / collaboration
Extension developers should open an account on Wikimedia's, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.