Utilisateur:FH/BUtilisateur/Documentation

Un article de Wikipédia, l'encyclopédie libre.

Modèle | Documentation | Discussion

Ce Méta-modèle permet de générer facilement des boîtes utilisateur standardisées.

Ce modèle emploie quelques fonctionnalités complexes de la syntaxe des ParserFunctions. Veuillez ne pas tenter de l’altérer à moins que vous ne soyez certain de bien comprendre sa conception et êtes préparé à réparer tous les dommages collatéraux si les résultats sont inattendus. Toute expérimentation devrait être conduite d’abord via une copie sur le Modèle bac à sable ou dans votre espace utilisateur. Cliquez ici pour purger le cache

[modifier] Constantes

• largeur de la boîte : 238px
• largeur de l'emplacement de l'icone : 45px
• image(s) et textes sont centrés dans leurs cellules

[modifier] Modèles courants à recopier

{{BUtilisateur|
  couleur=|
  img=|
  img-taille=|
  img-titre=|
  titre=|
  texte=|
}}

{{BUtilisateur|
  couleur=|
  img-couleur=|
  img=|
  img-taille=|
  img-titre=|
  img2=|
  img2-taille=|
  img2-titre=|
  titre=|
  texte=|
}}

{{BUtilisateur|
  couleur=| 
  img-couleur=| 
  img-texte=| 
  img-texte-couleur=| 
  img-texte-taille=| 
  titre=| 
  texte=| 
}}

{{BUtilisateur|
  couleur=| 
  img-couleur=| 
  img=|
  img-taille=|
  img-titre=|
  titre=| 
  texte=| 
  texte2=| 
}}

[modifier] Syntaxe

{{BUtilisateur|
  bordure=#999999|             <!-- facultatif - par défaut, #999999 (gris) -->
  couleur=#EEEEEE|             <!-- facultatif - par défaut, #EEEEEE (gris clair) -->
  texte-couleur=#000000|       <!-- facultatif - par défaut, #000000 (noir) -->
  img-couleur=#FFFFFF|         <!-- facultatif - par défaut, #FFFFFF (blanc) -->
  img=icone.svg|               <!-- facultatif mais fortement conseillé - si absent, pas d'image -->
  img-taille=45px|             <!-- facultatif - par défaut, 45px -->
  img-titre=Titre Icône|       <!-- facultatif mais conseillé - par défaut, {{{img}}} -->
  titre=Poker|                 <!-- facultatif - la boîte peut ne pas comporter de titre en gras  -->
  titre-taille=8pt|            <!-- facultatif - par défaut, 8pt -->
  texte=Je joue au [[poker]].| <!-- facultatif mais fortement conseillé - si absent, pas de texte -->
  texte-taille=8pt|            <!-- facultatif - par défaut, 8pt (augmenter pour arabe et chinois) -->
}}

Note : le titre partage la même couleur que le texte.

Si la boîte doit contenir deux images, l'une à côté de l'autre, il faut renseigner trois autres paramètres :

  imgd=icone2.svg|           <!-- facultatif - si absent, pas d'image -->
  imgd-taille=45px|          <!-- facultatif - par défaut, 45px -->
  imgd-titre=Titre Icône 2|  <!-- facultatif mais conseillé - par défaut, {{{imgd}}} -->

Si la boîte doit contenir deux images, l'une au dessus de l'autre, il faut renseigner trois autres paramètres :

  img2=logo.svg|             <!-- facultatif - si absent, pas d'image -->
  img2-taille=45px|          <!-- facultatif - par défaut, 45px -->
  img2-titre=Titre Logo|     <!-- facultatif mais conseillé - par défaut, {{{img2}}} -->

La boîte peut contenir jusqu'à quatre images, img et imgd en première ligne, img2 et impd2 en seconde ligne :

  imgd2=logo2.svg|           <!-- facultatif - si absent, pas d'image -->
  imgd2-taille=45px|         <!-- facultatif - par défaut, 45px -->
  imgd2-titre=Titre Logo 2|  <!-- facultatif mais conseillé - par défaut, {{{imgd2}}} -->

À la place des images, on peut mettre un texte :

  img-texte=Abbrev|          <!-- facultatif - si absent, pas de texte dans la partie gauche -->
  img-texte-couleur=#000000| <!-- facultatif - par défaut, #000000 (noir) -->
  img-texte-taille=14pt|     <!-- facultatif - par défaut, 14pt -->

Si on veut ajouter un second texte séparé par un filet horizontal (par exemple une traduction dans une autre langue), on peut renseigner (ce second texte utilise les mêmes couleurs que le premier texte et le titre mais peut avoir une taille différente) :

  texte2=I play [[poker]].|  <!-- facultatif - si absent, pas de second texte séparé par un filet -->
  texte2-taille=8pt|         <!-- facultatif - par défaut, 8pt (augmenter pour arabe ou chinois) -->

