Modification de Modèle:Méta bandeau/documentation

{{Sous-page de documentation}}
{{Avertissement méta-modèle}}
{{Modèle utilisant les modules Lua|Bandeau}}

== 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 {{bma}}).",
			"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 ==
 <nowiki>{{</nowiki>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)
 <nowiki>}}</nowiki>

== Paramètres principaux ==
* <code>forme</code> : Définit la forme du bandeau (article à bord gauche plus épais, discussion à coins arrondis...) en fonction de l'utilisation prévue du bandeau.
* <code>niveau</code> : Définit les couleurs du bandeau.
* <code>icône</code> : 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é).
* <code>alt</code> : alternative textuelle de l'image.
* <code>texte</code> : 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.
* <code>id</code> : Affecte un identificateur au bandeau (correspond à l'attribut « id » en [[HTML]]).  Par exemple, le bandeau {{m|Titre incorrect}} utilise « id = RealTitleBanner » (voir la documentation de ce modèle pour en comprendre l'utilité).
* <code>class</code> : affecte une ''class'' au bandeau. Par exemple <code>class = noprint</code> désactivera l'affichage du bandeau lors de l'impression.
* <code>style</code> : code [[Feuilles de style en cascade|CSS]] permettant de personnaliser le style du bandeau (largeur, couleur, taille de police...)
* <code>supplément</code> : Contenu supplémentaire à afficher en dessous du contenu du bandeau proprement dit. Par exemple, le bandeau {{m|À 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 ===
{| class="wikitable" style="width: 100%; table-layout: fixed;"
! scope=col style="width: 50%"| Code
! scope=col style="width: 50%"| Rendu
|-
| <pre>{{Méta bandeau
  | forme = simple <!-- valeur par défaut -->
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | forme = simple <!-- valeur par défaut -->
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | forme = article
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | forme = article
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | forme = discussion
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | forme = discussion
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | forme = note
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | forme = note
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | forme = section
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | forme = section
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | forme = système
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | forme = système
  | texte  = texte du bandeau.
 }}
|}

=== Les niveaux ===
{| class="wikitable" style="width: 100%; table-layout: fixed;"
! scope=col style="width: 50%"| Code
! scope=col style="width: 50%"| Rendu
|-
| <pre>{{Méta bandeau
  | niveau = aucun
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | niveau = aucun
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | niveau = neutre <!-- niveau par défaut -->
  | texte  = texte du bandeau.
 }}</pre>
| {{Méta bandeau
  | niveau = neutre <!-- niveau par défaut -->
  | texte  = texte du bandeau.
 }}
|-
| <pre>{{Méta bandeau
  | niveau = detail
  | texte  = texte du bandeau.
}}</pre>
| {{Méta bandeau
  | niveau = detail
  | texte  = texte du bandeau.
}}
|-
| <pre>{{Méta bandeau
  | niveau = ebauche
  | texte  = texte du bandeau.
}}</pre>
| {{Méta bandeau
  | niveau = ebauche
  | texte  = texte du bandeau.
}}
|-
| <pre>{{Méta bandeau
  | niveau = information
  | texte  = texte du bandeau.
}}</pre>
| {{Méta bandeau
  | niveau = information
  | texte  = texte du bandeau.
}}
|-
| <pre>{{Méta bandeau
  | niveau = modéré
  | texte  = texte du bandeau.
}}</pre>
| {{Méta bandeau
  | niveau = modéré
  | texte  = texte du bandeau.
}}
|-
| <pre>{{Méta bandeau
  | niveau = grave
  | texte  = texte du bandeau.
}}</pre>
| {{Méta bandeau
  | niveau = grave
  | texte  = 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 :
<pre>{{Méta bandeau
  | icône = information
  | texte  = texte du bandeau.
 }}</pre>
{| class="wikitable" style="width: 100%; table-layout: fixed;"
! scope=col style="width: 50%"| contenu du paramètre icône
! scope=col style="width: 50%"| Rendu
|-
| <code><nowiki>| icône = accessibilite</nowiki></code>
| {{Méta bandeau
  | icône = accessibilite
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = ADQ</nowiki></code>
| {{Méta bandeau
  | icône = ADQ
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = archives</nowiki></code>
| {{Méta bandeau
  | icône = archives
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = attention</nowiki></code>
| {{Méta bandeau
  | icône = attention
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = BA</nowiki></code>
| {{Méta bandeau
  | icône = BA
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = biblio</nowiki></code>
| {{Méta bandeau
  | icône = biblio
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = categorie</nowiki></code>
| {{Méta bandeau
  | icône = categorie
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = conflit</nowiki></code>
| {{Méta bandeau
  | icône = conflit
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = ebauche</nowiki></code>
| {{Méta bandeau
  | icône = ebauche
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = engrenage</nowiki></code>
| {{Méta bandeau
  | icône = engrenage
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = general</nowiki></code>
| {{Méta bandeau
  | icône = general
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = important</nowiki></code>
| {{Méta bandeau
  | icône = important
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = incomplet</nowiki></code>
| {{Méta bandeau
  | icône = incomplet
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = information</nowiki></code>
| {{Méta bandeau
  | icône = information
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = loupe</nowiki></code>
| {{Méta bandeau
  | icône = loupe
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = outils</nowiki></code>
| {{Méta bandeau
  | icône = outils
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = protection</nowiki></code>
| {{Méta bandeau
  | icône = protection
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = protege</nowiki></code>
| {{Méta bandeau
  | icône = protege
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = recyclage</nowiki></code>
| {{Méta bandeau
  | icône = recyclage
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = semiprotection</nowiki></code>
| {{Méta bandeau
  | icône = semiprotection
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = sons</nowiki></code>
| {{Méta bandeau
  | icône = sons
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = sources</nowiki></code>
| {{Méta bandeau
  | icône = sources
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = stop</nowiki></code>
| {{Méta bandeau
  | icône = stop
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = travaux</nowiki></code>
| {{Méta bandeau
  | icône = travaux
  | texte  = texte du bandeau.
 }}
|-
| <code><nowiki>| icône = videos</nowiki></code>
| {{Méta bandeau
  | icône = videos
  | texte  = texte du bandeau.
 }}
|-
| <pre>| icône = Puppeter template.svg
| alt = icône représentant un faux-nez
</pre>
| {{Méta bandeau
  | icône = Puppeter template.svg
  | alt = icône représentant un faux-nez
  | texte  = texte du bandeau.
 }}
|-
| <pre>| icône = <span style="white-space:nowrap;">[[Image:Merge-arrow.svg|32px|poubelle]]&ensp;[[Image:Wikimedia Community Logo.svg|40px|Wikimedia]]</span></pre>
| {{Méta bandeau
  | icône = <span style="white-space:nowrap;">[[Image:Merge-arrow.svg|32px|poubelle]]&ensp;[[Image:Wikimedia Community Logo.svg|40px|Wikimedia]]</span>
  | texte  = texte du bandeau.
 }}
|}

== Voir aussi ==
* {{m|Méta bandeau d'avertissement}}
* {{m|Méta bandeau de note}}
* {{m|Méta bandeau de section}}
<includeonly>
[[Catégorie:Modèle de bandeau| ]]
[[Catégorie:Méta-modèle]]
</includeonly>