Help:Extension:ParserFunctions/fr

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 40% complete.

Other languages:
العربية • ‎български • ‎বাংলা • ‎català • ‎Deutsch • ‎Zazaki • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎galego • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎मराठी • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎русский • ‎svenska • ‎தமிழ் • ‎ไทย • ‎Türkçe • ‎Tiếng Việt • ‎中文

The ParserFunctions extension provides eleven additional parser functions to supplement the "magic words", which are already present in MediaWiki. (It may be configured to provide additional parser functions for string handling; these string functions are documented elsewhere.) All the parser functions provided by this extension take the form:

{{#nom_de_la_fonction: argument 1 | argument 2 | argument 3 ... }}

#expr

Type Opérateurs
Regroupement (parenthèses) ( )
Nombres 1234.5   e (2.718)   pi (3.142)
Opérateur binaire e   Opérateurs unaires +,-
Unaires not ceil trunc floor abs exp ln sin cos tan acos asin atan
Binaires ^
* / div mod
+ -
Arrondi round
Logiques = != <> > < >= <=
and
or

La fonction #expr: évalue une expression mathématique, et retourne la valeur calculée.

{{#expr: expression }}

Les opérateurs utilisables dans les calculs avec #expr: sont listés ci-contre, par ordre de précédence. Voir Help:Calculation pour plus de détails sur un opérateur. La précision et le format du résultat retourné dépendent du système d'exploitation du serveur sur lequel est installé le Wiki, ainsi que du format de nombre du langage du site.

Dans un calcul booléen, zéro équivaut à false et toute autre valeur différente de zéro (positive ou négative) équivaut à un true :

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

S'il n'y a aucune expression en entrée (ou une expression vide), la fonction retournera une chaîne vide. Toute expression invalide retournera le message d'erreur correspondant, que l'on peut capturer avec la fonction #iferror :

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

L'ordre des opérandes d'additions et soustractions avant ou après un nombre est important, un signe mal placé peut ne pas être considéré comme une erreur mais comme l'indicateur que le nombre est positif ou négatif :

{{#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 3 108 917, where we want 3108917, which can be obtained using {{formatnum:{{NUMBEROFUSERS}}|R}}. This is especially important in some languages, where numerals are translated. For example, in Bengali, {{NUMBEROFUSERS}} produces ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}}Expression error: Unrecognized punctuation character "�".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}3109017
Avertissement Avertissement: L'opérateur mod donne de mauvais résultats pour certaines valeurs du deuxième argument :
{{#expr: 123 mod (2^64-1)}}Division by zero. (produit une chaîne vide ; devrait être 123)
Si vous voulez faire des calculs basés sur des dates (p. ex. tester si la date actuelle est postérieure à une date déterminée), convertissez en premier lieu la date et l'heure en nombre de secondes depuis le 1er janvier 1970 en utilisant {{#time: xNU }} ; ensuite vous pourrez simplement ajouter et soustraire des dates comme des nombres.

Arrondir

Rounds arrondit le nombre à sa gauche en un multiple d'une puissance de 1/10, l'exposant étant égal à la valeur tronquée du nombre donné à sa droite.

Pour arrondir au supérieur ou à l'inférieur, utilisez respectivement les opérateurs unaires ceil et floor.

Exemple de test Résultat Méthode d'arrondi
{{#expr: 1/3 round 5 }} 0.33333 Le chiffre final est < 5, pas d'arrondi apparent
{{#expr: 1/6 round 5 }} 0.16667 Le chiffre final est >= 5, arrondi vers le haut
{{#expr: 8.99999/9 round 5 }} 1 De nouveau, le résultat est arrondi vers le haut sur le dernier chiffre, ce qui se traduit par un arrondi supplémentaire
{{#expr: 1234.5678 round -2 }} 1200 Arrondi aux 100 les plus proches car les valeurs négatives de l'exposant appliquent l'arrondi à la gauche de la virgule décimale
{{#expr: 1234.5678 round 2 }} 1234.57 Arrondi aux 1/100 les plus proches car les valeurs positives de l'exposant appliquent l'arrondi à la droite de la virgule décimale
{{#expr: 1234.5678 round 2.3 }} 1234.57 Des décimales dans l'ordre d'arrondi ne donnent aucune différence dans le résultat
{{#expr: trunc 1234.5678 }} 1234 Partie décimale tronquée
Arrondi à l'entier le plus proche
{{#expr: 1/3 round 0 }} 0 Arrondi à l'entier le plus proche, qui est zéro
{{#expr: 1/2 round 0 }} 1 Arrondi vers le haut vers l'entier le plus proche, qui est un
{{#expr: 3/4 round 0 }} 1 Arrondi vers le haut vers l'entier le plus proche, qui est un
{{#expr: -1/3 round 0 }} 0 Arrondi vers le haut vers l'entier le plus proche, qui est zéro
{{#expr: -1/2 round 0 }} -1 Arrondi vers le bas vers l'entier le plus proche, qui est moins un
{{#expr: -3/4 round 0 }} -1 Arrondi vers le bas vers l'entier le plus proche, qui est moins un
Arrondi vers le haut et le bas par ceil et floor
{{#expr: ceil(1/3) }} 1 Arrondi vers le haut vers l'entier le plus proche, qui est un
{{#expr: floor(1/3) }} 0 Arrondi vers le bas vers l'entier le plus proche, qui est zéro
{{#expr: ceil(-1/3) }} 0 Arrondi vers le haut vers l'entier le plus proche, qui est zéro
{{#expr: floor(-1/3) }} -1 Arrondi vers le bas vers l'entier le plus proche, qui est moins un
{{#expr: ceil 1/3 }} 0.33333333333333 Pas arrondi car 1 est déjà un entier
Avertissement Avertissement: Interprété comme (ceil 1)/3, pas ceil(1/3) comme vous auriez pu le penser

#if

La fonction #if: évalue une chaîne de test et détermine si elle est vide ou non. Une chaîne de test contenant seulement des espaces est considérée comme vide.

{{#if: chaîne test | valeur si la chaîne test n'est pas vide | valeur si la chaîne test est vide (ou contient seulement des espaces) }}
{{#if: premier paramètre | deuxième paramètre | troisième paramètre }}

La fonction #if: teste d'abord si le premier paramètre n'est pas vide. S'il n'est pas vide, la fonction affiche le deuxième paramètre. Si le premier paramètre est vide ou ne contient que des caractères d'espacement (espaces, retour à la ligne, etc...), elle affiche le troisième paramètre.

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


| yes | no}}
no

La chaîne test est toujours interprétée comme du texte pur, ainsi les expressions mathématiques ne sont pas évaluées :

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

Le dernier paramètre (false) peut être omis

{{#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 a 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) }} }}

You can also use a parameter as the test string in your #if statement. You need to ensure you add the | (pipe symbol) after the name of the variable.

  • Example {{#if:{{{1|}}}|You entered text in variable 1|There is no text in variable 1}}

Voir Help:Parser functions in templates pour plus d'exemples de cette fonction.

#ifeq

La fonction #ifeq: compare deux chaînes de caractères et détermine si elles sont identiques.

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

Si les deux chaînes sont des valeurs numériques valides, les chaînes sont comparées numériquement :

{{#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


Sinon la comparaison s'effectue comme du texte ; cette comparaison est sensible à la casse :

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (comparer à l'exemple similaire ci-dessus, sans les quotes)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (comparer à l'exemple similaire ci-dessus, avec #expr)

Comme exemple pratique, étant donné un template existant Template:Size utilisé pour définir des tailles standards courte et longue, défini ainsi :

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

il en résulte ce qui suit :

{{size|short}}20
{{size|20}}40
{{size}}40
Avertissement Avertissement: Les comparaisons numériques par #ifeq et #switch ne sont pas équivalentes aux comparaisons par #expr :
{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

parce que PHP compare deux nombres de type entier, alors que :

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

parce que MediaWiki convertit les nombres littéraux dans les expressions en type flottant, lequel, pour de grands entiers comme ceux-ci, implique un arrondi.

Avertissement Avertissement: Les tags et les fonctions du parseur à l'intérieur de tags du parseur (comme <nowiki>) sont temporairement remplacés par un code unique. Ceci affecte les comparaisons :
{{#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.

Avertissement Avertissement:

Be careful when comparing against the current page title using the page name magic words. These magic words convert special characters into numeric HTML entities. This may result in misleading results. For example, if you are on a page titled "L'Aquila"...

{{#ifeq: L'Aquila | {{FULLPAGENAME}} | equal | not equal}}not equal[dubious ]

NOTE: The above is actually wrong: Due to improvements, it will now return "equal". However, this can be important in some other cases; for example, {{FULLPAGENAME}}, depending on wiki, may capitalize the first letter, and will replace all underscores with spaces.

To work around this, apply the magic word to both parameters:

{{#ifeq: {{FULLPAGENAME: L'Aquila}} | {{FULLPAGENAME}} | equal | not equal}}equal

#iferror

This function takes an input string and returns one of two results; the function evaluates to true if the input string contains an HTML object with class="error", as generated by other parser functions such as #expr, #time and #rel2abs, template errors such as loops and recursions, and other "failsoft" parser errors.

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

L'une ou l'autre des chaînes de retour, ou les deux, peuvent être omises. Si la chaîne correct est omise, la chaîne test string est retournée si elle n'est pas erronée. Si la chaîne error est aussi omise, une chaîne vide est retournée en erreur :

{{#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: {{#expr: . }} | error | correct }}correct
{{#iferror: <strong class="error">a</strong> | error | correct }}error

#ifexpr

La fonction #ifexpr: évalue une expression mathématique, et retourne une des deux chaînes selon la valeur booléenne du résultat :

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

L' expression d'entrée est évaluée exactement comme pour #expr plus haut, avec les mêmes opérateurs disponibles. Le résultat est alors évalué comme expression booléenne.

Une expression vide en entrée s'évalue à false :

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

Comme mentionné plus haut, zéro est évalué à false et toute valeur non-zéro est évaluée à true, ainsi cette fonction est équivalente à cette autre utilisant seulement #ifeq et #expr :

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

sauf pour une expression d'entrée vide ou erronnée (un message d'erreur est traité comme une chaîne vide ; il n'est pas égal à zéro, donc on obtient value if true) :

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

à comparer à :

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

L'une ou l'autre des valeurs de retour peut être omise, ou les deux ; on n'a aucune sortie quand la branche appropriée est laissée vide :

{{#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 }}

#ifexist

La fonction #ifexist: prend une chaîne en entrée, l'interprète comme titre de page, et retourne une des deux valeurs selon que la page existe ou non sur le wiki local.

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

La fonction s'évalue à true si la page existe, qu'elle ait un contenu, ou qu'elle soit visiblement blanche (mais contenant des méta-données telles que des liens vers des catégories ou des mots magiques, mais aucun contenu visible), ou qu'elle soit complètement vide, ou qu'il s'agisse d'une redirection. Seules les pages en liens rouges s'évaluent à false, y compris si la page a existé autrefois mais a été supprimée.

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

La fonction s'évalue à true pour les system messages that have been customized, and for special pages that are defined by the software.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (car l'extension CheckUser est installée sur ce wiki)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (car le MediaWiki:Copyright a été personnalisé)

Si une page vérifie une page cible par #ifexist:, alors cette page apparaîtra dans la liste Special:WhatLinksHere de la page cible. Ainsi, si le code {{#ifexist:Foo}} était inclus et actif sur cette page (Help:Extension:ParserFunctions/fr), Special:WhatLinksHere/Foo listerait Help:Extension:ParserFunctions/fr.

Sur les wikis utilisant un dépôt de médias partagé, #ifexist: peut être utilisé pour vérifier si un fichier a été chargé dans ce dépôt, mais pas sur le wiki lui-même :

{{#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

Si une page de description locale a été créée pour le fichier, le résultat est exists for tous les cas ci-dessus.

#ifexist: ne fonctionne pas avec des liens interwiki.

limitations de ifexist

#ifexist: est considéré comme "fonction du parseur coûteuse" ; on ne peut en inclure qu'un nombre limité sur chaque page (en comptant les fonctions internes aux modèles transclus). Quand cette limite est dépassée, toutes les fonctions #ifexist: surnuméraires retourneront automatiquement false, que la page cible existe ou non, et la page est catégorisée dans Category:Pages with too many expensive parser function calls. Le nom de la catégorie de traçage peut dépendre de la langue du contenu de votre wiki.

Dans quelques cas, il est possible d'émuler l'effet de ifexist par css, avec les sélecteurs a.new (pour sélectionner les liens vers des pages inexistantes) ou a:not(.new) (pour sélectionner les liens vers des pages existantes). De plus, puisque le nombre de fonctions du parseur coûteuses utilisables sur une page est contrôlé par $wgExpensiveParserFunctionLimitManual:$wgExpensiveParserFunctionLimit, on peut aussi augmenter la limite dans LocalSettings.php si besoin.

#rel2abs

La fonction #rel2abs: convertit un chemin relatif de fichier en chemin absolu.

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

Dans le path en entrée, la syntaxe suivante est valide :

  • . → le niveau courant
  • .. → "remonter d'in niveau"
  • /foo → "descendre d'un niveau dans le sous-répertoire /foo"

Le nom complet de la page est utilisé par défaut si base path n'est pas spécifié.

{{#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

Cette fonction compare une donnée à une liste de valeur, et retourne le résultat associé à la valeur correspondante.

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

Exemples :

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

#switch with partial transclusion tags can effect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.

Valeurs par défaut

La fonction retourne le résultat par défaut (default result) si aucune des valeurs (case) ne correspond à la donnée à comparer (comparison string) :

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

Le résultat par défaut doit être le dernier paramètre et ne doit pas contenir de signe égal.

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

La valeur par défault peut aussi être explicitement déclaré par la chaine "#default =".

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

Dans ce cas la valeur par défaut peut être placer à n'importe quelle position :

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

Si aucune valeur par défaut n'est défini et qu'aucune valeur ne correspond à la donnée entrée, la fonction ne retourne rien :

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

Groupe de valeurs

Il est possible de regrouper plusieurs valeurs ayant un même résultat, et ainsi n'avoir à fournir qu'une fois ce résultat.

{{#switch: comparison string
 | case1 = result1
 | case2 
 | case3 
 | case4 = result234
 | case5 = result5
 | case6 
 | case7 = result67
 | #default = default result
}}

Here cases 2, 3 and 4 all return result234; cases 6 and 7 both return result67

Comparison behavior

Comme pour #ifeq, la comparaison est numérique si la donnée à comparer et la valeur sont numérique ; sinon c'est une comparaison de chaine sensible à la casse :

{{#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

Il est possible de comparer avec un valeur vide :

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

Si une correspondance est trouvé avec la donnée à comparer, les valeur suivantes sont ignorées :

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
Avertissement Avertissement: Les comparaisons numériques par #ifeq et #switch ne sont pas équivalentes aux comparaisons par $expr :
{{#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
}}html

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.

Par exemple :

  • {{#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)
Année
Y année sur 4 chiffres 2015
y année sur 2 chiffres 15
L 1 si c'est une année bisextile, 0 sinon. 0
o ¹ ISO-8601 year of the specified week. ² 2015 ³

¹ 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.

Mois
n Month index, not zero-padded. 8
m Month index, zero-padded. 08
M An abbreviation of the month name, in the site language. août
F The full month name in the site language. août
xg Output the full month name in the genitive form for site languages that distinguish between genitive and nominative forms. This option is useful for many Slavic languages like Polish, Russian, Belarusian, Czech, Slovak, Slovene, Ukrainian, etc. 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

Semaine
W ISO 8601 week number, zero-padded. 35
Jour
j Day of the month, not zero-padded. 28
d Day of the month, zero-padded. 28
z Day of the year (January 1 = 0).
Note Note: To get the ISO day of the year add 1.
239
D An abbreviation for the day of the week. Rarely internationalized. Ven.
l The full weekday name. Rarely internationalized. vendredi
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
Heure
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. 7
h Hour in 12-hour format, zero-padded. 07
G Hour in 24-hour format, not zero-padded. 7
H Hour in 24-hour format, zero-padded. 07
Minute et seconde
i Minutes past the hour, zero-padded. 44
s Seconds past the minute, zero-padded. 22
U Seconds since January 1 1970 00:00:00 GMT. 1440747862
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
Divers
t Number of days in the current month. 31
c ISO 8601 formatted date, equivalent to Y-m-d"T"H:i:s+00:00. 2015-08-28T07:44:22+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, 28 Aug 2015 07:44:22 +0000
Non-Gregorian calendars
Islamic
xmj Day of the month. 13
xmF Full month name. Dhou al qi’da
xmn Month index. 11
xmY Full year. 1436
Iranian (Jalaly)
xij Day of the month. 6
xiF Full month name. Shahrivar
xin Month index. 6
xiY Full year. 1394
xiy 2-digit year. 94
Hebrew
xjj Day of the month. 13
xjF Full month name. Éloul
xjt Number of days in month. 29
xjx Genitive form of the month name. Éloul
xjn Month number. 12
xjY Full year. 5775
Thai solar
xkY Full year in Thai solar calendar.
Note Note : For years before 1941 the dates in Jan-Mar range are not calculated properly.
2558
Minguo/Juche year
xoY Full year. 104
Japanese nengo
xtY Full year. 平成27
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}} → MMXV
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 }}2015-08-28
{{#time: [[Y]] m d }}2015 08 28
{{#time: [[Y (year)]] }}2015 (15UTCamFri, 28 Aug 2015 07:44:22 +0000)
{{#time: [[Y "(year)"]] }}2015 (year)
{{#time: i's" }}44'22"

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, 28 Aug 2015 07:44:22 +0000
{{#time: r|+2 hours}}Fri, 28 Aug 2015 09:44:22 +0000
{{#time: r|now + 2 hours}}Fri, 28 Aug 2015 09:44:22 +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 }}1440747862
{{#time: r|@1440747862}}Fri, 28 Aug 2015 07:44:22 +0000

Avertissement Avertissement: 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 mars 0100
(correct, no leap year), but
{{#time: r | 29 Feb 0100 }}Mon, 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, except when written in 4-digit format with leading zeros:
{{#time: d F Y | 1 Jan 6 }}01 janvier 2006
{{#time: d F Y | 1 Jan 06 }}01 janvier 2006
{{#time: d F Y | 1 Jan 006 }}01 janvier 2006
{{#time: d F Y | 1 Jan 0006 }}01 janvier 0006 (4-digit format)

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 }}2015
Avertissement Avertissement: 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 }}2015 06 28 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 08 28 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 08 28 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 }}2015 08 28 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 décembre 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 février
{{#time: d F | February 29 2007 }}01 mars
{{#time:Y-F|now -1 months}}2015-juillet

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 }} ==> 3:44 AM

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 }} ==> 4:44 PM

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

  • {{#time:g:i A | -270 minutes }} ==> 3:14 AM
  • {{#time:g:i A | -16200 seconds }} ==> 3:14 AM

(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 }}2015-08-28
{{#timel: Y-m-d }}2015-08-28
{{#time: Y F d H:i:s}}2015 août 28 07:44:22
{{#timel: Y F d H:i:s}}2015 août 28 07:44:22


#titleparts

This function separates a page title 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 to return parameter is not specified, it defaults to "0", which returns all the segments from the first segment to return (included). If the first segment to return 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 See also {{ROOTPAGENAMEHelp:Magic_words#Page_names}}.
{{#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 the number of segments to return parameter effectively 'strips' segments from the end of the string. Negative values for the first segment to return 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

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).

For example, any occurence of &quot;, &#34;, or &#x22; in pagename will be replaced by ".
No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.
Some magic keywords or parser functions of MediaWiki (such as {{PAGENAMEHelp:Magic words#Page names}} and similar) are known to return strings that are needlessly HTML-encoded, even if their own input parameter was not HTML-encoded:

The titleparts parser function can then be used as a workaround, to convert these returned strings so that they can be processed correctly by some other parser functions also taking a page name in parameter (such as {{PAGESINCAT:Help:Magic words#PAGESINCAT}} but which are still not working properly with HTML-encoded input strings.

For example, if the current page is Category:Côte-d'Or, then:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, and {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} are both returning 1; (the #ifeq parser function does perform the HTML-decoding of its input parameters).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, and {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} are both returning 1; (the #switch parser function does perform the HTML-decoding of its input parameters).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }}, or even {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} will all return 1 if that category page exists (the #ifexist parser function does perform the HTML-decoding of its input parameters);
  • {{PAGESINCAT: Côte-d'Or }} will return a non-zero number, if that category contains pages or subcategories, but:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, may still unconditionally return 0, just like:
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d&apos;Or}} }}

The reason of this unexpected behavior is that, with the current versions of Mediawiki, there are two caveats:

  • {{FULLPAGENAME}}, or even {{FULLPAGENAME|Côte-d'Or}} may return the actually HTML-encoded string Category:Côte-d&apos;Or and not the expected Category:Côte-d'Or, and that:
  • {{PAGESINCAT: Côte-d&apos;Or }} unconditionally returns 0 (the PAGESINCAT magic keyword does not perform any HTML-decoding of its input parameter).

The simple workaround using titleparts (which will continue to work if the two caveats are fixed in a later version of MediaWiki) is:

  • {{PAGESINCAT: {{titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{titleparts: {{PAGENAME|Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{titleparts: {{PAGENAME|Category:Côte-d&apos;Or}} }} }}, that all return the actual number of pages in the same category.

Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:

  1. All underscores are automatically replaced with spaces:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Not bah_boo, despite the underscore in the original.
  2. 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
  3. The list of substrings is not cleaned up hierarchically (unlike with the {{PAGENAMEHelp:Magic words#Page names}} magic keyword, the ./ and ../ relative path segments are left intact by #titleparts):
    {{#titleparts: ../c/d }}../c/d
    {{PAGENAME: ../c/d }} → '
  4. Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c
Avertissement Avertissement: You can use #titleparts as a small "string parser and 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
Avertissement Avertissement: 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
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Does not work because "#" is also illegal in page titles.
Avertissement Avertissement: 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/fr | [[Help:Extension:ParserFunctions/fr]] | Help:Extension:ParserFunctions/fr }} → the code [[Help:Extension:ParserFunctions/fr]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/fr exists.
Avertissement Avertissement: 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.

Substitution does not work within <ref></ref>Extension:Cite#Substitution and embedded parser functions, you can use {{subst:#tag:ref|}} for this purpose.

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 (|) or use the {{!}} magic word which is available since MW 1.24. 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
{{!}}
|
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. Some people use also <nowiki> </nowiki> instead of spaces.

foo{{#if:|| bar }}foofoobarfoo
foo{{#if:||<nowiki></nowiki> bar <nowiki></nowiki>}}foofoo bar foo

But this method allows the rendering of only one whitespace, since the parser reduces multiple spaces to a single one.

<span style="white-space: pre;">foo{{#if:||<nowiki></nowiki>      bar      <nowiki></nowiki>}}foo</span>foo bar foo

In this example, the white-space: pre style is used to force the whitespace to be preserved by the browser, but even with it the spaces are not shown. This happens because the spaces are stripped by the software, before being sent to the browser.

It is possible to workaround this behavior replacing whitespaces with &#32; (breakable space) or &nbsp; (non-breakable space), since they are not modified by the software:

<span style="white-space: pre;">foo{{#if:||&#32;&#32;&#32;bar&#32;&#32;&#32;}}foo</span>foo bar foo
foo{{#if:||&nbsp;&nbsp;&nbsp;bar&nbsp;&nbsp;&nbsp;}}foofoo   bar   foo

See also