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/)
 * Slaat de bronnen aan de kant van de cliënt op zoals JavaScript, CSS en LESS voor de extensie.


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

Als je een extensie ontwikkelt, vervang "MyExtension" hierboven met de naam van jouw extensie. Gebruik "UpperCamelCase" naamgeving voor je bestandsmappen en PHP bestand(en); dit is de algemene Bestandsbenaming conventie. (De extensie is een goed startpunt voor jouw extensie.)

Instellen
Je doel bij het schrijven van het deel voor de setup is het zo eenvoudig mogelijk maken om de extensie te installeren, zodat gebruikers alleen deze regel hoeven toe te voegen aan LocalSettings.php:

Als je jouw 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, zelfgemaakte XML tag en variabele die gebruikt wordt in jouw 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.

Om dit te doen, voeg de details van de extensie toe aan extension.json. De regel is dan iets als dit:

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. De beschikbare versies zijn 1 en 2. Lees voor documentatie over deze functie. Tenzij je een oudere versie van de MediaWiki moet ondersteunen, kies de meest recente versie.

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 jouw 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 jouw extensie "Mijn Extensie" heet, dan wil je dat al je variabelen beginnen met. Het is belangrijk wat je kiest, kies geen beginwaarde die door MediaWiki core variabelen worden gebruikt of door gepubliceerde variabelen van extensies. 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:

Let op, na het aanroepen van  bestaat de globale variabele   niet. Indien je de variabele een waarde geeft, bijvoorbeeld in  dan wordt de standaardwaarde die in de extension.json wordt gegeven, niet gebruikt. If you set the variable, e.g. in  then the default value given in extension.json will not be used.

Lees voor meer informatie over hoe globale variabelen binnen aangepaste extensies te gebruiken.



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 jouw 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.

Overweeg namespaces bij meer complexere extensies. Lees Manual:Extension.json/Schema#AutoloadNamespaces voor details.



extra hooks definiëren
Zie.



Database-tabellen toevoegen
Controleer dat de extensie niet de kern database tabellen aanpast. Een extensie moet eigen tabellen aanmaken met foreign keys naar de bestaande tabellen.

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?



Afhankelijkheden
Als een extensie een andere extensie nodig heeft, bijvoorbeeld omdat die functionaliteit of database tabellen worden gebruikt moeten foutmelding vanwege het ontbreken ervan worden voorkomen.

Stel: extensie heeft de extensie  voor een bepaald functie nodig.

Een manier om dit te specificeren zou zijn met  key in extension.json.

Alternatieven zouden kunnen zijn:

Dit zou voor de versies van 1.23 t/m 1.35 moeten werken.

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. Elke key moet beginnen met de naam van de extensie in kleine letters. Een voorbeeld hiervan kan je zien in de extensie 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 extension.json, 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.
 *  – je kan eigen modules aan MediaWiki's action API koppelen, die door javascript, bots en clients aangeroepen kan worden.
 *  – Als het nodig is om gegevens op te slaan in formaten anders dan wikitext, JSON, enz. maak dan een aan.



Andere core versies ondersteunen
Er zijn twee veelgebruikte conventies voor het ondersteunen van oudere versies van de MediaWiki:


 * Master: de master branch van de extensie is compatibel met zoveel mogelijk versies van de core. Dit zorgt voor een last bij het onderhouden (backward compatibiliteit moet lange tijd mogelijk zijn en aanpassingen aan de extensie moeten dus op meerdere versies van de MediaWiki getest worden), maar het zorgt wel dat ook websites met oudere MediaWiki versies voordelen hebben bij recent toegevoegde functionaliteit van de extensie.
 * Release branches: de release branches van een extensie zijn compatibel met de overeenkomende branches van de core, dus websites die MediaWiki gebruiken dienen de  branch van de extensie te gebruiken. (Voor extensies gehost op gerrit, deze branches worden automatisch aangemaakt bij de release d van een nieuwe versie van MediaWiki.) Dit zorgt voor een schonere code en een snellere ontwikkeling, maar gebruikers op een oudere versie van MediaWiki profiteren niet van het oplossen van fouten en nieuwe functionaliteit tenzij deze wijzigingen handmatig worden toegevoegd aan de oudere versie.

De onderhouders van een extensie dienen met de  parameter van het sjabloon Extension aan te geven welke conventie er voor die extensie gevolgd wordt.

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

<span id="Deploying_and_registering">

Inzetten en registreren
Als het je bedoeling is de extensie op de Wikimedia websites te gebruiken (inclusief mogelijk Wikipedia), dan is aanvullend onderzoek nodig op gebied van performance en veiligheid. raadpleeg.

Als je extensie namespaces toevoegt, dan wil je wellicht de standaard namespaces van de extensie registeren; soortgelijk, als er database-tabellen of -velden worden toegevoegd, dan kan dat bij  geregistreerd worden.

Weet dat het beoordelen en gebruiken van nieuwe extensies op de Wikimedia websites lang kan duren, in enkele gevallen heeft het meer dan 2 jaar geduurd.

<span id="Help_documentation">

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.

<span id="Providing_support_/_collaboration">

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.

<span id="See_also">

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 cookiecutter sjabloon om een BoilerPlate extensie te genereren (met variabelen enz.)
 * 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.
 * Beste gebruik bij extensies
 * Beste gebruik bij extensies
 * Beste gebruik bij extensies
 * Beste gebruik bij extensies