Manual:Developing extensions/nl



Elke extensie bestaat uit drie onderdelen:


 * 1) Instellen
 * 2) Uitvoering
 * 3) Lokalisatie

Een extensie bestaat minimaal uit drie bestanden, één voor elk onderdeel:


 * MyExtension/extension.json
 * Bevat de instel-instructies. Het bestand moet "extension.json" heten. (Voor MediaWiki 1.25 zaten de opzet instructies in een  bestand vernoemd naar de extensienaam. Veel extensies hebben 'backwards-compatibility' functies in dit PHP bestand.)


 * MyExtension/includes/ (or MyExtension/src/)
 * Bevat de uitvoer code voor de extensie.


 * MyExtension/resources/ (or MyExtension/modules/)
 * Stores the client-side resources such as JavaScript, CSS and LESS for the extension.


 * MyExtension/i18n/*.json
 * Bevat lokalisatie informatie voor de extensie.

Als je een extensie ontwikkelt, vervang "MyExtension" hierboven met de naam van jou extensie. Gebruik "UpperCamelCase" naamgeving voor je bestandsmappen en PHP bestand(en); dit is de algemene Bestandsbenaming conventie. (The is a good starting point for your extension.)

Instellen
Your goal in writing the setup portion is to make installing the extension as easy as possible, so users only have to add this line to LocalSettings.php:

Als je jou extensie door gebruikers wilt laten aanpassen, dan moet je configuratieparameters definiëren en documenteren, de gebruikersinstellingen zien er dan ongeveer zo uit:

Om deze eenvoud te bereiken, moeten je installatiebestanden een aantal taken uitvoeren (gedetailleerd beschreven in de volgende secties):


 * registreer elke media handler, parser functie, speciale pagina's, zelfgemaakte XML tag, en variabele die gebruikt worden in jou extensie.
 * definieer en/of valideer elke configuratie variabele die je hebt gedefinieert voor je extensie.
 * maak de klassen die gebruikt worden in je extensie klaar voor autoloading
 * bepaal welke onderdelen van je instellingen onmiddellijk uitgevoerd moeten worden en welke onderdelen uitgevoerd moeten worden nadat de MediaWiki core is ge-initialiseerd en geconfigureerd is
 * definieer bijgevoerde Hooks die nodig zijn voor je extensie
 * maak of controleer nieuwe database-tabellen de nodig zijn voor je extensie.
 * stel lokalisatie voor je extensie in

MediaWiki kenmerken registreren
MediaWiki laat alle geinstalleerde extensies zien op de  pagina. Je kan bijvoorbeeld alle extensies die geïnstalleerd zijn op deze wiki zien in Special:Version.

To do this, add the extension details to extension.json. The entry will look something like this:

Veel velden zijn optioneel, maar het is verstandig om ze in te vullen. De  refereert naar de versie van het schema die in het  bestand is geschreven. The available versions are 1 and 2. See here for the documentation on this feature. Unless you need to support an older version of MediaWiki, pick the latest version.

Naast de hierboven geschreven registratie moet je ook je functionaliteit een "hook" geven in MediaWiki. Het bovenstaande installeert alleen de Special:Version pagina. De manier waarop je dit doet hangt af van you extensietype. Voor details, lees de documentatie voor elke extensietype:

Je extensie configureerbaar maken voor gebruikers
Als je gebruikers jou extensie wilt laten configureren, dan moet je één of meerdere configuratievariabelen verschaffen. Het is slim om deze variabelen unieke namen te geven. Ze moeten ook de MediaWiki benamings conventies volgen(bijvoorbeeld: globale variabelen moeten beginnen met $wg).

Bijvoorbeeld, als jou extensie "extensie die niks doet" heet, dan wil je dat al je variabelen beginnen met $ednd of $EDND. Het is niet belangrijk wat je kiest zolang geen van de  MediaWiki core variabelen zo beginnen en je hebt gecheckt dat gepubliceerde extensievariabelen zo beginnen. Gebruikers zullen het niet waarderen als ze moeten kiezen tussen extensies omdat je variabelenamen overlappen met een andere extensie.

Het is ook een goed idee om uitgebreide documentatie voor alle configuratievariabelen in je installatienotities te plaatsen.

Hier is een boilerplate voorbeeld dat kan gebruikt worden om te starten:

Note that after calling  the global variable   does not exist. If you set the variable, e.g. in  then the default value given in extension.json will not be used.

For more details on how to use global variable inside custom extensions, please refer to.

Klassen klaarmaken om automatisch in te laden
Als je ervoor kiest om klassen te gebruiken om je extensie te implementeren, dan biedt MediaWiki een versimpeld mechanisme om PHP te helpen met het vinden van het bronbestand waar je klasse staat. In de meeste gevallen hoef je dan niet je eigen  methode te schrijven.

Om MediaWiki's autoloading mechanisme te gebruiken, voeg je vermeldingen toe aan het veld. De sleutel voor elke vermelding is de klassenaam; de waarde is het bestand dat de definitie van jou klasse bevat. Voor een 1-klasse-extensie heeft de klasse meestal dezelfde naam als de extensie, dus je autoloading sectie zit er ongeveer zo uit(extensie is genaamd "MyExtension"):

De bestandsnaam is gerelateerd aan de map waar je extension.json bestand in zit.

For more complex extensions, namespaces should be considered. See Manual:Extension.json/Schema#AutoloadNamespaces for details.

extra hooks definiëren
Zie.

Database-tabellen toevoegen
Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

Als je extensie eigen tabellen moet toevoegen, gebruik de hook. Bekijk de handleidingpagina voor meer informatie over het gebruik.

Lokalisatie instellen
Zie:
 * Lokalisatie(Samenvatting)

Logs toevoegen
in Mediawiki worden alle gebruikersactie op een wiki gevolgd tbv transparantie en samenwerking. Bekijk om te zien hoe je dit doet?

Handling dependencies
Assume that an extension requires the presence of another extension, for example because functionalities or database tables are to be used and error messages are to be avoided in case of non-existence.

For example the extension requires the presence of the extension  for certain functions.

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.

Lokalisatie
Als je wilt dat je extensie gebruikt wordt op meertalige wiki's, dan is het verstandig om lokalisatie te ondersteunen in je extensie.

Berichten opslaan in "".json
Sla berichtdefinities in een lokalisatie JSON bestand op, één voor elke taal waarin je extensie vertaald is. De berichten worden opgeslagen met een berichtsleutel en het bericht zelf in standaard JSON format. Elk bericht ID moet kleine letters bevatten en mag geen spaties bevatten. Each key should begin with the lowercased extension name. een voorbeeld hiervan kan je zien in MobileFrontend. Hier is een voorbeeld van een minimum JSON bestand (in dit geval "en.json":

en.json

Berichtdocumentatie opslaan in "qqq".json
De documentatie voor berichtsleutels kan opgeslagen worden in het JSON bestand for de pseudo-taal met de code qqq. de documentatie voor het voorbeeld hierboven kan er zo uitzien:

qqq.json:

lokalisatiebestand laden
In je installatie/opzet routine, definieer de locatie van je berichtbestanden(bijv. in de map i18n/):

Gebruik wfMessage in PHP
in je installatie- en implementatiecode, vervang elke statisch bericht met een call naar. In klassen die toepassen(alsook sommige subklassen van SpecialPage), kan in plaats daarvan  gebruiken. Voorbeeld:

Gebruik mw.message in JavaScript
het is mogelijk om i18n functies in JavaScript te gebruiken. zie voor details.

Extensietypes
Extensies kunnen gecategoriseerd worden gebaseerd op de programmeertechnieken die gebruikt zijn om hun functionaliteit te tonen. De meeste complexe extensies gebruiken vaak meer dan 1 van de volgende technieken:


 * Subklassering: MediaWiki verwacht bepaalde extensies die als subklassen van een MediaWiki basisklassen geïmplementeerd worden.
 *  – Subklassen van de klasse worden gebruikt om pagina's te bouwen waarvan de inhoud dynamisch gegenereerd wordt met behulp van ene combinatie van de huidige systeemstaat, input parameters en databasie queries. Zowel report en data invoer formulieren kunnen gegenereerd worden. Ze worden gebruikt voor rapportage- en  administratiedoeleinden.
 *  – Skins veranderen het uiterlijk en gebruik van Mediawiki door de code die pagina's maakt aan te passen door een subklasse te maken van de MediaWiki klasse.
 *  – Een techniek voor speciale PHP code te injecteren op specifieke punten in MediaWikiprocessen. Ze worden veel gebruikt door MediaWiki's parser, de lokalisatie-engine, de extensiemanagementsysteem, and haar pagina-onderhoudsysteem.
 *  – XML style tags die gekoppeld zijn aan een PHPfunctie die HTML code teruggeeft. Je hoeft jezelf niet te limiteren tot het formateren van text binnenin de tags. Je hoeft het niet eens weer te geven. Veel tag-extensies gebruiken tekst als parameters die de generatie van HTML helpt bij het invoegen van google objecten, data-invoer formulieren, RSS feeds en uittreksels van geselecteerde wiki-artikelen.
 *  – Een techniek voor het indexeren van een variëteit aan wiki tekst string aan een ID dat gekoppeld is aan een functie. zowelvariabelen enparser functies gebruiken beide deze techniek. Alle text die gekoppeld is aan dat id zal vervangen worden met de teruggave van de functie. de indexatie tussen de strings en het ID is opgeslagen in de $magicWords Array. De interpretatie van het id is een vrij ingewikkeld process - zie voor meer informatie.
 *  – Variabelen zijn een soort van misnaming. Variabelen zijn stukjes wikitekst die er uitzien als sjablonen maar die geen parameters hebben en die gekoppeld zijn aan hard-gecodeerde waardes. Standaard wiki-opmaak zoals  of   zijn voorbeelden van variabelen. Ze krijgen hun naam van hun bronwaarden: een php-variabele of iets dat aan een variable gekoppeld kan worden, bijvoorbeeld een string, nummer, expressie of een teruggave van een functie.
 *  – .  Soortgelijk aan tag-extensies, parserfuncties bewerken argumenten een geven een waarde terug. in tegenstelling tot tag-extensies, het resultaat van een parserfunctie is wikitekst.
 *  – ya kan eigen modules aan MediaWiki's web API koppelen, die door javascript, bots en clients aangeroepen kan worden.
 *  – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new.

Andere core versies ondersteunen
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.

Publiceren
Om de documentatie van je bestaande extensie te auto-categoriseren en standaardiseren, zie. om je nieuwe extensie aan deze Wiki toe te voegen:

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

Als je extensie namespaces toevoegt, dan will je wellicht zijn standaard namespaces registeren; soortgelijk, als database-tabellen of -velden toevoegt, dan wil je die wellicht registreren bij.

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.

Hulpdocumentatie
You moet public-domain hulpdocumentatie voor capaciteiten van je extensie beschikbaar maken. is een goed voorbeeld. Je moet gebruikers een link naar de documentatie geven via de functie.

Ondersteuning bieden / samenwerken
extensie-ontwikkelaars moeten een account maken op Wikimedia's, en een nieuw project voor de extensie aanvragen. Dit biedt een publiek forum waar gebruikers problemen en suggesties kunnen bieden, en je kan samenwerken met gebruikers en ontwikkelaars om bugs te vinden en toekomstige functionaliteiten toe te voegen aan je extensie.

Zie ook

 * – Implementeert sommige voorbeeldfunctionaliteiten met uitgebreide interne documentatie
 * – een functionele boilerplate extensie, handig als startpunt voor je eigen extensie
 * "Lees" de voorbeeldextensie, "baseer je eigen code op" de BoilerPlate extensie.
 * cookiecutter-mediawiki-extension – Een sjabloon voor de python tool cookiecutter om en BoilerPlate extensie te genereren (met variabelen etc.)
 * Zorgen ervoor dat je snel met je eigen extensie aan de slag kan.
 * Kan ook de BoilerPlate extensie genereren.
 * - Kopieer specifieke code daarvan.
 * – Legt uit hoe je extensie API kan bieden an cliënten.
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions