Module:Unité/Documentation
Ceci est la page de documentation de Module:Unité [modifier] [purger].
Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.
Ce module est principalement destiné à implémenter le modèle {{Unité}}.
Utilisation
Fonctions exportables
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 premier paramètres pour facilité la saisie (par exemple fonction avec <syntaxhighlight lang=lua inline>p.unite{ '1.23 ±0.05 e5 m/s-2' }</syntaxhiglight> ;_unite( args )– affiche l'unité a partir des paramètres classique du modèle Unité (exemple <syntaxhighlight lang=lua inline>p._unite{ '1.23', 'm', '/s', '-2', ['±'] = '0.05', e='5' }</syntaxhiglight>) ;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 convention du français ; si la chaine n'est pas reconnu comme un nombre, elle n'est pas modifiée ;_formatNum( num )– transforme un number, ou un 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 arrondi éventuels de lua) ; les chaines non reconnues sont retournée sans modification.
Autres fonctions
sanitizeNum( nombre )– transforme les signes moins en tiret, les espaces insécable 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
- Module:Unité/Data – Liste d'unité et de multiple, avec leur abréviation et leur nom en toute lettre.
- Module:Delink – Utilisé pour supprimer les liens des unité pour essayer de les reconnaitre.
Exemples
Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.
