Modification de Module:Unité/Documentation

Ce module est principalement destiné à implémenter le modèle {{m|Unité}}.

== Utilisation ==
=== Fonctions exportables ===
* <code>unite( frame )</code> – 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 avec <syntaxhighlight lang="lua" inline>p.unite{ '1.23 ±0.05 e5 m/s-2' }</syntaxhighlight>) ;
* <code>_unite( args )</code> – affiche l'unité à partir des paramètres classiques du modèle Unité (exemple <syntaxhighlight lang="lua" inline>p._unite{ '1.23', 'm', '/s', '-2', ['±'] = '0.05', e='5' }</syntaxhighlight>) ;
* <code>formatNombres( texte )</code> – formate tous les nombres de la chaine fournie suivant les conventions du français ;
* <code>formatNombre( nombre )</code> – 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 ;
* <code>_formatNum( num )</code> – 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 ;
* <code>parseNombre( nombre )</code> – 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 ===
* <code>sanitizeNum( nombre )</code> – transforme les signes moins en tiret, les espaces insécables en espace simple (simplifie les pattern ultérieures) ;
* <code>parseUnit( texte )</code> – essaye de séparer une chaine en différents paramètres du modèle unité ;
* <code>nomUnit( unit, exposant )</code> – 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é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 ==
Pour des exemples, voir la [[Modèle:Unité/Test|page de test]] permettant de tester diverses modifications apportées.

Voir aussi : '''[[Discussion module:Unité/Test|les tests unitaires]]''' et [[Discussion module:Unité/Bac à sable/Test|ceux du bac à sable]].

{{Projet Scribunto}}

<includeonly>
[[Catégorie:Module en langage Lua]]
</includeonly>