5.4 Magic words

Revision as of 15:07, 7 November 2023 by Margit Link-Rodrigue (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


A "Magic word" is a string of text that is recognized by the MediaWiki software. It triggers the software to return the value of a function, such as dates, website statistics or page names.

Types of Magic words

There are basically four different types of Magic words:

Behavior switch

Characteristics of a behavior switch

  • Purpose: controls the layout or behavior of the page
  • Syntax: __NOTOC__

Description

A behavior switch includes or omits certain elements of the page. It is also known as "double underscore". Behavior switches can be put anywhere in the source code of the designated page (usually at the end of the page). The behavior switch __TOC__ produces as output the table of contents exactly where it was inserted on the page.====

Variable

Characteristics of a variable

  • Purpose: returns information about the page, wiki, or date
  • Syntax: {{PAGENAME}}

Description

Variables contain (simple) dynamic data. If a template name conflicts with a variable, the variable is used. For example, you have the variable {{PAGENAME}}. In that case, you have to transclude the template with the same name as {{Template:PAGENAME}}.

Parser Function

Characteristics of a parser function
  • Purpose: simple "programming language" for page content (mainly in templates)
  • Syntax: {{#if:{{{field|}}} | {{{field|}}} | N/A }}
Description

Parser functions are similar to variables, but take one or more parameters.Example:

{{#ifeq:{{{type}}}|warning
|This is a warning!
|
}}

They are used for simple logic only, since they are hard to read and to maintain on a larger scale. If complex logic is required, consider Lua scripts in the "Module" namespace (mediawiki.org/wiki/Extension:Scribunto) and invoke using {{#invoke:...}}

Parser functions can also be "tag-like", e.g. {{#ask:...}} from SemanticMediaWiki. For more information, refer to the MediaWiki help pages mediawiki.org/wiki/Help:Extension:ParserFunctions and mediawiki.org/wiki/Help:Magic_words#Parser_functions.

Tag

Characteristics of a tag

  • Purpose: often used for custom development to process dynamic content
  • Syntax: <smartlist />

Description

Tags are implemented in PHP as part of a MediaWiki extension. Tags with "bs:" prefix come from BlueSpice. All others come from MediaWiki or from third-party extensions, e.g. the extension SyntaxHighlight.

How to add a magic word   -v4.2

Magic words are available as a menu item only until BlueSpice 4.2. In version 4.3. they have been replaced with Content Droplets


Magic words are inserted directly in the source code. Some frequently used Magic words can also be added directly with the VisualEditor Insert > Magic word menu item:

Manual:VE-insert-magicword.png

Related info




To submit feedback about this documentation, visit our community forum.

Discussions