Modèle:Méta bandeau d'avertissement/Documentation

Ceci est la page de documentation de Modèle:Méta bandeau d'avertissement [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": { "niveau": { "description": "Type de bandeau.", "example": "grave, modéré, ébauche ou information", "required": true, "suggested": true, "type": "string" }, "class": { "description": "Ajoute une class au bandeau.", "example": "noprint", "type": "string" }, "icône": { "description": "Nom de l'image.", "suggested": true, "type": "string" }, "alt": { "description": "Alternative textuelle de l'icône (obligatoire si icône est le nom d'une image).", "aliases": [ "légende" ], "type": "string" }, "titre": { "description": "Titre du bandeau.", "example": "Attention, cet article n'existe pas !", "required": true, "suggested": true, "type": "string" }, "texte": { "description": "Texte de l'avertissement.", "suggested": true, "type": "string" }, "date": { "description": "Affiché à droite du titre, sur la même ligne mais sans formatage. ", "suggested": true, "type": "string" }, "icône-complexe": {

"description": "À utiliser à la place du paramètre icône, pour remplacer l'image par du contenu quelconque. Par exemple, le modèle

utilise un tel paramètre pour afficher plusieurs icônes lorsque plusieurs thèmes lui sont fournis. À utiliser avec parcimonie.",

"type": "string" }, "id": { "description": " Affecte un identificateur au bandeau (correspond à l'attribut « id » en HTML). Par exemple, le bandeau Modèle:Titre incorrect utilise « id = RealTitleBanner » (voir la documentation de ce modèle pour en comprendre l'utilité).", "type": "string" }, "supplément": { "description": "Contenu supplémentaire à afficher en dessous du contenu du bandeau proprement dit. Par exemple, le bandeau Modèle:À 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 les paramètres « titre » et « texte », sans tenir compte du contenu fourni par le paramètre « supplément ».", "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" }, "domaine public": { "example": "oui", "type": "string" } }, "description": "Ce modèle est utilisé dans d'autres modèles pour construire des bandeaux d'avertissements conformes à la charte graphique. NE PAS UTILISER DANS LES ARTICLES !", "format": "block", "paramOrder": [ "niveau", "class", "id", "icône", "alt", "icône-complexe", "titre", "texte", "date", "domaine public", "icône bma", "supplément" ] } </templatedata>

Syntaxe

{{Méta bandeau d'avertissement
| niveau = grave, modéré, ébauche, ou information (obligatoire)
| icône = nom de l'image (facultatif)
| alt = alternative textuelle de l'icône (obligatoire si icône est le nom d'une image)
| titre = titre de l'avertissement (obligatoire)
| texte = texte de l'avertissement (facultatif)
}}

D'autre part, le paramètre icône peut être remplacé par un paramètre icône-complexe, et des paramètres id et supplément peuvent être ajoutés.

Paramètres

niveau

Type de bandeau. Voici quelques indications pour choisir le niveau :

• Niveau « grave » : Nécessité de modification urgente, violation manifeste d'un principe fondateur (non neutralité de point de vue, etc.), ou d'une règle (travail inédit, etc.), disparition prochaine possible de contenu (violation de copyright, proposition de suppression, etc.)
• Niveau « modéré » : Besoin de modification sur l'article (à internationaliser, etc.), annonce de travail en cours (traduction, etc.). (Les avertissements permanents sont exclus.)
• Niveau « ébauche » : Bandeaux d'ébauche. Un tel paramètre devrait être utilisé uniquement par le modèle {{ébauche}}. Par défaut, le style est le même que pour les bandeaux de niveau « information ».
• Niveau « information » : Avertissements permanents, y compris les avertissement d'évènement récents ou futurs. (Les bandeaux de maintenance, les annonces de travaux, etc. sont exclus.)

icône

Nom d'une image (sans le préfixe « Image: ») à faire apparaître à gauche du bandeau en guise d'icône. 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.

Pour l'accessibilité du bandeau, si un nom d'icône est précisé, il faut renseigner le paramètre alt, alternative textuelle de l'image.

titre et texte

Titre et texte explicatif du bandeau. Idéalement, le titre doit être court et significatif (maximum une ligne), et le texte ou sous-titre 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.

date

Affiché à droite du titre, sur la même ligne mais sans formatage.

Paramètres supplémentaires

• icône-complexe : À utiliser à la place du paramètre icône, pour remplacer l'image par du contenu quelconque. Par exemple, le modèle {{Ébauche}} utilise un tel paramètre pour afficher plusieurs icônes lorsque plusieurs thèmes lui sont fournis. À utiliser avec parcimonie.
• 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é).
• 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 les paramètres « titre » et « texte », sans tenir compte du contenu fourni par le paramètre « supplément ».
• icône bma : Définir ce paramètre à oui pour ajouter en haut à droite du bandeau une icône liant vers Aide:Bandeau (voir modèle {{bma}}).

Exemples

Avec le paramètre icône

Code	Rendu
{{Méta bandeau d'avertissement | niveau = modéré | icône = Nuvola apps locale.svg | alt = drapeaux | titre = Cet article doit être [[wikipédia:Guide d'internationalisation|internationalisé]]. | texte = Cet article adopte un point de vue régional ou culturel particulier et doit être internationalisé. [[{{TALKPAGENAME}}|Discutez-en]] ou [{{fullurl:{{BASEPAGENAME}}|action=edit}} améliorez-le] ! }}

Sans paramètre icône

Une icône générique est fournie.

Code	Rendu
{{Méta bandeau d'avertissement | niveau = grave | titre = Bandeau de niveau grave. | texte = Alerte avec icône générique. }}
{{Méta bandeau d'avertissement | niveau = modéré | titre = Bandeau de niveau modéré. | texte = Avertissement avec icône générique. }}
{{Méta bandeau d'avertissement | niveau = ébauche | titre = Bandeau de niveau ébauche. | texte = Ébauche avec icône générique. }}
{{Méta bandeau d'avertissement | niveau = information | titre = Bandeau de niveau information. | texte = Information avec icône générique. }}

Avec le paramètre date

Code	Rendu
{{Méta bandeau d'avertissement | niveau = modéré | titre = Bandeau de niveau modéré. | date = octobre 2012 | texte = Avertissement avec icône générique. }}