Utilisateur:Paulokoko/Modèle:Avancement/Documentation
Le modèle {{Avancement}} permet d'afficher une barre de progression calibrée de 0 à 100%, idéale pour afficher :
- les résultats d'un sondage ;
- l'état d'avancement d'une traduction ;
- l'état d'évaluation des articles d'un projet ;
- etc...
Il peut facilement être utilisé dans un tableau pour ajouter des commentaires, avant ou après le modèle.
Utilisation
[modifier | modifier le code]Vous pouvez placer ce modèle n'importe où, en utilisant les deux syntaxes suivantes.
Syntaxe simple
[modifier | modifier le code]La syntaxe simple permet d'utiliser rapidement le modèle. Les paramètres doivent être spécifiés dans un ordre précis.
{{Avancement|''avancement''|couleur|fond|barre|texte|alt|inv}}
Consultez les exemples d'utilisation pour comprendre l'utilisation de cette syntaxe.
Syntaxe complexe
[modifier | modifier le code]La syntaxe complexe permet d'éviter l'utilisation des caractères « | » et peut s'avérer plus facile d'utilisation dans certains cas de barre de progression complexes. En remplissant chaque champ connu (après le signe « = ») avec la valeur adaptée. Seul le premier paramètre est obligatoire, les autres paramètres sont optionnels et ont une valeur par défaut.
{{Avancement | avancement= | couleur= | fond= | barre= | texte= | alt= | inv= }} |
Paramètres
[modifier | modifier le code]La signification des paramètres est la suivante :
Paramètre | Description | Type | Format |
---|---|---|---|
avancement |
Avancement | Obligatoire | Numérique. |
couleur |
Couleur de la barre d'avancement. Par défaut la couleur de la barre d'avancement est en fonction du paramètre d'avancement (dégradé de rouge (0%) à vert (100%)). | Facultatif | Couleur (aide). |
fond |
Style du fond de la barre d'avancement. Par défaut « gris clair » avec une bordure « grise foncée ». | Style CSS. | |
barre |
Style de la barre d'avancement. La couleur ne devrait pas être spécifiée ici mais par le paramètre couleur. Vous pourriez y spécifier un style supplémentaire à la barre d'avancement (marges, bordures, etc). | Facultatif | Style CSS. |
texte |
Style du texte affiché. Par défaut reprend le style de texte de la section où est inséré le modèle. | Facultatif | Stle CSS. |
alt |
Texte alternatif. Par défaut affiche l'avancement suivi du signe « % » | Facultatif | Chaîne de caractères |
inv |
Dégradé inversé. Passant du vert (0%) au rouge (100%). Par défaut affiche le dégradé dans son ordre « logique ». | Facultatif | "1" pour activer (voir exemples) |
inv |
Permet un affiche dans le court du texte (mode d'affichage CSS « inline »). Notez que cette option désactive les styles définis pour les barres d'avancemnts dans votre monobook CSS (voir personnalisation). L'utilisation de cette option peut donner des résultats variables voir inattendus sur certains navigateurs | Facultatif | "1" pour activer (voir exemples) |
Dégradés
[modifier | modifier le code]Normal | Inverse |
---|---|
|
|
Exemples d'utilisation
[modifier | modifier le code]Syntaxe simple
[modifier | modifier le code]{{Avancement|''avancement''|couleur|fond|barre|texte|alt|inv|inline}}
- Barre simple (dégradé par défaut) :
- {{Avancement|25}}
- {{Avancement|46}}
- {{Avancement|77}}
- {{Avancement|25}}
- Paramètre couleur de barre spécifié :
- {{Avancement|75|lightgreen}}
- {{Avancement|75|#8080FF}}
- {{Avancement|75|lightgreen}}
- Paramètre style de fond spécifié :
- {{Avancement|75||border:0;}}
- {{Avancement|75||background-color:yellow;}}
- {{Avancement|75||margin-top:10px;margin-bottom:10px;}}
- {{Avancement|75||border:0;}}
- Paramètre style de la barre spécifié :
- {{Avancement|75|||border-right:solid 2px red;}}
- {{Avancement|75|||border:solid 2px #FF8000;}}
- {{Avancement|75|||border-right:solid 2px red;}}
- Paramètre style du texte spécifié :
- {{Avancement|75||||font-weight:bold;}}
- {{Avancement|75||||color:red;}}
- {{Avancement|75||||font-weight:bold;}}
- Paramètre texte alternatif spécifié :
- {{Avancement|25|||||¼ L}}
- {{Avancement|70|||||En cours}}
- {{Avancement|25|||||¼ L}}
- Paramètre d'inversion spécifié :
- {{Avancement|25||||||1}}
- {{Avancement|75||||||1}}
- {{Avancement|25||||||1}}
- Paramètre inline spécifié :
- {{Avancement|50|||||||1}} Traduction effectuée à ██████████50%
- {{Avancement|100|||||||1}} Je suis d'accord à ██████████100% !
- Exemple d'utilisation de multiple paramètres (style du texte, style de la barre et texte alternatif spécifiés) :
- {{Avancement|50|||border:solid 1px black;|font-style:italic;|½ portion}}
- {{Avancement|50|||border:solid 1px black;|font-style:italic;|½ portion}}
Syntaxe complexe
[modifier | modifier le code]{{Avancement | avancement= | couleur= | fond= | barre= | texte= | alt= | inv= | inline= }} |
- Barre simple (dégradé par défaut) :
- {{Avancement|avancement=25}}
- {{Avancement|avancement=46}}
- {{Avancement|avancement=77}}
- {{Avancement|avancement=25}}
- Paramètre couleur de barre spécifié :
- {{Avancement|avancement=75|couleur=lightgreen}}
- {{Avancement|avancement=75|couleur=#8080FF}}
- {{Avancement|avancement=75|couleur=lightgreen}}
- Paramètre style de fond spécifié :
- {{Avancement|avancement=75|fond=border:0;}}
- {{Avancement|avancement=75|fond=background-color:yellow;}}
- {{Avancement|avancement=75|fond=margin-top:10px;margin-bottom:10px;}}
- {{Avancement|avancement=75|fond=border:0;}}
- Paramètre style de la barre spécifié :
- {{Avancement|avancement=75|barre=border-right:solid 2px red;}}
- {{Avancement|avancement=75|barre=border:solid 2px #FF8000;}}
- {{Avancement|avancement=75|barre=border-right:solid 2px red;}}
- Paramètre style du texte spécifié :
- {{Avancement|avancement=75|texte=font-weight:bold;}}
- {{Avancement|avancement=75|texte=color:red;}}
- {{Avancement|avancement=75|texte=font-weight:bold;}}
- Paramètre texte alternatif spécifié :
- {{Avancement|avancement=25|alt=¼ L}}
- {{Avancement|avancement=70|alt=En cours}}
- {{Avancement|avancement=25|alt=¼ L}}
- Paramètre d'inversion spécifié :
- {{Avancement|avancement=25|inv=1}}
- {{Avancement|avancement=75|inv=1}}
- {{Avancement|avancement=25|inv=1}}
- Paramètre inline spécifié :
- {{Avancement|avancement=50|inline=1}} Traduction effectuée à ██████████50%
- {{Avancement|avancement=100|inline=1}} Je suis d'accord à ██████████100% !
- Exemple d'utilisation de multiple paramètres (style du texte, style de la barre et texte alternatif spécifiés) :
- {{Avancement|avancement=50|barre=border:solid 1px black;|texte=font-style:italic;|alt=½ portion}}
- {{Avancement|avancement=50|barre=border:solid 1px black;|texte=font-style:italic;|alt=½ portion}}
Personnalisation
[modifier | modifier le code]Ce modèle peut être également personnalisable via le monobook CSS grâce aux deux classes suivantes :
.avance_boite { } .avance_barre { }
Exemple d'utilisation :
.avance_boite { width: 100px; // largeur de la boite background-color: lightgray; // couleur du fond border: solid 1px gray; // style, taille et couleur de la bordure } .avance_barre { background-color: #A0FFA0; // couleur de la barre text-align: right; // alignement du texte font-size: 100%; // taille du texte font-weight: bold; // epaisseur du texte }
Notez que cette personnalisation est inutile dans le cas de l'utilisation du paramètre inline.