Help:Magic words
From DrumCorpsWiki
This is an organised index of Magic words used in MediaWiki (and thus DrumCorpsWiki as well).
A "magic word" is a symbol which is recognized by the MediaWiki software and which when seen in the non-commented text of the page, triggers the software to do something other than display that symbol, or transclude a page with that name, but instead to use the symbol directly. A magic word can be:
- an upper case word, preceded and followed by two underlines "__", e.g. __NOTOC__
- an XML object, coded similar to HTML, preceded by "<" and followed by ">", e.g. <nowiki>
- a parser function: similar to a template, a word preceded by the symbols "{{" and followed by "}}", and optionally parameter definitions between pipe characters, except that the part before the first pipe (or without pipes, the text between the braces) contains a colon (":"), e.g. {{ns:3}} and {{#ifexpr:{{{1}}}>3|large|small}}
- a variable: similar to a template without parameters, a word preceded by the symbols "{{" and followed by "}}", except the word used is in all upper case, e.g. {{CURRENTDAY}}
- a template modifier
- an image modifier
If a page in the template namespace has the same name as a magic word, the magic word will be invoked instead. If you discover you absolutely have to define a template with the same name as a magic word, prefix the name of the template with "msg:" or the name of the template namespace ("Template:"). See below for further details if you need this feature.
Tags which are used on this page such as "[MW1.5+]" indicate the version that first supported the magic word. "XYZ" indicates user input, which is used in the example.
Contents |
[edit] Magic words between double underscores
[edit] Table of contents
- For details see Help:Section
| Word | Explanation |
|---|---|
| __NOTOC__ | Hides ToC on the current page. |
| __FORCETOC__ | Forces the table of contents to appear. |
| __TOC__ | Places a ToC here (overriding any __NOTOC__). |
[edit] Other
| Word | Explanation |
|---|---|
| __NOEDITSECTION__ | Hides the edit links beside headings. |
| __NEWSECTIONLINK__ | [MW1.7+] Gives a "+"-link next to the edit-tab to make a new section on a non-talk page. |
| __NOCONTENTCONVERT__ __NOCC__ | Don't perform the content language conversion (character and phase) in article display; for example, Chinese zh with zh_cn, zh_tw, zh_sg, zh_hk. |
| __NOGALLERY__ | [MW1.7+] This magic word allows images in category pages to be displayed as inline links instead of gallery. |
| __NOTITLECONVERT__ __NOTC__ | Like __NOCC__ but affecting article title only. |
| __END__ | Allows for trailing whitespace to be included in the page save (does not seem to work anymore). |
| __START__ | This magic word has no effect but an ID in MagicWord.php (MAG_START).
|
[edit] Variables
- For details see Help:Variable
[edit] Time
The time in UTC. Note that if the page was displayed by the same user and has not changed (has not been edited) since the last time it was displayed, it is possible that the page may be cached (by the user's browser) and the displayed time or date may not change. Also, if a heavily used page, rather than freshly rendered by the software each time it is generated, is instead being retrieved from a caching system (such as the main page on Wikipedia) the date or time may not change from the last time the page was originally retrieved by the caching hardware or software.
| Word | Example | Explanation |
|---|---|---|
| {{CURRENTDAY}} | 7
| Displays the current day in numeric form. |
| {{CURRENTDAY2}} | 07
| [MW1.6+] Same as {{CURRENTDAY}}, but with leading zero (01 .. 31). |
| {{CURRENTDAYNAME}} | Tuesday
| Name of the day in the language of the project or English. |
| {{CURRENTDOW}} | 2
| Same as {{CURRENTDAYNAME}}, but as a number (0=Sunday, 1=Monday...). |
| {{CURRENTMONTH}} | 10
| The number 01 .. 12 of the month. |
| {{CURRENTMONTHABBREV}} | Oct
| [MW1.5+] Same as {{CURRENTMONTH}}, but in abbreviated form as Jan .. Dec. |
| {{CURRENTMONTHNAME}} | October
| Same as {{CURRENTMONTH}}, but in named form January .. December. |
| {{CURRENTTIME}} | 11:11
| The current time (00:00 .. 23:59). |
| {{CURRENTHOUR}} | 04
| The current hour (00 .. 23). |
| {{CURRENTMINUTE}} | Template:CURRENTMINUTE
| The current minute (00 .. 59). |
| {{CURRENTWEEK}} | 41
| Number of the current week (1-53) according to ISO 8601 with no leading zero. |
| {{CURRENTYEAR}} | 2008
| Returns the current year. |
| {{CURRENTTIMESTAMP}} | 20081007111132
| [MW1.7+] ISO 8601 time stamp. |
[edit] Local time
The time depending on the local timezone of the wiki (not depending on the timezone in the user's preference settings). (All words [MW1.8+] )
| Word | Example | Explanation |
|---|---|---|
| {{LOCALDAY}} | 7
| Displays the local day of the month in numeric form. |
| {{LOCALDAY2}} | 07
| Same as {{LOCALDAY}}, but with a leading zero (01 .. 31). |
| {{LOCALDAYNAME}} | Tuesday
| Name of the day in the language of the project or English. |
| {{LOCALDOW}} | 2
| Same as {{LOCALDAYNAME}}, but as a number (0=Sunday, 1=Monday...). |
| {{LOCALMONTH}} | 10
| The number 01 .. 12 of the month. |
| {{LOCALMONTHABBREV}} | Oct
| Same as {{LOCALMONTH}}, but in abbreviated form as Jan .. Dec. |
| {{LOCALMONTHNAME}} | October
| Same as {{LOCALMONTH}}, but in named form as January .. December. |
| {{LOCALTIME}} | 04:11
| The local time (00:00 .. 23:59). |
| {{LOCALHOUR}} | 04
| The local hour (00 .. 23). |
| {{LOCALWEEK}} | 41
| Number of the local week (1-53) according to ISO 8601 with no leading zero. |
| {{LOCALYEAR}} | 2008
| Returns the local year. |
| {{LOCALTIMESTAMP}} | 20081007041132
| ISO 8601 time stamp. |
- See also the ParserFunction #time:
[edit] Statistics
Statistics variables give thousands separators unless ":R" for "raw" is added (actually, these versions are parser functions).
| Word | Example | Explanation | |
|---|---|---|---|
| {{CURRENTVERSION}} | 1.9.3
| [MW1.7+] Template:H:mwg [1] | |
| {{NUMBEROFARTICLES}} {{NUMBEROFARTICLES:R}} | 1,3051305
| A variable which returns the total number of articles on the Wiki. | |
| {{NUMBEROFPAGES}} {{NUMBEROFPAGES:R}} | 4,1784178
| [MW1.7+] Returns the total number of pages. [2] | |
| {{NUMBEROFFILES}} {{NUMBEROFFILES:R}} | 254254
| [MW1.5+] Returns the number of uploaded files (rows in the image table). | |
| {{NUMBEROFUSERS}} {{NUMBEROFUSERS:R}} | 1,8591859
| [MW1.7+] Returns the number of registered users (rows in the user table). | |
| {{NUMBEROFADMINS}} {{NUMBEROFADMINS:R}} | 22
| [MW1.7+] Returns the number of administrators (sysop, bureaucrat, steward and checkuser). | |
| {{PAGESINNAMESPACE}} | {{#if:{{#ifexpr:Template:PAGEINNS:0}}|disabled here}} | Longer alias of PAGESINNS | |
| {{PAGESINNS:ns}} {{PAGESINNS:ns:R}} | {{PAGESINNS:2}} {{#if:{{#ifexpr:Template:PAGEINNS:0}} | = Template:PAGESINNS:2}} {{PAGESINNS:2:R}} {{#if:{{#ifexpr:Template:PAGEINNS:0}}| disabled here|= Template:PAGESINNS:2}} | [MW1.7+] Returns the number of pages in the given namespace. Disabled by default, enable with Template:H:mwg. |
[edit] Page names and related info
[edit] Parser functions
- For details see Help:Parser function.
[edit] Namespaces and URLs
| Word | Example | Explanation |
|---|---|---|
| {{ns:}} | {{ns:4}} = DrumCorpsWiki{{ns:project}} = DrumCorpsWiki
| Returns the name of a given namespace number. |
| {{localurl:x y @}} {{localurle:x y @}} {{localurl:a|b=c}} | /X_y_%40
| Returns the local URL of a page (might not exist). Optional query parameter, see Help:Variable. |
| {{urlencode:x y @}} | x+y+%40
| [MW1.7+] Encodes variable values for use in external links. [3] |
| {{anchorencode:x #y @}} | x_.23y_.40
| [MW1.8+] Encodes variable values for use in section anchors. [4] |
| {{fullurl:x y @}} {{fullurle:x y @}} {{fullurl:m:a|b=c}} | http://drumcorpswiki.com/X_y_%40 http://drumcorpswiki.com/X_y_%40 http://drumcorpswiki.com/index.php?title=M:a&b=c | [MW1.5+] Returns the full URL of a given page. Optional query parameter as for localurl:. |
[edit] Formatting
| Word | Example | Explanation |
|---|---|---|
| {{#language:}} | {{#language:da}} = Dansk
| [MW1.7+] Native name of language code. |
| {{lc:}} | {{lc:AbC dEf}} = abc def
| [MW1.5+] LowerCase |
| {{lcfirst:}} | {{lcfirst:Ab Cd}} = ab Cd
| [MW1.5+] LC first char. |
| {{uc:}} | {{uc:aBc DeF}} = ABC DEF
| [MW1.5+] UpperCase |
| {{ucfirst:}} | {{ucfirst:aB cD}} = AB cD
| [MW1.5+] UC first char. |
| {{formatnum:}} | {{formatnum:-299792458.56789}} = -299,792,458.56789
| [MW1.7+] Add decimal separators according to the wiki's default locale. Leading minus and plus are recognized. |
| {{padleft:}} {{padright:}} | {{padleft:bcd|6|a}} = aaabcd{{padleft:café|6|-}}=-café {{padright:bcd|6|a}} = bcdaaa
| [MW1.8+] Pads a string with a character to the specified width. |
A letter like é counts for two. It does not seem possible to use padleft and padright for padding with characters with a multi-character code, such as , which would be useful with padleft for sorting tables with Javascript.
[edit] Template modifiers
| Usage | Explanation |
|---|---|
| {{:xyz}} | A bare colon is not a template modifier, it's the prefix for the main namespace. Test e.g. article {{:UTC}} vs. template {{UTC}}. Using this syntax you include the text of the main namespace article xyz in another article. |
| {{int:xyz}} | Shorthand for {{MediaWiki:xyz}}, rendered as <xyz> if MediaWiki:xyz doesn't exist. See Help:MediaWiki namespace. |
| {{msg:xyz}} | Even if there is a magic word named "xyz", use template:xyz unless the template doesn't exist (equivalent to {{template:xyz}}). Normally, magic words have priority when there is a conflict. |
| {{msgnw:xyz}} | The unevaluated wikitext is rendered. See msgnw. |
| {{raw:xyz}} | [MW1.6+] Equivalent to {{msg:xyz}} above<ref>Wikimedia SVN revision 12925</ref>.
|
| {{subst:xyz}} | In the wikitext, the tag is substituted by the content (single-level evaluation only), see Help:Substitution. |
[edit] Image modifiers
- For details see w:en:Wikipedia:Extended image syntax.
These are image modifiers used in [[Image:title.ext|modifier|...|modifier]] links. Some are mutually exclusive, and then the last specified wins.
[edit] Size
The last unrecognized modifier is used as caption for framed images or together with thumbnails. It's also used as description alt=text.
| Word | Usage | Explanation |
|---|---|---|
| framed frame enframed | [[Image:Mediawiki.png|framed]] | Places an image in a frame with a description. Uses original size. |
| thumbnail thumb | [[Image:Mediawiki.png|thumbnail]] | Modifies image size, sets it to dependant on user's favourite thumbnail size in their preferences. |
| thumb=xyz | [[Image:Mediawiki.png|thumb=Wiki.png]] | Manualthumb: instead of displaying an automatically-sized thumbnail for Mediawiki.png, display the image Wiki.png. |
| width px | [[Image:Mediawiki.png|40px]] | Scales image to given width in pixels |
[edit] Position
- For details see Help:Images_and_other_uploaded_files
The positions are mutually exclusive, the last specified wins. Template:- can stop floating. For inline images only modifier px (see above) is supported.
| Word | Usage | Explanation |
|---|---|---|
| right | [[Image:Mediawiki.png|right]] | Modifies position, floats the image to the right. |
| left | [[Image:Mediawiki.png|left]] | Modifies position, floats the image to the left. |
| none | [[Image:Mediawiki.png|none]] | Explicitly states that the image should not float. |
| center centre | [[Image:Mediawiki.png|center]] | Modifies position, like none but centered. |
[edit] Miscellany
| Word | Example | Explanation |
|---|---|---|
| {{DISPLAYTITLE:xyz}} | default disabled | [MW 1.7+] Set the page's title [5], see Template:H:mwg. |
| {{DIRMARK}} {{DIRECTIONMARK}} |
| [MW1.7+] u+200E left to right or u+200D right to left mark |
| {{CONTENTLANGUAGE}} | en
| [MW1.7+] Default content Template:H:mwg |
| {{DEFAULTSORT:xyz}} | [MW1.10+] Sets a default category sort key for the current page<ref>"Technology report", en-Wikipedia Signpost, January 2007</ref>. | |
| #REDIRECT | #REDIRECT [[target]]at top of source page | Creates a redirect to another page. |
[edit] Language-dependent word conversions
| Word | Example | Explanation |
|---|---|---|
| {{ CURRENTMONTHNAMEGEN }} | October
| Genitive form of month name used for Czech, Polish, Ukrainian[6] |
| {{grammar:case | word }} | {{grammar:7sg|Wikipedie}} on cs: is Wikipedií.
| Derived word forms in inflected languages like Czech [7] |
| {{plural:count |form1 |form2 }} {{plural:count |1st | 2nd | 3rd }} | {{plural: 2 | is | are }} outputs are{{plural: 0 | this | these }} outputs these
| count 1 yields form1 (singular), plural transformations are used for languages like Russian [8] based on "count mod 10". |
"Grammar" and "Plural" are language-dependent functions, defined in [9], [10], etc. (note that in PHP, the modulo operator is the percent sign).
"Grammar" can either be applied to predefined words only, or to arbitrary words, depending on whether the definition is just a 2D array, or involves string manipulations. See also cs:Šablona:Wikivar/GRAMMAR.
"Plural" is a project-dependent switch function, e.g. giving the first text if count = 1, the second if count = 2,3, or 4, and else the third.
The original source of this article is from Mediawiki, used under the terms of the GFDL. See this article's Talk page for details.
