Wikipédia:Jargon/Paramètre booléen

Cette page définit un jargon de Wikipédia. Cette page est un patch info et peut-être employée en inclusion comme un modèle.

Cette page décrit un type de paramètres de modèle : le « Wikipédia:Jargon/Paramètre booléen ».

Définition

Un paramètre booléen (parfois appelé indicateur ou drapeau) ne prend que 2 valeurs : faux (0/false/nul/non/off/...) / vrai (1/true/non nul/oui/on/...). En tant que paramètre de modèle, ces valeurs sont : manquant ou vierge (faux) / quelconque (1 ou oui sont recommandées) (vrai).

Exemples

Quelques exemples de paramètres booléens dans les modèles :

• le paramètre nohr de {{confusion}} permet de supprimer le soulignement :

Code wiki	Rendu
{{Confusion|texte=Usage fictif}}	Usage fictif
{{Confusion|texte=Usage fictif|nohr=1}}	Usage fictif

• le paramètre code est employé dans {{Documentation paramétrage de carte}} pour passer à une version optimisée.

Description détaillée

Le bon sens veut qu'un paramètre booléen soit facultatif et prenne la valeur « faux » par défaut. Lorsqu'il prend la valeur « vrai », on dit d'un paramètre booléen qu'il est positionné ou défini.

Un tel paramètre <booléen> s'emploie uniquement ainsi dans le code d'un modèle :

{{#if: {{{<booléen>|}}}
|<!-- alors ... (vrai) -->
|<!-- sinon ... (faux) -->
}}

Voici un exemple de code de documentation de ce paramètre <booléen> :

:<code><booléen></code> : [[Wikipédia:Jargon/Paramètre booléen|paramètre booléen]] ; ... s'il est défini.

et un exemple d'usage dans le modèle <nom du modèle> :

{{<nom du modèle>|<booléen>=1}}

Les valeurs 1 ou oui sont recommandées pour "vrai". En revanche, l'utilisation de valeurs telles que 0, faux ou non sont à proscrire absolument, car elles sont ambigüe voire erronée