Handleiding:Magische woorden

Magische woorden zijn een techniek voor het koppelen van verschillende wiki teksten aan een enkele ID die behoort bij een functie. Zowel variabelen als parser functies gebruiken deze techniek. Alle tekst die gekoppeld is aan dat ID zal vervangen worden door het resultaat van de functie. De koppeling tussen de teksten en het ID wordt opgeslagen in de variabele $magicWords in een bestand dat kan worden geladen met $wgExtensionMessagesFiles[] .

De standaard magische woorden zijn geïmplementeerd in CoreParserFunctions.php .

Hoe magische woorden werken

Als MediaWiki een tekst vindt tussen dubbele accolades ({{XXX ...}}) moet het beslissen of XXX een variabele, parser functie of een sjabloon is. De vragen zijn dan:

1. Heeft het een ID van een geassocieerd magisch woord Als eerste stap in het oplossen van de opmaak van het formulier {{XXX...}} probeert MediaWiki om XXX te vertalen naar een ID van een magisch woord. De vertaaltabel is gedefinieerd door $magicWords.
   • Als er geen magisch woord hoort bij XXX, dan wordt aangenomen dat XXX een sjabloon is.

   
   

2. Is het een variabele? Als er een ID van een magisch woord is gevonden, controleert MediaWiki of er parameters zijn.
   • Als er geen parameters gevonden worden, MediaWiki controleert of het magische woord ID is gedeclareerd als een variabele ID. Om dit te controleren haalt het de lijst met magische woorden op door een aanroep van MagicWord::getVariableIDs(). Deze methode haalt de lijst van variabele ID's op uit een vast gecodeerde lijst met variabele ID's (zie Help:Variables ) en uit een lijst van aangepaste variabele ID's aangeleverd door alle functies gekoppeld met de hook MagicWordwgVariableIDs .
     • Als het magische woord ID geclassificeerd is als een variabele, roept MediaWiki de functie ParserGetVariableValueSwitch aan om de waarde van die variabele op te halen.

   
   

3. Is het een parser-functie? Als er parameters zijn of het magische woord ID ontbreekt in de lijst variabele magische woorden ID's, dan neemt MediaWiki aan dat het magische woord een parser functie is of een sjabloon. Als het magische woord ID is gevonden in de lijst parser-functies gedeclareerd via een aanroep van $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), wordt het behandelt als een parser-functie en bouwt het op met gebruik van de functie $renderingFunctionName. In het andere geval wordt aangenomen dat het een sjabloon is.

Volgens conventie:

• De variabelen die magische woorden zijn beginnen met een hoofdletter, zijn hoofdletterafhankelijk en bevatten geen spaties.
• Parserfuncties worden voorafgegaan door een hash-teken (#), zijn hoofdletterongevoelig en bevatten geen spatietekens.

Dit is echter een conventie en een die niet consequent is toegepast (om historische redenen).

• Variabelen bevatten geen spaties, maar enkele vertaalde variabelen bevatten wel spaties.
• Variabelen zijn in het algemeen met een hoofdletter en hoofdletterafhankelijk, ook enkele parserfuncties gebruiken deze conventie.
• Enkele parserfuncties beginnen met een hekje.

Waar mogelijk moet u de conventies volgen bij het definiëren of vertalen van magische woorden. Magische woorden hebben een hogere prioriteit dan sjablonen, dus elk gedefinieerd toverwoord blokkeert het gebruik van die gebruikte naam als sjabloon.

Het volgen van de conventies voorkomt het toevoegen van meer en meer potentiële conflicten in naamgeving.

Magische woorden definiëren

Voor een magische woord magisch wordt, moeten er twee dingen worden gedaan:

• een koppeling tussen wikitekst en het ID van een magisch woord
• een koppeling tussen dat ID en een php-functie die het magisch woord interpreteert.

Wikitekst en ID magisch woord koppelen

De variabele $magicWords wordt gebruikt voor het associëren van het ID met een taalafhankelijk array dat alle teksten beschrijft die aan dat ID worden gekoppeld. Belangrijk: dit is alleen de back end i18n koppeling, u moet zelf nog de code schrijven zodat MediaWiki ook wat doet als het magische woord wordt gebruikt. Zorg er ook voor dat u $magicWords initialiseert als een lege array voordat u taalspecifieke waarden toevoegt, anders krijgt u fouten wanneer u het magische woord probeert te laden en moet u uw lokalisatiecache opnieuw opbouwen voordat deze werkt.

Het eerste element van dit array is een integer vlag, die aangeeft of het magische woord hoofdlettergevoelig is. De andere elementen zijn teksten die geassocieerd worden met het magische woord via het ID. Een vlag 0 geeft aan dat de elke tekst hoofdletter onafhankelijk is. Bij een vlag 1 moet een van de teksten precies overeenkomen. Een voorbeeld: $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

Deze associatie is gemaakt door $magicWords in een bestand geregistreerd met gebruik van $wgExtensionMessagesFiles[] .

In onderstaand voorbeeld ziet een Spaanse MediaWiki installatie het ID MagischeWoord-ID 'MAG_CUSTOM' met "personalizado", "custom", "PERSONALIZADO", "CUSTOM" en alle andere varianten met hoofd- en kleine letters. In een Engelse MediaWiki wordt alleen "custom" in allerlei varianten gekoppeld aan 'MAG_CUSTOM':

Bestand Example.i18n.magic.php:

<?php

$magicWords = [];

$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, 'custom' ],
];

