Modèle:Méta bandeau de section/Documentation

Ceci est la page de documentation de Modèle:Méta bandeau de section [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.

Ce modèle utilise le module Bandeau, un script écrit dans le langage de programmation Lua. Toute expérimentation devrait être conduite d'abord via une sous-page bac à sable. Voir le projet Scribunto si vous voulez en savoir plus.

Ce méta-modèle ne doit pas être utilisé directement dans l’espace principal (articles, catégories, etc.).

Ce modèle générique paramétré est destiné uniquement à la construction d’autres modèles.

Utilisation modifier

Ce modèle est utilisé dans d'autres modèles pour construire des bandeaux de section conformes à la charte graphique. NE PAS UTILISER DANS LES ARTICLES !

Paramètres du modèle[Modifier les données du modèle]
La mise en forme multiligne est préférée pour ce modèle.
Paramètre		Description	Type	État
Icône	`icône` `image`	Nom de l'image.	Ligne de texte	facultatif
Icône - domaine public	`domaine public`	Mettre à la valeur « oui » si l'image choisie est dans le domaine public. Utilisation inutile si le paramètre icône correspond à une image affichée depuis une classe CSS.	Ligne de texte	facultatif
Alternative	`alt` `légende`	Alternative textuelle de l'icône.	Chaîne	facultatif
Texte	`texte`	Texte de l'avertissement.	Chaîne	facultatif

Syntaxe modifier

{{Méta bandeau de section
| icône  = ''nom de l'image'' (facultatif)
| alt    = alternative textuelle de l'icône (facultatif)
| texte  = ''texte de l'avertissement'' (facultatif)
}}

Paramètres modifier

`icône` modifier

Image à faire apparaître à gauche du bandeau en guise d'icône. Il existe deux utilisations possibles du paramètre.

A. Sollicitation d'une image prédéfinie dans les classes CSS dédiées (liste des paramètres valides dans Module:Bandeau/Class dans la définition de la variable locale « icones » ; images correspondantes dans MediaWiki:Common.css).
Exemples : icône=travaux, icône=recyclage.
B. Sollicitation d'une autre image depuis un fichier de Wikipédia ou de WikiCommons.
Nom d'une image (sans le préfixe « Image: »). Pour raison d'uniformité de style, la taille ne peut pas être spécifiée : ce sera la plus grande taille qui permet d'insérer l'image dans un rectangle de Modèle:Dunité. Préférer une icône graphiquement simple et significative. En l'absence de ce paramètre, une icône par défaut dépendant du niveau est fournie.
Par exemple, les icônes des collections Nuvola et Crystal Clear conviennent particulièrement bien du point de vue graphique.
En cas d'utilisation d'un fichier image (option B.), il est possible de marquer l'icône comme faisant partie du domaine public (grâce au paramètre additionnel domaine public = oui), ce qui a pour effet de retirer le lien sur l'image.

`texte` modifier

Texte explicatif du bandeau. Idéalement, le texte doit être bref, en un seul paragraphe. Ne pas enrober le message dans une prose inutilement longue. Limiter les liens aux liens les plus pertinents.