Sjabloon:Extensie
Dit sjabloon maakt gebruikt van ingewikkelde functies van de sjabloonsyntax.
U wordt aangeraden om uzelf bekend te maken met de setup en parserfuncties alvorens dit sjabloon te bewerken. Indien uw bewerking onverwachte problemen veroorzaakt, gelieve deze zo snel mogelijk ongedaan te maken, omdat dit sjabloon mogelijk op een groot aantal pagina's wordt gebruikt. Onthoudt dat u kunt experimenteren en dat alle verbeteringen moeten worden getest, in de {{{general}}} dan wel in uw gebruikersruimte, alvorens hier iets te wijzigen. |
Uses Lua: |
This template uses TemplateStyles: |
Dit sjabloon moet toegevoegd worden aan elke hoofdpagina van een extensie op deze wiki (alleen op de hoofdpagina). Het voegt een nuttige box met informatie (zie onder) toe en voegt de extensie toe aan Category:All extensions/nl , met de betreffende status en implementatie type categorieën. It autofills some fields of the infobox with extension data collected by wikitech:Tool:Extjsonuploader.
Gebruik
Kopieer en plak: {{Extension |templatemode = |name = |status = |type1 = |type2 = |hook1 = |hook2 = |newhook1 = |newhook2 = |username = |author = |description = |image = |imagesize = |version = |update = |version preview = |update preview = |compatibility policy = |mediawiki = |php = |needs-updatephp = |composer = |virtual domain = |table1 = |table2 = |license = |download = |repo = |readme = |changelog = |help = |example = |namespace = |parameters = |tags = |rights = |compatibility = |phabricator = |translate = |vagrant-role = }}Voor hulp met de waarden van de parameters, zie hieronder. |
|
Inhoud parameters
Deze sectie beschrijft de parameters die de box met informatie vullen. Voor hulp met templatemode en andere controle parameters, zie Controle parameters.
Parameter | Beschrijving |
---|---|
name | naam van de extensie |
status |
status huidige release Een van:
Als de status is anders is dan hier genoemd, wordt het genegeerd en wordt de standaardwaarde 'Onbekend' getoond. Als de waarde wordt weggelaten, dat krijgt het de waarde onbekend. Als de waarde ongeldig is, wordt het geplaatst in een speciale categorie zodat de fout wordt herkend en kan worden verbeterd. |
type1 type2 type3 type4 type5 type6 | implementatie type
De implementatie strategie(en) gebruikt voor het builden van deze extensie. Deze parameter wordt gebruikt om categorieën aan te maken die programmeurs helpen om voorbeelden te vinden van verschillende MediaWiki specifieke implementatie strategieën of patronen. Alhoewel de waarden van deze parameter soms overeenkomen met het gebruik of doel van de extensie, is dat niet de reden van deze parameter. Als de waarden die u heeft gekozen voor deze parameter niet goed het doel of mogelijke use cases aangeven, bevelen wij aan om aanvullende categorie links toe te voegen, als die nodig zijn. Toegestane waarden voor de type1, type2, ... parameters zijn:
Elke andere waarde bij 'type' is ongeldig en zal leiden tot een plaatsing van de extensie op de lijst Category:Extensions with invalid or missing type/nl. NB: Een extensie kan meer dan een type hebben, als dat zo is, vervang dan|type= door |type1=|type2=|type3=... . U kunt maximaal zes types bij een extensie definiëren. |
hook1 hook2 hook3 hook4 ... |
naam van elke hook die door de extensie wordt gebruikt
Door dit veld in te vullen krijgt uw extensie meer aandacht en het helpt andere ontwikkelaars. Elke gedocumenteerde hook zorgt automatisch voor het plaatsen van de extensie op een categorie de de extensie toont die die bepaalde hook gebruiken. Deze categorie is automatisch gelinkt aan elke hook pagina zodat een programmeur eenvoudig voorbeelden van extensies kan vinden van het gebruik van een bepaalde hook. Voor meerdere hooks, koppel de eerste hook aano hook1, de tweede aan hook2 enz. |
newhook1 newhook2 newhook3 newhook4 ... newhook90 |
naam van elke hook die door de extensie wordt toegevoegd U wilt mogelijk de hook ook toevoegen aan Extension hook registry. |
username | De gebruikersnaam van de auteur op MediaWiki.org (indien die er is). Optioneel, maar indien bekend dan wordt er een link gemaakt naar de gebruikerspagina en de overlegpagina van de auteur. Het moet zonder namespace en zonder [[]]s worden ingevuld. |
De naam van de auteur van de extensie, als die anders is dan de gebruikersnaam op MediaWiki.org. Vrije tekst. Indien weggelaten wordt het veld 'gebruikersnaam' gebruikt (indien aanwezig). | |
description | korte beschrijving |
image | schermafbeelding of logo van extensie. Het moet zonder namespace en zonder [[]]s worden ingevuld. |
imagesize | facultatief, grootte van de afbeelding zonder 'px', dus bijv. 360 (standaardgrootte is 300px) |
version | laatste versie |
update | datum van de laatste wijziging |
version preview | preview versie |
update preview | datum laatste wijziging van de preview versie |
compatibility policy | beleid compatibiliteit (geaccepteerde waarden: master, main, rel, ltsrel). (backlog ) |
mediawiki | Verplichte versie van MediaWiki. De meeste extensies zullen dit niet hoeven te doen, het geeft de standaardwaarde van de 'requires' property van extension.json. Bekijk ook Category:Extensions without MediaWiki version en Category:Extensions with manual MediaWiki version . |
php | verplichte versie van PHP |
needs-updatephp |
Extensies die volgens de standaarden van MediaWiki voor extensies zijn hebben een script dat handmatig gestart moet worden om het databaseschema te wijzigen (eenmalig) voor het starten en benaderen van de MediaWiki met de webbrowser, maar na het kopiëren van alle bestanden van de extensie naar
$IP staat voor het Installatie Pad (of "map") van de MediaWiki installatie, dezelfde map die LocalSettings.php , index.php etc. bevat. |
composer | De extensie Composer package naam, in het standaardformaat. het zal automatisch worden toegevoegd indien aangegeven in het bestand "composer.json" van de extensie (bijv. deze parameter is dat geval niet verplicht). Het zal worden gelinkt naar de extensie-pagina op Packagist. |
virtual domain | Het virtuele database domein dat door de extensie wordt gebruikt. |
table1 table2 table3 table4 ... table30 | naam van elke niet standaard tabel die door de extensie wordt gebruikt Linkt naar een subpagina van uw extensie-pagina. Bijvoorbeeld, "table1 = cu_changes" op Extension:CheckUser zal linken naar Extension:CheckUser/cu_changes table . Noem hier geen kerntabellen zoals page of revision ; noem alleen tabellen die door extensies zijn toegevoegd. |
license | licentie dominant (governing) gebruik van deze extensie, als een van de code staat in https://spdx.org/licenses/, bijv. GPL-2.0-or-later , GPL-2.0-only of GPL-3.0-or-later , enz. |
download | link om te downloaden : Git, {{WikimediaDownload/nl }}. |
repo | Naam van de Gerrit repository waar de code staat, indien dat afwijkt van de naam van de pagina. Door het invullen hiervan wordt automatisch |download= gezet, en mag het sjabloon automatisch gegevens downloaden uit het passende bestand extension.json . |
readme | externe link naar het bestand readme, bijv. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README |
changelog | externe link naar het bestand changelog, bijv. Extension:GeoGebra/Changelog |
help | Link naar de helppagina van de extensie voor de gebruiker. If not provided, will look for Help:Extension:ExtensionName . Indien meegegeven, dan moet de volledige wikitext link worden gegeven (dit vanwege het mogelijk linken naar een externe pagina). |
example | voorbeeld, website of schermafdruk van werkende extensie |
namespace | namespace waar de extensie in wordt gebruikt |
parameters | beschikbare parameters voor LocalSettings.php |
elke tag die de extensie gebruikt (bijv. <tag1>, <tag2>). | |
rights | rechten toegevoegd door de extensie. Verwar dit niet met de licentie! Rechten zijn bijvoorbeeld makebot of desysop , niet GFDL, LGPL of GPL (dat zijn licenties). |
compatibility | Aanvullende informatie over compatibiliteit, bijvoorbeeld met instantie compatibiliteitskaarten. Het wordt aangemoedigd ook dergelijk informatie te geven over de client-side, vooral als er geen volledige ondersteuning voor een type webbrowser is. |
bugzilla | Bugzilla MediaWiki extensie componentnaam |
phabricator | Phabricator projectnaam |
translate |
Optionele parameter om te linken naar de exacte pagina waar (message-group-id met welke) de extensie vertaalbaar zal zijn op translatewiki.net, indien ingeschakeld. Als de standaardlink niet goed is, zet het dan handmatig op:
|
vagrant-role | MediaWiki-Vagrant rol |
CheckUsageNameOverride | overschrijf de paginanaam die gebruikt wordt voor de link controleer gebruik. |
Controle parameters
Parameter | Beschrijving |
---|---|
templatemode |
Controleert automatische categorisatie van host pagina. Normaal leeg. Andere waarden zijn:
|
Informatie box gebruiken
Bestaande extensie pagina
Als u het informatieveld aan een bestaande pagina wilt toevoegen, kopieer en plak dan de code bovenaan deze pagina.
Een extensie pagina aanmaken
Als u een nieuwe extensie-pagina wilt aanmaken, voer dan hieronder de naam in en klik op de knop. Er wordt een pagina aangemaakt, met het sjabloon infobox al op de plek.
Een ontwikkelaar die de eigen code deelt in de MediaWiki code repository kan verwachten:
- Feedback / Kritiek / Review van de code
- Review en commentaar door andere ontwikkelaars over zaken als framework gebruik, veiligheid, efficiëntie en bruikbaarheid.
- Optimaliseren, verbeteren
- Andere ontwikkelaars kunnen uw code aanpassen om het te verbeteren, optimaliseren, op te schonen, te voldoen aan standaarden over bijvoorbeeld codeer conventies, aanpassen voor nieuwe framework classes en methoden en vertalingen.
- Verbeterde toegang voor wiki systeembeheerders
- Als u besluit om uw code op de wiki te zetten,mag een andere ontwikkelaar besluiten het te verplaatsen naar de MediaWiki code repository omdat het daar eenvoudiger te onderhouden is. U kunt dan een Ontwikkelaarsaccount aanmaken om het beheer ervan te blijven doen.
- Toekomstige versies van andere ontwikkelaars.
- Er worden automatisch nieuwe branches van uw code aangemaakt als er een nieuwe versie van MediaWiki uitkomt. U dient deze branches te backporten als u oudere versies wilt blijven ondersteunen.
- Het overnemen van uw code in een andere extensie met hetzelfde of vergelijke doelen, het overnemen van de beste functies van elke extensie.
- Credit
- Het bedanken voor uw werk wordt ook in toekomstige versies gedaan, ook bij elke extensie die uw code heeft overgenomen.
- Dat betekent ook dat u dat zelf moet aangeven, geef de credits aan degenen waar u wat code van heeft overgenomen.
Als u zich niet gemakkelijk voelt bij het uitvoeren van een van deze acties, plaats uw code dan niet in de repository. Ongeacht waar u uw code neerzet, zien we graag dat u een samenvattingspagina op de wiki aanmaakt voor uw extensie zodat iedereen kan lezen over uw extensie, en waar het te downloaden is.
Sjabloon verbeteren
Als u dit sjabloon wilt verbeteren, alvast bedankt! Dit is een complex sjabloon, er is wat hulp geweest bij de ontwikkeling:
Knop Extensie aanmaken
Om het gedrag te verbeteren van de knop om een extensie aan te maken:
- Template:Extension/Sample : De boilerplate extensie die vooraf wordt geladen op nieuw aangemaakte pagina's.
- Template:Extension/CreateExtensionInputBox/nl : een invoerveld dat op de plaats kan worden toegevoegd waar u de gebruikers een nieuwe extensie wilt laten aanmaken. Documentatie over de tag
<inputbox>
, lees Extension:InputBox .
Informatie box parameters
In het algemeen:
- Om dit sjabloon eenvoudig te kunnen gebruiken, is elk label in het informatieveld gelinkt naar de documentatie op de sjabloonparameter(s) die wordt getoond. Als u een parameter toevoegt, controleer dan of u het ook aan de inhoud parameter documentatie toevoegt en link het label aan die documentatie.
Voor het wijzigen/verbeteren/toevoegen aan de implementatie type parameters:
- Controleer de overlegpagina, er zijn flinke discussies gevoerd over dit veld.
- De geldige types en naar wat ze linken is gedefinieerd op Module:Extension
Om het gedrag van de hook parameters te wijzigen:
- Template:Extension/HookInUse: Voegt links en categorieën voor een gebruikte hook toe. Meerdere gebruikte hooks worden geïmplementeerd door het aanroepen van dit sjabloon met Template:Foreach, dus voor elke gebruikte hook.
- Template:Extension/HookInUseNoCats: Gebruikt in plaats van Template:Extension/HookInUse wanneer dit sjabloon wordt gebruikt in
templatemode=nocats
. Sjablonen die met Template:Foreach worden gebruikt kunnen maar een parameter gebruiken, dus pakken we de aanroep van Template:Extension/HookInUse in met een ander sjabloon dat de mode zet.
Testgeval
Controleer of de volgende pagina's nog goed zijn na het wijzigen van dit sjabloon.
TemplateData
TemplateData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Dit is de TemplateData documentatie van dit sjabloon dat gebruikt wordt door de VisualEditor en andere hulpmiddelen. Extension An infobox for a MediaWiki extension.
|
Maintenance: vulnerabilities, archived