Modifications

Sauter à la navigation Sauter à la recherche

Modèle:Unité/documentation

13 713 octets ajoutés, 18 novembre 2019 à 14:06
Page créée avec « == Utilisation == Le modèle '''<nowiki>{{Unité}}</nowiki>''' permet d’écrire facilement et de w:Wikipédia:Conventions concernant les nombres#Usage des espaces ins... »
== Utilisation ==
Le modèle '''<nowiki>{{Unité}}</nowiki>''' permet d’écrire facilement et de [[w:Wikipédia:Conventions concernant les nombres#Usage des espaces insécables|typographier correctement]] un nombre suivi d’une unité ou d’un nom<ref>''[[w:Lexique des règles typographiques en usage à l'Imprimerie nationale|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 […] ».</ref>. Par rapport à une écriture directe, ses avantages sont :
* éviter un retour à la ligne automatique entre le nombre et l’unité correspondante, comme dans « {{Unité|30|km}} » ;
* faciliter l’écriture des exposants et des unités multiples, comme dans « {{Unité|10|m||s|-1}} » ;
* mettre en forme le nombre automatiquement en groupant les chiffres par groupes de trois, comme dans « {{unité|30000|habitants}} ».

Dans le cas d’un [[#Nombres seul|nombre seul]] il est préférable d’utiliser le mot magique [[mw:Help:Magic words#Formatting|<nowiki>{{formatnum:}}</nowiki>]].

== Syntaxe ==
* <tt><nowiki>{{</nowiki>Unité|''nombre''|''unité{{ind|1}}''|''exposant{{ind|1}}''|''unité{{ind|2}}''|''exposant{{ind|2}}''|''unité{{ind|3}}''|''exposant{{ind|3}}''|''unité{{ind|4}}''|''exposant{{ind|4}}''<nowiki>}}</nowiki></tt>
* <tt><nowiki>{{</nowiki>Unité|''nombre''|e=''puissance de 10''|''unité{{ind|1}}''|''exposant{{ind|1}}''|''symbole{{ind|2}}''|''unité{{ind|2}}''|''symbole{{ind|3}}''|''unité{{ind|3}}''|''unité{{ind|4}}''|''exposant{{ind|4}}''<nowiki>}}</nowiki></tt>

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

{|class="wikitable" style="margin-left:2em"
|-
! Paramètre || Description || Type
|-
| <code>1=</code> || Valeur à afficher || '''Obligatoire'''
|-
| <code>e=</code> || Puissance de 10 à afficher || Facultatif
|-
| <code>2=</code> || Premier symbole || Facultatif
|-
| <code>3=</code> || Exposant du premier symbole || Facultatif
|-
| <code>4=</code> || Deuxième symbole || Facultatif
|-
| <code>5=</code> || Exposant du deuxième symbole || Facultatif
|-
| <code>6=</code> || Troisième symbole || Facultatif
|-
| <code>7=</code> || Exposant du troisième symbole || Facultatif
|-
| <code>8=</code> || Quatrième symbole || Facultatif
|-
| <code>9=</code> || 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 <code>symbole|exposant</code>. 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.

'''ATTENTION''' :
* Le premier paramètre, celui de la valeur à afficher, est mis en forme à l’aide du mot magique <code>[[m:Help:Magic_words|<nowiki>{{formatnum:}}</nowiki>]]</code>. 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 :
** « <code><nowiki>{{Unité|2,3|g}}</nowiki></code> » affiche « {{Unité|2,3|g}} », ce qui n’est sans doute pas le résultat attendu ;
** entrer « <code><nowiki>{{Unité|2.3|g}}</nowiki></code> » pour afficher « {{Unité|2.3|g}} » ;
** entrer « <code><nowiki>{{Unité|1002.3|km}}</nowiki></code> » pour afficher « {{Unité|1002.3|km}} » ;
** noter encore « <code><nowiki>{{Unité|1234567890.123 456 78|¤}}</nowiki></code> » qui affiche « {{Unité|1234567890.123 456 78|¤}} », etc.

== Exemples d’utilisation ==
{| class="wikitable"
|-
! style="width:180px"|Syntaxe
! Résultat
! Commentaire
|-
| <nowiki>{{Unité|1234567}}</nowiki><br/><nowiki>{{Unité|1234567.89}}</nowiki><br/><nowiki>{{Unité|1.23456789|e=15}}</nowiki> || {{Unité|1234567}}<br/>{{Unité|1234567.89}}<br/>{{Unité|1.23456789|e=15}} || 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 {{m|x10}}. L’utilisation du modèle uniquement pour une valeur équivaut à l’utilisation du modèle spécial <code><nowiki>{{formatnum:}}</nowiki></code>.
|-
| <nowiki>{{Unité|10000|km}}</nowiki><br/><nowiki>{{Unité|10000|km/h}}</nowiki> || {{Unité|10000|km}}<br/>{{Unité|10000|km/h}} || Cas d’utilisation simple<!-- minimale --> : une valeur suivie d’un symbole.
|-
| <nowiki>{{Unité|10000|km|2}}</nowiki><br/><nowiki>{{Unité|10000|m|3}}</nowiki> || {{Unité|10000|km|2}}<br/>{{Unité|10000|m|3}} || Cas d’utilisation pour une unité avec un exposant.
|-
| <nowiki>{{Unité|10000|kilomètres par heure}}</nowiki> || {{Unité|10000|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 « <code><nowiki>{{Unité|10000|kilomètres}}</nowiki></code> par heure ». Notez bien que le modèle <nowiki>{{Unité}}</nowiki> empêche les ruptures de ligne dans ''toute'' l’expression « {{Unité|10000|kilomètres par heure}} ».
|-
| <nowiki>{{Unité|10000|km||h|-1}}</nowiki> || {{Unité|10000|km||h|-1}} || Deux symboles successifs, le second avec un exposant.
|-
| <nowiki>{{Unité|10000|J|2|K|3|s|-1}}</nowiki> || {{Unité|10000|J|2|K|3|s|-1}} || Trois symboles avec des exposants spécifiques.
|-
| <nowiki>{{Unité|10000|J||kg||m|-2}}</nowiki> || {{Unité|10000|J||kg||m|-2}} || Trois symboles, les deux premiers ne possédant pas d’exposant.
|-
| <nowiki>{{Unité|−40.234|°C}}</nowiki> || {{Unité|−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.
|-
| <nowiki>{{Unité|1.23456|e=9|J|2|K|3|s|-1}}</nowiki> || {{Unité|1.23456|e=9|J|2|K|3|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 {{m|x10}}.
|}

== Nombres seul ==
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 « <code><nowiki>{{formatnum:}}</nowiki></code> » est suffisant :
<nowiki>{{</nowiki>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 {{m|x10}}.

== Dans quel cas ne pas utiliser ce modèle ? ==
{| class="wikitable droite"
|+ Résultat identique pour un code wiki beaucoup plus simple à éditer sans modèle
! Code wiki !! Rendu HTML
|-
| <code><nowiki>{{Unité|20|%}}</nowiki></code> || <code>20{{rouge|&amp;#160;}}%</code>
|-
| <code><nowiki>20&amp;nbsp;%</nowiki></code> || <code>20{{rouge|&amp;#160;}}%</code>
|-
| <code>20 %</code> || <code>20{{rouge|&amp;#160;}}%</code>
|}

=== Cas particuliers de % ===
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 [[w:MediaWiki|MediaWiki]], voir les [[w:Wikipédia:Conventions typographiques#Pour cent|conventions typographiques]].

Note : en revanche, ce modèle doit être utilisé lorsque l’unité est le « pour mille ». <code><nowiki>{{Unité|5|‰}}</nowiki></code> aura pour rendu : {{Unité|5|‰}}.

=== Unités sexagésimales d’angle et degré d’alcool ===
Dans le cas des [[w:Système sexagésimal|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 est donc inutile d’utiliser le modèle.

On écrira donc simplement : « un angle de 30° » , « un vin titrant 11° ».

Voir également le modèle {{m|Angle}} pour les mesures d’angle.

== Problème connu ==
Lorsque l’expression produite par le modèle <nowiki>{{Unité}}</nowiki> se trouve entre parenthèses, comme dans ''({{Unité|1309|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 Internet Explorer 6 et 7, mais est résolu depuis la version 8.

== Notes et références ==
{{Références}}

== 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>

== Voir aussi ==
* [[w:Wikipédia:Conventions concernant les nombres|Wikipédia:Conventions concernant les nombres]]
* [[w:Espace insécable|Espace insécable]], obtenue par « &amp;nbsp; » dans MediaWiki — éviter la rupture de ligne sur une espace.
* {{m|x10}} — notation scientifique avec puissance de 10.
* {{m|exp}} — mettre en exposant.
* {{m|Angle}}
* [[mw:Help:Magic words#Formatting|Aide de « formatnum », sur Meta]].

<includeonly>

{{DEFAULTSORT:Unite}}
[[Catégorie:Modèles de formatage]]

</includeonly>

Menu de navigation