Jump to content

Aide:Extension:Fonctions d'analyse

From mediawiki.org
This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 99% complete.

L'extension ParserFunctions fournit plusieurs fonctions d'analyse syntaxique qui viennent en complément des « mots magiques  » déjà intégrés dans MediaWiki. (Elle peut être configurée pour fournir des fonctions d'analyse supplémentaires pour la gestion des chaînes de caractères ; ces fonctions sur les chaînes sont documentées ici .) Toutes les fonctions d'analyse fournies par cette extension ont la syntaxe suivante :

{{#nom_de_la_fonction: argument 1 | argument 2 | argument 3 ... }}
PD Note : si vous modifiez cette page, vous acceptez de placer votre contribution sous licence CC0. Plus d’informations sont disponibles sur le projet Aide dans le domaine public. PD

#expr

Pour un manuel plus détaillé sur les points plus précis du fonctionnement de l'évaluateur d'expression, y compris certains opérateurs supplémentaires non couverts par le présent document, voir : Manual:Expr parser function syntax.
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 sqrt
Binaires ^
* / div mod fmod
+ -
Arrondi round
Logiques = != <> > < >= <=
and
or

Cette fonction évalue une expression mathématique, et renvoie la valeur calculée. Cette fonction est également disponible dans Scribunto au travers de la fonction mw.ext.ParserFunctions.expr .

{{#expr: expression }}

Basic example

{{#expr: 1 + 1 }}2

Les opérateurs disponibles sont listés à droite, par ordre de priorité. Voir Manual:Expr parser function syntax pour plus de détails sur la fonction de chaque opérateur. La précision et le format du résultat renvoyé varient en fonction du système d'exploitation du serveur qui exécute le wiki et du format des nombres dans la langue du site.

Lors de l'évaluation utilisant l'algèbre de Boole, zéro équivaut à false et toute autre valeur différente de zéro (positive ou négative) équivaut à 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 renverra une chaîne vide. Toute expression invalide causera le renvoi du message d'erreur correspondant, que l'on peut capturer avec la fonction #iferror :

{{#expr: }}
{{#expr: 1+ }}Expression error: Missing operand for +.
{{#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

Notez que si vous utilisez la sortie de mots magiques, vous devez les formater en brut afin de supprimer les virgules et de traduire les chiffres. Par exemple, {{NUMBEROFUSERS}} donne 18 021 423, où nous voulons 18021423, qui peuvent être obtenus en utilisant {{formatnum :{{NUMBEROFUSERS}}|R}}. Ceci est particulièrement important dans certaines langues, où les chiffres sont traduits. Par exemple, en Bengali, {{NUMBEROFUSERS}} produit ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} Expression error: Unrecognized punctuation character " ".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}18021523
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 les 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 (UTC) 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 (0.333333… → 0.33333)
{{#expr: 1/6 round 5 }} 0.16667 Le chiffre final est >= 5, arrondi vers le haut (0.166666… → 0.16667)
{{#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 (0.999998… → 1.00000 → 1)
{{#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 ou 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
Rounding large numbers
{{#expr: 1e-92 round 400 }} 1.0E-92 Rounding to a very large number leads to infinity. Hence, the original value without the infinity is given as the answer.
{{#expr: 1e108 round 200 }} 1.0E+108 Same as above.

Chaînes

Les expressions ne fonctionnent qu'avec des valeurs numériques, elles ne peuvent pas comparer des chaînes ou des caractères. #ifeq doit être utilisé dans ce cas.

{{#expr: "a" = "a" }}Expression error: Unrecognized punctuation character """.
{{#expr: a = a }}Expression error: Unrecognized word "a".
{{#ifeq: a | a | 1 | 0 }}1

#if

Cette fonction é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 de 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 }}

Cette fonction 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: &nbsp;&nbsp;&nbsp;&nbsp; | 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 (voir #ifexpr pour cela) :

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

La fonction peut être imbriquée. Pour cela, écrivez la fonction #if interne avec son code à la place d'un paramètre de la fonction #if englobante. Jusqu'à sept niveaux d'imbrication sont possibles, bien que cela puisse dépendre du wiki ou d'une limite de la mémoire.

{{#if:chaîne de test
|valeur si la chaîne de test n'est pas vide
|{{#if:chaîne de test
  |valeur quand la chaîne de test n'est pas vide
  |valeur si la chaîne de test est vide (ou contient seulement des espaces)
  }}
}}

Vous pouvez également utiliser un paramètre qui serait une chaîne testée dans un #if. Vous devez vous assurer d'ajouter le symbole | (barre verticale) après le nom de la variable. (De sorte que, si le paramètre n'a pas de valeur, l'évaluation rende une chaîne vide au lieu de la chaîne « {{{1}}} »).

{{#if:{{{1|}}}|Vous avez saisi du texte dans la variable 1|Il n'y a pas de texte dans la variable 1}}

Voir Aide:Fonctions d'analyse dans les modèles pour plus d'exemples de cette fonction d'analyseur.

#ifeq

Cette fonction d’analyse compare deux chaînes d'entrée, détermine si elles sont identiques et renvoie une chaîne en fonction du résultat. Si plus de comparaisons ou de chaînes de sortie sont nécessaires, envisagez d'utiliser #switch.

{{#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 guillemets (" ") )
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (comparer à l'exemple similaire ci-dessus, avec #expr renvoyant en premier un nombre valide)

Comme exemple concret, prenons le modèle existant Template:Timer qui utilise l'analyseur pour choisir entre deux formats de temps, un format court et un format long. Il compare le premier paramètre à la chaîne « courte » (il n'y a pas de convention pour l'ordre, mais c'est plus simple à lire si le paramètre est en premier). Voici le code du modèle :

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

il en résulte ce qui suit :

{{timer|short}}20
{{timer|20}}40
{{timer}}40
Avertissement Avertissement : Lorsqu'elles sont utilisées à l'intérieur d'une fonction d'analyse, les balises d'analyseur et autres fonctions d'analyseur doivent être temporairement remplacées par un code unique . Cela 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
Si les chaînes à comparer sont données comme des appels égaux au même modèle contenant de telles balises, alors la condition est vraie ; mais dans le cas de deux modèles avec un contenu identique et contenant de telles balises, la condition est fausse.
Avertissement Avertissement : La comparaison littérale avec des mots magiques de nom de page peut échouer en fonction de la configuration du site. Par exemple, {{FULLPAGENAME}}, en fonction du wiki, peut mettre la première lettre en majuscule, et remplacer tous les caractères '_' par des espaces.

Pour contourner ce problème, utilisez les mots magiques pour les deux paramètres :

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

#iferror

Cette fonction prend une chaîne en entrée et renvoie un des deux résultats : la fonction s'évalue à true si la chaîne d'entrée contient un objet HTML avec class="error", tel que généré par d'autres fonctions du parseur comme #expr, #time et #rel2abs, des erreurs de templates comme des boucles ou les récursions, et d'autres erreurs "douces" du parseur.

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

L'une ou les deux chaînes de retour peuvent être omises. Si la chaîne correct est omise, la chaîne test string est renvoyée si elle n'est pas fausse. Si la chaîne error est aussi omise, une chaîne vide est renvoyée sur une 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

Certaines erreurs peuvent entraîner l'ajout d'une catégorie de suivi, l'utilisation de {{#iferror:}} ne supprimera pas l'ajout de cette catégorie.

#ifexpr

Cette fonction évalue une expression mathématique, et renvoie une des deux chaînes selon la valeur booléenne du résultat :

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

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

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

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

Comme mentionné plus haut, zéro équivaut à false et toute autre valeur est évaluée à true, ainsi cette fonction est équivalente à une 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 erroné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, l'autre ou les deux valeurs de retour peuvent être omises; 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 }}

Les opérateurs booléens d'égalité ou les opérateurs d'inégalité sont pris en charge.

{{#ifexpr: 0 = 0 or 1 = 0 | yes}}yes
{{#ifexpr: 0 = 0 and 1 = 0 | | no}}no
{{#ifexpr: 2 > 0 or 1 < 0 | yes}}yes
{{#ifexpr: 2 > 0 and 1 > 0 | yes | no}}yes
Avertissement Avertissement : Le résultat de la comparaison numérique avec #ifexpr ne correspond pas toujours à celui de #ifeq et #switch. Ces deux derniers sont plus précis que #ifexpr, et ne renvoient pas forcément les mêmes résultats.

Soit les comparaisons suivantes, où seul le dernier chiffre est différent :

{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

Parce que PHP, utilisé dans #ifeq et #switch, compare deux nombres de type entier, il renvoie le bon résultat correctement. Mais avec #ifexpr et les mêmes nombres :

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

Puisqu’un chiffre diffère, le résultat qui indique une égalité se révèle incorrect.

Ce comportement de #ifexpr vient du fait que Mediawiki convertit les nombres littéraux en type flottant, ce qui pour des entiers très grands comme ceux-ci, implique un arrondi.

#ifexist

Voir Tester l'existence d'une page pour les autres méthodes permettant de savoir si une page existe avec différentes limitations

Cette fonction prend une chaîne en entrée, l'interprète comme un titre de page, et renvoie 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 rend true si la page existe, qu'elle ait un contenu, ou qu'elle soit visiblement vide (mais contenant des méta-données telles que des liens vers les 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 qui ont un liens en rouge sont évaluées à false, même si la page a existé autrefois et a été ensuite 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 messages système qui ont été personnalisés, et pour les pages spéciales définies par le logiciel.

{{#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 }}doesn't exist (car le MediaWiki:Copyright n'a pas é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 les codes {{#ifexist:Foo }} ont été inclus dynamiquement dans cette page (Help:Extension:ParserFunctions/fr), Special:WhatLinksHere/Foo listera Help:Extension:ParserFunctions/fr.

Sur les wikis utilisant un espace référentiel partagé de médias, #ifexist: peut être utilisé pour vérifier si un fichier a été téléversé dans cet espace, 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 en local une page de description a été créée pour le fichier (média), le résultat est exists pour tous les cas ci-dessus.

#ifexist: ne fonctionne pas avec des liens interwiki.

limitations de ifexist

#ifexist: est considéré comme une "fonction d'analyse 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 renverront automatiquement false, que la page cible existe ou non, et qu'elle soit catégorisée dans Category:Pages with too many expensive parser function calls. Le nom de la catégorie de suivi peut varier en fonction de la langue du contenu de votre wiki.

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

ifexist et les pages désirées

Un lien vers une page inexistante et qui est testée par #ifexist atterrira sur les Pages demandées. Voir tâche T14019 pour les raisons, et w:Template:Linkless exists pour une alternative.

#rel2abs

Cette fonction convertit un chemin relatif de fichier en chemin absolu.

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

Dans le paramètre path, la syntaxe suivante est valide :

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

Si base path n'est pas renseigné, le nom complet de la page sera utilisé à la place :

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

Une syntaxe invalide, telle que /. ou /./, sera ignorée. Étant donné que seuls deux full stops consécutifs sont autorisés, les séquences de ce type peuvent être utilisées pour séparer les éléments successifs :

{{#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 }}Erreur : profondeur invalide dans le chemin « Help:Foo/bar/baz/../../../../quok » (tentative d’accès à un nœud au-dessus du nœud racine).

Pour un groupe similaire de fonctions, voir aussi les Données d'URL. Les fonctions d'analyse embarquées comprennent : 'localurl:', 'fullurl:', 'anchorencode:' etc.

#switch

Voir aussi : w:Help:Switch parser function

Cette fonction compare une valeur d'entrée parmi plusieurs cas de test, et renvoie la chaîne associée si une correspondance est trouvée.

{{#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 avec des balises de transclusion partielle peuvent perturber un fichier de configuration qui autorise un éditeur qui n'est pas familier avec le codage des modèles à visualiser et éditer les éléments configurables.

Valeurs par défaut

Le résultat par défaut (default result) est renvoyé si aucune des chaînes (case) ne correspond à la donnée à comparer (comparison string) :

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

Dans cette syntaxe, le résultat par défaut doit être le dernier paramètre et ne doit pas contenir de signe égal brut (un signe égal sans {{}}). S'il en contient un, cela sera considéré comme un cas de comparaison, et aucun texte ne sera affiché si aucun cas ne correspond. Cela vient du fait que la valeur par défaut n’a pas été définie ou qu'elle est vide. Cependant si un cas correspond, la chaîne qui lui est associée sera renvoyée.

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

Par ailleurs, la valeur par défaut peut aussi être explicitement déclarée avec une chaîne de case valant "#default".

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

Les valeurs par défaut déclarées de cette manière peuvent être placées n'importe où dans la fonction :

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

Si le paramètre default est omis et qu'aucune valeur ne correspond à la donnée entrée, la fonction ne renvoie pas de result :

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

Regrouper les résultats

Il est possible d’avoir des valeurs « communes », où plusieurs chaînes case renvoient la même chaîne résultat. Cela minimise les doublons.

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

Ici les valeurs case2, case3 et case4 renvoient toutes result234 ; case6 et case7 renvoient toutes result67. Le « #default =  » du dernier paramètre peut être omis dans l’exemple ci-dessus.

Utiliser les paramètres

La fonction peut être utilisée avec des paramètres comme chaîne de test. Dans ce cas il n'est pas nécessaire de mettre la barre verticale '|' après le nom du paramètre car il est très rare que vous choisissiez d'initialiser un cas avec la chaîne « {{{parameter name}}} » . (C'est la valeur qui sera affectée au paramètre par défaut si la barre verticale '|' est absente et que le paramètre n'existe pas ou qu'il a une valeur. Voir Aide:Fonctions d'analyse dans les modèles .)

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

Dans le cas ci-dessus, si {{{1}}} vaut foo, la fonction renverra Foo. S'il vaut baz, la fonction renverra Baz. Si le paramètre est vide ou s'il n'existe pas, la fonction renverra Bar.

Comme dans la section ci-dessus, les cas peuvent être combinés pour donner un seul résultat.

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

Ici, si {{{1}}} vaut foo, zoo ou roo, la fonction renverra Foo. S'il vaut baz, la fonction renverra Baz. Si le paramètre est vide ou s'il n'existe pas, la fonction renverra Bar.

De plus, le résultat par défaut peut être omis si vous ne souhaitez pas renvoyer quelque chose lorsque la valeur du paramètre à tester correspond à aucun des cas.

{{#switch: {{{1}}} | foo = Foo | bar = Bar }}

Dans ce cas, la fonction renvoie une chaîne vide à moins que {{{1}}} existe et qu'il vaut foo ou bar, auquel cas elle renvoie respectivement Foo ou Bar.

Ceci a le même effet que si on déclarait vide le résultat par défaut.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}

Si pour quelque raison vous décidez d'initialiser un cas comme « {{{parameter name}}} », la fonction va renvoyer le résultat de ce cas quand le paramètre n'existe pas, ou bien s'il n'a pas de valeur. Le paramètre devrait exister et avoir une valeur autre que la chaîne « {{{parameter name}}} » pour renvoyer le résultat par défaut de la fonction.

(si {{{1}}} n'existe pas ou est vide) :
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(si {{{1}}} a la valeur "test") :
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(si {{{1}}} a la valeur «{{{1}}} ») :
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo

Dans cet hypothétique cas, il faudrait ajouter une barre verticale au paramètre ({{{1|}}}).

Comportement de comparaison

Comme pour #ifeq, la comparaison est numérique si la chaîne à comparer et la chaîne du case à tester sont toutes deux numériques ; 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: 02 | +1 = one | +2 = two | three}} → two
{{#switch: 100 | 1e1 = ten | 1e2 = hundred | other}} → hundred
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

Une chaîne case peut être vide :

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

Une fois qu'une correspondance est trouvée avec la donnée à comparer, les valeurs suivantes sont ignorées :

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
Avertissement Avertissement : Les comparaisons numériques avec #switch et #ifeq ne sont pas équivalentes aux comparaisons dans les expressions (voir aussi ci-dessus) :
{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

Signes égal bruts

Les chaînes de caractères des Case ne peuvent pas contenir de signes '=' bruts. Pour contourner ce comportement utilisez le mot magique {{=}}, ou remplacez les signes '=' par le code html &#61;.

Exemple :

Vous entrez Vous obtenez
{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1{{=}}2 = template
 | default
}}
template
{{#switch: 1=2
 | 1&#61;2 = html
 | default
}}
html
Pour une utilisation simple de cette fonction en conditions réelles, regardez Template:NBA Color. Deux exemples complexes peuvent être trouvés sur Modèle:Extension et w:Template:BOTREQ.

Remplacement de #ifeq

#switch peut être utilisé pour réduire la profondeur d’expansion.

Par exemple :

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

est équivalent à :

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

c'est à dire imbriquer, en linéaire :

{{#ifeq:{{{1}}}|condition1
  |<!--then-->branch1
  |<!--else-->{{#ifeq:{{{1}}}|condition2
                |<!--then-->branch2
                |<!--else-->{{#ifeq:{{{1}}}|condition3
                              |<!--then-->branch3
                              |<!--else-->branch4}}}}}}

D'un autre côté, le remplacement du sélecteur pourrait être compliqué ou pas pratique pour les if imbriqués dans les deux branches (affichés avec les alternatives d'indentation, indentés de chaque côté), rendant l'arbre complètement symétrique :

{{#ifeq:{{{1}}}|condition1
 |<!--then-->branch1t{{
  #ifeq:{{{1}}}|condition2
   |<!--then-->branch1t2t{{#ifeq:{{{1}}}|condition4|<!--then-->branch1t2t4t|<!--else-->branch1t2t4e}}
   |<!--else-->branch1t2e{{#ifeq:{{{1}}}|condition5|<!--then-->branch1t2e5t|<!--else-->branch1t2e5e}}
  }}
 |<!--else-->branch1e{{#ifeq:{{{1}}}|condition3
   |<!--then-->branch1e3t{{#ifeq:{{{1}}}|condition6|branch1e3t6t|branch1e3t6e}}
   |<!--else-->branch1e3e{{
    #ifeq:{{{1}}}|condition7
     |branch1e3e7t
     |branch1e3e7t
    }}
  }}
}}

#time

Cette fonction prend une date ou une heure (selon le calendrier grégorien) et la formate selon la syntaxe donnée. Un objet date et/ou heure peut être spécifié ; par défaut, la valeur du mot magique {{CURRENTTIMESTAMP}} est utilisée – c'est-à-dire, le moment auquel la page a été transformée en HTML pour la dernière fois.

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

La liste des codes de formatage acceptés figure dans la table à droite. Tout caractère de la chaîne du format, qui n'est pas reconnu, est passé tel quel sans modification; ceci s'applique également aux espaces (pas utiles pour le système pour interpréter les codes). Si aucun caractère n'est reconnu dans la chaîne de format et que l'objet date / heure est sans erreur, alors la chaîne de format est renvoyée en sortie. Il existe également deux manières d'échapper les caractères à partir de la chaîne du format :

  1. Un antislash suivi d'un caractère de formatage est interprété comme une caractère littéral unique
  2. Les caractères entre guillemets sont considérés comme des caractères littéraux et les guillemets sont supprimés.

De plus, le digraphe xx est interprété comme le littéral unique x.

La liste des codes de formatage continuant à évoluer (avec le support de nouveaux calendrier, ou de nouveaux champs de date calculés et formatés différemment), vous devez échapper tous les caractères littéraux (et pas seulement les lettres ASCII utilisées actuellement par les codes de formatage) devant être transmis sans être modifiés.

Malheureusement, à ce jour, le caractère ASCII apostrophe n'est toujours pas reconnu comme alternative simple au caractère ASCII reconnu guillemet droit pour marquer du texte littéral (par exemple, les guillemets sont requis pour d'autres usages tels que la délimitation de valeurs de type string en JSON, C, C++... ) et caractère d'échappement \ (qui doit être échappé dans les constantes de type string utilisées dans beaucoup de langages, notamment JSON, C, C++, PHP, JavaScript, Lua). Aussi vous ne pouvez pas mettre des guillemets sans les échapper (\") (ou vous pouvez utiliser des guillemets courbes, angulaires, carrés à la place).

{{#time: Y-m-d }}2024-11-21
{{#time: [[Y]] m d }}2024 11 21
{{#time: [[Y (year)]] }}2024 (24UTCamThu, 21 Nov 2024 03:36:21 +0000)
{{#time: [[Y "(year)"]] }}2024 (year)
{{#time: i's" }}36'21"

L’objet date/time peut être dans tout format accepté par la fonction strtotime() de PHP. Les dates absolues (ex : 20 December 2000), relatives (ex : +20 hours), et combinées (ex : 30 July +1 year) sont acceptées.

{{#time: r|now}}Thu, 21 Nov 2024 03:36:22 +0000
{{#time: r|+2 hours}}Thu, 21 Nov 2024 05:36:22 +0000
{{#time: r|now + 2 hours}}Thu, 21 Nov 2024 05:36:22 +0000
{{#time: r|20 December 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|December 20, 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000-12-20}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000 December 20}}Erreur : durée invalide.

Le code de langue de la norme ISO 639-3 (?) permet à la chaîne d’être affichée dans la langue choisie

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

Le paramètre local spécifie si l' objet date/heure référence le fuseau horaire local ou l'UTC.

C'est un paramètre booléen : sa valeur est définie par un cast sur la valeur de l'argument (voir la documentation officielle PHP pour les détails sur la façon dont le cast est fait sur les chaînes de caractères pour en faire des valeurs booléennes).

Veuillez noter que, si la variable $wgLocaltimezone est mise à UTC, il n'y a pas de différence dans la sortie quand local vaut true ou false.

Voir les exemples suivants pour les détails :

{{#time: Y F d H:i:s|now|it|0}}2024 novembre 21 03:36:22
{{#time: Y F d H:i:s|now|it|1}}2024 novembre 21 03:36:22
{{#time: Y F d H:i:s|+2 hours||0}}2024 novembre 21 05:36:22
{{#time: Y F d H:i:s|+2 hours||1}}2024 novembre 21 05:36:22
{{#time:c|2019-05-16T17:05:43+02:00|it}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|0}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|true}}2019-05-16T15:05:43+00:00

Si vous avez calculé un horodatage Unix, vous pouvez l’utiliser dans les calculs de date en le préfixant avec le symbole @.

{{#time: U | now }}1732160182
{{#time: r | @1732160181 }}Thu, 21 Nov 2024 03:36:21 +0000
Avertissement Avertissement : Sans le préfixe @ avant la valeur numérique de l'horodatage, le résultat sera probablement une erreur ou une valeur inattendue.
{{#time: r | 1970-01-01 00:16:39 }}Thu, 01 Jan 1970 00:16:39 +0000
{{#time: U | 1970-01-01 00:16:39 }}999
{{#time: r | @999 }}Thu, 01 Jan 1970 00:16:39 +0000 (correct)
{{#time: r | 999 }}Erreur : durée invalide. (format d'année non reconnu)
{{#time: r | 1970-01-01 00:16:40 }}Thu, 01 Jan 1970 00:16:40 +0000
{{#time: U | 1970-01-01 00:16:40 }}1000
{{#time: r | @1000 }}Thu, 01 Jan 1970 00:16:40 +0000 (correct)
{{#time: r | 1000 }}Fri, 21 Nov 1000 00:00:00 +0000 (interprété comme une année, avec le mois actuel et le jour du mois)
{{#time: r | 1970-01-01 02:46:39 }}Thu, 01 Jan 1970 02:46:39 +0000
{{#time: U | 1970-01-01 02:46:39 }}9999
{{#time: r | @9999 }}Thu, 01 Jan 1970 02:46:39 +0000 (correct)
{{#time: r | 9999 }}Sun, 21 Nov 9999 00:00:00 +0000 (interprété comme une année, avec le mois et le jour actuel)
{{#time: r | 1970-01-01 02:46:40 }}Thu, 01 Jan 1970 02:46:40 +0000
{{#time: U | 1970-01-01 02:46:40 }}10000
{{#time: r | @10000 }}Thu, 01 Jan 1970 02:46:40 +0000 (correct)
{{#time: r | 10000 }}Erreur : durée invalide. (format d'année non reconnu)
Avertissement Avertissement : L’étendue des entrées acceptables est du 1er janvier 0111 au 31 décembre 9999. Le résultat est inconsistant pour les années 100 à 110; Y et les années bissextiles sont comme les années 100-110; r, D, I et U semblent interpréter ces années de la même façon que les années 2000 à 2010.
{{#time: d F Y | 29 Feb 0100 }}01 mars 0100
(correct, année non bissextile), mais
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (faux, même si 100 est interprété comme 2000, car c’était bien une année bissextile)
{{#time: d F Y | 15 April 10000 }}Erreur : durée invalide.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

Les années 0 à 99 sont interprétées comme 2000 à 2069 et 1970 à 1999, sauf lorsqu’elles sont écrites dans un format à 4 chiffres avec des zéros initiaux :

{{#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)
Le jour de la semaine est correctement fourni pour les années 100 à 110 et à partir de 1753; mais pour les années 111 à 1752, le format de sortie r produit Unknown et le format l produit <>. Par conséquent, le format de sortie r n'est pas accepté en entrée pour ces années.

Des dates absolues complètes ou partielles peuvent être spécifiées ; la fonction va "remplir" les parties de la date qui ne sont pas spécifiées en utilisant les valeurs "actuelles" :

{{#time: Y | January 1 }}2024
Avertissement Avertissement : La fonction de remplissage n'est pas cohérente ; certaines parties sont remplies à l'aide des valeurs actuelles, d'autres ne le sont pas :
{{#time: Y m d H:i:s | June }}2024 06 21 00:00:00 Donne le début du jour pour le jour actuel du mois et de l’année courante.
{{#time: Y m d H:i:s | 2003 }}2003 11 21 00:00:00 Donne le début du jour pour le jour actuel de l’année.

Il y a une exception pour la complétion du jour :

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Donne le début du jour et le début du mois.

Un nombre à quatre chiffres est toujours interprété comme une année, jamais comme des heures et des minutes :[1]

{{#time: Y m d H:i:s | 1959 }}1959 11 21 00:00:00

Un nombre à six chiffres est interprété comme heures, minutes et secondes dans la mesure du possible, sinon comme erreur (non, par exemple, comme année et mois) :

{{#time: Y m d H:i:s | 195909 }}2024 11 21 19:59:09 L'entrée est traitée comme un code de temps plutôt qu'un code d'année+mois.
{{#time: Y m d H:i:s | 196009 }}Erreur : durée invalide. Bien que 19:60:09 ne soit pas une heure valide, 196009 n'est pas interprété comme septembre 1960.

La fonction exécute un certain nombre de calculs de dates :

{{#time: d F Y | January 0 2008 }}31 décembre 2007
{{#time: d F | January 32 }}Erreur : durée invalide.
{{#time: d F | February 29 2008 }}29 février
{{#time: d F | February 29 2007 }}01 mars
{{#time:Y-F|now -1 months}}2024-octobre

La longueur totale des chaînes de format des appels de #time est limitée à 6 000 caractères [2].

Problème du fuseau horaire

Il y a un bogue dans cette fonction #time d'analyse de la date (plus particulièrement dans PHP DateTime) qui ne permet pas de passer des nombres non-entiers pour le décalage relatif des fuseaux horaires. Ce problème n'apparait pas quand le fuseau est aligné sur une heure entière, comme EDT. Par exemple :

  • {{#time:g:i A | -4 hours }} → 11:36 PM

Néanmoins l'Inde a un décalage de +5,5 heures sur l'UTC, ainsi en utilisant son décalage on ne pourra pas normalement calculer correctement le décalage horaire. Voici ce qui se passe :

  • {{#time:g:i A | +5.5 hours }} → 3:36 AM

Pour contourner ce problème, convertissez simplement le temps en minutes ou en secondes comme ceci :

  • {{#time:g:i A | +330 minutes }} → 9:06 AM
  • {{#time:g:i A | +19800 seconds }} → 9:06 AM

(Tim Starling, le développeur de cette fonction, a fourni la syntaxe exacte pour cette solution).

Format de #time comme dans les signatures

Il est quelques fois pratique de construire un horodatage qui ressemble à l'horodatage automatique généré par les signatures des commentaires sur les pages de discussion. Avec un wiki en anglais, il peut être créé avec :

  • {{#timel:H:i, j xg Y (e)|+330 minutes}} → 09:06, 21 novembre 2024 (UTC)

#timel

Cette fonction est un raccouci syntaxique qui fonctionne de la même manière que {{#time: ... }} lorsque le paramètre local vaut true, ainsi elle utilise toujours l'heure préférée de l'utilisateur ou l'heure locale du wiki (comme défini dans $wgLocaltimezone ).

Le syntaxe de la fonction est la suivante :

{{#timel: format string }}
{{#timel: format string | date/time object }}
{{#timel: format string | date/time object | language code }}
Veuillez noter que, si la variable $wgLocaltimezone est mise à UTC, il n'y a pas de différence dans la sortie quand local vaut true ou false
Exemple d’utilisation des fonctions d’analyse #time et #timel depuis un serveur situé sur un autre fuseau horaire que UTC.

Par exemple voir les cas suivants :

{{#time:c|now|it}}2024-11-21T03:36:22+00:00
{{#time:c|now|it|0}}2024-11-21T03:36:22+00:00
{{#time:c|now|it|1}}2024-11-21T03:36:22+00:00
{{#timel:c|now|it}}2024-11-21T03:36:22+00:00
Exemple d'avertissement de https://no.wikipedia.org/wiki/Maldiskusjon:Sommertid
Avertissement Avertissement : Remarquez que U, à la fois pour time et timel renvoie le même nombre de secondes depuis le 1er janvier 1970 00:00:00 UTC sur les Wikipedias avec des fuseaux horaires différents de UTC (anciennement connu sous le nom GMT)
U Temps Unix. Secondes depuis le 1er janvier 1970 00:00:00 GMT.
Z Décalage horaire en secondes.
{{#time: U}}1732160181
{{#timel: U}}1732160181
{{#time: Z}}0
{{#timel: Z}}0

#timef

This function formats a date using a standard format for the selected language, as defined in $dateFormats (see tâche T223772).

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

The format of the date/time object is the same as for #time. If it is empty, the time when the page was rendered is used.

The format type may be one of:

time
Only the time is shown.
date
Only the date is shown.
both
Both the time and date are shown.
pretty
Only the date is shown, using an abbreviated format which does not include the year. Not all languages support this; if it is not supported, the "date" format is used.

If the format type is not specified, both the time and date will be show, as if both were specified.

If the language code is not specified, the page's content language is used.

Using #timef instead of #time allows templates to more easily support multiple languages, since different languages have different ways to format dates.

In English, the order of the day and month is controlled by $wgAmericanDates .

Examples:

{{#timef:now|both|en}} 03:36, 21 November 2024
{{#timef:now|both|ja}} 2024年11月21日 (木) 03:36
{{#timef:now|pretty|en}} 21 November
{{#timef:now|pretty|pl}} 21 listopada
{{#timef:|time}} 03:36

#timefl

This function is the same as #timef except that it uses the local timezone of the wiki as configured in $wgLocaltimezone .

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

#titleparts

Cette fonction sépare le titre d'une page en segments basés sur les barres inclinées, puis renvoie en sortie, certains de ces segments.

{{#titleparts: nom de page | nombre de segments à renvoyer | segment où commencer }}

Si le paramètre nombre de segments à renvoyer n'est pas spécifié, il vaut "0" par défaut, ce qui fait renvoyer tous les segments à partir du segment de début jusqu'au dernier (inclus). Si le paramètre segment initial n'est pas spécifié ou vaut "0", sa valeur par défaut est mise à "1" :

{{#titleparts: Talk:Foo/bar/baz/quok }}Talk:Foo/bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}Talk:Foo Voir aussi {{ROOTPAGENAME }}.
{{#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 | 3 }}baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 3 | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}

Les valeurs négatives sont acceptées pour les deux valeurs. Les valeurs négatives pour le paramètre nombre de segments à renvoyer va effectivement 'supprimer' des segments à partir de la fin de la chaîne. Les valeurs négatives pour le premier segment à renvoyer sont traduites en "commencer avec ce segment en comptant à partir de la droite" :

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Enlève un segment à la fin de la chaîne. Voir aussi {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Enlève l'ensemble des quatre segments de la fin de la chaîne
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Enlève cinq segments de la fin de la chaîne (plus qu'il n'en existe)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Renvoie le dernier segment. Voir aussi {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Enlève un segment de la fin de la chaîne, puis renvoie le second segment et les suivants
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Commence la copie au second dernier élément; enlève un segment de la fin de la chaîne

Avant traitement, le paramètre pagename est décodé au niveau HTML: s'il contient des entités caractères HTML standards, elles seront converties en caractères simples (codés en interne en UTF-8, c'est à dire avec le même encodage que les pages source de MediaWiki qui utilisent cette fonction d'analyseur).

Par exemple, toute occurence de &quot;, &#34;, ou &#x22; de pagename sera remplacée par ".
Aucune autre conversion de HTML en texte à plat n'est réalisée, donc les balises HTML sont laissées intactes à cette étape initiale même si elles sont invalides dans le titre des pages.
Certains mots-clé magiques ou fonctions d'analyseur de MediaWiki (telles que {{PAGENAME }} et similaires) sont connues pour renvoyer des chaînes qui sont inutilement encodées HTML, même si leur propre paramètre d'entrée n'était pas encodé HTML :

La fonction d'analyse des composants des titres peut alors être utilisée comme palliatif, pour convertir ces chaînes renvoyées pour qu'elles puissent être traitées correctement par d'autres fonctions d'analyse qui prennent aussi le nom de page en paramètre (comme {{PAGESINCAT: }} mais qui ne fonctionnent pas encore correctement avec les chaînes de caractères encodées HTML en entrée).

Par exemple, si la page actuelle est Category:Côte-d'Or, alors:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, et {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} renvoient tous deux 1; (la fonction analyseur #ifeq réalise bien le décodage HTML de ses paramètres d'entrée).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, et {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} renvoient tous deux 1; (la fonction d'analyse #switch, réalise effectivement le décodage HTML de ses paramètres d'entrée).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }}, ou même {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} vont tous renvoyer 1 si cette page de catégorie existe (la fonction analyseur #ifexist réalise effectivement le décodage HTML de ses paramètres d'entrée);
  • {{PAGESINCAT: Côte-d'Or }} va renvoyer un nombre différent de zéro, si cette catégorie contient des pages ou des sous-catégories, mais:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, peut encore inconditionnellement renvoyer 0, tout comme :
  • {{PAGESINCAT: {{PAGENAME:Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME:Category:Côte-d&apos;Or}} }}

La raison de ce comportement inattendu est que, avec les versions actuelles de MediaWiki, il existe deux mises en garde :

  • {{FULLPAGENAME}} ou même {{FULLPAGENAME:Côte-d'Or}} peuvent renvoyer la chaîne encodée en entités HTML Category:Côte-d&apos;Or et pas celle attendue Category:Côte-d'Or
  • {{PAGESINCAT: Côte-d&apos;Or }} renvoie 0 inconditionnellement (le mot-clé magique PAGESINCAT ne réalise aucun décodage HTML de son paramètre d'entrée).

Le palliatif simple utilisant des parties de titre (qui continuera à fonctionner si les deux mises en garde sont corrigées dans une version ultérieure de MediaWiki) est :

  • {{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d&apos;Or}} }} }}, que tous renvoient le nombre actuel de pages dans la même catégorie.

Ensuite le nom de page décodé est mis sous forme canonique dans un titre de page standard supporté par MediaWiki, au tant que possible :

  1. Tous les soulignés sont automatiquement remplacés par des espaces :
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Pas bah_boo, malgré le souligné figurant dans l'original.
  2. La chaîne est divisée au maximum 25 fois; le autres barres obliques sont ignorées et le 25ième élément va contenir le reste de la chaîne. La chaîne est aussi limitée à 255 caractères, parce qu'elle est traitée comme un titre de page :
    {{#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
    Si pour une raison quelconque vous avez besoin de pousser cette fonction à ses limites, ce qui est très improbable, il est possible de dépasser la limite des 25 découpages en imbriquant les appels de fonction:
    {{#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. Finalement la première sous-chaîne est capitalisée conformément aux règles des majuscules du wiki local (si cette sous-chaîne commmence aussi par un nom de l'espace de noms local, ce nom d'espace de noms est aussi normalisé).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c
Vous pouvez utiliser #titleparts comme un petit "analyseur de chaînes et convertisseur", mais prenez en compte qu'il renvoie la première sous-chaîne capitalisée :
{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

S'il faut des minuscules, utilisez la fonction lc: pour contrôler la sortie :

{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one

Vous pouvez préfixer avec une barre inclinée 'vide' le début de la chaîne pour obtenir correctement la capitalisation de la première sous-chaîne (en majuscules ou en minuscules). Utilisez 2 au lieu de 1 pour le premier segment à renvoyer:

{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One
Avertissement Avertissement : Certains caractères qui sont illégaux dans un titre de page feront que #titleparts n'analysera pas la chaîne :
{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Ne produit pas ce qui est attendu : {one
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Ne fonctionne pas parce que les accolades '{}' sont illégales dans les titres de page et que cette fonction d'analyse ne supporte pas les liens imbriqués dans ses paramètres d'entrée pagename, même s'ils utilisent la syntaxe MediaWiki, ou tout autre balise HTML ou MediaWiki.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Ne fonctionne pas car "#" est aussi illegal dans les titres de page.
Avertissement Avertissement : Si une partie quelconque du titre est juste "." ou "..", #titleparts n'analysera pas la chaîne :
{{#titleparts: one/./three | 1 | 1 }}one/./three. La chaîne complète est renvoyée. Cela ne produit pas ce qui est attendu: one
Avertissement Avertissement : Cette fonction ne se dégrade pas correctement si l'entrée dépasse 255 octets en UTF-8. Si la chaîne d'entrée fait 256 octets ou plus, la chaîne entière est renvoyée.

Extension StringFunctions

L'extension ParserFunctions définit facultativement différentes fonctions sur les chaînes de caractères quand $wgPFEnableStringFunctions vaut true :

  • #len
  • #pos
  • #rpos
  • #sub
  • #count
  • #replace
  • #explode
  • #urldecode

Voir les sous-pages pour la documentation et Manual:Performing string operations with parser functions pour les exemples.

Avertissement Avertissement : En 2013, il a été décidé que ces fonctions ne seront jamais activées sur aucun wiki Wikimedia, car elles sont inefficaces si elles sont utilisées à grande échelle (voir phab:T8455 pour l'historique). Ces fonctions ne sont pas opérationnelles sur les wikis Wikimedia !

Si vous êtes ici pour écrire quelque chose sur un projet Wikimedia, vous cherchez autre chose : si votre wiki d'accueil a des fonctions de chaîne de caractères, il utilise probablement Lua . Par exemple, la Wikipedia anglaise utilise Module:String, qui réalise partiellement des fonctions similaires mais avec une syntaxe très différente. Il existe aussi des modèles de traitement de chaines de caractères individuels.

Voici un bref aperçu des fonctions Module:String :

  • #len (longueur de la chaîne): {{#invoke:String|len|target_string}}
  • #sub (sous-chaîne): {{#invoke:String|sub|target_string|start_index|end_index}}
  • #match: {{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
  • #pos (position de la cible): {{#invoke:String|pos|target_string|index_value}}
  • #find: {{#invoke:String|find|source_string|target_string|start_index|plain_flag}}
  • #replace: {{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
  • #rep (répéter): {{#invoke:String|rep|source|count}}
  • #escapePattern: {{#invoke:String|escapePattern|pattern_string}}
  • #count: {{#invoke:String|count|source_str|pattern_string|plain_flag}}
  • #join: {{#invoke:String|join|separator|string1|string2|...}}

Points généraux

Substitution

Les fonctions d'analyseur peuvent être substituées en préfixant le caractère de hachage par subst: :

{{subst:#ifexist: Help:Extension:ParserFunctions/fr | [[Help:Extension:ParserFunctions/fr]] | Help:Extension:ParserFunctions/fr }} → le code [[Help:Extension:ParserFunctions/fr]] sera inséré dans le texte wiki car la page Help:Extension:ParserFunctions/fr existe.
Avertissement Avertissement : Les résultats des fonctions substituées d'analyse sont non-définis si les expressions contiennent du code volatile nonsubstitué tel que variables ou d'autres fonctions d'analyse. Pour avoir des résultats cohérents, tout le code volatile des expressions à évaluer doit avoir été substitué. Voir Help:Substitution.

La substitution ne fonctionne pas à l'intérieur de ‎<ref>‎</ref> , vous pouvez utiliser {{subst:#tag:ref|}} dans ce but.

Redirections

Particulièrement {{#time:…|now-…}} serait pratique pour les redirections vers les pages contenant des dates, mais cela ne fonctionne pas.

Protection des caractères '|' (pipe) dans les tableaux

Les fonction d'analyseur vont casser la syntaxe des tableaux wiki et des caractères pipe (|), en traitant l'ensemble de la ligne des caractères pipe comme des séparateurs de paramètres. Pour éviter cela, la plupart des wikis utilisaient un modèle Template:! dont le contenu n'était qu'un caractère pipe (|), depuis MW 1.24 un {{!}} mot magique a remplacé cette structure. Ceci 'cache' le pipe à l'analyseur MediaWiki, en assurant qu'il n'est pas pris en compte tant que tous les modèles et les variables d'une page n'ont pas été expansés. Après seulement, il sera interprété comme un séparateur de rangée ou de colonne de tableau. Alternativement, la syntaxe des lignes de tableau HTML peut être utilisée, bien qu'elle reste moins intuitive et plus sujette à faire des erreurs.

Vous pouvez aussi protéger le caractère pipe pour être affiché directement, comme un caractère non interprété, en utilisant un entité HTML: &#124; .

Description Vous entrez Vous obtenez
Protection du caractère pipe en tant que séparateur de ligne/colonne de tableau
{{!}}
|
Protection du caractère pipe comme simple caractère
&#124;
|

Enlever les espaces

Les blancs, incluant les nouvelles lignes, les tabulations, et les espaces, sont supprimés au début et à la fin de tous les paramètres de ces fonctions d'analyse. Si cela n'est pas souhaité, la comparaison des chaînes peut être faite en les entourant avec des apostrophes.

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

Pour éviter le rognage des parties then et else, voir m:Template:If. Certaines personnes y parviennent en utilisant <nowiki > </nowiki> au lieu d'espaces.

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

Cependant, cette méthode peut être utilisée pour restituer un caractère espace unique, car l'analyseur remplace plusieurs caractères espace consécutifs d'une ligne par un seul.

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

Dans cet exemple, le style white-space: pre est utilisé pour forcer à préserver les blancs par le navigateur, mais même avec cela, les espaces ne sont pas affichées. Ceci arrive parce que les espaces sont supprimées par le logiciel, avant qu'elles ne soient envoyées au navigateur.

Il est possible de contourner ce comportement en remplaçant les blancs par &#32; (espace sécable) ou &nbsp; (espace non sécable), parce qu'ils ne sont pas modifiés par le logiciel :

<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

Attention à ne pas créer tous les paramètres avec la même valeur. Dans ParserFunctions, l'espace figurant au début et à la fin est toujours supprimé. Dans templates , les espaces de début et de fin sont supprimées pour les paramètres nommés et les paramètres numérotés mais pas pour les paramètres non nommés :

foo{{1x|content= bar}}foofoobarfoo
foo{{1x|1= bar}}foofoobarfoo
foo{{1x| bar }}foofoo bar foo

Autres fonctions d'analyse

Fonction de conversion de la casse

  • Mise en minuscules : "{{lc: AbC}}" → "abc" [1]
  • Mise en majuscules : "{{uc: AbC}}" → "ABC" [2]
  • Premier caractère en minuscules : "{{lcfirst: AbC}}" → "abC" [3]
  • Premier caractère en majuscule : "{{ucfirst: abc}}" → "Abc" [4]

Fonctions d'encodage

  • Encodage d'URL
"{{urlencode: AbC
dEf ghi}}"

Rendu :


"AbC%0AdEf+ghi"


Ainsi, les sauts de ligne internes sont convertis en %0A, et les espaces internes sont convertis en +.

Encodage des ancres

{{anchorencode: AbC dEf ghi}}

Rendu :


AbC_dEf_ghi


Fonctions de remplissage

  • "{{padleft: bc d |8|a}}" gives "aaaabc d" [5]
  • "{{padright: bc d |8|a}}" gives "bc daaaa" [6]

Fonctions de formatage

  • "{{formatnum: 1234567890}}" gives "1 234 567 890" [7]

Voir aussi

Références

  1. Avant r86805 en 2011 ce n'était pas le cas.
  2. ParserFunctions.php sur phabricator.wikimedia.org