Aller au contenu

Module:Outils/Documentation

Une page de Wikipédia, l'encyclopédie libre.
Ceci est une version archivée de cette page, en date du 18 septembre 2013 à 11:47 et modifiée en dernier par Zebulon84 (discuter | contributions) (Nouvelle page : Ce module contient différentes fonction pratiques. == Résumé des fonctions == Fonctions exportables : * <code>extractArgs</code> – retourne une table avec l...). Elle peut contenir des erreurs, des inexactitudes ou des contenus vandalisés non présents dans la version actuelle.
(diff) ← Version précédente | Voir la version actuelle (diff) | Version suivante → (diff)

Ce module contient différentes fonction pratiques.

Résumé des fonctions

Fonctions exportables :

  • extractArgs – retourne une table avec les paramètres, à partir d'un objet frame, d'une table ou d'une liste de paramètre.
  • trim(frame) – similaire à mw.text.trim mais renvoi nil lorsque la chaine est vide et ne génère pas d'erreur lorsque le paramètre n'est pas une chaine (revoit nil).
  • erreur() – destiné à affiché une message d'erreur en gros et rouge. Retourne la chaine transmise dans un span de class "error". Par défaut aucune erreur indiquée.
  • validTextArg – renvoi le premier paramètre chaine non vide à partir de la table des paramètres et d'une liste de nom de paramètres
  • notEmpty() – renvoi le premier élément non vide.
  • abr – génère une chaine d'abréviation discrète (ou non)
  • nobr – équivalent de {{nobr}}, transforme la chaine fournie en chaine insécable.
  • ordinal – retourne un ordinal abrégé comme {{1er}}, {{2e}}… à partir d'un nombre ou d'une chaine contenant uniquement des chiffres. Si le deuxième est défini, renvoi 1re au lieu de 1er.
  • nombre2texte_reel – transforme un nombre en texte (5 → cinq ou cinquième). gère la langue (fr, be, ch), l'orthographe pré ou post 1990, le genre

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

  • Module:Outils/Data – pour les conversion nombre → texte.

Détail par fonction

extractArgs

extractArgs( frame, ... )

Exemples

Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.