Template:Wp/shi/Modèle:Nombre/Documentation

From Wikimedia Incubator
Jump to navigation Jump to search

Le modèle {{Wp/shi/Unité}} permet d’écrire facilement et de typographier correctement un nombre suivi d’une unité. Par rapport à une écriture directe, ses avantages sont :

  • mettre en forme le nombre automatiquement en groupant les chiffres par groupes de trois, comme dans « 508 » ;
  • éviter un retour à la ligne automatique entre le nombre et l’unité correspondante, comme dans « 508 » en fin de ligne ;
  • faciliter l’écriture des exposants et des unités multiples, comme dans « 508 ».

Syntaxe[edit]

Paramètres[edit]

Le modèle peut prendre jusqu’à neuf paramètres numéroté 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 1), pour cela, il suffit de laisser celui-ci vide. Au maximum, il est possible d’afficher quatre symboles possédant chacun un exposant.
Template:Wp/shi/Attention Attention 
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).
  • 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 :
  • « {{Wp/shi/Unité|2,3|g}} » affiche « 508 », ce qui n’est sans doute pas le résultat attendu ;
  • entrer « {{Wp/shi/Unité|2.3|g}} » pour afficher « 508 » ;
  • entrer « {{Wp/shi/Unité|1002.3|km}} » ou « {{Wp/shi/Unité|1,002.3|km}} » pour afficher « 508 » ;
  • noter encore « {{Wp/shi/Unité|12345,67890.12345678|¤}} » qui affiche « 508 », etc.

Exemples d’utilisation[edit]

Syntaxe Résultat Commentaire
{{Wp/shi/Unité|1234567}}
{{Wp/shi/Unité|1234567.89}}
{{Wp/shi/Unité|1.23456789|e=15}}
508
508
508
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}}.
{{Wp/shi/Unité|10000|km}}
{{Wp/shi/Unité|10000|km/h}}
{{Wp/shi/Unité|10000|km²}}
508
508
508
Cas d’utilisation simple : une valeur suivie d’un symbole.
{{Wp/shi/Unité|10000|kilomètres par heure}} 508 (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 « {{Wp/shi/Unité|10000|kilomètres}} par heure ». Notez bien que le modèle {{Wp/shi/Unité avec unité}} empêche les ruptures de ligne dans toute l’expression « 508 ».
{{Wp/shi/Unité|10000|km||h|-1}} 508 Deux symboles successifs, le second avec un exposant.
{{Wp/shi/Unité|10000|J|2|K|3|s|-1}} 508 Trois symboles avec des exposants spécifiques.
{{Wp/shi/Unité|10000|J||kg||m|-2}} 508 Trois symboles, les deux premiers ne possédant pas d’exposant.
{{Wp/shi/Unité|-40.234|°C}} 508 Cas mettant en évidence l’utilisation de la notation anglo-saxonne dans le premier paramètre, lequel est affiché selon les conventions francophones.
{{Wp/shi/Unité|1.23456|e=9|J|2|K|3|s|-1}} 508 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}}.
{{Wp/shi/Unité|1|[[kilomètre carré|km²]]}} 508 Il est aussi possible de placer un lien vers les unités.

Nombres sans unité[edit]

Pour typographier une quantité sans unité, il n’est pas nécessaire d’utiliser ce modèle (dont le nom est contre-intuitif pour cet usage), mais il suffit d’utiliser le mot magique « {{formatnum:}} » de la façon suivante :

{{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 ?[edit]

Résultat identique pour un code wiki beaucoup plus simple à éditer sans modèle
Code wiki Rendu HTML
{{Wp/shi/Unité|20|%}} 20Template:Wp/shi/Rouge%
20 % 20Template:Wp/shi/Rouge%
20 % 20Template:Wp/shi/Rouge%

Template:Wp/shi/Aide détaillée

Ce modèle est inutile lorsque l’unité est le pourcent.

En effet, en principe, on doit placer une espace insécable entre un nombre et le caractère « % » qui le suit. On pourrait donc penser que le modèle est utile dans ce cas.

Mais dans Wikipédia, il n’est pas nécessaire d’ajouter manuellement cette espace insécable avant le caractère « % » : en effet, une espace normale suffit, car MediaWiki (le logiciel utilisé par Wikipédia) la transforme automatiquement en espace insécable à l’affichage de la page (on peut éditer le code HTML pour s’en convaincre).

En fait, ce n’est pas seulement inutile, mais déconseillé, car cela complique l’édition et la lecture du code wiki pour un résultat identique.

Note : En revanche, ce modèle doit être utilisé lorsque l’unité est le « pour mille ». {{Wp/shi/Unité|5|‰}} aura pour rendu : 508.

Problème connu[edit]

Lorsque l’expression produite par le modèle {{Wp/shi/Unité}} se trouve entre parenthèses, comme dans (508), certains navigateurs web permettent une rupture de ligne entre l’une des parenthèses et l’expression. — 5 septembre 2009 à 18:29 (CEST)

Voir aussi[edit]