Modification de Modèle:Icône/doc

<noinclude>{{page de documentation}}</noinclude>
Ce modèle permet de placer une icône définie par un mot-clé.

== Syntaxe ==

<pre>{{icône|mot-clé de l'icône}}</pre>

<pre>{{icon|mot-clé de l'icône}}</pre>

== Paramètres ==

<templatedata>
{
	"params": {
		"1": {
			"label": "Mot-clé de l'icône",
			"description": "Mot-clé de l'icône, voir la documentation du modèle pour une liste complète des mots-clés disponibles. Une icône par défaut s'affiche si le mot-clé n'est pas reconnu.",
			"example": "soin",
			"required": true,
			"type": "string"
		},
		"2": {
			"label": "Dimension",
			"description": "Il est déconseillé de modifier les dimensions de l'icône. Mais il est possible de renseigner de modifier la taille en utilisant la valeur normal ou grand, ou en utilisant une taille en pixel.",
			"type": "string",
			"default": "normal"
		},
		"lien": {
			"aliases": [
				"link"
			],
			"label": "Lien",
			"description": "Lien vers un article.",
			"example": "Maître",
			"type": "string"
		},
		"infobulle": {
			"aliases": [
				"tooltip"
			],
			"label": "Infobulle",
			"description": "Texte qui s'affiche lorsque l'utilisateur survole l'icône. Par défaut, il s'agit du texte défini dans le module Icône/Données.",
			"example": "Je suis une icône",
			"type": "string"
		}
	},
	"description": "Affiche une icône",
	"paramOrder": [
		"1",
		"2",
		"lien",
		"infobulle"
	],
	"format": "inline"
}
</templatedata>

=== Tableau des icônes disponibles ===

{{#invoke:Icône|doc}}

{{clear}}

=== Ajouter une nouvelle icône ===

Il faut se rendre sur le module [[:Module:Icône/Données|Icône/Données]] et ajouter les lignes suivantes dans la table <code>icons</code>.

Merci de vérifier si l'icône existe avant d'en ajouter une nouvelle en cherchant le mot-clé ou l'alias. Rangez l'icône dans l'ordre alphabétique.

<pre>
    ['mot_cle'] = {
        aliases  = { 'alias1', 'alias2' },
        filename = 'mon_fichier.png',
        tooltip  = 'Mon infobulle !'
    },
</pre>

* <code>mot_cle</code> est le mot-clé qui permet d'identifier l'icône. Il doit être écrit en minuscule.
* <code>aliases</code> est une table contenant des mots-clés supplémentaires permettant d'identifier l'icône. Les mots-clés doivent être écrits en minuscule.
* <code>filename</code> est le nom du fichier qui sera affiché en tant qu'icône.
* <code>tooltip</code> est l'infobulle par défaut de l'icône.

== Exemples ==

{| class="va-table va-table-center-col2"
|-
! style="width: 70%;" | Entrée
! style="width: 30%;" | Résultat
|-
| <code><nowiki>{{icône|radiation}}</nowiki></code>
| {{icône|radiation}}
|-
| <code><nowiki>{{icône|radiation|grand}}</nowiki></code>
| {{icône|radiation|grand}}
|-
| <code><nowiki>{{icône|radiation|60}}</nowiki></code>
| {{icône|radiation|60}}
|-
| <code><nowiki>{{icône|radiation|100px}}</nowiki></code>
| {{icône|radiation|100px}}
|-
| <code><nowiki>{{icône|radiation|lien=Mutation}}</nowiki></code>
| {{icône|radiation|lien=Mutation}}
|-
| <code><nowiki>{{icône|radiation|infobulle=Une infobulle !}}</nowiki></code>
| {{icône|radiation|infobulle=Une infobulle !}}
|}