Modèle:Documentation boîte utilisateur

 Documentation[voir] [modifier] [historique] [purger]

Utilisation et paramètres

Ce modèle est destiné à être apposé sur les modèles de boîtes utilisateur afin de guider les contributeurs désireux d'en utiliser dans la manière de les apposer sur leur page utilisateur. Il affiche automatiquement le contenu de la sous-page /Documentation si elle existe, ou bien un contenu spécifique passé par le paramètre contenu. Il est possible de cibler une page de documentation autre que la sous-page /Documentation en utilisant le paramètre page doc.

Les autres paramètres sont les suivants :

Boîte simple

Pour la plupart des boîtes utilisateur, il suffit d'ajouter : {{Documentation boîte utilisateur}} au modèle, entre les balises noinclude. Si la boîte contient une sous-page de documentation, celle-ci est automatiquement affichée en tant que contenu de ce modèle.

Boîte avec accord de genre

Si la boîte s'accorde en genre automatiquement, il faut ajouter le paramètre accord pour le signifier. La syntaxe est alors : {{Documentation boîte utilisateur|accord=oui}}

Boîte ajustable

Pour les boîtes ajustables, c'est-à-dire les boîtes hautes possédant un paramètre permettant de réduire le contenu et leur donner une taille standard, le paramètre ajustable doît être ajouté à cette documentation : {{Documentation boîte utilisateur|ajustable=oui}}

Babel et alphabets

Langues

Pour les boîtes utilisateur linguistiques, ajouter les deux paramètres obligatoires suivants :

  1. langue : texte à afficher (par exemple, le [[français]])
  2. initiales : initiales de la langue (par exemple, fr)

Alphabets

Pour les boîtes utilisateur d'alphabets comportant plusieurs boîtes de niveau, ajouter les deux paramètres obligatoires suivants :

  1. alphabet : texte à afficher (par exemple, l'[[Alphabet phonétique international]])
  2. initiales : initiales utilisées pour nommer les boîtes (par exemple, API)

Boîtes destinées aux catégories

Normalement, les boîtes utilisateurs sont destinées aux pages utilisateur. Dans le cas particulier des boîtes de langue et d'alphabet dont le nom finit par "-*", celles-ci sont destinées à un affichage sur les catégories. Dans ce cas, il faut ajouter le paramètre pour catégorie=oui.

Template data

Ce modèle est destiné à être apposé sur les modèles de boîtes utilisateur afin de guider les contributeurs désireux d'en utiliser dans la manière de les apposer sur leur page utilisateur.

[Modifier les données du modèle]

Paramètres du modèle

ParamètreDescriptionTypeStatut
accordaccord

Permet d'indiquer que la boîte s'accorde automatiquement en genre. Ajouter le paramètre avec n'importe quelle valeur pour activer.

Chaînefacultatif
ajustableajustable

À ajouter sur une boîte haute qui prend en charge l'ajustement en hauteur à l'aide du paramètre 'alt'. Ajouter le paramètre avec n'importe quelle valeur pour activer.

Chaînefacultatif
languelangue

Pour les boîtes de langue, indique le texte à afficher pour décrire la langue. Si ce paramètre est renseigné, il faut également indiquer le paramètre 'initiales'.

Exemple
le [[français]] ; l'[[anglais]]
Chaînefacultatif
alphabetalphabet

Pour les boîtes d'alphabet, indique le texte à afficher pour décrire l'alphabet. Si ce paramètre est renseigné, il faut également indiquer le paramètre 'initiales'.

Exemple
l'[[alphabet phonétique international]]
Chaînefacultatif
initialesinitiales

Pour les boîtes de langue et d'alphabet, indique le code utilisé par les boîtes.

Exemple
fr ; en ; API
Chaînefacultatif
pour catégoriepour catégorie

Pour les boîtes de langue et d'alphabet, indique que la boîte est destiné aux catégories et non aux pages utilisateur (boîtes dont le nom finit par '-*'). Ajouter le paramètre avec n'importe quelle valeur pour activer.

Chaînefacultatif
contenucontenu

Permet d'ajouter un contenu supplémentaire décrivant l'utilisation de la boîte.

Chaînefacultatif

La documentation de ce modèle est générée par le modèle {{Documentation}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer) et la page de test (créer).
Voir les statistiques d'utilisation du modèle sur l'outil wstat.