Modèle:Nombre avec unité/Documentation

De plongeplo
Aller à la navigation Aller à la recherche

Le modèle Modèle:M permet de contourner l'absence de gestion des espaces insécables par le logiciel MediaWiki dans les nombres avec unités.

Principe

Du point de vue typographique, une espace insécable doit être présente entre une valeur et son unité (pour que la valeur et l'unité ne soient pas séparées par un retour automatique à la ligne, ce qui nuit à la lisibilité). Par exemple, sans utiliser ce modèle, il est nécessaire d'écrire « 10 km » afin d'afficher « 10 km ».

Ce modèle, Modèle:M, permet de s'affranchir de la balise   et d'utiliser, en outre, la fonction {{formatnum:}} pour mettre en forme la valeur.

Noms alternatifs

Par simplicité, dans les articles, il n'est pas nécessaire d'écrire Modèle:M. Les modèles suivants, au nom abrégé, redirigent vers ce modèle :

Utilisation

La syntaxe générale du modèle est la suivante :

{{Unité|1|2|3|4|5|6|7|8|9}}

Le modèle peut prendre jusqu'à 9 paramètres :

Paramètre Description Type
1 Valeur à afficher Obligatoire
2 Premier symbole Obligatoire
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

Seuls les deux premiers paramètres sont obligatoires : il est possible de spécifier l'unité en une seule fois (ce qui permet d'utiliser une unité quelconque) 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.

Le premier paramètre, celui de la valeur à afficher, est mis en forme à l'aide de la fonction {{formatnum:}}. Attention : il faut utiliser la notation anglophone des nombres dans le paramètre transmis au modèle, lequel sera affiché suivant les conventions francophones. La virgule affiche une espace, une espace étant aussi insérée automatiquement pour tout groupe de plus de 3 chiffres non explicitement séparé par une virgule, seul le point affiche une virgule séparatrice des décimales.

Exemples :

  • « {{NaU|2,3|%}} » affiche « 2,3 {{#if:%|%{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} », ce qui n’est sans doûte pas le résultat attendu ;
  • entrer « {{NaU|2.3|%}} » pour afficher « 2,3 {{#if:%|%{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} » ;
  • entrer « {{NaU|1002.3|km}} » ou « {{NaU|1,002.3|km}} » pour afficher « 1 002,3 {{#if:km|km{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} » ;
  • noter encore « {{NaU|12345,67890.12345678|¤}} » qui affiche « 12 345,67 890,12345678 {{#if:¤|¤{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} », etc.

Exemples d'utilisation

Syntaxe Résultat Commentaire
{{Unité|10000|km}} km{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Cas d'utilisation minimale : une valeur suivie d'un symbole
{{Unité|10000|km/h}} km/h{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Cas similaire au précédent : le résultat affiche une espace insécable entre la valeur et son unité
{{Unité|10000|kilomètres par heure}} kilomètres par heure{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Il est possible d'écrire l'unité en toutes lettres ; dans ce cas l'usage d'une espace insécable entre la valeur et l'unité n'est cependant pas strictement nécessaire
{{Unité|10000|km|2}} km{{#if:2|2}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Adjonction d'un exposant au symbole d'unité
{{Unité|10000|km||h|-1}} km{{#if:|}}{{#if:h|∙h{{#if:-1|-1}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Deux symboles successifs, le premier ne possédant pas d'exposant
{{Unité|10000|J|2|K|3|s|-1}} J{{#if:2|2}}{{#if:K|∙K{{#if:3|3}}{{#if:s|∙s{{#if:-1|-1}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Trois symboles avec des exposants spécifiques
{{Unité|10000|J||kg||m|-2}} J{{#if:|}}{{#if:kg|∙kg{{#if:|}}{{#if:m|∙m{{#if:-2|-2}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Trois symboles, les deux premiers ne possédant pas d'exposant
{{Unité|-40.234|°C}} °C{{#if:|{{{3}}}}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Cas mettant en évidence l'utilisation de la notation anglophone dans le premier paramètre, lequel est affiché selon les conventions francophones
{{Unité|1.23456{{x10|9}}|J|2|K|3|s|-1}} 1,23456Modèle:X10 {{#if:J|J{{#if:2|2}}{{#if:K|∙K{{#if:3|3}}{{#if:s|∙s{{#if:-1|-1}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Trois symboles avec des exposants spécifiques, mettant en évidence l'utilisation de la notation anglophone et l'usage de puissances de 10 (usage scientifique) dans le premier paramètre
{{Unité|1|[[kilomètre|km]]|2}} 1 {{#if:km|km{{#if:2|2}}{{#if:|∙{{{4}}}{{#if:|{{{5}}}}}{{#if:|∙{{{6}}}{{#if:|{{{7}}}}}{{#if:|∙{{{8}}}{{#if:|{{{9}}}}}}}}}}}}} Il est aussi possible de placer un lien vers les unités, mais le modèle y perd de son efficacité

Limitations et « effets de bord »

  • Utilisé avec un seul paramètre, {{Nombre avec unité}} donne le même résultat que {{formatnum}}. Il n'est pas conseillé d'utiliser {{Nombre avec unité}} pour cet usage.
  • Le symbole degré (°) semble être considéré comme un caractère « sécable » par MediaWiki. Ceci est géré par le modèle, qui rend toutes les unités elles-mêmes insécables de la quantité qui la précède (y compris les multiplicateurs par un exposant de base 10, ou les exposants et autres unités composées).