Modèle:Documentation boîte utilisateur

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 :

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.

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}}

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}}

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)

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)

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.