Modèle:Unité/Documentation

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

Ce modèle utilise le module Unité, un script écrit dans le langage de programmation Lua. Toute expérimentation devrait être conduite d'abord via une sous-page bac à sable. Voir le Projet:Scribunto si vous voulez en savoir plus.

Raccourcis [+]

1 Utilisation

Le modèle {{unité}} permet d’écrire facilement et de typographier correctement un nombre écrit en chiffres arabes ou romains suivi d’une unité ou d’un nom^[1]. Par rapport à une écriture directe, ses avantages sont :

empêcher le retour à la ligne entre le nombre et l’unité ou le nom correspondant, comme dans « 30 km » ou « 250 habitants » ;
faciliter l’écriture des exposants et des unités multiples, comme dans « 10 m s⁻¹ » ;
faciliter les traductions d'articles lors d'import de valeurs (il faut toutefois modifier le nom du modèle) en affichant le nombre selon le format local ;
mettre en forme le nombre automatiquement en groupant les chiffres par groupes de trois, comme dans « 30 000 habitants ». Note : dans certains cas la redirection {{nombre}} peut paraître préférable d'un point de vue sémantique, exemple : {{nombre|250000|déportés}}.

2 Syntaxe

{{Unité|nombre|unité₁|exposant₁|unité₂|exposant₂|unité₃|exposant₃|unité₄|exposant₄|unité₅|exposant₅}}
{{Unité|nombre|à=seconde valeur de la plage|et=seconde valeur|±=incertitude|e=puissance de 10|unité₁|exposant₁|symbole₂|unité₂|symbole₃|unité₃|unité₄|exposant₄|unité₅|exposant₅}}
{{Unité|nombre ±incertitude epuissance de 10 unité₁exposant₁ symbole₂unité₂ symbole₃unité₃ unité₄exposant₄ unité₅exposant₅}}

3 Paramètres

Le modèle peut prendre jusqu’à neuf paramètres numérotés et un paramètre nommé :

Paramètre	Description	Type	note
`1=`	Valeur à afficher	Facultatif
`à=`	Seconde valeur de la plage à afficher	Facultatif
`–=`	Seconde valeur de la plage à afficher	Facultatif	Demi-cadratin
`et=`	Seconde valeur à afficher	Facultatif
`ou=`	Seconde valeur à afficher	Facultatif
`/=`	Seconde valeur à afficher	Facultatif
`×=`	deuxième valeur de la dimension	Facultatif
`××=`	troisième valeur de la dimension	Facultatif
`±=`	incertitude	Facultatif
`+=`	incertitude + si la plage n'est pas symétrique	Facultatif
`−=`	incertitude − si la plage n'est pas symétrique	Facultatif	Signe moins
`e=`	Puissance de 10 à afficher	Facultatif
`2=`	Premier symbole	Facultatif
`3=`	Exposant du premier symbole	Facultatif
`4=`	Deuxième symbole	Facultatif
`5=`	Exposant du deuxième symbole	Facultatif
`6=`	Troisième symbole	Facultatif
`7=`	Exposant du troisième symbole	Facultatif
`8=`	Quatrième symbole	Facultatif
`9=`	Exposant du quatrième symbole	Facultatif
`fraction=`	fraction à afficher après le nombre	Facultatif
`arrondi=`	Arrondi la valeur après ce nombre de décimale	Facultatif	Peut être négatif
`décimales`	Affiche exactement ce nombre de décimales	Facultatif

Il est possible de spécifier une unité complexe à l’aide d’un paramètre seul ou de la décomposer sous la forme d’une liste symbole|exposant. Il est aussi possible de ne pas mettre d’exposant (quand il vaut 0) ; pour cela, il suffit de laisser celui-ci vide. Au maximum, il est possible d’afficher quatre symboles possédant chacun un exposant.

Le modèle reconnait aussi bien le point que la virgule comme séparateur décimal, exemples :

