Module:Message box/doc/nl
 | Dit is een documentatie subpagina van Module:Message box/doc. Het bevat informatie over het gebruik, categorieën en andere inhoud die geen deel is van de originele pagina Module. |
 | Deze module wordt gebruikt in systeemberichten. Het wijzigen hiervan kan direct doorwerken in de gebruikersinterface van de MediaWiki. Om grootschalige verstoringen te voorkomen, dient elke wijziging van deze module eerst getest te worden in de module zandbak of de testcases subpagina of op de eigen gebruikerspagina.De geteste wijzigingen kunnen dan in één bewerking aan deze module worden toegevoegd. Stem de wijzigingen eerst op de op de overlegpagina af alvorens deze te implementeren. |
 | Deze module wordt beschreven als gereed voor algemeen gebruik. Het heeft een volwaardige vorm en lijkt foutenvrij te zijn en is beschikbaar voor gebruik waar dat gewenst is. Dit kan op de helppagina's en andere bronnen genoemd worden als een optie voor gebruikers om het uit te proberen. Om de serverload en slechte uitvoer te beperken, dient het verbetert te worden met testen in de zandbak eerder dan door op de bonnefooi te testen. |
 | Deze module is onderwerp voor de pagina beveiliging. Het is een erg zichtbare module die op erg veel pagina's gebruikt wordt. Omdat vandalisme en foutjes veel effect kunnen hebben, ook bij zeer kleine wijzigingen, en er dan serieuze problemen kunnen ontstaan op de servers, worden deze pagina's beveiligd tegen het wijzigen. |
 | Uses Lua: |
 | This module uses TemplateStyles: |
Dit is een meta-module die de berichtenboxsjablonen {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}} en {{tmbox}} implementeert. Het is bedoeld om te worden gebruikt vanuit Lua-modules en mag niet direct worden gebruikt vanuit wiki-pagina's. Als u de functionaliteit van deze module op een wiki-pagina wilt gebruiken, gebruik dan de sjablonen voor individuele berichtenboxen.
Gebruik
Om deze module in een andere Lua-module te gebruiken, moet u deze eerst laden.
local messageBox = require('Module:Message box')
Gebruik de functie main om een berichtenbox te maken.
Er zijn twee parameters:
- de eerste is het 'box type' (een tekst).
- de tweede is een tabel met de parameters van de berichtenbox.
local box = messageBox.main( boxType, {
param1 = param1,
param2 = param2,
-- Meer parameters...
})
Er zijn zeven 'box types' beschikbaar:
| Box type | Sjabloon | Doel |
|---|---|---|
mbox
|
{{mbox}} | Voor berichtenboxen die in meerdere namespaces worden gebruikt |
ambox
|
{{ambox}} | Voor artikel berichtenboxen |
cmbox
|
{{cmbox}} | Voor categorie berichtenboxen |
fmbox
|
{{fmbox}} | Voor interface berichtenboxen |
imbox
|
{{imbox}} | Voor bestand-namespaces berichtenboxen |
tmbox
|
{{tmbox}} | Voor overlegpagina berichtenboxen |
ombox
|
{{ombox}} | Voor berichtenboxen in andere namespaces |
Zie de sjabloonpagina van elk 'box type' voor de beschikbare parameters.
Gebruik met #invoke
Naast de functie main heeft deze module voor elk 'box type' afzonderlijke functies.
Ze zijn toegankelijk met de code {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}}, enz.
Deze werken wanneer ze worden aangeroepen vanuit andere modules, maar ze hebben toegang tot de code die wordt gebruikt om argumenten te verwerken die zijn doorgegeven met {{#invoke:...}}, en daarom zal het aanroepen van hen minder efficiënt zijn dan het aanroepen van main.
Technische details
De module gebruikt dezelfde basiscode voor elk van de hierboven genoemde sjablonen; De verschillen tussen elk van hen worden geconfigureerd met behulp van de gegevens op Module:Message box/configuration.