Manual:Magic words/da

From mediawiki.org
This page is a translated version of the page Manual:Magic words and the translation is 47% complete.
Outdated translations are marked like this.
MediaWiki udvidelser

Magisk ord er en teknik til kortlægning af en række wiki tekststrenge til et enkelt ID, der er forbundet med en funktion. Både variabler og parser funktioner bruger denne teknik. Al kortlagt tekst til ID'et vil blive erstattet med funktionens returværdi. Kortlægningen mellem tekststrengene og ID'et er gemt i variablen $magicWords i en fil, der kan indlæses ved hjælp af $wgExtensionMessagesFiles[] .

Standard magiske ord er indbygget i CoreParserFunctions.php .

Hvordan magiske ord virker

Når MediaWiki finder tekst mellem dobbelte parenteser ({{XXX ...}}) skal programmet afgøre, om XXX er en variabel, parser funktion eller skabelon. For at afgøre dette, stiller det en række spørgsmål:

  1. Har det et tilhørende magisk ord ID? Som et første skridt i at løse opmærkning med formen {{XXX...}}, forsøger MediaWiki at oversætte XXX til et magisk ord ID. Oversættelses-tabellen er defineret ved $magicWords.
    • Hvis der ikke er et magisk ord ID forbundet med XXX, antages XXX at være en skabelon.

  2. Er det en variabel? Hvis et magisk ord ID er fundet, tjekker MediaWiki dernæst om det har nogen parametre.
    • Hvis ingen parametre er fundet, undersøger MediaWiki om magisk ord ID'et er blevet erklæret som et variabel ID. To check this, it retrieves the list of magic words serving by calling MagicWord::getVariableIDs(). This method gets its list of variable IDs from a hard coded list of variable IDs (see Help:Variables ) and from a list of custom variable IDs provided by all functions attached to the hook MagicWordwgVariableIDs .
      • Hvis magisk ord ID'et er blevet klassificeret som en variabel, kalder MediaWiki krogen de funktioner, der er forbundet med hændelsesnavnet ParserGetVariableValueSwitch indtil der findes en, som anerkender det magiske ord og kan returnere dens værdi.

  3. Er det en parser funktion? Hvis der er nogen parametre, eller hvis magisk ord ID'et mangler fra listen over variable magisk ord ID'er, så antager MediaWiki, at det magiske ord er en parser funktion eller skabelon. Hvis magisk ord ID'et er fundet på listen over parser funktioner erklæret via et kald til $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), behandles det som en parser funktion og gengives ved hjælp af funktion med navnet $renderingFunctionName. Ellers antages det at være en skabelon. If the magic word ID is found in the list of parser functions declared via a call to $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), it is treated as a parser function and rendered using the function named $renderingFunctionName. Otherwise, it is presumed to be a template.

By convention:

  • The magic words called variables are capitalised, case-sensitive and do not have space characters.
  • Parserfunctions are prefixed with a hash sign (#), are case insensitive and do not include space characters.

This is however a convention and one not consistently applied (for historic reasons).

  • Variables do not have space characters, but some translations of variables in other languages DO have spaces
  • Variables generally are capitalised and case-sensitive, but some parser functions also use this convention.
  • Some parser functions start with a hash sign, but some do not.

Where possible you should follow the conventions when defining or translating magic words. Magic words are higher in priority than templates, so any magic word defined, will block the usage of that defined name as a template.

Following the conventions avoids adding more and more potential collisions.

Definition af magiske ord

For at gøre et magisk ord magisk, skal vi definere to ting:

  • en kortlægning mellem wikitekst og et magisk ord ID
  • en kortlægning mellem et magisk ord ID og nogle php-funktioner, der fortolker det magiske ord.

Kortlægning af wikitekst til magisk ord ID'er

Variablen $magicWords bruges til at knytte hvert magisk ord ID med en sprog-afhængig tabel, der beskriver alle tekststrenge, der er kortlagt til magisk ord ID'et. Important: This only sets up the back end i18n mapping, you still have to write other code to make MediaWiki use the magic word for anything. Also, make sure that you initialize $magicWords as an empty array before adding language-specific values or you will get errors when trying to load the magic word and will need to rebuild your localization cache before it will work.

Det første element i denne tabel er et flag, der angiver om det magiske ord følsom overfor store og små bogstaver. De resterende elementer er en liste over tekst, der skal knyttes til magisk ord ID'et. Hvis stort/lille begyndelsesbogstav flaget er 0, vil alle bostavs-varianter af navnene i tabellen matche. Hvis begyndelsesbogstav flaget er 1, vil kun eksakt match være forbundet med magisk ord ID'et. Thus the format is $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

Denne forbindelse er skabt af $magicWords i en registreret fil, der bruger $wgExtensionMessagesFiles[] .

I eksemplet nedenfor, vil en spansk MediaWiki-installation forbinde magisk ord ID'et 'MAG_CUSTOM' med "#personalizado", "#custom", "#PERSONALIZADO", "#CUSTOM" og alle andre bogstavs-varianter. I en engelsk MediaWiki vil kun "#custom" i forskellige bogstavs-kombinationer blive kortlagt til 'MAG_CUSTOM': In an English MediaWiki only "custom" in various case combinations will be mapped to 'MAG_CUSTOM':

Filen Example.i18n.magic.php:

<?php

$magicWords = [];

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

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

In part of the extension.json file:

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

Bemærk, at "ExampleMagic" er anderledes fra nøglen du ville bruge til en almindelig internationaliseringsfil (normalt bare titlen på udvidelsen, nemlig "Eksempel"). "Magic" er blevet vedhæftet bevidst, så man ikke overskriver den anden.

In inline PHP

You can associate magic words inline in PHP rather than through a i18n file. This is useful when defining hooks in LocalSettings.php but should not be done in extensions.

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

Knytning af et magisk ord ID til en PHP-funktion

Mekanismen for tilknytning af magisk ord ID'er med visnings-funktioner afhænger af om det magiske ord vil blive brugt som en parser funktion eller en variabel. For mere information, se venligst:

Sprog-versioner

Se Help:Magic words#Localisation for at få hjælp.

Adfærds-omskiftere (dobbelt-understregede magiske ord)

Adfærds-omskiftere er en særlig type magiske ord. De kan kendes på deres brug af dobbelt understregning (i stedet for dobbelte parenteser). Eksempel: __NOTOC__

Disse magiske ord udsender typisk ikke i noget indhold, men ændrer i stedet en sides adfærd og/eller indstiller en sides tilhørsforhold. Disse magiske ord er opført i MagicWordFactory::mDoubleUnderscoreIDs og også på Help:Magic words#Behavior switches. Virkningen af hver adfærds-omskifter er defineret i Parser::handleDoubleUnderscore(). Hvis ingen specifik effekt er defineret, vil det magiske ord blot sætte en sides tilhørsforhold i page_props tabellen. This can also be checked later by testing if $parser->getOutput()->getPageProperty( 'MAGIC_WORD' ) is null or the empty string

Custom behavior switch

Here is an example extension implementing a custom __CUSTOM__ behaviour switch

custom/extension.json - This is minimal, a real extension would fill out more fields.

{
	"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' );
		}
	}
}

Se også