« {{Unité|2,3|g}} » affiche « 2,3 g » ;
« {{Unité|2.3|g}} » affiche « 2,3 g » ;
« {{Unité|1002,3|km}} » affiche « 1 002,3 km » ;
« {{Unité|1002.3|km}} » affiche « 1 002,3 km » ;
« {{Unité|1,002.3|km}} » affiche « 1 002,3 km » ;
« {{Unité|1 002.3|km}} » affiche « 1 002,3 km » ;
« {{Unité|1234567890.12345678|¤}} » affiche « 1 234 567 890,123 456 78 ¤ »
« {{Unité|1.002,3|km}} » affiche « 1,0023 km » pour être compatible avec les limites précédentes du modèle, mais cette syntaxe est déconseillée.

Il est possible d'écrire l'ensemble nombre - unité dans le premier paramètre, ce qui simplifie la saisie :

« {{Unité|1,23 ± 0,02 e-3 m/s2}} » affiche « (1,23 ± 0,02) × 10⁻³ m/s² »

Cette possibilité ne permet pas de gérer certains cas complexes, souvent des détournements du modèle, tels que plusieurs nombres séparés par du texte dans un seul modèle, par exemple « 1,23 jusqu'à 2,32 m² », ou des nombres ou exposants contenant des lettres (des variables mathématiques), par exemple « 2,5y e²ⁱ ».

4 Exemples d’utilisation

