Modèle:Unité/Documentation
Modèle:Sommaire à droite Modèle:raccourci de modèle
Sommaire
Utilisation
Le modèle {{unité}} permet d’écrire facilement et de typographier correctement un nombre suivi d’une unité ou d’un nom. Par rapport à une écriture directe, ses avantages sont :
- éviter un retour à la ligne automatique entre le nombre et l’unité correspondante, comme dans « 30 km » ;
- faciliter l’écriture des exposants et des unités multiples, comme dans « 10 m⋅s-1 » ;
- 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}} mais en tant que redirection elle risque d'être remplacée par des contributeurs ou des robots.
Dans le cas d’un nombre seul il est préférable d’utiliser le mot magique {{formatnum:}}. Cependant, le modèle {{unité}} est plus simple d’emploi dans le cas d’un nombre suivi d'une partie décimale car, alors que pour séparer les tranches de trois chiffres de la partie décimale (à droite de la virgule) il est nécessaire d’utiliser la virgule pour {{formatnum:}}, un espace simple suffit pour {{unité}}.
Syntaxe
- {{Unité|nombre|unitéModèle:ind|exposantModèle:ind|unitéModèle:ind|exposantModèle:ind|unitéModèle:ind|exposantModèle:ind|unitéModèle:ind|exposantModèle:ind}}
- {{Unité|nombre|e=puissance de 10|unitéModèle:ind|exposantModèle:ind|symboleModèle:ind|unitéModèle:ind|symboleModèle:ind|unitéModèle:ind|unitéModèle:ind|exposantModèle:ind}}
Paramètres
Le modèle peut prendre jusqu’à neuf paramètres numérotés et un paramètre nommé :
| Paramètre | Description | Type |
|---|---|---|
1= |
Valeur à afficher | Obligatoire |
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 |
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 premier paramètre, celui de la valeur à afficher, est mis en forme à l’aide du mot magique
{{formatnum:}}. Par conséquent :- il faut utiliser le point comme séparateur décimal (convention anglo-saxonne), et non la virgule, dans le paramètre transmis au modèle. Le modèle affichera automatiquement le nombre suivant les conventions francophones.
- le mot magique ne sait pas convertir les notations scientifiques exponentielles (utilisant le symbole e avant l’exposant entier) ; on placera l’exposant entier dans le paramètre nommé e ;
- il ne faut pas insérer de séparateurs de milliers sous forme d’espace ou d’apostrophe : ils sont automatiquement ajoutés par le modèle sous forme d’espace (insécable), sauf pour la partie décimale, où, pour respecter la typographie recommandée, il est préférable de placer des espaces simples par groupes de trois chiffres.
- il est cependant possible de grouper les chiffres autrement que par trois, en insérant explicitement une virgule comme séparateur (convention anglo-saxonne), laquelle sera transformée en espace (insécable) par le modèle.
- Exemples :
- «
{{Unité|2,3|g}}» affiche « 2 3 g », ce qui n’est sans doute pas le résultat attendu ; - entrer «
{{Unité|2.3|g}}» pour afficher « 2,3 g » ; - entrer «
{{Unité|1002.3|km}}» pour afficher « 1 002,3 km » ; - noter encore «
{{Unité|1234567890.123 456 78|¤}}» qui affiche « 1 234 567 890,123 456 78 ¤ »Modèle:etc.
- «
Exemples d’utilisation
| Syntaxe | Résultat | Commentaire |
|---|---|---|
| {{Unité|1234567}} {{Unité|1234567.89}} {{Unité|1.23456789|e=15}} |
1 234 567 1 234 567,89 1,23456789Modèle:x10 |
Cas d’utilisation minimale : une valeur seule (sans unité), éventuellement avec usage de puissances de 10 (usage scientifique) dans le paramètre nommé e, formaté à l’aide du modèle {{x10}}. L’utilisation du modèle uniquement pour une valeur équivaut à l’utilisation du modèle spécial {{formatnum:}}.
|
| {{Unité|10000|km}} {{Unité|10000|km/h}} |
10 000 km 10 000 km/h |
Cas d’utilisation simple : une valeur suivie d’un symbole. |
| {{Unité|10000|km|2}} {{Unité|10000|m|3}} |
10 000 km2 10 000 m3 |
Cas d’utilisation pour une unité avec un exposant. |
| {{Unité|10000|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é}} Modèle:incise empêche les ruptures de ligne dans toute l’expression « 10 000 kilomètres par heure ».
|
| {{Unité|10000|km||h|-1}} | 10 000 km⋅h-1 | Deux symboles successifs, le second avec un exposant. |
| {{Unité|10000|J|2|K|3|s|-1}} | 10 000 J2⋅K3⋅s-1 | Trois symboles avec des exposants spécifiques. |
| {{Unité|10000|J||kg||m|-2}} | 10 000 J⋅kg⋅m-2 | Trois symboles, les deux premiers ne possédant pas d’exposant. |
| {{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}} | 1,23456Modèle:x10 J2⋅K3⋅s-1 | 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|[[kilomètre carré|km{{exp|2}}]]}} | 1 km2 | Il est aussi possible de placer un lien vers les unités. |
| {{unité|10{{exp|−1}}|m}} {{unité|10{{-1}}|m}} |
10−1 m 10Modèle:-1 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. |
Nombres seuls
Bien que ce modèle fonctionne aussi dans ce cas, pour typographier une quantité sans unité ou non suivie d’un nom, il n’est pas nécessaire de l’utiliser. Le mot magique « {{formatnum:}} » est suffisant :
{{formatnum:nombre}}
(notez la présence du deux-points plutôt que la barre verticale). Pour les nombres en notation scientifique sans unité, vous pouvez utiliser le modèle {{x10}}.
Dans quel cas ne pas utiliser ce modèle ?
| Code wiki | Rendu HTML |
|---|---|
{{Unité|20|%}} |
20 %
|
20 % |
20 %
|
20 % |
20 %
|
Cas particuliers de %
Modèle:aide détaillée Ce modèle est inutile et déconseillé lorsque l’unité est le « pour cent ». Cela complique l’édition et la lecture du code wiki pour un résultat identique. Il suffit d’insérer une espace simple car, dans ce cas particulier, l'espace insécable est automatiquement gérée par MediaWiki, voir les conventions typographiques.
Note : en revanche, ce modèle doit être utilisé lorsque l’unité est le « pour mille ». {{Unité|5|‰}} aura pour rendu : 5 ‰.
Unités sexagésimales d’angle et degré d’alcool
Modèle:article détaillé Dans le cas des unités sexagésimales d’angle (mesure d’angle, latitude, longitude) et du degré d’alcool, le symbole d’unité ne doit pas être détaché du nombre. Il ne faut donc pas utiliser le modèle.
On écrira donc simplement : « un angle de 30° » , « un vin titrant 11° ».
Mais il est souhaitable d’écrire (en utilisant le modèle {{nobr}}) : {{nobr|35° 19′ 20″ de latitude N}} qui donne Modèle:nobr.
Problème connu
Lorsque l’expression produite par le modèle {{Unité}} se trouve entre parenthèses, comme dans (1 309 m), certains navigateurs web permettent une rupture de ligne entre l’une des parenthèses et l’expression. Ce problème est notamment rencontré avec Modèle:nobr et 7, mais est résolu depuis la Modèle:nobr.
Notes et références
<references> incorrecte ;
seul l’attribut « group » est autorisé.
Utilisez <references />, ou bien <references group="..." />.
Templatedata
<templatedata> {
"description": "Ce modèle permet d’écrire facilement et de typographier correctement un nombre suivi d’une unité ou d’un nom.",
"params": {
"1": {
"label": "Valeur",
"description": "Valeur à afficher. Utilisez le point comme séparateur décimal (convention anglo-saxonne, au lieu de la virgule) et n'insérez pas de séparateurs de milliers sous forme d’espace. Le modèle affichera automatiquement le nombre suivant les conventions francophones.",
"type": "number",
"required": true
},
"e": {
"label": "Exposant",
"description": "Puissance de 10 à afficher, par exemple « 9 » pour la valeur « 4,5×10^9 ».",
"type": "number",
"required": false
},
"2": {
"label": "Premier symbole",
"description": "Premier symbole, par exemple « m » pour l'unité de « mètre ».",
"type": "string",
"required": false
},
"3": {
"label": "Premier exposant",
"description": "Exposant du premier symbole, par exemple « 2 » pour l'unité « mètre carré ».",
"type": "number",
"required": false
},
"4": {
"label": "Deuxième symbole",
"description": "Deuxième symbole, par exemple « m » pour l'unité « mètre carré ».",
"type": "string",
"required": false
},
"5": {
"label": "Deuxième exposant",
"description": "Exposant du deuxième symbole, par exemple « 2 » pour l'unité « mètre carré ».",
"type": "number",
"required": false
},
"6": {
"label": "Troisième symbole",
"description": "Troisième symbole, par exemple « m » pour l'unité « mètre carré ».",
"type": "string",
"required": false
},
"7": {
"label": "Troisième Exposant",
"description": "Exposant du troisième symbole, par exemple « 2 » pour l'unité « mètre carré ».",
"type": "number",
"required": false
},
"8": {
"label": "Quatrième symbole",
"description": "Quatrième symbole, par exemple « m » pour l'unité « mètre carré ».",
"type": "string",
"required": false
},
"9": {
"label": "Quatrième exposant",
"description": "Exposant du quatrième symbole, par exemple « 2 » pour l'unité « mètre carré ».",
"type": "number",
"required": false
}
}
} </templatedata>
</includeonly>
