Module:Arguments/Documentation

Utilisation

Ce module fournit la fonction getArgs(frame, options) permettant un traitement simplifié des arguments reçus dans un frame lors d'une invocation de module avec {{#invoke:}}. Il est prévu pour un usage par d'autres modules et non pour une invocation directe dans un modèle.

Fonctions exportables

• getArgs(frame, options) – Met en forme les arguments reçus dans le frame dans un tableau, dont le traitement peut être modifier selon la valeur de option. Le tableau est nommé args dans la liste des options ci-dessous.

Liste des options

Nom du paramètre	Type	Valeur par défaut	Utilisation
Gestion des espaces vides
trim	booléen	true	Lorsque mis à true, enlève les espaces au début et à la fin de chaque argument du frame.
removeBlanks	booléen	true	Lorsque mis à true, remplace les arguments constitués d'une chaîne de caractère vide ou d'une chaîne de caractère contenant uniquement des espaces par nil.
valueFunc	fonction : (key, value) -> formattedValue	/	Fonction à appliquer à chaque argument du frame, où frame[key] = value. Exemple : fonction enlevant les arguments vides et passant les arguments en minuscule : valueFunc = function (key, value) if not value then return nil end value = mw.ustring.lower(value) if mw.ustring.find(value, '%S') then return value end return nil end
Gestion frame / parent
Par défaut, ce module, récupère d'abord les arguments donnés dans l'invocation du module, puis ceux parents, généralement ceux issus de l'appel de modèle, mais les paramètres du parent sont effacés par ceux du frame. Concrètement, si un modèle ModèleExemple contient le code {{#invoke:ModuleExemple|fonction|ArgInvoke1}} et que ce modèle est lui-même appelé avec {{ModèleExemple|ArgModèle1|ArgModèle2}}, les arguments renvoyé par la fonction getArgs seront ArgInvoke1 et ArgModèle2. ArgModèle1 n'est pas renvoyé. (nb.: Si l'appel de modèle est {{ModèleExemple}} sans argument, la fonction getArgs renvoie quand même ArgInvoke1.)
frameOnly	booléen	false	Lorsque mis à true, ce paramètre permet de ne prendre en compte que les arguments reçus du frame, c'est-à-dire généralement les arguments issus du {{#invoke:}} et non ceux issus de l'appel de modèle.
parentOnly	booléen	false	Lorsque mis à true, ce paramètre permet de ne prendre en compte que les arguments reçus du parent, c'est-à-dire généralement les arguments issus de l'appel de modèle et non ceux issus du {{#invoke:}}.
parentFirst	booléen	false	Lorsque mis à true, ce paramètre inverse l'ordre de priorité : les arguments reçus du parent écrasent les arguments reçus du frame.
wrappers	'str' ou { 'str', 'str', ... },	/	Ce paramètre permet de définir une liste de modèles sur lesquels appliquer parentOnly = true (permet de cibler, contrairement au paramètre parentOnly qui désactive la lecture des arguments donnés au {{#invoke:}} pour toutes les invocations).
Modification du contenu de args au sein du module
readOnly	booléen	false	Lorsque mis à true, empêche toute modification du contenu de args. (Par défaut, rien ne l'empêche.)
noOverwrite	booléen	false	Lorsque mis à true, l'ajout de valeurs à args reste autorisée, mais les modifications du contenu déjà présent sont bloquées.

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

• mw.title.new – Crée un nouvel objet title.

• frame:getParent() – Si le {{#invoke:}} est contenu dans un modèle, frame contient les arguments passés dans le {{#invoke:}} et frame:getParent() contient les paramètres donnés dans l'appel de modèle.
• frame:getTitle() – Renvoie le titre associé à l'objet frame sous forme de chaine de caractères. Pour l'objet frame créé par {{#invoke:}}, c'est le titre du module invoqué.

Ce module fonctionne en utilisant des méta-tables lua, dont notamment __index qui permet de modifier le fonctionnement de l'indexation sur une table. Cela permet la récupération des arguments issus du frame et du parent simultanément, sans utiliser pairs() qui pose parfois problème lorsqu'un argument contient des <ref>...</ref>. En contrepartie, effectuer des opérations directement sur args ne fonctionnera pas correctement dans certains cas. Pour éviter toute surprise, il vaut mieux ne se servir d'args que comme d'un intermédiaire pour l'attribution de valeur à des variables locales.

Exemples

Syntaxe minimale

local getArgs = require('Module:Arguments').getArgs

local p = {}

function p.nomFonction(frame)
    local val = ''
	local args = getArgs(frame) -- Les données fournies au {{#invoke:}} sont traitées ici.

    if args[1] == 'nom' then -- Le code qui suit est un exemple, rien n'est obligatoire pour l'utilisation du module.
        val = args[2]
    else
        return nil
    end

    return val
end

return p

Syntaxe complète

Dans le cas où la fonction est susceptible d'être appelée depuis un autre module, il est recommandé de créer deux fonctions. En plus de donner un exemple de syntaxe complète, l'exemple suivant donne un exemple de cette bonne pratique.

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame, {
		trim = false,
		removeBlanks = false,
		valueFunc = function (key, value)
			-- Code de valueFunc
		end,
		frameOnly = true,
		parentOnly = true,
		parentFirst = true,
		wrappers = {
			'Modèle:A',
			'Modèle:B'
		},
		readOnly = true,
		noOverwrite = true
	})

	return p._main(args)
end

function p._main(args)
	-- Code principal du module.
end

return p

Traitements supplémentaires des arguments

Le traitement des booléens n'est pas géré par défaut. Pour récupérer des booléens, il faut utiliser le Module:yesno. En outre, la conversion de str en nombres se fait via la fonction tonumber.

local yesno = require('Module:yesno')
local getArgs = require('Module:Arguments').getArgs

local p = {}

function p.nomFonction(frame)
	local args = getArgs(frame) -- Les données fournies au {{#invoke:}} sont traitées ici.

    if yesno(args[1]) then -- Le changement de string en booléens est effectué à l'aide du module Yesno.
        return tonumber(args[2]) -- Le changement de string en nombre est effectué à l'aide de la fonction tonumber.
    end
end

return p

Voir aussi

• Module:Outils dont la fonction extractArgs(frame, options) est une version simplifiée de arguments.getArgs(frame, options).