Syntaxe	Résultat	Commentaire
`{{Unité\|1234567}}` `{{Unité\|1234567,89}}` `{{Unité\|1,23456789\|e=15}}` `{{Unité\|1,23456789e15}}`	1 234 567 1 234 567,89 1,234 567 89 × 10¹⁵ 1,234 567 89 × 10¹⁵	Pour un nombre seul, la différence avec formatnum est la possibilité d'utiliser la virgule comme séparateur décimal, les décimales sont groupées par 3 (à partir de 5 décimales), et les puissances de 10 sont correctement affichées.
`{{Unité\|10000\|km}}` `{{Unité\|10000\|km/h}}` `{{Unité\|10000 km/h}}`	10 000 km 10 000 km/h 10 000 km/h	Cas d’utilisation simple : une valeur suivie d’un symbole.
`{{Unité\|10000\|km\|2}}` `{{Unité\|10000\|m\|3}}` `{{Unité\|10000 m3}}`	10 000 km² 10 000 m³ 10 000 m³	Cas d’utilisation pour une unité avec un exposant.
`{{Unité\|10000\|kilomètres par heure}}` `{{Unité\|10000 kilomètres par heure}}`	10 000 kilomètres par heure 10 000 kilomètres par heure	Non conseillé. Il est possible d’écrire l’unité en toutes lettres. Dans ce cas il n’est cependant pas strictement nécessaire d’empêcher une rupture de ligne entre le nombre et l’unité complète, seul le premier terme doit être lié au nombre, ici « `{{Unité\|10000 kilomètres}}` par heure ». Notez bien que le modèle {{Unité}} — tel {{nobr}} — empêche les ruptures de ligne dans toute l’expression « 10 000 kilomètres par heure ».
`{{Unité\|10000\|km\|\|h\|-1}}` `{{Unité\|10000 km h-1}}`	10 000 km h⁻¹ 10 000 km h⁻¹	Deux symboles successifs, le second avec un exposant.
`{{Unité\|10000\|J\|2\|K\|3\|s\|-1}}` `{{Unité\|10000 J2K3s-1}}`	10 000 J² K³ s⁻¹ 10 000 J² K³ s⁻¹	Trois symboles avec des exposants spécifiques.
`{{Unité\|10000\|J\|\|kg\|\|m\|-2}}` `{{Unité\|10000 J kg m-2}}`	10 000 J kg m⁻² 10 000 J kg m⁻²	Trois symboles, les deux premiers ne possédant pas d’exposant. Dans la syntaxe en un seul paramètre, chaque unité doit être séparée par une espace.
`{{Unité\|−40.234\|°C}}`	−40,234 °C	Cas mettant en évidence l’utilisation de la notation anglo-saxonne dans le premier paramètre, lequel est affiché selon les conventions francophones.
`{{Unité\|1.23456\|e=9\|J\|2\|K\|3\|s\|-1}}` `{{Unité\|1,23456 e9 J2 K3 s-1}}`	1,234 56 × 10⁹ J² K³ s⁻¹ 1,234 56 × 10⁹ J² K³ s⁻¹	Trois symboles avec des exposants spécifiques, mettant en évidence l’utilisation de la notation anglo-saxonne, ainsi que l’usage de puissances de 10 (usage scientifique) dans le paramètre nommé e, formaté à l’aide du modèle {{x10}}.
`{{Unité\|1\|\|m{{exp\|2}}}}` `{{Unité\|1\|m\|2}}`	1 m² 1 m²	Il est aussi possible de placer un lien vers les unités.
`{{unité\|e-1 m}}` `{{unité\|10{{exp\|−1}}\|m}}` `{{unité\|10{{-1}}\|m}}`	10⁻¹ m 10⁻¹ m 10⁻¹ m	Affichage d’une puissance de 10 suivie d’un symbole, au moyen du modèle {{exp}}. Pour cet exemple, le modèle {{-1}}, plus pratique, donne le même résultat.
`{{Unité\|1235 ±20 m}}` `{{Unité\|1235 +20 -10 m}}` `{{Unité\|1,235 ±0.02 e3 m}}`	1 235 ± 20 m 1 235+20 −10 m (1,235 ± 0,02) × 10³ m	Une incertitude peut-être ajoutée. Dans le cas de la notation avec des puissances de 10, des parenthèses sont ajoutées pour clarifier la portée de cette puissance, mais elles ne sont pas prises en charge dans le paramètre.
`{{Unité\|1200 à 1300 m}}` `{{Unité\|1200 – 1300 m}}` `{{Unité\|1200 et 1300 m}}` `{{Unité\|1200 / 1300 m}}` `{{Unité\|1200 × 600 m}}` `{{Unité\|12×6×2,3 cm}}` `{{Unité\|12\|×=6\|××=2,3\|cm}}`	1 200 à 1 300 m 1 200–1 300 m 1 200 et 1 300 m 1 200 / 1 300 m 1 200 × 600 m 12 × 6 × 2,3 cm 12 × 6 × 2,3 cm	Il est possible de relier plusieurs nombres avec quelques mots clé. Pour les surfaces ou volumes, les « x » et les « * » sont acceptés dans la syntaxe en un paramètre, et toujours affichés par « × ». En cas d'utilisation avec des paramètres séparés seul le « × » est accepté, et il faut le doubler pour la troisième dimension.
`{{Unité\|16 2/3 Hz}}` `{{Unité\|1/2 lb}}`	16 ²⁄₃ Hz ¹⁄₂ lb	Fraction pour éviter une approximation ou être plus proche de l'expression courante. Notez qu'il ne faut pas mettre d'espace entre les chiffres et la barre de fraction, sinon c'est interprété comme deux nombres séparés par une barre oblique (paramètre `/`)
`{{Unité\|1.23456\|m\|arrondi=3}}` `{{Unité\|1.23456\|m\|arrondi=6}}` `{{Unité\|123456\|m\|arrondi=-2}}` `{{Unité\|1.23456 e5 m\|arrondi=3}}` `{{Unité\|1.23456\|m\|décimales=3}}` `{{Unité\|1.23456\|m\|décimales=6}}`	1,235 m 1,234 56 m 123 500 m 1,235 × 10⁵ m 1,235 m 1,234 560 m	Les résultats d'un calcul automatique peuvent être arrondis ou affichés avec un nombre fixe de décimales.

5 Notes et références

