Module:Arguments/Documentation

Utilisation

Ce modèle 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 pas pour une invocation directe.

Fonctions exportables

• getArgs(frame, options) – Met en forme les arguments reçus dans le frame dans un tableau.

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é.

Exemples

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

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.

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 en booléens est effectué à l'aide du module Yesno.
        return args[2]
    end
end

return p

Dans le cas où la fonction est susceptible d'être appelée depuis un autre module, il est recommandé de créer deux fonctions :

<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs local p = {}

function p.main(frame) local args = getArgs(frame) return p._main(args) end

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

return p

Voir aussi

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