Module:Arguments/doc

Documentation pour la page Module:Arguments, Par chat GPT

Fonction : getArgs(frame, options) Cette fonction récupère et traite les arguments à partir de l'objet frame donné ou de la table Lua, en appliquant diverses options de personnalisation.

Paramètres : frame : (optionnel) Un objet frame représentant le frame Scribunto actuel. S'il n'est pas fourni, le module suppose qu'il est appelé depuis un autre module Lua ou la console de débogage et attend une table Lua d'arguments directement. options : (optionnel) Une table contenant des options de personnalisation pour le traitement des arguments.

Options :

translate : (optionnel) Une table pour traduire les clés d'argument. Chaque clé dans cette table représente un alias qui peut être utilisé à la place de la clé d'origine. Cela permet d'offrir une interface plus flexible et conviviale.

backtranslate : (optionnel) Une table pour traduire les clés vers leur forme d'origine. C'est utile lorsque vous souhaitez référencer la clé d'origine, même si un alias a été utilisé lors de la récupération de l'argument. wrappers : (optionnel) Une chaîne ou une table représentant le titre des modèles d'enveloppe. Lorsqu'il est défini, le module recherche les arguments dans le cadre des arguments ou le cadre parent, en fonction de la présence des modèles d'enveloppe spécifiés.

parentFirst : (optionnel) Si défini sur true, le module récupère les arguments du cadre parent avant le cadre actuel.

frameOnly : (optionnel) Si défini sur true, le module récupère les arguments uniquement du cadre actuel, en ignorant le cadre parent.

parentOnly : (optionnel) Si défini sur true, le module récupère les arguments uniquement du cadre parent, en ignorant le cadre actuel.

readOnly : (optionnel) Si défini sur true, la table d'arguments résultante devient en lecture seule, empêchant toute modification.

noOverwrite : (optionnel) Si défini sur true, les arguments existants ne peuvent pas être écrasés lors de l'ajout de nouvelles valeurs.