Si la boîte doit contenir un lien de type WhatLinksHere, il faut renseigner un paramètre supplémentaire (cela affiche un triangle en bas à droite vers une page spéciale listant toutes les pages liées au modèle) :

  lien=Poker| <!-- Fin du nom de la boîte utilisateur (ici pour le Modèle:Utilisateur Poker) -->

Cependant, s'il existe une catégorie correspondante pour les pages d'utilisateurs, on utilisera plutôt :

  catégorie=Utilisateur Poker| <!-- facultatif - en principe le même nom que la boîte utilisateur (ici pour le Modèle:Utilisateur Poker) -->
  nocat={{{nocat|}}}|          <!-- facultatif - par défaut, vide -->

Avec ce paramètre, les utilisateurs qui insère cette boîte dans leur page personnelle ont leur page personnelle automatiquement catégorisée. Note: on doit indiquer le nom complet de la catégorie, car pour des raisons de compatibilité avec d'ancien noms de catégories, le préfixe "Catégorie:Utilisateur xxx" n'est pas toujours présent (on trouve aussi "Catégorie:User xxx").
Le paramètre optionnel nocat, s'il est non vide (par exemple nocat=o), évite de catégoriser automatiquement une page "Utilisateur:xxx" qui incluerait ce modèle. En principe, on ne doit l'employer que dans une sous-page "Utilisateur:xxx/xxx" (archive, essais...) pour ne pas polluer les catégories d'utilisateurs. (Des sous-modèles de Boîtes Utilisateur suffixés par "/nocat" peuvent être créés pour indiquer ce paramètre en plus du modèle normal de boîte utilisateur qui n'inclue pas ce paramètre).

[modifier] Paramètres

Boîte :

