Module:Nombre2texte/Documentation
Ce module contient différentes fonction pratiques.
Résumé des fonctions
[modifier le code]Fonctions exportables :
ordinal( nombre, feminin )
– retourne un ordinal abrégé comme {{1er}}, {{2e}}… à partir d’un nombre ou d’une chaîne contenant uniquement des chiffres. Si le deuxième paramètre 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
[modifier le code]nombre2texte_reel
[modifier le code]Syntaxe
[modifier le code]Nombre2texte.nombre2texte_reel( pnombre, plangue, ptype, porthographe, pgenre, pmajuscule )
Retourne la forme textuelle du nombre passé en paramètre. Prend en charge l’orthographe pré/post 1990, la création d’ordinaux ou de cardinaux et les variantes de certains nombres (septante, nonante, huitante…).
Contraintes
[modifier le code]- Ne traite que les nombres entre -999999999999 et 999999999999 (inclus).
- Ne gère pas les nombres à point flottant (avec une virgule) — la partie décimale est ignorée, et seule 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
[modifier le code]pnombre
– doit être une chaîne de caractères. Le nombre à convertir.plangue
– langue utilisée. Valeurs possibles : "fr" (soixante-dix, quatre-vingts, quatre-vingt-dix) ; "be" (septante, quatre-vingts, nonante) ; "ch" (septante, huitante, nonante) ; "ch2" (septante, octante, nonante). Une valeur vide 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ée (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 dans 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 mise en majuscule, sinon elle reste en minuscule.
Exemples
[modifier le code]Voir ci-dessous.
nombre2texte
[modifier le code]Même fonction que ci-dessus mais pour un appel depuis un article (via un modèle).
Paramètres
[modifier le code]Voir ci-dessus pour les détails.
- Premier paramètre non nommé – le nombre à convertir (format numérique).
langue=
– la langue utilisée (vide ou "fr" (équivalents), "be", "ch" ou "ch2").orthographe=
– l’orthographe suivie (vide ou "réformée").genre=
– le genre du résultat (vide ou "féminin").majuscule=
– mettre une majuscule à la première lettre (vide ou “oui”).type
– générer un cardinal ou un ordinal (absent ou “ordinal”).
Exemples
[modifier le code]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