Aller au contenu

Module:Nombre2texte/Documentation

Une page de Wikipédia, l'encyclopédie libre.
Ceci est une version archivée de cette page, en date du 29 septembre 2017 à 15:34 et modifiée en dernier par Od1n (discuter | contributions) (documentation en reprenant une partie de Module:Outils/Documentation). Elle peut contenir des erreurs, des inexactitudes ou des contenus vandalisés non présents dans la version actuelle.
(diff) ← Version précédente | Version actuelle (diff) | Version suivante → (diff)


Ce module contient différentes fonction pratiques.

Résumé des fonctions

Fonctions exportables :

  • ordinal( nombre, feminin ) – retourne un ordinal abrégé comme {{1er}}, {{2e}}… à partir d'un nombre ou d'une chaine contenant uniquement des chiffres. Si le deuxième est défini, retourne 1re au lieu de 1er.
  • nombre2texte_reel(pnombre, plangue, ptype, porthographe, pgenre, pmajuscule) – transforme un nombre en texte (5 → cinq ou cinquième). Gère la langue (fr, be, ch), l'orthographe pré ou post 1990, le genre ainsi que les variantes locales des nombres.
  • nombre2texte(frame) – similaire à nombre2texte_reel mais pour un appel depuis un modèle.


Modules externes et autres éléments dont ce module a besoin pour fonctionner :

  • Module:Nombre2texte/Data – pour les conversions nombre → texte.

Détail par fonction

nombre2texte_reel

Syntaxe

Nombre2texte.nombre2texte_reel( pnombre, plangue, ptype, porthographe, pgenre, pmajuscule )

Retourne la forme textuelle du nombre passé en paramètre. Supporte l'orthographe pré/post 1990, la création d'ordinaux ou de cardinaux, et les variantes de certains nombres (septante, nonante, huitante…).

Contraintes
  • ne traite que les nombres entre -999999999999 et 999999999999 (inclus)
  • ne gère pas les nombres à virgule (la partie décimale est ignorée, la partie entière est traitée)
  • pour les ordinaux seuls les nombres positifs sont traités (un nombre négatif est accepté mais son signe est ignoré)
Paramètres
  • pnombre – doit être un string. Le nombre à convertir
  • plangue – langue utilisée. Valeur possibles : "fr" (soixante-dix, quatre-vingts, quatre-vingt-dix) ; "be" (septante, quatre-vingts, nonante) ; "ch" (septante, huitante, nonante) ; "ch2" (septante, octante, nonante). Une valeur nil correspond à "fr"
  • ptype – le type de sortie. Seules valeurs possibles : nil ou "ordinal". Si "ordinal" l'ordinal correspondant au nombre est généré (exemple : 12 → "douzième") sinon un cardinal est généré (exemple : 12 → "douze"). nil correspond à un cardinal
  • porthographe – le type d'orthographe suivi. Valeurs possibles : nil ou "réformée". Si "réformée" l'orthographe post-1990 est utilisé (tirets entre chaque termes) sinon c'est l'orthographe « historique » qui est suivie
  • pgenre – le genre du nombre. Valeurs possibles : nil ou "féminin". Si "féminin" la seule différence est pour les ordinaux ("premier" devient "première"), aucun changement pour les autres cas
  • pmajuscule – mettre une majuscule à la première lettre. Valeurs possibles : nil ou "oui". Si "oui" la première lettre du résultat est passée en majuscule, elle reste en minuscule sinon
Exemples

Voir ci-dessous.

nombre2texte

Même fonction que ci-dessus mais pour appel depuis un article (via un modèle).

Paramètres
  • premier paramètre non nommé – le nombre à convertir (format numérique)
  • langue= – la langue utilisée (absent ou "fr", "be", "ch" ou "ch2", voir ci-dessus)
  • orthographe= – l'orthographe suivie (absent, "réformée", voir ci-dessus)
  • genre= – le genre du résultat (absent, "féminin", voir ci-dessus)
  • majuscule= – mettre une majuscule à la première lettre (absent, "oui", voir ci-dessus)
  • type – générer un cardinal ou un ordinal (absent, "ordinal", voir ci-dessus)
Exemples

Appel de base : {{#invoke:Nombre2texte|nombre2texte|132}} → cent trente-deux
Ordinal : {{#invoke:Nombre2texte|nombre2texte|132|type=ordinal}} → cent trente-deuxième
Majuscule : {{#invoke:Nombre2texte|nombre2texte|132|majuscule=oui}} → Cent trente-deux
Langue : {{#invoke:Nombre2texte|nombre2texte|198|langue=be}} → cent nonante huit
Genre : {{#invoke:Nombre2texte|nombre2texte|1|genre=féminin|type=ordinal}} → première
Orthographe : {{#invoke:Nombre2texte|nombre2texte|1927|orthographe=réformée}} → mille-neuf-cent-vingt-sept