Module:ExempleParams/Documentation

ExempleParams est un court module qui montre comment récupérer les paramètres à l'intérieur du module au moyen de ipairs() et de pairs(). Il s'agit d'un modèle à visée pédagogique (voir Aide:Module).

Utilisation

Fonctions exportables :

• imprime_les_parametres(params) – cette fonction imprime les paramètres qu'on lui passe.

Modules externes et autres éléments dont ce module a besoin pour fonctionner :

• mw.ipairs – générateur de paramètres non nommés.
• mw.pairs – générateur de paramètres nommés (remarques, il reprend également les paramètres non nommés avec '1', '2', '3',... comme clé.

Exemples

{{#invoke:ExempleParams|imprime_les_parametres|paramètre non nommé 1|paramètre non nommé 2|troisième paramètre|nommé1=couleur|nommé2=bleu|dernier nommé=last}} donne :

Paramètres séquentiels uniquement (entiers de 1 à N, sans aucun trou)

args[1] = "paramètre non nommé 1"

args[2] = "paramètre non nommé 2"

args[3] = "troisième paramètre"

Tous les paramètres (dans un ordre arbitraire)

args[1] = "paramètre non nommé 1"

args[2] = "paramètre non nommé 2"

args[3] = "troisième paramètre"

args["nommé1"] = "couleur"

args["dernier nommé"] = "last"

args["nommé2"] = "bleu"

Tous les paramètres (dans l’ordre numérique sinon lexicographique ASCII des clefs)

args[1] = "paramètre non nommé 1"

args[2] = "paramètre non nommé 2"

args[3] = "troisième paramètre"

args["dernier nommé"] = "last"

args["nommé1"] = "couleur"

args["nommé2"] = "bleu"

{{#invoke:ExempleParams|imprime_les_parametres|écrivain|wallon|nom=[[Arthur Masson]]|mort à=[[Namur]]|mort en=1970}} donne :

Paramètres séquentiels uniquement (entiers de 1 à N, sans aucun trou)

args[1] = "écrivain"

args[2] = "wallon"

Tous les paramètres (dans un ordre arbitraire)

args[1] = "écrivain"

args[2] = "wallon"

args["nom"] = "Arthur Masson"

args["mort en"] = "1970"

args["mort à"] = "Namur"

Tous les paramètres (dans l’ordre numérique sinon lexicographique ASCII des clefs)

args[1] = "écrivain"

args[2] = "wallon"

args["mort en"] = "1970"

args["mort à"] = "Namur"

args["nom"] = "Arthur Masson"

Remarquer

• la table d'exportation de fonctions (ici « p ») contient déclaration et retour ; les fonctions exportées sont de la forme p.nomFonction()) ;
• le passage des paramètres aux fonctions exportées et leur récupération (frame, pairs, ipairs) ;