↑ Lexique des règles typographiques en usage à l'Imprimerie nationale, Imprimerie nationale (ISBN 978-2-7433-0482-9), p. 61-62, dont : « Un nombre en chiffres arabes ou romains ne sera jamais séparé du nom qui le précède ou qui le suit […] ».

6 Templatedata

Ce modèle permet d’écrire facilement et de typographier correctement un nombre suivi d’une unité ou d’un nom.

Paramètres du modèle
La mise en forme sur une seule ligne est préférée pour ce modèle.
Paramètre		Description	Type	Statut
Valeur	`1`	Valeur à afficher. Exemple 12,34	Nombre	obligatoire
À	`à`	Permet d'avoir un deuxième nombre avec la conjonction « à ». Exemple 15,36	Nombre	facultatif
Ou	`ou`	Permet d'avoir un deuxième nombre avec la conjonction « ou ». Exemple 15,36	Nombre	facultatif
Et	`et`	Permet d'avoir un deuxième nombre avec la conjonction « et ». Exemple 15,36	Nombre	facultatif
–	`–` `-`	Permet d'avoir un deuxième nombre séparé du premier par un tiret demi cadratin. Exemple 15,36	Nombre	facultatif
/	`/`	Permet d'avoir un deuxième nombre clairement séparé par «&ensp;/&ensp;». Notamment utilisé dans les infobox pour séparer deux séries de nombres. Exemple 15,36	Nombre	facultatif
×	`×` `x`	Permet d'avoir un deuxième nombre séparé par un signe multiplier, par exemple pour une surface. Exemple 29,7	Nombre	facultatif
××	`××`	Permet d'avoir un troisième nombre séparé par un signe multiplier, par exemple pour un volume. Exemple 3	Nombre	facultatif
Exposant	`e`	Puissance de 10 à afficher. Exemple 9 pour la valeur « 4,5×10^9 ».	Nombre	facultatif
Premier symbole	`2`	aucune description Exemple m pour l'unité de « mètre ».	Ligne	suggéré
Premier exposant	`3`	Exposant du premier symbole. Exemple 2 pour l'unité « mètre carré ».	Nombre	facultatif
Deuxième symbole	`4`	aucune description Exemple s pour l'unité « métre par seconde carré ».	Ligne	facultatif
Deuxième exposant	`5`	Exposant du deuxième symbole. Exemple -2 pour l'unité « métre par seconde carré ».	Nombre	facultatif
Troisième symbole	`6`	aucune description Exemple « s » pour l'unité « métre par seconde carré ».	Ligne	facultatif
Troisième Exposant	`7`	Exposant du troisième symbole.	Nombre	facultatif
Quatrième symbole	`8`	aucune description	Ligne	facultatif
Quatrième exposant	`9`	Exposant du quatrième symbole.	Nombre	facultatif
Cinquième symbole	`10`	aucune description	Ligne	facultatif
Cinquième exposant	`11`	Exposant du cinquième symbole.	Nombre	facultatif
±	`±` `+-` `+/-`	Incertitude. Exemple 0,05	Nombre	facultatif
+	`+`	Incertitude positive, si la valeur est différente de l'incertitude négative. Exemple 0,2	Nombre	facultatif
−	`−`	Incertitude négative, si la valeur est différente de l'incertitude positive. Exemple 0,1	Nombre	facultatif
Arrondi	`arrondi`	Nombre maximal de décimales affichées. Exemple 2	Nombre	facultatif
Décimales	`décimales`	Nombre de décimales affichées. Exemple 2	Nombre	facultatif
Fraction	`fraction`	fraction a afficher après l'éventuel nombre. Exemple 2/3	Ligne	facultatif

[1] Lexique des règles typographiques en usage à l'Imprimerie nationale, Imprimerie nationale (ISBN 978-2-7433-0482-9), p. 61-62, dont : « Un nombre en chiffres arabes ou romains ne sera jamais séparé du nom qui le précède ou qui le suit […] ».

[1]