Module:Outils/Documentation

Ceci est la documentation de Module:Outils [modifier] [purger].
Cette sous-page contient les instructions, les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.

Ce module contient différents outils pratiques, à destination d’autres modules.

Note : Voir l’historique du module et de sa documentation pour d’autres fonctions supprimées car inutilisées.

Résumé des fonctions

Fonctions exportables :

• trim( texte ) – similaire à mw.text.trim mais retourne nil lorsque la chaine est vide ou lorsque le paramètre n'est pas une chaine (ne génère pas d'erreur).
• extractArgs( frame, ... ) – retourne une table avec les paramètres, à partir d'un objet frame, d'une table ou d'une liste de paramètre.
• notEmpty( var, ... ) – retourne le premier élément non vide.

Détail par fonction

trim

Cette section est vide, pas assez détaillée ou incomplète. Améliore-la !

extractArgs

Syntaxe

Outils.extractArgs( frame, ... )

• si frame n'est pas une table, retourne { frame, ... }
• Si frame est une table simple et non une objet Frame, retourne frame
• Si frame est un objet créé par #invoke:, retourne les paramètres passé à #invoke: (en priorité) et ceux passées au modèle. Si le paramètre invokeArgsOnly n'est pas vide, seul les paramètres transmis à invoke seront utilisés.

Attention : cette fonction peut modifier la table frame.getParent().args. S'il est probable qu'un autre module passe un objet frame à votre fonction, il est préférable de l'indiquer dans la documentation.

Exemple

function p.maFonction( frame, ... )
    local args = Outils.extractArgs( frame, ... )
    return ( args[1] or 'nil' ) .. ' ' .. ( args[2] or 'nil' ) .. ' ' .. ( args['nom'] or 'nil' )
end

• appel direct : p.maFonction( 'oui', 'deux', 'Zebulon84' ) → « oui deux nil » (impossible de transmettre un paramètre nommé)
• appel par table : p.maFonction{ 'oui', 'deux', nom = 'Zebulon84' } → « oui deux Zebulon84 »
• appel par #invoke: : {{#invoke:p |maFonction |oui |2 |nom = Zebulon84}} → « oui deux Zebulon84 »
• appel par modèle {{Ma fonction}} :
  • le modèle contient {{#invoke:p |maFonction}},
    • {{Ma fonction|oui | deux |nom= Zebulon84}} → « oui deux Zebulon84 »
  • le modèle contient {{#invoke:p |maFonction |nom = Zebulon84}}
    • {{Ma fonction |oui | deux }} → « oui deux Zebulon84 »
    • {{Ma fonction |oui | deux |nom = Hexasoft}} → « oui deux Zebulon84 »
  • le modèle contient {{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} }}
    • {{Ma fonction |oui | deux }} → « oui deux Zebulon84 »
    • {{Ma fonction |oui | deux |nom = Hexasoft}} → « oui deux Hexasoft »
    • {{Ma fonction |oui | deux |nom = }} → « oui deux nil »
  • le modèle contient {{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} |invokeArgsOnly = oui}}
    • {{Ma fonction |oui | deux }} → « nil nil Zebulon84 »
    • {{Ma fonction |oui | deux |nom = Hexasoft}} → « nil nil Hexasoft»

notEmpty

Outils.notEmpty( var, ... )

Retourne le premier élément non vide, sinon retourne nil.

• Sont considérés comme vide :

  nil, false, '', '  \t \n ', 0, { }
  

• Sont considérés comme non vide :

  true, 'blabla', ' ', 1, { '' },  { {} }, function () end