Modèle:Documentation boîte utilisateur/Documentation

Documentation du modèle

Ceci est la page de documentation de Modèle:Documentation boîte utilisateur. [rafraîchir] · [modifier] · [historique]

Utilisation et paramètres

Ce modèle est destiné à être apposé sur les 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

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

Utilisation avec texte additionnel

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

Si la boîte s'accorde en genre, il faut penser à utiliser en plus le paramètre accord : {{Documentation boîte utilisateur|contenu=Texte additionnel|accord=1}}

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.