Help:Extension:ParserFunctions/de

From MediaWiki.org
Jump to: navigation, search
Other languages:
български 1% • ‎বাংলা 0% • ‎Deutsch 14% • ‎Zazaki 0% • ‎English 100% • ‎British English 98% • ‎español 5% • ‎français 8% • ‎日本語 52% • ‎Lëtzebuergesch 7% • ‎मराठी 1% • ‎polski 14% • ‎پښتو 8% • ‎português 5% • ‎português do Brasil 23% • ‎русский 7% • ‎svenska 37% • ‎ไทย 0% • ‎Türkçe 8%

Die Erweiterung ParserFunctions bietet elf zusätzliche Funktionen, um die "Magic words" zu ergänzen, die es in MediaWiki bereits gibt. Alle Funktionen, die diese Erweiterung unterstützt, haben folgende Form:

{{#Funktionsname: Parameter 1 | Parameter 2 | Parameter 3 ... }}

#expr

Art Operatoren
Gruppieren (Klammern) ( )
Zahlen 1234.5   e (2.718)   pi (3.142)
Binärer Operator e   unäre +,-
Unäre Operatoren not ceil trunc floor abs exp ln sin cos tan acos asin atan
Binäre Operatoren ^
* / div mod
+ -
Runden round
Logische Operatoren = != <> > < >= <=
and
or

Diese Funktion berechnet einen mathematischen Ausdruck und gibt den errechneten Wert aus.

{{#expr: Ausdruck }}

Die verfügbaren Operatoren sind rechts aufgelistet, in der Reihenfolge des Rangs. Siehe Hilfe:Rechnen für nähere Details über die Funktion der einzelnen Operatoren. Genauigkeit und Format des ausgegebenen Ergebnisses hängen vom Betriebssystem des Wikiservers sowie dem Zahlenformat der eingestellten Sprache ab.

Bei Nutzung der Booleschen Algebra ergibt 0 immer falsch und jeder andere Wert, ob positiv oder negativ, immer wahr:

{{#expr: 1 and -1 }}1
{{#expr: 1 and 0 }}0

Ein leerer eingegebener Ausdruck erzeugt eine leere Ausgabe. Ungültige Ausdrücke erzeugen verschiedene Fehlermeldungen, welche durch Nutzung der Funktion #iferror abgefangen werden können:

{{#expr: }}
{{#expr: 1+ }}Expression error: Missing operand for +.
{{#expr: 1 foo 2 }}Expression error: Unrecognized word "foo".

The order of addition and subtraction operands before or after a number is meaningful, and may be treated as a positive or negative value instead of as an operand with an erroneous input:

{{#expr: +1 }}1
{{#expr: -1 }}-1
{{#expr: + 1 }}1
{{#expr: - 1 }}-1

Note, if using the output of magic words, you must raw format them in order to remove commas, and translate the numerals. For example {{NUMBEROFUSERS}} results in 1.484.416, where we want 1484416 which can be obtained by {{formatnum:{{NUMBEROFUSERS}}|R}}. This is especially important in some languages, where numerals are translated. For example, in Bengali, {{NUMBEROFUSERS}} produces ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}}101.484
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}1484516


Warning Warning: Der Operator mod ergibt bei einigen Werten des zweiten Parameters falsche Ergebnisse:
{{#expr: 123 mod (2^64-1)}}Division by zero. (erzeugt einen leeren String; sollte eigentlich 123 ergeben)

Runden

Rounds off the number on the left to a multiple of 1/10 raised to a power, with the exponent equal to the truncated value of the number given on the right.

To round up or down use unary ceil or floor respectively.

Test case Result Method of rounding
{{#expr: 1/3 round 5 }} 0.33333 Final digit is < 5, so no apparent rounding occurs
{{#expr: 1/6 round 5 }} 0.16667 Final digit is >= 5, so it is rounded up
{{#expr: 8.99999/9 round 5 }} 1 Again, the result is rounded up on the last digit, which results in additional rounding
{{#expr: 1234.5678 round -2 }} 1200 Rounded to nearest 100 because negative values round to the left of the decimal point
{{#expr: 1234.5678 round 2 }} 1234.57 Rounded to nearest 100th since positive values round to the right of the decimal point
{{#expr: 1234.5678 round 2.3 }} 1234.57 Decimals in the rounding index make no difference in the rounded result
{{#expr: trunc 1234.5678 }} 1234 Decimal portion truncated (chopped off)
Rounding to the nearest integer
{{#expr: 1/3 round 0 }} 0 Down to the nearest integer, which is zero
{{#expr: 1/2 round 0 }} 1 Up to the nearest integer, which is one
{{#expr: 3/4 round 0 }} 1 Up to the nearest integer, which is one
{{#expr: -1/3 round 0 }} -0 Up to the nearest integer, which is zero
Warning Warning: The negative sign on zero could cause equality mismatches
{{#expr: -1/2 round 0 }} -1 Down to the nearest integer, which is negative one
{{#expr: -3/4 round 0 }} -1 Down to the nearest integer, which is negative one
Rounding up or down with ceil and floor
{{#expr: ceil(1/3) }} 1 Up to the next larger integer, which is one
{{#expr: floor(1/3) }} 0 Down to the next smaller integer, which is zero
{{#expr: ceil(-1/3) }} -0 Up to the next larger integer, which is zero
Warning Warning: The negative sign on zero could cause equality mismatches
{{#expr: floor(-1/3) }} -1 Down to the next smaller integer, which is negative one
{{#expr: ceil 1/3 }} 0.33333333333333 Not rounded since 1 already is an integer
Warning Warning: Interpreted as (ceil 1)/3, not ceil(1/3) as you might expect

#if

This function evaluates a test string and determines whether or not it is empty. A test string containing only white space is considered to be empty.

{{#if: test string | value if test string is not empty | value if test string is empty (or only white space) }}
{{#if: first parameter | second parameter | third parameter }}

This function first tests whether the first parameter is not empty. If the first parameter is not empty the function displays the second argument. If the first parameter is empty or contains only whitespace characters (spaces, newlines, etc.) it displays the third argument.

{{#if: | yes | no}}no
{{#if: string | yes | no}}yes
{{#if:      | yes | no}}no
{{#if:


| yes | no}}
no

The test string is always interpreted as pure text, so mathematical expressions are not evaluated:

{{#if: 1==2 | yes | no }}yes
{{#if: 0 | yes | no }}yes

Either or both the return values may be omitted:

{{#if: foo | yes }}yes
{{#if: | yes }}
{{#if: foo | | no}}

The function may be nested. To do so, nest the inner #if function in its full form in place of the third parameter of the enclosing #if function. A depth of at least seven levels of nesting is possible, although that may depend on the wiki or a memory limit.

  • Example: {{#if: test string | value if test string is not empty | {{#if: test string | value if test string is not empty | value if test string is empty (or only white space) }} }}

See Help:Parser functions in templates for more examples of this parser function.

#ifeq

This parser function compares two strings and determines whether they are identical.

{{#ifeq: string 1 | string 2 | value if identical | value if different }}

If both strings are valid numerical values, the strings are compared numerically:

{{#ifeq: 01 | 1 | equal | not equal}}equal
{{#ifeq: 0 | -0 | equal | not equal}}equal
{{#ifeq: 1e3 | 1000 | equal | not equal}}equal
{{#ifeq: {{#expr:10^3}} | 1000 | equal | not equal}}equal

Otherwise the comparison is made as text; this comparison is case sensitive:

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (compare to similar example above, without the quotes)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (compare to similar example above, with #expr)

As a practical example, given an existing template Template:Size used to set standard short and long sizes, defined as:

{{#ifeq: {{{1|}}} | short | 20 | 40}}

the following ensue:

{{size|short}}20
{{size|20}}40
{{size}}40
Warning Warning: Numerical comparisons with #ifeq and #switch are not equivalent to comparisons with #expr:
{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

because PHP compares two numbers of type integer, whereas:

{{#ifexpr: 12345678901234567 = 12345678901234568 | equal | not equal}}equal

because MediaWiki converts literal numbers in expressions to type float, which, for large integers like these, involves rounding.

Warning Warning: Content inside parser tags (such as <nowiki>) is temporarily replaced by a unique code. This affects comparisons:
{{#ifeq: <nowiki>foo</nowiki> | <nowiki>foo</nowiki> | equal | not equal}}not equal
{{#ifeq: <math>foo</math> | <math>foo</math> | equal | not equal}}not equal
{{#ifeq: {{#tag:math|foo}} | {{#tag:math|foo}} | equal | not equal}}not equal
{{#ifeq: [[foo]] | [[foo]] | equal | not equal}}equal

If the strings to be compared are given as equal calls to the same template containing such tags, then the condition is true, but in the case of two templates with identical content containing such tags it is false.

#iferror

Diese Funktion überprüft, ob der eingegebene Ausdruck einen Fehler erzeugt. Die Funktion gibt true aus, wenn der Ausdruck ein HTML-Objekt mit class="error" enthält, wie es z.B. von den Funktionen #expr, #time und #rel2abs bei Fehlern ausgegeben wird. Auch Vorlagenfehler wie Rekursionsschleifen werden erkannt.

{{#iferror: test string | value if error | value if correct }}

Die Ausgabe-Parameter können auch weggelassen werden. Wenn der Parameter für "kein Fehler" weggelassen wird, wird der zu überprüfende Ausdruck ausgegeben, sofern er keinen Fehler enthält. Wenn der Ausdruck für "Fehler" ebenfalls weggelassen wird, wird bei einem Fehler nichts ausgegeben.

{{#iferror: {{#expr: 1 + 2 }} | error | correct }}correct
{{#iferror: {{#expr: 1 + X }} | error | correct }}error
{{#iferror: {{#expr: 1 + 2 }} | error }}3
{{#iferror: {{#expr: 1 + X }} | error }}error
{{#iferror: {{#expr: 1 + 2 }} }}3
{{#iferror: {{#expr: 1 + X }} }}
{{#iferror: <strong class="error">a</strong> | error | correct }}error

#ifexpr

Diese Funktion berechnet einen mathematischen Ausdruck und gibt – abhängig vom Wahrheitswert des Ergebnisses – einen von zwei Werten aus.

{{#ifexpr: expression | value if true | value if false }}

Für den Ausdruck gelten dabei dieselben Regeln wie bei #expr. Nach der Berechnung überprüft die Funktion, ob das Ergebnis ungleich Null ist.

Eine leere Eingabe führt zur Ausgabe false:

{{#ifexpr: | yes | no}}no

Wie gesagt führt das Ergebnis Null zur Ausgabe false, jeder andere Wert hingegen zur Ausgabe true. Es handelt sich also praktisch um eine Kombination von #ifeq und #expr:

{{#ifeq: {{#expr: expression }} | 0 | value if false | value if true }}

except for an empty or wrong input expression (an error message is treated as an empty string; it is not equal to zero, so we get value if true).

{{#ifexpr: = | yes | no }}Expression error: Unexpected = operator.

comparing

{{#ifeq: {{#expr: = }} | 0 | no | yes }}yes

Die Parameter können auch weggelassen werden, in diesem Fall wird nichts ausgegeben:

{{#ifexpr: 1 > 0 | yes }}yes
{{#ifexpr: 1 < 0 | yes }}
{{#ifexpr: 0 = 0 | yes }}yes
{{#ifexpr: 1 > 0 | | no}}
{{#ifexpr: 1 < 0 | | no}}no
{{#ifexpr: 1 > 0 }}
If you want to do calculations based on dates (If current date and time is after some other date and time), first convert the time to number of seconds after January 1, 1970 using {{#time: U }}, then you can simply add and subtract dates.

#ifexist

Diese Funktion überprüft, ob eine bestimmte Seite im Wiki existiert, und gibt je nachdem einen von zwei Parametern aus.

{{#ifexist: page title | value if exists | value if doesn't exist }}

Die Funktion überprüft nur, ob die Seite existiert, und nicht, ob sie irgendeine Form von Inhalt enthält. Auch Weiterleitungen werden als existente Seiten gewertet. Gelöschte Seiten gelten als nicht existent.

{{#ifexist: Help:Extension:ParserFunctions/de | exists | doesn't exist }}exists
{{#ifexist: XXHelp:Extension:ParserFunctions/deXX | exists | doesn't exist }}doesn't exist

MediaWiki-Systemnachrichten gelten so lange als nicht existent, bis sie bearbeitet werden. Auch die Existenz von Spezialseiten kann überprüft werden.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (weil die Erweiterung CheckUser in diesem Wiki installiert ist)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (weil MediaWiki:Copyright bearbeitet wurde)

Wenn eine Seite A die Existenz einer Seite B mittels #ifexist: überprüft, taucht Seite A auf der Spezialseite Links auf diese Seite für Seite B auf. Wenn also im Artikel Bla der Code {{#ifexist: Blubb}} steht, wird auf Spezial:Linkliste/Blubb die Seite Bla aufgelistet.

In Wikis, die eine gemeinschaftliche Bilddatenbank nutzen (z.B. Wikimedia Commons), kann #ifexist: benutzt werden, um zu überprüfen, ob Dateien im lokalen Wiki oder in der externen Bilddatenbank hochgeladen wurden.

{{#ifexist: File:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Image:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Media:Example.png | exists | doesn't exist }}exists

Wenn die lokale Bildbeschreibungsseite angelegt wurde, ist das Resultat für all diese Tests existiert.

#ifexist: does not work with interwiki links.

ifexist limits

#ifexist: is considered an "expensive parser function"; only a limited number of which can be included on any one page (including functions inside transcluded templates). When this limit is exceeded, any further #ifexist: functions automatically return false, whether the target page exists or not, and the page is categorized into Category:Pages with too many expensive parser function calls. The name of the tracking category may vary depending on the content language of your wiki.

For some use cases it is possible to emulate the ifexist effect with css, by using the selectors a.new (to select links to unexisting pages) or a:not(.new) (to select links to existing pages). Furthermore, since the number of expensive parser functions that can be used on a single page is controlled by $wgExpensiveParserFunctionLimit, one can also increase the limit in LocalSettings.php if needed.

#rel2abs

This function converts a relative file path into an absolute filepath.

{{#rel2abs: path }}
{{#rel2abs: path | base path }}

Within the path input, the following syntax is valid:

  • . → the current level
  • .. → "go up one level"
  • /foo → "go down one level into the subdirectory /foo"

If the base path is not specified, the full page name of the page will be used instead:

{{#rel2abs: /quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ./quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ../quok | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../. | Help:Foo/bar/baz }}Help:Foo/bar

Invalid syntax, such as /. or /./, is ignored. Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:

{{#rel2abs: ../quok/. | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../../quok | Help:Foo/bar/baz }}Help:Foo/quok
{{#rel2abs: ../../../quok | Help:Foo/bar/baz }}quok
{{#rel2abs: ../../../../quok | Help:Foo/bar/baz }}Error: Invalid depth in path: "Help:Foo/bar/baz/../../../../quok" (tried to access a node above the root node).

#switch

This function compares one input value against several test cases, returning an associated string if a match is found.

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | default result
}}

Example:

{{#switch: baz | foo = Foo | baz = Baz | Bar }}Baz

#switch allows an editor to add information in one template and this information will be visible in several other templates which all have different formatting.

Default

The default result is returned if no case string matches the comparison string:

{{#switch: test | foo = Foo | baz = Baz | Bar }}Bar

In this syntax, the default result must be the last parameter and must not contain a raw equals sign.

{{#switch: test | Bar | foo = Foo | baz = Baz }} →
{{#switch: test | foo = Foo | baz = Baz | B=ar }} →

Alternatively, the default result may be explicitly declared with a case string of "#default".

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | #default = default result
}}

Default results declared in this way may be placed anywhere within the function:

{{#switch: test | foo = Foo | #default = Bar | baz = Baz }}Bar

If the default parameter is omitted and no match is made, no result is returned:

{{#switch: test | foo = Foo | baz = Baz }}

Grouping results

It is possible to have 'fall through' values, where several case strings return the same result string. This minimizes duplication.

{{#switch: comparison string
 | case1 = result1
 | case2 
 | case3 
 | case4 = result2
 | case5 = result3
 | case6 
 | case7 = result4
 | #default = default result
}}

Here cases 2, 3 and 4 all return result2; cases 6 and 7 both return result4

Comparison behavior

As with #ifeq, the comparison is made numerically if both the comparison string and the case string being tested are numeric; or as a case-sensitive string otherwise:

{{#switch: 0 + 1 | 1 = one | 2 = two | three}} → three
{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}} → one
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

A case string may be empty:

{{#switch: | = Nothing | foo = Foo | Something }}Nothing

Once a match is found, subsequent cases are ignored:

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
Warning Warning: Numerical comparisons with #switch and #ifeq are not equivalent with comparisons in expressions (see also above):
{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

Raw equal signs

"Case" strings cannot contain raw equals signs. To work around this, create a template {{=}} containing a single equals sign: =.

Example:

{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1&#61;2 = html
 | 1{{=}}2 = template
 | default
}}template

Note Note: For a simple real life example of the use of this function, check Template:NBA color. Two complex examples can be found at Template:Extension and Template:BOTREQ.

Replacing #ifeq

#switch can be used to reduce expansion depth.

For example:

  • {{#switch:{{{1}}} |condition1=branch1 |condition2=branch2 |condition3=branch3 |branch4}}

is equivalent to

  • {{#ifeq:{{{1}}}|condition1 |branch1 |{{#ifeq:{{{1}}}|condition2 |branch2 |{{#ifeq:{{{1}}}|condition3 |branch3 |branch4}}}}}}
(i.e. {{#ifeq:{{{1}}}|condition1 |<!--then-->branch1 |<!--else-->{{#ifeq:{{{1}}}|condition2 |<!--then-->branch2 |<!--else-->{{#ifeq:{{{1}}}|condition3 |<!--then-->branch3 |<!--else-->branch4}}}}}})

#time

Code Description Current output
(Purge this page's cache to update)
Year
Y 4-digit year. 2014
y 2-digit year. 14
L 1 if it's a leap year, 0 if not. 0
o ¹ ISO-8601 year of the specified week. ² 2014 ³

¹ Requires PHP 5.1.0 and newer and rev:45208.
² This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead.
³ Will output literal o if ¹ not fulfilled.

Month
n Month index, not zero-padded. 4
m Month index, zero-padded. 04
M An abbreviation of the month name, in the site language. Apr.
F The full month name in the site language. April
xg Output the full month name in the genitive form for site languages that distinguish between genitive and nominative forms. For Polish:

(nominative)

{{#time:d F Y|20 June 2010|pl}} → 20 czerwiec 2010

(genitive)

{{#time:d xg Y|20 June 2010|pl}} → 20 czerwca 2010

Week
W ISO 8601 week number, zero-padded. 17
Day
j Day of the month, not zero-padded. 25
d Day of the month, zero-padded. 25
z Day of the year (January 1 = 0).
Note Note: To get the ISO day of the year add 1.
114
D An abbreviation for the day of the week. Rarely internationalized. Fr
l The full weekday name. Rarely internationalized. Freitag
N ISO 8601 day of the week (Monday = 1, Sunday = 7). 5
w Number of the day of the week (Sunday = 0, Saturday = 6). 5
Hour
a "am" during the morning (00:00:00 → 11:59:59), "pm" otherwise (12:00:00 → 23:59:59). am
A Uppercase version of a above. AM
g Hour in 12-hour format, not zero-padded. 2
h Hour in 12-hour format, zero-padded. 02
G Hour in 24-hour format, not zero-padded. 2
H Hour in 24-hour format, zero-padded. 02
Minutes and seconds
i Minutes past the hour, zero-padded. 26
s Seconds past the minute, zero-padded. 34
U Seconds since January 1 1970 00:00:00 GMT. 1398392794
Timezone (as of 1.22wmf2)
e Timezone identifier. UTC
I Whether or not the date is in daylight savings time. 0
O Difference to Greenwich time (GMT) +0000
P Difference to Greenwich time (GMT), with colon +00:00
T Timezone abbreviation. UTC
Z Timezone offset in seconds. 0
Miscellaneous
t Number of days in the current month. 30
c ISO 8601 formatted date, equivalent to Y-m-dTH:i:s+00:00. 2014-04-25T02:26:34+00:00
r RFC 5322 formatted date, equivalent to D, j M Y H:i:s +0000, with weekday name and month name not internationalized. Fri, 25 Apr 2014 02:26:34 +0000
Non-Gregorian calendars
Islamic
xmj Day of the month. 24
xmF Full month name. Dschumada th-thaniyya
xmn Month index. 6
xmY Full year. 1435
Iranian (Jalaly)
xij Day of the month. 5
xiF Full month name. Ordibehesht
xin Month index. 2
xiY Full year. 1393
xiy 2-digit year. 93
Hebrew
xjj Day of the month. 25
xjF Full month name. Nisan
xjt Number of days in month. 30
xjx Genitive form of the month name. Nisan
xjn Month number. 7
xjY Full year. 5774
Thai solar
xkY Full year. 2557
Minguo/Juche year
xoY Full year. 103
Japanese nengo
xtY Full year. 平成26
Flags
xn Format the next numeric code as a raw ASCII number. In the Hindi language, {{#time:H, xnH}} produces ०६, 06.
xN Like xn, but as a toggled flag, which endures until the end of the string or until the next appearance of xN in the string.
xr Format the next number as a roman numeral. Only works for numbers up to 10,000
(upto 3,000 in pre MediaWiki 1.20).
{{#time:xrY}} → MMXIV
xh Format the next number as a Hebrew numeral. {{#time:xhY}} → ב'י"ד

This parser function takes a date and/or time (in the Gregorian calendar) and formats it according to the syntax given. A date/time object can be specified; the default is the value of the magic word {{CURRENTTIMESTAMP}} – that is, the time the page was last rendered into HTML.

{{#time: format string }}
{{#time: format string | date/time object }}
{{#time: format string | date/time object | language code }}

The list of accepted formatting codes is given in the table to the right. Any character in the formatting string that is not recognized is passed through unaltered; this applies also to blank spaces (the system does not need them for interpreting the codes). There are also two ways to escape characters within the formatting string:

  1. A backslash followed by a formatting character is interpreted as a single literal character
  2. Characters enclosed in double quotes are considered literal characters, and the quotes are removed.

In addition, the digraph xx is interpreted as a single literal "x".

{{#time: Y-m-d }}2014-04-25
{{#time: [[Y]] m d }}2014 04 25
{{#time: [[Y (year)]] }}2014 (14UTCamFri, 25 Apr 2014 02:26:34 +0000)
{{#time: [[Y "(year)"]] }}2014 (year)
{{#time: i's" }}26'34"

The date/time object can be in any format accepted by PHP's strtotime() function. Both absolute (eg 20 December 2000) and relative (eg +20 hours) times are accepted.

{{#time: r|now}}Fri, 25 Apr 2014 02:26:34 +0000
{{#time: r|+2 hours}}Fri, 25 Apr 2014 04:26:34 +0000
{{#time: r|now + 2 hours}}Fri, 25 Apr 2014 04:26:34 +0000

The language code in ISO 639-3 (?) allows the string to be displayed in the chosen language {{#time:d F Y|1988-02-28|nl}}28 februari 1988
{{#time:l|now|uk}}п'ятниця
{{#time:d xg Y|20 June 2010|pl}}20 czerwca 2010

If you've calculated a Unix timestamp, you may use it in date calculations by pre-pending an @ symbol.

{{#time: U | now }}1398392794
{{#time: r|@1398392794}}Fri, 25 Apr 2014 02:26:34 +0000

Warning Warning: The range of acceptable input is 1 January 0111 → 31 December 9999. For the years 100 through 110 the output is inconsistent, Y and leap years are like the years 100-110, r, D, l and U are like interpreting these years as 2000-2010.

{{#time: d F Y | 29 Feb 0100 }}01 März 0100
(correct, no leap year), but
{{#time: r | 29 Feb 0100 }}Tue, 01 Mar 0100 00:00:00 +0000 (wrong, even if 100 is interpreted as 2000, because that is a leap year)
{{#time: d F Y | 15 April 10000 }}Error: Invalid time.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

Year numbers 0-99 are interpreted as 2000-2069 and 1970-1999, even when written with leading zeros:
{{#time: d F Y | 1 Jan 0069 }}01 Januar 0069

{{#time: d F Y | 1 Jan 0070 }}01 Januar 0070

The weekday is supplied for the years 100-110 and from 1753, for the years 111-1752 the r-output shows "Unknown" and the l-output "<>". As a consequence, the r-output is not accepted as input for these years.

Full or partial absolute dates can be specified; the function will "fill in" parts of the date that are not specified using the current values:

{{#time: Y | January 1 }}2014
Warning Warning: The fill-in feature is not consistent; some parts are filled in using the current values, others are not:

{{#time: Y m d H:i:s | June }}2014 06 25 00:00:00 Gives the start of the day, but the current day of the month and the current year. {{#time: Y m d H:i:s | 2003 }}2003 04 25 00:00:00 Gives the start of the day, but the current day of the year.

With MediaWiki r86805 - Code Review, a four-digit number is always interpreted as a year, never as hours and minutes:
{{#time: Y m d H:i:s | 1959 }}1959 04 25 00:00:00

A six-digit number is interpreted as hours, minutes and seconds if possible, but otherwise as an error (not, for instance, a year and month):
{{#time: Y m d H:i:s | 195909 }}2014 04 25 19:59:09 Input is treated as a time rather than a year+month code.
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:

{{#time: d F Y | January 0 2008 }}31 Dezember 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 Februar
{{#time: d F | February 29 2007 }}01 März
{{#time:Y-F|now -1 months}}2014-März

The total length of the format strings of the calls of #time is limited to 6000 characters [1].

Time Zone issue

There is a bug in this #time parser function (more specifically in PHP DateTime) that does not allow the passing-in of non-integers as relative time zone offsets. This issue does not apply when using an on-the-hour time zone, such as EDT. For example:

  • {{#time:g:i A | -4 hours }} ==> 10:26 PM

However, Venezuela is on a -4.5 hours time offset from UTC, and thus using its time zone will not normally allow the correct calculation of a relative time zone offset. Here's what happens:

  • {{#time:g:i A | -4.5 hours }} ==> 11:26 AM

To workaround this issue, simply convert the time into minutes or seconds, like this:

  • {{#time:g:i A | -270 minutes }} ==> 9:56 PM
  • {{#time:g:i A | -16200 seconds }} ==> 9:56 PM

(Tim Starling, the developer of this function, provided the exact syntax for this solution.)


#timel

This function is identical to {{#time: ... }}, except that it uses the local time of the wiki (as set in $wgLocaltimezone) when no date is given.

{{#time: Y-m-d }}2014-04-25
{{#timel: Y-m-d }}2014-04-25
{{#time: Y F d h:i:s}}2014 April 25 02:26:34
{{#timel: Y F d h:i:s}}2014 April 25 02:26:34

#titleparts

This function separates a pagetitle into segments based on slashes, then returns some of those segments as output.

{{#titleparts: pagename | number of segments to return | first segment to return }}

If the number of segments parameter is not specified, it defaults to "0", which returns all the segments from first segment (included). If the first segment parameter is not specified or is "0", it defaults to "1":

{{#titleparts: Talk:Foo/bar/baz/quok }}Talk:Foo/bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}Talk:Foo
{{#titleparts: Talk:Foo/bar/baz/quok | 2 }}Talk:Foo/bar
{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 2 }}bar/baz
{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}bar/baz/quok

Negative values are accepted for both values. Negative values for number of segments effectively 'strips' segments from the end of the string. Negative values for first segment translates to "start with this segment counting from the right":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Strips one segment from the end of the string. See also {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }}Strips all 4 segments from the end of the string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }}Strips 5 segments from the end of the string (more than exist)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }}quok Returns last segment. See also {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }}bar/baz Strips one segment from the end of the string, then returns the second segment and beyond
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }}baz Start copying at the second last element; strip one segment from the end of the string

The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:

{{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee | 1 | 25 }}y/z/aa/bb/cc/dd/ee

If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:

{{#titleparts: {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee| 1 | 25 }} | 1 | 2}}z

Warning Warning: You can use #titleparts as a small "string parser & converter", but consider that it returns the first substring capitalized.

{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two
  • If lower case is needed, use lc: function to control output.
{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one
  • You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use |2 instead of |1 for first segment to return.
{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One

Warning Warning: Certain characters that are illegal in a page title will cause #titleparts to not parse the string.

{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Does not produce the expected: {one

Warning Warning:

{{#titleparts: [[page]]/123 | 1 | 2 }}page/123

Warning Warning: This function does not degrade gracefully if your input exceeds 255 characters. If the inputted string is 256 characters long or more, this function will simply toss the string back at you.

General points

Substitution

Parser functions can be substituted by prefixing the hash character with subst::

{{subst:#ifexist: Help:Extension:ParserFunctions/de | [[Help:Extension:ParserFunctions/de]] | Help:Extension:ParserFunctions/de }} → the code [[Help:Extension:ParserFunctions/de]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/de exists.
Warning Warning: The results of substituted parser functions are undefined if the expressions contain unsubstituted volatile code such as variables or other parser functions. For consistent results, all the volatile code in the expression to be evaluated must be substituted. See Help:Substitution.

Redirects

Especially {{#time:…|now-…}} could be handy in redirects to pages including dates, but this does not work.

Escaping pipe characters in tables

Parser functions will mangle wikitable syntax and pipe characters (|), treating all the raw pipe characters as parameter dividers. To avoid this, most wikis create the template Template:! with its contents only a raw pipe character (|). This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

You can also escape the pipe character for display as a plain, uninterpreted character using an HTML entity: &#124; .

Description You type You get
Escaping pipe character as table row/column separator (most wikis)
{{!}}
|
Escaping pipe character as a plain character
&#124;
|


Stripping whitespace

Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, comparison of strings can be done after putting them in quotation marks.

{{#ifeq: foo            |            foo | equal | not equal }}
equal
{{#ifeq: "foo           " | "           foo" | equal | not equal }}
not equal

For preventing trimming then- and else-parts, see m:Template:If.

See also

Sprache: English  • български • বাংলা • Deutsch • Zazaki • español • français • 日本語 • मराठी • polski • português • português do Brasil • русский • svenska • ไทย • Türkçe
This page is a translated version of a page Help:Extension:ParserFunctions and the translation is 14% complete.