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 modèle utilise le module Bandeau, un script écrit dans le langage de programmation Lua. Toute expérimentation devrait être conduite d'abord via sa sous-page bac à sable. Voir le Projet:Scribunto si vous voulez en savoir plus.

Utilisation

<templatedata> { "params": { "forme": { "description": "Définit la forme du bandeau en fonction de l'utilisation prévue du bandeau", "type": "line", "default": "simple", "suggested": true, "example": "système, discussion, article..." }, "niveau": { "example": "grave, modéré, information ou neutre", "type": "line", "default": "neutre", "suggested": true, "description": " Définit la couleur du bandeau en fonction de sa gravité." }, "icône": { "description": "Icône associée au bandeau, fichier d'image ou image wikifiée.", "type": "string", "example": "attention", "aliases": [ "image" ] }, "alt": { "label": "Alternative textuelle", "type": "content", "description": "Alternative textuelle de l'image.", "aliases": [ "légende" ] }, "domaine public": { "description": "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).", "example": "oui", "type": "string" }, "taille icône": { "description": "Change la taille de l’icône.", "example": "15", "type": "string", "default": "45x45" }, "texte": { "required": true, "suggested": true, "description": "Texte explicatif du bandeau", "example": "Cet article ne cite pas suffisamment ses sources.", "type": "content" }, "supplément": { "description": "Contenu supplémentaire à afficher en dessous du contenu du bandeau proprement dit.", "example": "Une marche à suivre", "type": "content" }, "style": { "description": "Code CSS permettant de personnaliser le style du bandeau (largeur, couleur, taille de police...).", "type": "content" }, "id": { "description": "Affecte un identificateur au bandeau (correspond à l'attribut « id » en HTML)", "type": "string" }, "class": { "example": "noprint", "description": "Ajoute une class au bandeau.", "type": "string" }, "centrer": { "description": "Définir ce paramètre à oui pour centrer le bandeau.", "example": "oui", "type": "string" }, "droite": { "description": "Contenu à ajouter à droite du texte.", "type": "string" }, "icône bma": {

"description": "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

).",

"example": "oui", "type": "string" } }, "description": "Ce modèle est utilisé dans d'autres modèles pour construire des bandeaux conformes à la charte graphique.", "format": "block", "paramOrder": [ "forme", "niveau", "class", "id", "style", "icône", "taille icône", "alt", "texte", "supplément", "centrer", "droite", "icône bma", "domaine public" ] } </templatedata>

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)
| 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é).
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, couleur, taille de police...)
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;">[[Image:Merge-arrow.svg\|32px\|poubelle]] [[Image:Wikimedia Community Logo.svg\|40px\|Wikimedia]]</span>	texte du bandeau.

Voir aussi