Majestix: Created page with " {{Magic words}} MediaWiki provides a standard text markup that can be easily customized. Extensions can customize wiki markup by: * '''Adding standard token types''' – The standard approach to customized MediaWiki markup is to add new markup that looks like the built-in MediaWiki XML tags (`&l..."`


2026-04-17T08:10:35Z
Created page with "<languages/> {{Magic words}} <translate><!--T:1--> MediaWiki provides a standard text markup that can be easily customized.</translate> <translate><!--T:37--> Extensions can customize wiki markup by:</translate> <translate> <!--T:2--> * '''Adding standard token types''' – The standard approach to customized MediaWiki markup is to add new markup that looks like the built-in MediaWiki [[<tvar name=1>Special:MyLanguage/Manual:Tag extensions</tvar>|XML tags]] (<code>&l..."
New page
<languages/>

{{Magic words}}

<translate><!--T:1--> MediaWiki provides a standard text markup that can be easily customized.</translate>

<translate><!--T:37--> Extensions can customize wiki markup by:</translate>

<translate>

<!--T:2-->

* '''Adding standard token types''' &ndash; The standard approach to customized MediaWiki markup is to add new markup that looks like the built-in MediaWiki [[<tvar name=1>Special:MyLanguage/Manual:Tag extensions</tvar>|XML tags]] (<code>&lt;''tag''&gt;</code>), [[<tvar name=2>Special:MyLanguage/Help:Templates</tvar>|template]] (<tvar name=3><code><nowiki>{{...}}</nowiki></code></tvar>), or link markup (<tvar name=4><code><nowiki>[[...]]</nowiki></code></tvar>).</translate>

<translate>

<!--T:3-->

* '''Adding custom token types''' &ndash; Some extensions define new token types.</translate>

<translate>

<!--T:4-->

* '''Making fundamental changes to the parser''' &ndash;  A few extensions attempt to fundamentally change the parsing strategy so that other markup languages can be used instead of the standard wiki markup.



== Adding to the standard token types == <!--T:5-->



<!--T:38-->

The simplest way to extend wiki markup is by adding to a standard token type using one of these features.



=== Variables === <!--T:39-->

</translate>

<translate><!--T:40--> A variable calls a PHP function that outputs a string of <tvar name=1>{{ll|wikitext}}</tvar> that replaces the variable on the page.</translate>

<translate><!--T:28--> Variables are usually used to insert system information into wiki markup, such as the current time or the current page.</translate>



<translate><!--T:41--> Syntax example:</translate>



<syntaxhighlight lang="wikitext">{{VARIABLENAME}}</syntaxhighlight>



<translate><!--T:42--> To define a variable, see <tvar name=1>{{ll|Manual:Variables}}</tvar>.</translate>

<translate><!--T:43--> For a list of extensions that define custom variables, see <tvar name=1>{{ll|Category:Variable extensions}}</tvar>.</translate>



<translate>

=== Parser functions === <!--T:44-->

</translate>

<translate><!--T:45--> Like variables, a parser function calls a PHP function and outputs a wikitext string that replaces the parser function on the page.</translate>

<translate><!--T:46--> Unlike variables, a parser function can pass parameters to the PHP function.</translate>

<translate><!--T:26--> Parser functions are used to handle wikitext generation that involves logic that is too complex or confusing to write using templates.</translate>



<translate><!--T:47--> Syntax example:</translate>

<syntaxhighlight lang="wikitext">{{#functionname: param1 | param2}}</syntaxhighlight>



<translate><!--T:48--> To define a parser function, see <tvar name=1>{{ll|Manual:Parser functions}}</tvar>.</translate>

<translate><!--T:49--> For a list of extensions that define custom parser functions, see <tvar name=1>{{ll|Category:Parser function extensions}}</tvar>.</translate>



<translate>

=== Parser tags === <!--T:50-->

</translate>

<translate><!--T:51--> Unlike variables and parser functions, which output wikitext, parser tags output HTML.</translate>

<translate><!--T:52--> A parser tag is an [[w:XML|XML]] tag that calls a PHP function, parses the contents of the tag, and outputs HTML that replaces the tag and its contents on the page.</translate>

<translate><!--T:53--> Parser tags can also pass arguments to the PHP function.</translate>

<translate><!--T:54--> For example, <tvar name=1>{{tag|syntaxhighlight|open}}</tvar> is a parser tag defined by <tvar name=2>{{ll|Extension:SyntaxHighlight}}</tvar>.</translate>



<translate><!--T:55--> Syntax example:</translate>



<syntaxhighlight lang="xml"><tagname param1name="param1value" param2name="param2value"> some text </tagname></syntaxhighlight>



<translate><!--T:56--> To define a parser tag, see <tvar name=1>{{ll|Manual:Tag extensions}}</tvar>.</translate>

<translate><!--T:57--> For a list of extensions that define custom parser tags, see <tvar name=1>{{ll|Category:Tag extensions}}</tvar>.</translate>



<translate>

=== Behavior switches === <!--T:58-->

</translate>

<translate><!--T:59--> A behavior switch calls a PHP function, but, unlike other methods of extending wiki markup, behavior switches usually do not output any content.</translate>

<translate><!--T:60--> Instead, they change the behavior of the page or set a page property.</translate>

<translate><!--T:61--> For example, adding <tvar name=1><code><nowiki>__NOTOC__</nowiki></code></tvar> to a page hides the table of contents.</translate>



<translate><!--T:62--> Syntax example:</translate>



<syntaxhighlight lang="wikitext">__SWITCHNAME__</syntaxhighlight>



<translate><!--T:63--> To define a behavior switch, see <tvar name=1>{{ll|Manual:Magic words#Behavior switches (double underscore magic words)}}</tvar>.</translate>

<translate><!--T:64--> For a list of extensions that define custom behavior switches, see <tvar name=1>{{ll|Help:Magic words#From Extensions}}</tvar>.</translate>



<translate>

=== Link markup === <!--T:65-->



<!--T:66-->

Link markup customizations change the way MediaWiki interprets internal links.



<!--T:67-->

Syntax example:

</translate>



<syntaxhighlight lang="wikitext">[[ ... ]]</syntaxhighlight>



<translate>

<!--T:68-->

For a list of extensions that define custom link markup, see <tvar name=1>{{ll|Category:Link markup extensions}}</tvar>.



== Adding new token types == <!--T:11-->



<!--T:12-->

To add new token types or to change the entire markup strategy, implementers need to add functions to one or more of the various parser and page output [[<tvar name=1>Special:MyLanguage/Manual:Hooks</tvar>|hooks]]:



<!--T:15-->

* <tvar name=1>'''{{ll|Category:ParserBeforeInternalParse extensions}}'''</tvar> rely on the <tvar name=2>{{ll|Manual:Hooks/ParserBeforeInternalParse|ParserBeforeInternalParse}}</tvar> hook.</translate>

<translate>

<!--T:16-->

* <tvar name=1>'''{{ll|Category:OutputPageBeforeHTML extensions}}'''</tvar> rely on the <tvar name=2>{{ll|Manual:Hooks/OutputPageBeforeHTML|OutputPageBeforeHTML}}</tvar> hook.</translate>

<translate>

<!--T:18-->

* <tvar name=1>'''{{ll|Category:ParserAfterTidy extensions}}'''</tvar> rely on the <tvar name=2>{{ll|Manual:Hooks/ParserAfterTidy|ParserAfterTidy}}</tvar> hook.



<!--T:69-->

See also <tvar name=1>{{ll|Category:Extensions by hook usage}}</tvar>.



== See also == <!--T:19-->

</translate>

* {{ll|Manual:Extensions}} - <translate><!--T:20--> provides general instructions for finding, installing, and writing extensions.</translate>



{{Extension development}}



[[Category:Parser extensions{{#translation:}}|*{{PAGENAME}}]]

[[Category:Customization techniques{{#translation:}}|{{PAGENAME}}]]
Manual:Extending wiki markup - Revision history
