Module:Unité/Documentation
Ceci est la page de documentation du module Scribunto dont le code écrit en Lua est dans la page Module:Unité [historique].
Cette page n’est pas destinée à être visualisée directement. Les liens utilisant des pseudo-variables peuvent paraître rompus (en rouge) ; ne pas les remplacer par des noms de pages codés en dur ni des URL.
Cette page n’est pas destinée à être visualisée directement. Les liens utilisant des pseudo-variables peuvent paraître rompus (en rouge) ; ne pas les remplacer par des noms de pages codés en dur ni des URL.
{{Module|nom du module}} · {{Modèle utilisant les modules Lua}}Modules de base :
Documentation module · String · List · Wikibase · TNTUtilisation modifier
Fonctions exportables modifier
unite( frame )– implémente le modèle unité. Les paramètres sont pris soit au niveau du modèle appelant le module via #invoke, soit directement dans la table fournie lorsque la fonction est appelée depuis un autre module. Essaye de parser les deux premiers paramètres pour facilité la saisie (par exemple fonction avecp.unite{ '1.23 ±0.05 e5 m/s-2' }) ;_unite( args )– affiche l'unité à partir des paramètres classiques du modèle Unité (exemplep._unite{ '1.23', 'm', '/s', '-2', ['±'] = '0.05', e='5' }) ;formatNombres( texte )– formate tous les nombres de la chaine fournie suivant les conventions du français ;formatNombre( nombre )– transforme un nombre formaté ou non en chaine formatée suivant les conventions du français ; si la chaine n'est pas reconnue comme un nombre, elle n'est pas modifiée ;_formatNum( num )– transforme un number, ou une chaine correspondant à un number en chaine formatée suivant les conventions du français ; si le paramètre ne représente pas un number lua il est retourné sans modification ;parseNombre( nombre )– transforme si possible une chaine formatée en un chaine interprétable par tonumber() (retourne une chaine pour éviter les arrondis éventuels de lua) ; les chaines non reconnues sont retournées sans modification.
Autres fonctions modifier
sanitizeNum( nombre )– transforme les signes moins en tiret, les espaces insécables en espace simple (simplifie les pattern ultérieures) ;parseUnit( texte )– essaye de séparer une chaine en différents paramètres du modèle unité ;nomUnit( unit, exposant )– retourne si possible le nom de l'unité et son exposant en toute lettre.
Modules externes et autres éléments dont ce module a besoin pour fonctionner modifier
- Module:Unité/Data – Liste d'unités et de multiples, avec leur abréviation et leur nom en toute lettre.
- Module:Delink – Utilisé pour supprimer les liens des unités pour essayer de les reconnaitre.
Exemples modifier
Pour des exemples, voir la page de test de la Wikipédia en français permettant de tester diverses modifications apportées.