$magicWords['es'] = [
	'MAG_CUSTOM' => [ 0, 'personalizado' ],
];

In deel van het bestand extension.json:

"ExtensionMessagesFiles": {
	"ExampleMagic": "Example.i18n.magic.php"
}

Zie dat "ExampleMagic" verschilt van de key die u zou gebruiken in een internationalization tekstbestand (normaal allen de naam van de extensie, bijv. "Example"). "Magic" is opzettelijk toegevoegd zodat de een de ander niet overschrijft.

In inline PHP

U kunt magische woorden inline in PHP associëren, liever dan via een i18n bestand. Dit is handig bij het definiëren van hooks in LocalSettings.php maar het zou niet moeten worden gedaan in extensies.

MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['MAG_CUSTOM', 'custom'];

MagischWoord-ID koppelen aan een PHP-functie

Het mechanisme voor het koppelen van het ID met de opbouwende functie hangt of het wordt gebruikt voor een parserfunctie of als een variabele. Meer informatie:

• Handboek:Parserfuncties
• Manual:Variables

Lokalisatie

Help bij lokalisatie van magische woorden.

Informatie over de definitie en gebruik van magische woorden voor lokalisatie: API Berichten, Namespaces; Voorkom {{SITENAME}} in berichten.

Gedragschakelaars (dubbele underscore)

Gedragsschakelaars zijn een speciaal type magische woorden. U herkent ze aan het gebruik van dubbele underscores (in plaats van accolades). Voorbeeld: __NOTOC__

Deze magische woorden geven geen uitvoer, maar passen het gedrag van een pagina aan of wijzigen een eigenschap van de pagina. Een lijst van deze woorden staat in MagicWordFactory::mDoubleUnderscoreIDs en ook op Gedragschakelaars. Het effect van de meeste gedragsschakelaars is aangegeven in Parser::handleDoubleUnderscore(). Als er geen specifiek effect is gedefinieerd, het magische woord zal eenvoudig een pagina-eigenschap zetten in de tabel page_props. Dit kan later ook worden gecontroleerd door te testen of $parser->getOutput()->getPageProperty( 'MAGIC_WORD' ) null of een lege tekst is

Eigen gedragsschakelaar

Hier een voorbeeld van een extensie die een __CUSTOM__ gedragsschakelaar aanmaakt

custom/extension.json - Dit is minimaal, een echte extensie zou meer velden invullen.

{
	"name": "Custom",
	"type": "parserhook",
	"AutoloadClasses": {
		"MyHooks": "MyHooks.php"
	},
	"Hooks": {
		"GetDoubleUnderscoreIDs": [
			"MyHooks::onGetDoubleUnderscoreIDs"
		],
		"ParserAfterParse": [
			"MyHooks::onParserAfterParse"
		]
	},
	"ExtensionMessagesFiles": {
		"CustomMagic": "custom.i18n.php"
	},
	"manifest_version": 1
}

custom/custom.i18n.php

<?php
$magicWords = [];
$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, '__CUSTOM__' ],
];

custom/MyHooks.php

<?php
class MyHooks {
	public static function onGetDoubleUnderscoreIDs( &$ids ) {
		$ids[] = 'MAG_CUSTOM';
	}

	public static function onParserAfterParse( Parser $parser, &$text, StripState $stripState ) {
		if ( $parser->getOutput()->getPageProperty( 'MAG_CUSTOM' ) !== null ) {
			// Do behavior switching here ...
			// e.g. If you wanted to add some JS, you would do $parser->getOutput()->addModules( 'moduleName' );
		}
	}
}

Zie ook

• Help:Magische woorden - Lijst met variabelen als {{PAGENAME}} en {{SERVER}}
• Manual:MagicWord.php