Module:Arguments/doc/fr
More actions
{{#ifeq:fr|doc||{{#ifeq:fr |doc
|
{{#ifeq:show |show
|
File:Edit-copy green.svg | Template:Strong for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Module |User |module template page |{{#if:Module |module page|article}}}}}}}}. |
}}{{#if: | | {{#ifexist:Module:Arguments/doc | [[Category:{{#switch:Module |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] | }} }} | }}}}{{#switch:
| =
Template:Shared Template Warning Template:Used in system Template:Module rating Template:Module rating
Ce module facilite le traitement des arguments reçus de Template:Magic word. Il s'agit d'un méta-module, destiné à être utilisé par d'autres modules; il ne doit pas être appelé directement à partir de Template:Tlc. Ses fonctionnalités comprennent :
- la séparation facile des arguments et la suppression des arguments vides.
- les arguments peuvent venir à la fois de l'environnement (frame) courant et de l'environnement parent (informations plus détailées ci-dessous).
- vous pouvez passer les arguments directement à partir d'un autre module Lua ou de la console de débogage.
- les arguments sont récupérés selon les besoins, ce qui permet d'éviter (certains) problèmes avec les balises Template:Xtag.
- la plupart des fonctionnalités peuvent être personnalisées.
Utilisation de base
Vous devez d'abord charger le module.
Il contient une fonction nommée getArgs
.
<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs </syntaxhighlight>
Pour un scénario élémentaire, vous pouvez utiliser getArgs
dans votre fonction principale.
La variable args
est une table contenant les arguments de Template:Tlc
(voir les détails ci-dessous).
<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs local p = {}
function p.main(frame) local args = getArgs(frame) -- Placer ici le code principal du module. end
return p </syntaxhighlight>
Néanmoins, il est recommandé d'utiliser une fonction juste pour traiter les arguments de Template:Tlc. Cela signifie que si quelqu'un appelle votre module à partir d'un autre module Lua, vous n'avez pas besoin d'avoir un objet frame disponible, ce qui améliore les performances.
<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) -- Placer ici le code principal du module. end
return p </syntaxhighlight>
Si vous voulez que plusieurs fonctions utilisent les arguments, et qu'ils soient accessibles à partir de Template:Tlc, vous pouvez utiliser une fonction conteneur (wrapper).
<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs
local p = {}
local function makeInvokeFunc(funcName) return function (frame) local args = getArgs(frame) return p[funcName](args) end end
p.func1 = makeInvokeFunc('_func1')
function p._func1(args) -- placer ici le code de la première fonction end
p.func2 = makeInvokeFunc('_func2')
function p._func2(args) -- placer ici le code de la seconde fonction end
return p </syntaxhighlight>
Options
Les options suivantes sont disponibles. Elles sont expliquées dans les sections ci-dessous.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { trim = false, removeBlanks = false, valueFunc = function (key, value) -- code pour traiter un argument end, frameOnly = true, parentOnly = true, parentFirst = true, wrappers = { 'Template:A wrapper template', 'Template:Another wrapper template' }, readOnly = true, noOverwrite = true }) </syntaxhighlight>
Séparation et suppression des caractères espace
Les arguments vides posent souvent problème aux nouveaux codeurs dans la conversion des modèles MediaWiki en Lua.
Dans la syntaxe du modèle, les chaînes vides et les chaînées constituées uniquement d'espaces sont considérées comme false
.
Cependant, en Lua, les chaînes vides et les chaînées constituées d'espaces sont considérées comme true
.
Cela signifie que si vous ne faites pas attention à ces arguments lorsque vous écrivez vos modules Lua, vous pouvez traiter quelque chose comme true
alors qu'il devrait être traité comme false
.
Pour éviter cela, ce module supprime par défaut tous les arguments vides.
De même, le caractère espace (blanc) peut causer des problèmes si vous utilisez des arguments positionnels. Bien que le caractère blanc soit supprimé pour les arguments nommés venant de Template:Tlc, il est conservé pour les arguments positionnels. La plupart du temps, cet espace blanc supplémentaire n'est pas souhaité, donc ce module le supprime par défaut.
Cependant, parfois vous voulez utiliser des arguments vides en entrée, et parfois vous voulez garder l'espace blanc supplémentaire.
Cela peut obliger à convertir certains modèles exactement comme ils ont été écrits.
Si vous voulez faire cela, vous pouvez initialiser les arguments trim
et removeBlanks
à false
.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { trim = false, removeBlanks = false }) </syntaxhighlight>
Format personnalisé des arguments
Parfois, vous voulez supprimer certains arguments vides mais pas les autres, ou peut-être vous voulez mettre tous les arguments positionnels en minuscules.
Pour faire des choses similaires, utilisez l'option valueFunc
.
L'entrée de cette option doit être une fonction qui prend deux paramètres key
et value
, et qui renvoie une seule valeur.
Cette valeur est celle que vous obtenez lorsque vous accédez au champ key
de la table args
.
Exemple 1 : Cette fonction préserve l'espace blanc pour le premier argument positionnel, mais le supprime pour tous les autres arguments; les arguments vides restants sont supprimés.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { valueFunc = function (key, value) if key == 1 then return value elseif value then value = mw.text.trim(value) if value ~= then return value end end return nil end }) </syntaxhighlight>
Exemple 2 : Cette fonction supprime les arguments vides et convertit tous les arguments en minuscules, mais n'élimine pas l'espace blanc des paramètres positionnels.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { 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 }) </syntaxhighlight>
Exemples 1 et 2 avec le contrôle de type |
---|
{{#if:|{{{2}}}|<translate> The following is a closed debate.</translate> Template:Strong}} |
Exemple 1 : <syntaxhighlight lang="lua"> local args = getArgs(frame, { valueFunc = function (key, value) if key == 1 then return value elseif type(value) == 'string' then value = mw.text.trim(value) if value ~= then return value else return nil end else return value end end }) </syntaxhighlight> Exemple 2 : <syntaxhighlight lang="lua"> local args = getArgs(frame, { valueFunc = function (key, value) if type(value) == 'string' then value = mw.ustring.lower(value) if mw.ustring.find(value, '%S') then return value else return nil end else return value end end }) </syntaxhighlight> |
Veuillez également noter que la fonction valueFunc
est appelée plus ou moins chaque fois qu'un argument est demandé à partir de la table args
, donc si vous vous souciez des performances vérifiez que votre code reste toujours efficace.
Environnement et environnement parent
Les arguments de la table args
peuvent venir à la fois de la frame actuelle et de la frame parente.
Pour comprendre ce que cela signifie, prenons un exemple.
Supposons que nous disposons d'un module appelé Module:ExampleArgs
.
Ce module imprime les deux premiers arguments positionnels qu'il a reçus.
code de Module:ExampleArgs |
---|
{{#if:|{{{2}}}|<translate> The following is a closed debate.</translate> Template:Strong}} |
<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) local first = args[1] or local second = args[2] or return first .. ' ' .. second end return p </syntaxhighlight> |
Module:ExampleArgs
est ensuite appelé par Template:ExampleArgs
qui contient le code {{#invoke:ExampleArgs|main|firstInvokeArg}}
.
Ceci produit le résultat "firstInvokeArg".
Maintenant si on devait appeler Template:ExampleArgs
, on aurait ceci :
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Résultat
|-
| {{ExampleArgs}}
| firstInvokeArg
|-
| {{ExampleArgs|firstTemplateArg}}
| firstInvokeArg
|-
| {{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstInvokeArg secondTemplateArg
Template:!)
Il existe trois options qui vous permettent de modifier ce comportement : frameOnly
, parentOnly
et parentFirst
.
Si vous définissez frameOnly
alors seulement les arguments passés du frame courant seront acceptés; si vous définissez parentOnly
alors seulement les arguments passés du frame parent seront acceptés. Et si vous définirez parentFirst
alors les arguments seront passés à la fois du frame actuel et de celui du parent, mais ce dernier aura la priorité sur le frame actuel.
Voici les résultats en termes de Template:ExampleArgs
:
frameOnly
-
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Résultat
|-
|
{{ExampleArgs}}
| firstInvokeArg |- |{{ExampleArgs|firstTemplateArg}}
| firstInvokeArg |- |{{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstInvokeArg Template:!) parentOnly
-
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Résultat
|-
|
{{ExampleArgs}}
| |- |{{ExampleArgs|firstTemplateArg}}
| firstTemplateArg |- |{{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstTemplateArg secondTemplateArg Template:!) parentFirst
-
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Résultat
|-
|
{{ExampleArgs}}
| firstInvokeArg |- |{{ExampleArgs|firstTemplateArg}}
| firstTemplateArg |- |{{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstTemplateArg secondTemplateArg Template:!)
Conteneurs
L'option wrappers
est utilisée pour spécifier un nombre limité de modèles utilisés comme conteneurs, c'est à dire des modèles qui ne font qu'appeler un module.
Si ce module détecte qu'il est appelé à partir d'un modèle conteneur, il vérifie les arguments dans la frame parente; sinon il vérifie les arguements dans la frame fournie à getArgs
.
Cela permet d'appeler les modules soit par Template:Tlc soit par un modèle conteneur sans la perte de performance associée à la vérification de la frame et de celle du parent dans chaque recherche d'argument.
Par exemple le seul contenu de {{Navbox}}
est {{#invoke:Navbox|navbox}}
(en excluant le contenu entre les balises Template:Tag).
Il n'est pas utile de vérifier les arguments transmis directement à la déclaration Template:Tlc pour ce modèle, car aucun argument n'y sera jamais spécifié.
Nous pouvons éviter de vérifier les arguments passés à Template:Tlc en utilisant l'option parentOnly
, mais si nous le faisons, Template:Tlc ne fonctionnera pas non plus depuis les autres pages.
Si c'était le cas, alors Template:Tmpl dans le code Template:Tmpl serait complètement ignoré, quelque soit la page où il a été utilisé.
En utilisant l'option wrappers
pour indiquer que Template:Navbox est un conteneur, nous pouvons faire que Template:Tmpl fonctionne sur la plupart des pages, tout en ne nécessitant pas que le module vérifie les arguments sur la page Template:Navbox lui-même.
Les conteneurs peuvent être spécifiés par des chaînes ou des tableaux de chaînes.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { wrappers = 'Template:Wrapper template' }) </syntaxhighlight>
<syntaxhighlight lang="lua"> local args = getArgs(frame, { wrappers = { 'Template:Wrapper 1', 'Template:Wrapper 2', -- Vous pouvez ajouter ici un nombre quelconque de conteneurs. } }) </syntaxhighlight>
Ecrire dans la table args
Il est quelques fois nécessaire d'écrire de nouvelles valeurs dans la table args
.
Ceci est possible avec les valeurs par défaut de ce module.
(Néanmoins gardez à l'esprit qu'au niveau codage, il vaut mieux créer une nouvelle table avec les nouvelles valeurs et copier les arguments de la table de args
selon les besoins).
<syntaxhighlight lang="lua"> args.foo = 'valeur quelconque' </syntaxhighlight>
Vous pouvez modifier ce comportement avec les options readOnly
et noOverwrite
.
Si readOnly
est initialisé, il n'est plus du tout possible d'écrire des valeurs dans la table args
.
Si noOverwrite
est défini, il est possible d'ajouter de nouvelles valeurs à la table, mais il n'est pas possible d'ajouter une valeur si elle vient réécraser un argument passé à partir de Template:Tlc.
Balises ref
Cemodule utilise les métatables pour récupérer les arguments de Template:Tlc.
Cela permet d'accéder aux arguments du frame et à ceux du parent sans passer par la fonction pairs()
.
Cela peut vous aider si votre module a reçu des balises Template:Xtag en entrée.
Dès que les balises Template:Xtag sont accédées par Lua, elles sont traitées par le logiciel MediaWiki et la référence apparaîtra dans la liste des références au bas de l'article.
Si votre module continue à omettre la balise de référence de la sortie, vous finirez par avoir une référence fantôme - une référence qui apparaît dans la liste des références, mais aucun numéro ne la relie.
Ceci a été un problème avec les modules qui utilisent pairs()
pour détecter s'il faut utiliser les arguments à partir du frame ou du frame parent, car ces modules traitent automatiquement chaque argument disponible.
Ce module résoud le problème en permettant l'accès à la fois aux arguments du frame et à celui du parent, tout en les récupérant quand lorsque c'est nécessaire.
Cependant le problème se produira toujours si vous utilisez pairs(args)
ailleurs dans votre module.
Limitations connues
L'utilisation des métatables a aussi ses inconvénients.
La plupart des outils Lua sur les tableaux usuels ne fonctionneront pas correctement sur la table args
, y compris l'opérateur #
, la fonction next()
, et les fonctions de la bibliothèque table
.
Si l'utilisation de ces éléments est importante pour votre module, vous devriez utiliser votre propre fonction de traitement des arguments au lieu de ce module.
Tests
| #default=
{{#switch:
| = Template:Languages Template:Shared Template Warning Template:Used in system Template:Module rating Template:Module rating
This module provides easy processing of arguments passed from Template:Magic word. It is a meta-module, meant for use by other modules, and should not be called from Template:Tlc directly. Its features include:
- Easy trimming of arguments and removal of blank arguments.
- Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)
- Arguments can be passed in directly from another Lua module or from the debug console.
- Arguments are fetched as needed, which can help avoid (some) problems with Template:Xtag tags.
- Most features can be customized.
Basic use
First, you need to load the module.
It contains one function, named getArgs
.
<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs </syntaxhighlight>
In the most basic scenario, you can use getArgs
inside your main function.
The variable args
is a table containing the arguments from Template:Tlc.
(See below for details.)
<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs local p = {}
function p.main(frame) local args = getArgs(frame) -- Main module code goes here. end
return p </syntaxhighlight>
However, the recommended practice is to use a function just for processing arguments from Template:Tlc. This means that if someone calls your module from another Lua module you don't have to have a frame object available, which improves performance.
<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) -- Main module code goes here. end
return p </syntaxhighlight>
If you want multiple functions to use the arguments, and you also want them to be accessible from Template:Tlc, you can use a wrapper function.
<syntaxhighlight lang="lua"> local getArgs = require('Module:Arguments').getArgs
local p = {}
local function makeInvokeFunc(funcName) return function (frame) local args = getArgs(frame) return p[funcName](args) end end
p.func1 = makeInvokeFunc('_func1')
function p._func1(args) -- Code for the first function goes here. end
p.func2 = makeInvokeFunc('_func2')
function p._func2(args) -- Code for the second function goes here. end
return p </syntaxhighlight>
Options
The following options are available. They are explained in the sections below.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { trim = false, removeBlanks = false, valueFunc = function (key, value) -- Code for processing one argument end, frameOnly = true, parentOnly = true, parentFirst = true, wrappers = { 'Template:A wrapper template', 'Template:Another wrapper template' }, readOnly = true, noOverwrite = true }) </syntaxhighlight>
Trimming and removing blanks
Blank arguments often trip up coders new to converting MediaWiki templates to Lua.
In template syntax, blank strings and strings consisting only of whitespace are considered false
.
However, in Lua, blank strings and strings consisting of whitespace are considered true
.
This means that if you don't pay attention to such arguments when you write your Lua modules, you might treat something as true
that should actually be treated as false
.
To avoid this, by default this module removes all blank arguments.
Similarly, whitespace can cause problems when dealing with positional arguments. Although whitespace is trimmed for named arguments coming from Template:Tlc, it is preserved for positional arguments. Most of the time this additional whitespace is not desired, so this module trims it off by default.
However, sometimes you want to use blank arguments as input, and sometimes you want to keep additional whitespace.
This can be necessary to convert some templates exactly as they were written.
If you want to do this, you can set the trim
and removeBlanks
arguments to false
.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { trim = false, removeBlanks = false }) </syntaxhighlight>
Custom formatting of arguments
Sometimes you want to remove some blank arguments but not others, or perhaps you might want to put all of the positional arguments in lower case.
To do things like this you can use the valueFunc
option.
The input to this option must be a function that takes two parameters, key
and value
, and returns a single value.
This value is what you will get when you access the field key
in the args
table.
Example 1: This function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { valueFunc = function (key, value) if key == 1 then return value elseif value then value = mw.text.trim(value) if value ~= then return value end end return nil end }) </syntaxhighlight>
Example 2: This function removes blank arguments and converts all arguments to lower case, but doesn't trim whitespace from positional parameters.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { 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 }) </syntaxhighlight>
Examples 1 and 2 with type checking |
---|
{{#if:|{{{2}}}|<translate> The following is a closed debate.</translate> Template:Strong}} |
Example 1: <syntaxhighlight lang="lua"> local args = getArgs(frame, { valueFunc = function (key, value) if key == 1 then return value elseif type(value) == 'string' then value = mw.text.trim(value) if value ~= then return value else return nil end else return value end end }) </syntaxhighlight> Example 2: <syntaxhighlight lang="lua"> local args = getArgs(frame, { valueFunc = function (key, value) if type(value) == 'string' then value = mw.ustring.lower(value) if mw.ustring.find(value, '%S') then return value else return nil end else return value end end }) </syntaxhighlight> |
Also, please note that the valueFunc
function is called more or less every time an argument is requested from the args
table, so if you care about performance you should make sure you aren't doing anything inefficient with your code.
Frames and parent frames
Arguments in the args
table can be passed from the current frame or from its parent frame at the same time.
To understand what this means, it is easiest to give an example.
Let's say that we have a module called Module:ExampleArgs
.
This module prints the first two positional arguments that it is passed.
Module:ExampleArgs code |
---|
{{#if:|{{{2}}}|<translate> The following is a closed debate.</translate> Template:Strong}} |
<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) local first = args[1] or local second = args[2] or return first .. ' ' .. second end return p </syntaxhighlight> |
Module:ExampleArgs
is then called by Template:ExampleArgs
, which contains the code {{#invoke:ExampleArgs|main|firstInvokeArg}}
.
This produces the result "firstInvokeArg".
Now if we were to call Template:ExampleArgs
, the following would happen:
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Result
|-
| {{ExampleArgs}}
| firstInvokeArg
|-
| {{ExampleArgs|firstTemplateArg}}
| firstInvokeArg
|-
| {{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstInvokeArg secondTemplateArg
Template:!)
There are three options you can set to change this behaviour: frameOnly
, parentOnly
and parentFirst
.
If you set frameOnly
then only arguments passed from the current frame will be accepted; if you set parentOnly
then only arguments passed from the parent frame will be accepted; and if you set parentFirst
then arguments will be passed from both the current and parent frames, but the parent frame will have priority over the current frame.
Here are the results in terms of Template:ExampleArgs
:
frameOnly
-
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Result
|-
|
{{ExampleArgs}}
| firstInvokeArg |- |{{ExampleArgs|firstTemplateArg}}
| firstInvokeArg |- |{{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstInvokeArg Template:!) parentOnly
-
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Result
|-
|
{{ExampleArgs}}
| |- |{{ExampleArgs|firstTemplateArg}}
| firstTemplateArg |- |{{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstTemplateArg secondTemplateArg Template:!) parentFirst
-
Template:(! class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Code
! style="width: 40%;" | Result
|-
|
{{ExampleArgs}}
| firstInvokeArg |- |{{ExampleArgs|firstTemplateArg}}
| firstTemplateArg |- |{{ExampleArgs|firstTemplateArg|secondTemplateArg}}
| firstTemplateArg secondTemplateArg Template:!)
Wrappers
The wrappers
option is used to specify a limited number of templates as wrapper templates, that is, templates whose only purpose is to call a module.
If the module detects that it is being called from a wrapper template, it will only check for arguments in the parent frame; otherwise it will only check for arguments in the frame passed to getArgs
.
This allows modules to be called by either Template:Tlc or through a wrapper template without the loss of performance associated with having to check both the frame and the parent frame for each argument lookup.
For example, the only content of {{Navbox}}
(excluding content in Template:Tag tags) is {{#invoke:Navbox|navbox}}
.
There is no point in checking the arguments passed directly to the Template:Tlc statement for this template, as no arguments will ever be specified there.
We can avoid checking arguments passed to Template:Tlc by using the parentOnly
option, but if we do this then Template:Tlc will not work from other pages either.
If this were the case, then Template:Tmpl in the code Template:Tmpl would be ignored completely, no matter what page it was used from.
By using the wrappers
option to specify Template:Navbox as a wrapper, we can make Template:Tmpl work from most pages, while still not requiring that the module check for arguments on the Template:Navbox page itself.
Wrappers can be specified either as a string, or as an array of strings.
<syntaxhighlight lang="lua"> local args = getArgs(frame, { wrappers = 'Template:Wrapper template' }) </syntaxhighlight>
<syntaxhighlight lang="lua"> local args = getArgs(frame, { wrappers = { 'Template:Wrapper 1', 'Template:Wrapper 2', -- Any number of wrapper templates can be added here. } }) </syntaxhighlight>
Writing to the args
table
Sometimes it can be useful to write new values to the args
table.
This is possible with the default settings of this module.
(However, bear in mind that it is usually better coding style to create a new table with your new values and copy arguments from the args
table as needed.)
<syntaxhighlight lang="lua"> args.foo = 'some value' </syntaxhighlight>
It is possible to alter this behaviour with the readOnly
and noOverwrite
options.
If readOnly
is set then it is not possible to write any values to the args
table at all.
If noOverwrite
is set, then it is possible to add new values to the table, but it is not possible to add a value if it would overwrite any arguments that are passed from Template:Tlc.
Ref tags
This module uses metatables to fetch arguments from Template:Tlc.
This allows access to both the frame arguments and the parent frame arguments without using the pairs()
function.
This can help if your module might be passed Template:Xtag tags as input.
As soon as Template:Xtag tags are accessed from Lua, they are processed by the MediaWiki software and the reference will appear in the reference list at the bottom of the article.
If your module proceeds to omit the reference tag from the output, you will end up with a phantom reference - a reference that appears in the reference list, but no number that links to it.
This has been a problem with modules that use pairs()
to detect whether to use the arguments from the frame or the parent frame, as those modules automatically process every available argument.
This module solves this problem by allowing access to both frame and parent frame arguments, while still only fetching those arguments when it is necessary.
The problem will still occur if you use pairs(args)
elsewhere in your module, however.
Known limitations
The use of metatables also has its downsides.
Most of the normal Lua table tools won't work properly on the args
table, including the #
operator, the next()
function, and the functions in the table
library.
If using these is important for your module, you should use your own argument processing function instead of this module.
Tests
Template:ModuleQuality {{safesubst:#if:{{safesubst:#ifeq:fr|sandbox|1}}{{safesubst:#ifeq:fr|doc|1}}|| }} | #default=
Lua error: expandTemplate: template loop detected.
}} }}