Modèle:Oui non/Documentation

Ceci est la page de documentation de Modèle:Oui non [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.

Utilisation[modifier le code]

Ce modèle permet de normaliser un paramètre booléen.

Le modèle distingue quatre cas différents suivant le contenu du premier paramètre :

oui, o, yes, y, true, on ou 1 (en minuscules ou majuscules)
non, n, no, false, off ou 0 (en minuscules ou majuscules)
vide ou uniquement des espaces
autre

Par défaut le modèle retourne « oui » dans le premier et le dernier cas, rien dans les autres cas.

Syntaxe[modifier le code]

{{ Oui non | paramètre à analyser }}
{{ Oui non | paramètre à analyser |oui=oui |non= |vide= |défaut=oui }}

Paramètres[modifier le code]

Les paramètres permettent de personnaliser le résultat suivant les quatre cas :

oui : valeur retournée si la valeur du paramètre analysé est oui, o, yes, y, true, on ou 1 (par défaut : oui)
non : valeur retournée si la valeur du paramètre analysé est non, no, n, false, off ou 0 (par défaut ne retourne rien)
vide : valeur retournée si le paramètre est vide ou absent (par défaut ne retourne rien)
défaut : valeur retournée dans les autres cas (par défaut : oui)

Clarification des cas "vide" et "défaut"[modifier le code]

Le cas "vide" signifiant que le paramètre est vide ou omis, on peut considérer qu'il s'agit là du "cas par défaut" à proprement parler.

Le cas "défaut" signifiant que la valeur n'est pas reconnue par le modèle, il est fortement souhaitable d'éviter ce cas de figure.

Exemples[modifier le code]

{{ Oui non | oui }} → oui
{{ Oui non | Oui }} → oui
{{ Oui non | OUI }} → oui
{{ Oui non | o }} → oui
{{ Oui non | yes }} → oui
{{ Oui non | 1 }} → oui
{{ Oui non | non }} →
{{ Oui non | Non }} →
{{ Oui non | NON }} →
{{ Oui non | n }} →
{{ Oui non | N }} →
{{ Oui non | 0 }} →
{{ Oui non | }} →
{{ Oui non | un contenu quelconque }} → oui

oui :

{{ Oui non | oui | oui=OUI }} → OUI
{{ Oui non | oui | oui=jambon }} → jambon

non :

{{ Oui non | n | non=NON }} → NON
{{ Oui non | 0 | non=pomme de terre }} → pomme de terre

vide :

{{ Oui non | | vide=tomate }} → tomate
{{ Oui non | | vide=tomate | non=pomme }} → tomate
{{ Oui non | vide=tomate }} → tomate

défaut :

{{ Oui non | je ne sais pas | défaut=OUI }} → OUI
{{ Oui non | je ne sais pas | oui=jambon }} → jambon
{{ Oui non | je ne sais pas | défaut= }} →
{{ Oui non | peut-être | oui=jambon | défaut=rosbif }} → rosbif
{{ Oui non | 5| oui=jambon | défaut=rosbif }} → rosbif

Utilisation dans un #if[modifier le code]

Pour avoir un code clair et éventuellement éviter des duplications, il peut être judicieux d'employer ce modèle dans un #if :

{{#if: {{Oui non|{{{paramètre|}}}}}
  | paramètre vaut "oui"
  | paramètre vaut "non" ou est absent/vide
}}

{{#if: {{Oui non|{{{paramètre|}}}|vide=oui}}
  | paramètre vaut "oui" ou est absent/vide
  | paramètre vaut "non"
}}

Rappel : comme indiqué précédemment, il est préférable que le cas "défaut" ne se produise jamais, et il ne devrait donc pas être nécessaire de le prendre en compte.

Logical distinctions[modifier le code]

Résumé des valeurs retournés par le modèle « »
parametre 1 (`1=`)	code	logique	valeur par défaut	texte retourné avec : `oui=Positif` `non=Negatif` `vide=Néant` `defaut=Autre`
oui, OUI, o, yes, y, true, on, 1	`{{Oui non\|oui}}`	`oui par définition`	"oui"	"Positif"
Texte quelconque	`{{Oui non\|Texte quelconque}}`	`oui par défault`	"oui"	"Autre"
non, NON, no, n, false, off, 0	`{{Oui non\|non}}`	`non par définition`	""	"Negatif"
<vide>	`{{Oui non\|}}`	`vide`	""	"Néant"

Voir aussi[modifier le code]