Module:Icône/Données

Documentation[voir] [modifier] [purger]

Ce module contient les données utilisés par Module:Icône pour générer une icône.

Ajouter une icône

Pour ajouter une nouvelle icône, il suffit d'ajouter les lignes suivantes dans la table icons.

	["nom_icône"] = {
		aliases   = {"alias1", "alias2",},
        alt       = "un_alt",
        image     = "nom_image.png",
        size      = "taille_image",
		tooltip   = "Connexe",
	},

Paramètre	Obligatoire	Description
nom_icône	oui	Mot-clé en minuscule qui sera utilisé pour identifier l'icône.
aliases	non	Une table contenant des alias à nom_icône
alt	non	Texte alternatif décrivant l'image si elle ne se charge pas, ou utile pour les non-voyants.
image	oui	Nom du fichier utilisé comme icône.
size	non	Taille de l'image
tooltip	non	Message à faire apparaître lors du passage du pointeur de la souris

L'ajout d'une icône est soumises à certaines règles.

• Avant d'ajouter une icône, veuillez vérifier qu'elle n'existe déjà pas dans l'inventaire.
• Les icônes doivent être rangées dans l'ordre alphabétique de nom_icône.
• Si un paramètre optionnel n'est pas renseigné, il doit être supprimé.
• Conserver toutes les virgules à la fin de chaque paramètre.
• Les chaînes de caractères doivent être définies entre guillemets doubles "...".

Exemples

Exemple le plus simple avec uniquement les paramètres obligatoires.

	["connexe"] = {
        image     = "Molécule.png",
	},

Icône avec un paramétrage complet

	["connexe"] = {
		aliases   = {"voisin", "lié",},
        alt       = "Image représentant une molécule",
        image     = "Molécule.png",
        size      = "20x20px",
		tooltip   = "Article connexe",
	},

La documentation de ce modèle est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.

-- Merci d'ajouter les icônes dans l'ordre alphabétique

local icons = {
	["connexe"] = {
		image   = "Molécule.png",
		tooltip = "Connexe",
	},
}

-- Gestion des alias

local data = {}

for k, t in pairs(icons) do
    if t.aliases then
        for i, alias in ipairs(t.aliases) do
            data[alias] = t
        end
        t.aliases = nil
    end
    data[k] = t
end

return data