Module:Chartes/Documentation

Ceci est la page de documentation pour Module:Chartes

Utilisation

Fonction exportable :

charte(frame) – retourne la couleur correspondant à l'infobox, la catégorie et le type de charte graphique désirée
- Paramètres :
  - infobox= : indique le type d'infobox (chaque type d'infobox peut avoir ses chartes graphiques). Valeur par défaut : "biographie"
  - type= : type de charte dans le cadre de l'infobox choisie. Valeur par défaut : "défaut"
  - catégorie= : catégorie de couleur dans le cadre de l'infobox et du type de charte. Les valeurs possibles sont "principale" (ou "1" ou "primaire"), "secondaire" (ou "2"), éventuellement "tertiaire" (ou "3"). Valeur par défaut : "primaire"
  - dièse=oui : la couleur retournée est précédée du dièse (#). Valeur par défaut : absent (le # n'est pas inséré)

Note : l'option dièse=oui pose problème : le # est interprété lors du retour du module, générant un début de liste numérotée. Ne pas utiliser pour le moment.

Fonction utilisable directement depuis un autre module :

charte_m(infobox, categorie, tpe, diese) − fonction identique à la précédente, mais appelable directement depuis un autre module (note : diese peut valoir « oui » ou true)

Sous-module de données

Ce module utilise le sous-module Module:Chartes/données qui décrit les chartes pour les différentes infobox, types et catégories.

Format

Le format de ce sous-module est le suivant :

une entrée dans la table data pour chaque infobox gérée
- cette entrée doit avoir comme index le nom de l'infobox (tel que passé au paramètre infobox=). Ceci peut se faire de deux façons :
  - data.nom = { … } pour l'infobox « nom », si et seulement si « nom » ne contient que des lettres non accentués (et pas d'espaces)
  - data["nom"] = { … } pour l'infobox « nom », dans les autres cas (espaces, accents, autres caractères)
- cette entrée est une table dont chaque élément décrit un type de charte. Construction :
  - indexé par le type tel que passé au paramètre type=
  - le contenu est une table contenant au moins deux chaînes, la première correspondant à la catégorie "primaire", la seconde à la catégorie "secondaire" (et éventuellement une troisième pour la catégorie "tertiaire")
  - il doit obligatoirement y avoir une entrée pour le type "défaut" correspondant aux couleurs par défaut
  - les entrées doivent obligatoirement être en minuscules. Il ne faut pas écrire "rugby à XIII" mais "rugby à xiii".
  - si un type reprend les mêmes valeurs qu'un autre type il faut remplacer la table par une chaîne contenant le nom du type cible (voir exemples)

Exemples

Dans l'exemple ci-dessous on crée une charte pour l'infobox "biographie" et une charte pour l'infobox "test" :

-- Note : bien penser au séparateur l'éléments (la virgule en fin de ligne).
--        Le dernier élément peut ne pas en avoir.
-- une entrée pour l'infobox "biographie" dans la table "data"
data["biographie"] = {
    -- on crée une entrée par "type"
    -- une entrée "défaut" obligatoire
    ["défaut"] = { "FFFFFF", "EEEEEE" },  -- une entrée par catégorie (primaire, secondaire)
    -- pour compatibilité on accepte "default", identique
    ["default"] = "défaut",  -- un texte au lieu d'une table indique une "redirection"
    -- type "animation et BD asiatique"
    ["animation et bande dessinée asiatiques"] = { "80DDBF", "B0FFD0" },
    -- version plus courte
    ["abda"] = "animation et bande dessinée asiatiques"
} -- fin de "biographie"

-- une entrée pour l'infobox "test" dans la table "data"
data["test"] = {
    -- une entrée "défaut" obligatoire
    ["défaut"] = { "AACCEE", "EECCAA", "AAEECC" },  -- une entrée par catégorie (primaire, secondaire, tertiaire)
    -- type "type1"
    ["type1"] = { "00CCEE", "00CCAA", "00EECC" },
    -- type "type2"
    ["type2"] = { "AACC00", "EECC00", "AAEE00" },
} -- fin de "test"

Exemples d'utilisation

{{#invoke:Chartes|charte|infobox=test|type=cat1|catégorie=primaire}} donne « AAAAAA »
{{#invoke:Chartes|charte|infobox=test|type=cat1|catégorie=secondaire}} donne « AAAA00 »
{{#invoke:Chartes|charte|infobox=test|type=cat2|catégorie=primaire}} donne « 777777 »
{{#invoke:Chartes|charte|infobox=test|type=cat2|catégorie=secondaire}} donne « 777700 »

Voir aussi Discussion module:Chartes.