Help:Magic words

From FORwiki

Current revision as of 08:46, 14 October 2009

Magic words (which include parser functions, variables and behavior switches) are features of wikitext that enable various instructions to be given to the Foresight Wiki software (for example, to suppress or position the table of contents), or else serve to produce variable output, as is often required in templates.

A quick reference for magic words can be found on this page. For more complete and updated documentation, refer to following pages on the Foresight Wiki site:

• Help:Magic words for all standard magic words, including the "standard" parser functions
• Help:Extension:ParserFunctions for some additional parser functions, including conditional expressions

General information

There are three types of magic words:

• Behavior switches: uppercase words surrounded by double underscores, e.g. __NOTOC__, or keywords using parser function syntax
• Variables: uppercase words surrounded by double braces, e.g. {{PAGENAME}} (thus resembling templates)
• Parser functions: keywords (some beginning #) in double braces with parameters after a colon, e.g. {{#expr:2+2}}

Some magic words are case-insensitive, but not all. Whitespace is stripped from the start and end of keywords and parameters, as in template syntax.

Page-dependent magic words will affect or return data about the current page, even if the word is added through a transcluded template or included system message.

It is possible to substitute parser functions and variables in the same way that templates are substituted (using the subst: keyword). This causes their current value (as evaluated at the time of substitution) to be written into the wikitext.

Behavior switches

For documentation, refer to the Behavior Switches section of the Foresight Wiki page.

• __NOTOC__ (can appear anywhere in the wikitext; suppresses the table of contents)
• __FORCETOC__ (can appear anywhere in the wikitext; makes a table of contents appear in its normal position above the first header)
• __TOC__ (places a table of contents at the word's position)

• __NOEDITSECTION__ (hides the section edit links beside headings)
• __NEWSECTIONLINK__ (adds a "+" link for adding a new section on a non-"Talk" page)
• __NONEWSECTIONLINK__ (removes the "+" link on "Talk" pages)

• __NOGALLERY__ (on a category page, replaces thumbnails with normal links)
• __HIDDENCAT__ (on a category page, makes it a hidden category)
• __INDEX__ (tells search engines to index the page)
• __NOINDEX__ (tells search engines not to index the page)

• {{DISPLAYTITLE:title}} (changes the displayed form of the page title)
• {{DEFAULTSORT:sortkey}} (sets a default category sort key)

Variables

For documentation, refer to the Variables section of the MediaWiki page.

• {{FULLPAGENAME}} (page title including namespace)
• {{PAGENAME}} (page title excluding namespace)
• {{BASEPAGENAME}} (page title excluding subpage and namespace)
• {{SUBPAGENAME}} (subpage part of title)
• {{SUBJECTPAGENAME}} (associated non-talk page)
• {{TALKPAGENAME}} (associated talk page)
• {{NAMESPACE}} (namespace of current page)
• {{SUBJECTSPACE}}, {{ARTICLESPACE}} (associated non-talk namespace)
• {{TALKSPACE}} (associated talk namespace)
• {{FULLPAGENAMEE}}, {{NAMESPACEE}} etc. (URL-encoded equivalents)

The above can all take a parameter, to operate on a page other than the current page.

• {{SITENAME}} (FORwiki)
• {{SERVER}} (http://forwiki.eu)
• {{SERVERNAME}} (www.forwiki.ro)
• {{SCRIPTPATH}} ()
• {{CURRENTVERSION}} (current MediaWiki version)
• {{REVISIONID}} (latest revision to current page)
• {{REVISIONDAY}}, {{REVISIONDAY2}}, {{REVISIONMONTH}}, {{REVISIONYEAR}}, {{REVISIONTIMESTAMP}}, {{REVISIONUSER}} (date, time, editor at last edit)

• {{CURRENTYEAR}}, {{CURRENTMONTH}}, {{CURRENTMONTHNAME}}, {{CURRENTMONTHABBREV}}, {{CURRENTDAY}}, {{CURRENTDAY2}}, {{CURRENTDOW}}, {{CURRENTDAYNAME}}, {{CURRENTTIME}}, {{CURRENTHOUR}}, {{CURRENTWEEK}}, {{CURRENTTIMESTAMP}} (current date/time variables)
• {{LOCALYEAR}} etc. (as above, based on site's local time)

• {{NUMBEROFPAGES}}, {{NUMBEROFARTICLES}}, {{NUMBEROFFILES}}, {{NUMBEROFEDITS}}, {{NUMBEROFVIEWS}}, {{NUMBEROFUSERS}}, {{NUMBEROFADMINS}}, {{NUMBEROFACTIVEUSERS}} (statistics on Foresight Wiki; add :R to return numbers without commas)

Parser functions

These are documented at the main documentation page unless otherwise stated.

Metadata

• {{PAGESIZE:page name}} (size of page in bytes)
• {{PROTECTIONLEVEL:action}} (protection level for given action on the current page)
• {{PAGESINCATEGORY:categoryname}} (number of pages in the given category)
• {{NUMBERINGROUP:groupname}} (number of users in a specific group)

Add |R to return numbers without commas.

Formatting

• {{lc:string}} (convert to lower case)
• {{lcfirst:string}} (convert first character to lower case)
• {{uc:string}} (convert to upper case)
• {{ucfirst:string}} (convert first character to upper case)
• {{formatnum:unformatted num}} (format a number with comma separators; add |R to unformat a number)
• {{#formatdate:date}} (formats a date according to user preferences; a default can be given as a second parameter for users without date preference)
• {{padleft:xyz|stringlength}}, {{padright:xyz|stringlength}} (pad with zeros to the right or left; an alternative padding string can be given as a third parameter)
• {{plural:n|is|are}} (produces alternative text according to whether n is greater than 1)
• {{#time: format string | date/time object }} (for date/time formatting; also #timel for local time. Covered at the extension documentation page.)

Paths

• {{localurl:page name}}, {{localurl:page name|query string}} (relative path to the title)
• {{fullurl:page name}}, {{fullurl:page name|query_string}} (absolute path to the title)
• {{filepath:file name}} (absolute URL to a media file)
• {{urlencode:string}} (input encoded for use in URLs)
• {{anchorencode:string}} (input encoded for use in URL section anchors)
• {{ns:n}} (name for the namespace with index n; use {{nse:}} for URL-encoded equivalent)
• {{#rel2abs: path }} (converts a relative file path to absolute; see the extension documentation)
• {{#titleparts: pagename | number of segments to return | first segment to return }} (splits title into parts; see the extension documentation)

Conditional expressions

These are covered at the extension documentation page. Some parameters are optional.

• {{#expr: expression }} (evaluates the given expression)
• {{#if: test string | value if non-empty | value if empty }} (selects one of two values based on whether the test string is empty)
• {{#ifeq: string 1 | string 2 | value if equal | value if unequal }} (selects one of two values based on whether the test strings are equal – numerically if applicable)
• {{#iferror: test string | value if error | value if correct }} (selects value based on whether the test string generates a parser error)
• {{#ifexpr: expression | value if true | value if false }} (selects value based on evaluation of expression)
• {{#ifexist: page title | value if exists | value if doesn't exist }} (selects value depending on whether a page title exists)
• {{#switch: test | case1 = value for case 1 | ... | default }} (provides alternatives based on the value of the test string)