• bordure : facultatif (défaut=#999999, gris foncé) la couleur de bordure de la boîte, exemple : "black" ou "#0000FF"

Partie de gauche : généralement l'image

• img-couleur : facultatif (défaut=#FFFFFF, blanc) la couleur de fond de l'image ou des images, exemple : "#906090" ou "#ccc"
• première image
  • img : facultatif (défaut=pas d'image) le nom de l'image, par exemple "Flag of France.svg"
  • img-taille : facultatif (défaut=45px) la largeur de l'image exprimée en pixels, exemple : "30px"
  • img-titre : facultatif (défaut=nom de l'image) exemple : "Drapeau de la France"
• seconde image, à droite de la première image
  • imgd : facultatif (défaut=pas d'image)
  • imgd-taille : facultatif (défaut=45px)
  • imgd-titre : facultatif (défaut=nom de l'image)
• première image en deuxième ligne, donc sous la première image
  • img2 : facultatif (défaut=pas d'image)
  • img2-taille : facultatif (défaut=45px)
  • img2-titre : facultatif (défaut=nom de l'image)
• seconde image en deuxième ligne, à droite de la première image en deuxième ligne
  • imgd2 : facultatif (défaut=pas d'image)
  • imgd2-taille : facultatif (défaut=45px)
  • imgd2-titre : facultatif (défaut=nom de l'image)
• ou alors un texte
  • img-texte : facultatif (défaut=pas de texte) le texte remplaçant l'image, par exemple "E=mc²"
  • img-texte-couleur : facultatif (défaut=#000) la couleur du texte/image, par exemple "red"
  • img-texte-taille : facultatif (défaut=14pt) la taille du texte/image, par exemple "10pt"

Partie de droite : le texte affiché

• couleur : facultatif (défaut=#EEEEEE, gris clair) la couleur de fond de la boîte, exemple : "#906090" ou "#ccc"
• texte-couleur : facultatif (défaut=#000000, noir) la couleur des textes et du titre dans la boîte, exemple : "yellow" ou "#0CCCC"

  Normalement la couleur de boîte est claire (pastel), et les textes restent dans la couleur par défaut en noir (inutile de préciser texte-couleur sauf si le paramètre couleur précise une teinte foncée). Voir la charte graphique des boîtes

• Le titre facultatif (automatiquement en gras et sur une ligne séparée en haut du texte)
  • titre : facultatif (défaut=pas de titre) le titre de la boîte ; sera affiché en gras suivi d'un saut de ligne
  • titre-taille : facultatif (défaut=8pt, augmenter à 13pt pour l'arabe ou le chinois)
• Le texte principal (affiché directement dans un paragraphe sous le titre)
  • texte : obligatoire, mais sa valeur peut être vide, le texte de la boîte, à la suite du titre
  • texte-taille : facultatif (défaut=8pt, augmenter à 13pt pour l'arabe ou le chinois)
• Un second texte optionnel (séparé du titre et du premier texte par un mince filet horizontal de la couleur de la bordure).
  • texte2 : facultatif (défaut=pas de texte) un second paragraphe, par exemple pour le texte dans une seconde langue.
  • texte2-taille : facultatif (défaut=8pt, augmenter à 13pt pour l'arabe ou le chinois)

Partie optionnelle : un lien de navigation en bas à droite (un petit triangle pointé vers le bas). On peut afficher ce lien de deux façons exclusives l'une de l'autre :

• soit vers une page spéciale "Special:Whatlinkshere" :
  • lien : facultatif, le nom du modèle de boîte lui-même sans le préfixe "Modèle:".
• soit vers une catégorie d'utilisateurs de cette boîte qui y seront automatiquement catégorisés :
  • catégorie : facultatif, indique le nom de la catégorie des utilisateurs de cette boîte, sans le préfixe "Catégorie:". Noter que seules les pages de l'espace "Utilisateur:" y seront catégorisées. On peut utiliser la même boîte ailleurs dans des discussions ou dans "Wikipédia:" sans que ces discussions soient catégorisées parmi les utilisateurs de la boîte. Note: si on utilise ce paramètre, le paramètre "lien=Utilisateur ...|" mentionnant le nom du modèle est ignoré et c'est le lien vers la catégorie d'utilisateurs qui apparaîtra.
  • nocat : facultatif, par défaut les utilisateurs de la boîte sont tous catégorisés si le paramètre catégorie est présent . La valeur recommandée est nocat={{nocat|}}}| ce qui permet de créer un second modèle de boîte utilisateur nommé avec le suffixe "/nocat" et appelant le premier modèle de boîte en précisant seulement le paramètre "nocat=o" (valeur quelconque non vide). Ce paramètre ne supprime pas le lien affiché vers la catégorie mais l'utilisateur de la boîte n'y sera pas listé. A l'utilisation du modèle, il n'est pas nécessaire de créer un modèle "/nocat" juste pour inclure la boite dans une page de discussion (le seul intéret de créer un second modèle nommé "Modèle:Utilisateur xxx/nocat" est de faire apparaîte la boîte utilisateur "{{Utilisateur xxx|nocat=o}}" pour pouvoir l'utiliser dans "{{Boîte Utilisateur| xxx/nocat | ...}}}" ou dans "{{Boîte Babel| xxx/nocat | ...}}}" inclus dans le code d'une page "Utilisateur:Untel", où on ne peut préciser aucun paramètre avec le nom, et la plupart des utilisateurs n'utiliseront pas cette option : c'est à dire qu'à partir du moment où ils affichent publiquement la boîte sur leur page personnelle, ils sont catégorisés parmi les utilisateurs de la boîte).

Optionnel : on peut définir l'alignement de flottaison de la boîte, essentiellement dans le cas d'une utilisation personnelle.

• align : facultatif, (défaut=left) ; les valeurs possibles sont right, left ou center

[modifier] Exemples

Code	Résultat
{{BUtilisateur| img=Wiki.png| img-titre=Wikipédia| couleur=#d0ffe0| titre=[[Wikipédia]]| texte=Mon encyclopédie libre et gratuite est '''[[Wikipédia]]'''.| catégorie=Wikipédiens|<!-- Choisir une meilleure sous-catégorie appropriée! --> }}	Wikipédia Mon encyclopédie libre et gratuite est Wikipédia.
{{BUtilisateur| img=SantaClaus.jpg| img-titre=Père Noël| couleur=#FF8080| titre=Père Noël| texte=Je crois au '''[[Père Noël]]'''.| catégorie=Utilisateur Père Noël| }}	Père Noël Je crois au Père Noël. ∇
{{BUtilisateur| img=Blason_Languedoc.svg| img-titre=Armoiries Languedoc| img-taille=21px| imgd=Swiss-coat of arms.svg| imgd-titre=Blason Suisse| imgd-taille=21px| img2=Blason_Nord-Pas-De-Calais.svg| img2-titre=Blason Nord-pas-de-calais| img2-taille=21px| imgd2=BlasonChampagneArdennes.PNG| imgd2-titre=Blason Champagne Ardennes| imgd2-taille=21px| couleur=#FFF0F5| titre=4 images| texte=On peut placer jusqu’à quatre images dans la partie droite.| }}	Quatre images On peut placer jusqu’à quatre images dans la partie droite.
{{BUtilisateur| texte=Cet utilisateur ne s’intéresse à rien.| }}	Cet utilisateur ne s’intéresse à rien.
{{BUtilisateur| img-couleur=red| img-texte-couleur=yellow| img-texte-taille=12pt| img-texte='''e=<br />mc²'''| couleur=darkblue| texte-couleur=white| texte=Cet utilisateur est un '''<big><big>génie</big></big>'''.| }}	e= mc² Cet utilisateur est un génie.
{{BUtilisateur| img-couleur=#FFBBBB| img-texte-taille=13pt| img-texte='''en-0'''| couleur=#FFEEEE| bordure=#FFBBBB| texte=Cet utilisateur '''[[:Catégorie:Utilisateur en|ne comprend rien]]''' à l’'''[[:Catégorie:Utilisateur en|anglais]]''', ou ne veut pas parler cette langue.| texte2=This user '''[[:Catégorie:Utilisateur en|does not]]''' speak '''[[:Catégorie:Utilisateur en|English]]''', or does not want to speak English.| catégorie=Utilisateur en-0| }}	en-0 Cet utilisateur ne comprend rien à l’anglais, ou ne veut pas parler cette langue. This user does not speak English, or does not want to speak English. ∇