Modèle:Méta bandeau/Documentation

Ceci est la page de documentation de Modèle:Méta bandeau [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 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.

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.

Utilisation

Ce modèle est utilisé dans d'autres modèles pour construire des bandeaux conformes à la charte graphique.

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
forme	`forme`	Définit la forme du bandeau en fonction de l'utilisation prévue du bandeau Par défaut simple Exemple système, discussion, article...	Ligne de texte	suggéré
niveau	`niveau`	Définit la couleur du bandeau en fonction de sa gravité. Par défaut neutre Exemple grave, modéré, information ou neutre	Ligne de texte	suggéré
class	`class`	Ajoute une class au bandeau. Exemple noprint	Chaîne	facultatif
id	`id`	Affecte un identificateur au bandeau (correspond à l'attribut « id » en HTML)	Chaîne	facultatif
style	`style`	Code CSS permettant de personnaliser le style du bandeau (largeur, taille de police...). Les couleurs doivent être personnalisées via le paramètre classe.	Contenu	facultatif
icône	`icône` `image`	Icône associée au bandeau, fichier d'image ou image wikifiée. Exemple attention	Chaîne	facultatif
Classe icône	`classe icône`	Classe de l'icône, par exemple pour inverser l'image en mode sombre. Exemple skin-invert-image	Chaîne	facultatif
taille icône	`taille icône`	Change la taille de l’icône. Par défaut 45x45 Exemple 15	Chaîne	facultatif
Alternative textuelle	`alt` `légende`	Alternative textuelle de l'image.	Contenu	facultatif
texte	`texte`	Texte explicatif du bandeau Exemple Cet article ne cite pas suffisamment ses sources.	Contenu	obligatoire
supplément	`supplément`	Contenu supplémentaire à afficher en dessous du contenu du bandeau proprement dit. Exemple Une marche à suivre	Contenu	facultatif
centrer	`centrer`	Définir ce paramètre à oui pour centrer le bandeau. Exemple oui	Chaîne	facultatif
droite	`droite`	Contenu à ajouter à droite du texte.	Chaîne	facultatif
icône bma	`icône bma`	Définir ce paramètre à oui pour ajouter en haut à droite du bandeau une icône liant vers la page Aide:Bandeau (voir modèle {{bma}}). Exemple oui	Chaîne	facultatif
domaine public	`domaine public`	Définir ce paramètre à oui pour supprimer l'hyperlien sur l’icône (paramètre autorisé seulement si l’icône est dans le domaine public). Exemple oui	Chaîne	facultatif

Syntaxe

{{Méta bandeau
| forme  = article, discussion, système ou simple (facultatif, simple par défaut)
| niveau = grave, modéré, information ou neutre (facultatif, neutre par défaut)
| icône  = nom de l'image (facultatif)
| classe icône = classe de l'image (facultatif)
| alt    = alternative textuelle de l'icône (obligatoire si icône est le nom d'une image)
| texte  = texte du bandeau (obligatoire)
}}

Paramètres principaux

forme : Définit la forme du bandeau (article à bord gauche plus épais, discussion à coins arrondis...) en fonction de l'utilisation prévue du bandeau.
niveau : Définit les couleurs du bandeau.
icône : Icône associée au bandeau. Cela peut être :
- Le nom d'une image d'arrière-plan par défaut (voir la section exemple) ;
- Le nom d'une image sera affiché au format 45x45px ;
- Une ou plusieurs images complète pour un format personnalisé (déconseillé).
classe icône : classe de l'image.
alt : alternative textuelle de l'image.
texte : texte explicatif du bandeau.

Paramètres supplémentaires

Ces paramètres sont présents pour répondre à un maximum de situation, mais leur utilisation est déconseillée.

id : Affecte un identificateur au bandeau (correspond à l'attribut « id » en HTML). Par exemple, le bandeau {{Titre incorrect}} utilise « id = RealTitleBanner » (voir la documentation de ce modèle pour en comprendre l'utilité).
class : affecte une class au bandeau. Par exemple class = noprint désactivera l'affichage du bandeau lors de l'impression.
style : code CSS permettant de personnaliser le style du bandeau (largeur, taille de police...). Les couleurs doivent être personnalisées par utilisation combinée du paramètre classe et de TemplateStyles.
supplément : Contenu supplémentaire à afficher en dessous du contenu du bandeau proprement dit. Par exemple, le bandeau {{À fusionner}} utilise un tel paramètre pour afficher la marche à suivre dans une section rétractable. L'icône du bandeau sera centrée sur le contenu fourni par le paramètre « texte », sans tenir compte du contenu fourni par le paramètre « supplément ».

Exemples

Les formes

Code	Rendu
{{Méta bandeau \| forme = simple <!-- valeur par défaut --> \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| forme = article \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| forme = discussion \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| forme = note \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| forme = section \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| forme = système \| texte = texte du bandeau. }}	texte du bandeau.

Les niveaux

Code	Rendu
{{Méta bandeau \| niveau = aucun \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| niveau = neutre <!-- niveau par défaut --> \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| niveau = detail \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| niveau = ebauche \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| niveau = information \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| niveau = modéré \| texte = texte du bandeau. }}	texte du bandeau.
{{Méta bandeau \| niveau = grave \| texte = texte du bandeau. }}	texte du bandeau.

Les icônes

Dans le tableau ci-dessous, seul le contenu du paramètre icône est précisé. Le code complet utilisé pour la première ligne est :

{{Méta bandeau
  | icône = information
  | texte  = texte du bandeau.
 }}

contenu du paramètre icône	Rendu
`\| icône = accessibilite`	texte du bandeau.
`\| icône = ADQ`	texte du bandeau.
`\| icône = archives`	texte du bandeau.
`\| icône = attention`	texte du bandeau.
`\| icône = BA`	texte du bandeau.
`\| icône = biblio`	texte du bandeau.
`\| icône = categorie`	texte du bandeau.
`\| icône = conflit`	texte du bandeau.
`\| icône = ebauche`	texte du bandeau.
`\| icône = engrenage`	texte du bandeau.
`\| icône = general`	texte du bandeau.
`\| icône = important`	texte du bandeau.
`\| icône = incomplet`	texte du bandeau.
`\| icône = information`	texte du bandeau.
`\| icône = loupe`	texte du bandeau.
`\| icône = outils`	texte du bandeau.
`\| icône = protection`	texte du bandeau.
`\| icône = protege`	texte du bandeau.
`\| icône = recyclage`	texte du bandeau.
`\| icône = semiprotection`	texte du bandeau.
`\| icône = sons`	texte du bandeau.
`\| icône = sources`	texte du bandeau.
`\| icône = stop`	texte du bandeau.
`\| icône = travaux`	texte du bandeau.
`\| icône = videos`	texte du bandeau.
\| icône = Puppeter template.svg \| alt = icône représentant un faux-nez	texte du bandeau.
\| icône = <span style="white-space:nowrap;">[[Fichier:Merge-arrow.svg\|32px\|poubelle]] [[Fichier:Wikimedia Community Logo.svg\|40px\|Wikimedia]]</span>	texte du bandeau.

Voir aussi