Modèle:Méta bandeau d'avertissement/Documentation
Ce modèle est utilisé dans d'autres modèles pour construire des bandeaux d'avertissements conformes à la charte graphique. Il n'est pas destiné à être utilisé directement dans les livres.
Syntaxe
modifier{{Méta bandeau d'avertissement | niveau = grave, modéré, ébauche, ou information (obligatoire) | icône = nom de l'image (facultatif) | 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é.
Explication des paramètres
modifierParamètre « niveau »
modifierType 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 officielle (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.), à l'exception des bandeaux d'ébauche. (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 « modéré ».
- 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.)
Paramètres « icône »
modifierNom d'une image (sans le préfixe « Image: ») à faire apparaitre à 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 45 pixels de large et 35 pixels de hauteur . 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.
Paramètres « titre » et « texte »
modifierTitre 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.
Paramètres supplémentaires : « icône-complexe », « id » et « supplément »
modifier- 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 w: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 ».
Exemples d’utilisation
modifierAvec le paramètre « icône »
modifierCode | Rendu | ||
---|---|---|---|
{{Méta bandeau d'avertissement |
|
Sans paramètre « icône »
modifierUne icône générique est fournie
Code | Rendu | ||
---|---|---|---|
{{Méta bandeau d'avertissement |
| ||
{{Méta bandeau d'avertissement |
| ||
{{Méta bandeau d'avertissement |
| ||
{{Méta bandeau d'avertissement |
|