Modèle:Documentation boîte utilisateur

Une page de Wikipédia, l'encyclopédie libre.
Sauter à la navigation Sauter à la recherche

 Documentation[modifier] [purger]

Utilisation et paramètres[modifier le code]

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.

Boîte simple[modifier le code]

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[modifier le code]

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[modifier le code]

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[modifier le code]

Langues[modifier le code]

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[modifier le code]

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[modifier le code]

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.

Utilisation avec texte additionnel[modifier le code]

Pour ajouter un texte court dans la documentation sans créer de sous-page dédiée, il est possible d'utiliser le paramètre contenu : {{Documentation boîte utilisateur|contenu=Texte additionnel}}

Notez que si le code du texte à afficher est complexe, il est fortement recommandé d'utiliser une sous-page de documentation dédiée. L'usage du paramètre contenu devrait être limité à des phrases simples.

Bandeaux[modifier le code]

Pour ajouter des bandeaux en bas de page, il est possible d'utiliser le paramètre autres liens (par exemple, {{Documentation boîte utilisateur|autres liens={{projet Asie}}}})

Template data[modifier le code]

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.

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 supporte 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
Autres liensautres liens

Permet d'ajouter des liens, par exemple sous la forme de bandeaux de catégories.

Chaînefacultatif