Différences entre les versions de « Aide:Fonctions du parseur »

Comme pour un fichier PHP, les articles du Wiki acceptent des fonctions préétablies. Ces fonctions sont principalement utilisées dans des mises en forme spéciales ou la conception de modèles.

Les fonctions listées si-dessous sont celles d'usage le plus courant sur le WikiHalo, la liste complète est accessible par ce lien.

Switches[modifier]

• __NOTOC__ : Masque le sommaire de l'article. Utilisable dans le cas d'un article court, mais avec plus de trois sections, où un sommaire n'est pas justifié.
• __TOC__ : Force l'apparition du sommaire à la position du code.
• __NOEDITSECTION__ : Masque le lien d'édition de la section contenant le code. Utilisable sur les pages de la Catégorie:Texte brut.

Variables[modifier]

Variables globales[modifier]

Ces variables sont utilisables partout sur le Wiki.

• {{CURRENTYEAR}} : Retourne l'année en cours.
• {{CURRENTMONTH}} : Retourne le numéro du mois en cours.
• {{CURRENTMONTHNAME}} : Retourne le nom du mois en cours.
• {{CURRENTDAY}} : Retourne le numéro du jour du mois en cours.
• {{CURRENTDAYNAME}} : Retourne le nom du jour de la semaine en cours.
• {{CURRENTTIMESTAMP}} : Affiche un numéro au format YYYYMMDDHHmmss.
• {{DISPLAYTITLE:titre}} : Contourne certaines restrictions d'affichage du titre. Voir : Aide:Construction des pages#Titres.
• {{FULLPAGENAME}} : Retourne le nom de la page, avec l'espace de nom (Aide:Fonctions du parseur).
• {{PAGENAME}} : Retourne le nom de la page, sans l'espace de nom (Fonctions du parseur).
• {{SUBPAGENAME}} : Dans les sous-pages, retourne uniquement le nom de la sous-page.

Variables locales[modifier]

Ces variables ne sont utilisables que sur la page où elle ont été définies.

• {{#vardefineecho:Titre | valeur}} : Définit une variable contenant le texte "valeur" et dont le nom est "Titre".
• {{#varexists:Titre}} : Renvoie vrai si la variable portant le nom "Titre" a été définie dans la page, et faux dans le cas inverse.

Fonctions[modifier]

Ces fonctions sont imbriquables entre elles. La plupart de ces fonctions utilisent le caractère pipe « | », accessible avec la combinaison des touches « AltGr » et « - » (6) sur le pavé alphabétique.

• {{#if: variable | Résultat si la variable est définie | Résultat si la variable est vide}} : Modifie le code à retourner selon si une variable est définie ou non. Une variable est indéfinie si elle est vide ou ne contient que des espaces.
  • Le test servira souvent à déterminer si un paramètre de modèle a été défini ou non, soit le code suivant : {{{Param|}}}.
  • Cette fonction teste uniquement la définition et pas un résultat mathématique.
• {{#ifeq: variable 1 | variable 2 | Résultat si les variables sont égales | Résultat si les variables ne sont pas égales }} : Cette fonction de comparaison fonctionne numériquement ou textuellement :
  • Si les deux variables contiennent uniquement des chiffres, la comparaison est numérique. Ainsi : 2 = 2 et 01 = 1 ;
  • Si au moins une variable contient des caractères non numériques, la comparaison est textuelle. Ainsi : Dés = Dés mais "01" ≠ "1". La comparaison est sensible à la casse : dés ≠ Dés.
• {{#expr: expression }} : Résout une expression mathématique (+, -, *, /, =, !=, <, >, <=, >=, …) et retourne son résultat, ou bien retourne une erreur si l'expression ne peut être résolue (par exemple, l'expression contient autre chose que des nombres).
• {{#ifexpr: expression | Résultat si l'expression est vraie | Résultat si l'expression est fausse}} : Vérifie le résultat d'un code #expr: et retourne le code adéquat.
• {{#switch: variable | Valeur 1 = Résultat si la variable et cette valeur sont égales | Valeur 2 = Idem | Valeur à utiliser si la variable ne correspond à aucune des valeurs listées}} : Compare une variable avec une liste de valeurs prédéfinies et retourne un résultat adéquat. Cet exemple n'utilise que deux résultats possibles, mais plus sont possibles. La dernière valeur contiendra généralement un message d'erreur indiquant que la variable a été mal définie.
• {{#iferror: expression | Résultat si l'expression renvoie une erreur | Résultat si l'expression renvoie un résultat correct}} : Permet de vérifier si une opération tombe en erreur, pour afficher un message d'erreur si besoin. Également utilisable en combinaison avec #expr: pour différencier un nombre d'une chaîne de caractères.
• Plusieurs opérations sont disponibles pour agir sur les chaînes de caractères, comme calculer leur longueur, chercher la présence d'un mot ou remplacer certains caractères. Voir la liste.

Cas particuliers[modifier]

Le pipe « | » étant utilisé comme marqueur dans les fonctions du parseur, il ne sera pas interprété correctement lorsqu'on veut afficher ce caractère dans le résultat de la fonction, comme pour afficher un tableau. Pour résoudre ce problème, il faut remplacer les pipes qu'on souhaite afficher par le code « {{!}} ». Seuls les pipes qui participent à construire le tableau sont concernés : si il y a une fonction du parseur imbriquée dans une autre fonction, il n'y a pas besoin de remplacer ses pipes.

Le signe = utilisé dans certaines url (notamment celles des vidéos) peut ne pas être reconnu correctement. Il est nécessaire de remplacer ce symbole par son code HTML pour qu'il soit reconnu correctement.