Module:Date/Documentation : Différence entre versions
(Création) |
|||
Ligne 1 : | Ligne 1 : | ||
== Utilisation == | == Utilisation == | ||
− | Fonctions | + | === Fonctions utilisables depuis un modèle === |
− | * <code> | + | * <code>modeleDate(frame)</code> – affiche une date avec les liens les plus pertinents (précisions ci-dessous). |
− | * <code> | + | * <code>modeleInscriptionDate(frame)</code> – affiche une date correctement formatée, sans lien. l'année est obligatoire. Paramètres nommés année, mois, jour. (utilisé par module Biblio) |
+ | * <code>dateISO(frame)</code> – similaire à modeleInscriptionDate mais la date est au format aaaa-mm-jj. Paramètres nommés année, mois, jour. | ||
+ | * <code>dateRepublicain(frame)</code> – affiche une date grégorienne au format républicain (sans liens). Paramètres 1=année, 2=mois, 3=jour. | ||
+ | * <code>modeleAge(frame)</code> - retourne l'age (nombre d'année) depuis une date ou entre deux dates. Paramètres 1=année, 2=mois, 3=jour, 4=année, 5=mois, 6=jour. | ||
+ | * <code>erreurModuleData()</code> - retourne un message d'erreur si Module:Date/Data ne se charge pas correctement. | ||
+ | * <code>checkDataCat(frame)</code> - retourne une liste de page annuelle et mensuelle pour facilité les mises à jour de Date/Data. Paramètres 1=cat, mois=liste de mois si 'oui', alias = liste tous les alias si 'oui' | ||
− | + | === fonction utilisable depuis un autre module === | |
− | * <code> | + | * <code>nomDuMois( num )</code> – retourne le nom français du mois n° <code>num</code>. |
+ | * <code>valideMois( mois )</code> – retourne le nom français et le n° de <code>mois</code> (nom français, abrégé, anglais, ou nombre entre 1 et 12). | ||
+ | * <code>determinationMois( mois, frame )</code> - similaire à valideMois, mais le numéro du mois n'est pas limité (14 → février), et peut même être une expréssion si un objet frame est fourni ( 6 + 3 → septembre ) | ||
+ | * <code>do_dayRank(arguments)</code> - Rang du jour dans l'année. Paramètre arguments = { année, mois, jour } ou { year = année, month = mois, day = jour } | ||
+ | * <code>isLeapYear(year)</code> - retourne true si year est une année bisextile dans le calendrier grégorien. | ||
+ | * <code>toRoman(number)</code> - transforme number en une chaine le représentant en « [[chiffres romains]] ». | ||
+ | * <code>age( an, mn, jn, ac, mc, jc )</code> - similaire à modeleAge, mais les paramètres ne sont pas dans une table | ||
+ | * <code>julianDay( year, month, day, hour, minute, second )</code> - retourne le [[jour julien]] de la date transmise, suivant le [[Calendrier grégorien proleptique|calendrier grégorien astronomique]] (avec année 0) | ||
+ | * <code>julianDayJulian( year, month, day, hour, minute, second )</code> - retourne le [[jour julien]] d'une date du [[Calendrier julien proleptique|calendrier julien astronomique]] (avec année 0) | ||
+ | * <code>jullianDayToGregorian( jd )</code> - retourne trois variable année, mois, jour représentant la date du [[Calendrier grégorien proleptique|calendrier grégorien astronomique]] correspondant à ce jour julien. | ||
+ | * <code>jullianToGregorian( year, month, day )</code> - transforme une date du calendrier julien en date du calendrier grégorien. | ||
Modules externes et autres éléments dont ce module a besoin pour fonctionner : | Modules externes et autres éléments dont ce module a besoin pour fonctionner : | ||
− | * <code> | + | * <code>Date/Data</code> - Base de donnée permettant de ne pas tester les pages que l'on sait existante, ou n'existant pas. |
+ | * <code>TableBuilder</code> – Utilise <code>.insert</code> et <code>.concat</code> pour simplifier la syntaxe. | ||
− | == | + | == modeleDate( frame ) == |
− | + | === Paramètres === | |
+ | * <code>1</code> - jour ou vide - numérique, exeption possible pour 1er ou {{1er}}. | ||
+ | * <code>2</code> - mois ou jour - numérique ou nom français ou anglais, éventuellement une abréviation courante. | ||
+ | * <code>3</code> - année ou mois - Un nombre sera considéré comme année. Les années sont considérées comme suivant le calendrier grégorien depuis le 14 octobre 1582 (sauf si julien = 'oui') et le calendrier julien auparavant, sans année 0. | ||
+ | * <code>4</code> - qualificatif ou année - texte correspondant à une page type « en photographie » pour « [[2008 en photographie]] » | ||
+ | * <code>5</code> - qualificatif | ||
+ | * <code>age</code> ou <code>âge</code> - non vide pour afficher l'age (aucun age n'est affiché pour les date dans le futur) | ||
+ | * <code>julien</code> - 'oui' pour que la date soit considérée suivant le calendrier julien après le 14 otobre 1582. La date sera affiché suivant les deux calendrier. | ||
+ | * <code>avJC</code> - 'non' pour ne pas affiché 'av. J.-C.' après l'année si elle représente une année anvant Jésus Chirst. Utile pour éviter les répétitions. | ||
+ | <!-- | ||
+ | * <code>paramètres page</code> - Si un modèle date contient ce paramètre, et les paramètre <code>julien</code>, <code>avJC</code> et <code>qualificatif</code> seront appliqué à toutes les dates de la page, sauf si une autre valeur de ces paramètres est indiquée. | ||
+ | * <code>qualificatif</code> - qualificatif a appliquer sur toute la page, en liaison avec le paramètre <code>paramétres page</code> | ||
+ | --> | ||
− | == Fonction modeleDate comparée aux modèles existant == | + | === fonctionnement === |
+ | * Le modèle cherche à afficher la date avec des liens vers les pages liè au qualificatif. s'il n'y a pas de page lié au qualificatif un lien sera fait vers la page générale. | ||
+ | * le premier paramètre est vide et le troisième correspond à un mois (texte uniquement), tous les paramètres sont considérés comme décalé et l'année ne sera pas affichée. | ||
+ | * S'il n'y a pas de page spécifique pour ce mois-année, le mois sera affiché liè avec le jour à l'éphéméride. Priorité est donné à l'éphéméride du qualificatif sur le lien mois-année sans qualificatif. | ||
+ | * Le modèle s'aide de la base de donnée [[Module:Date/Data|Date/Data]] pour éviter d'utiliser la fonction mw.title (équivalent du parser #ifexist:). | ||
+ | * Cette base permet de remplacer le qualificatif par une catégorie plus générique. Si le qualificatif est « en tennis », l'éphéméride et la page mensuelle sera liè au qualificatif « en sport ». | ||
+ | |||
+ | |||
+ | === Fonction modeleDate comparée aux modèles existant === | ||
=== Comparaison avec {{m|date}} === | === Comparaison avec {{m|date}} === | ||
Version du 31 août 2013 à 09:22
Sommaire
Utilisation
Fonctions utilisables depuis un modèle
-
modeleDate(frame)
– affiche une date avec les liens les plus pertinents (précisions ci-dessous). -
modeleInscriptionDate(frame)
– affiche une date correctement formatée, sans lien. l'année est obligatoire. Paramètres nommés année, mois, jour. (utilisé par module Biblio) -
dateISO(frame)
– similaire à modeleInscriptionDate mais la date est au format aaaa-mm-jj. Paramètres nommés année, mois, jour. -
dateRepublicain(frame)
– affiche une date grégorienne au format républicain (sans liens). Paramètres 1=année, 2=mois, 3=jour. -
modeleAge(frame)
- retourne l'age (nombre d'année) depuis une date ou entre deux dates. Paramètres 1=année, 2=mois, 3=jour, 4=année, 5=mois, 6=jour. -
erreurModuleData()
- retourne un message d'erreur si Module:Date/Data ne se charge pas correctement. -
checkDataCat(frame)
- retourne une liste de page annuelle et mensuelle pour facilité les mises à jour de Date/Data. Paramètres 1=cat, mois=liste de mois si 'oui', alias = liste tous les alias si 'oui'
fonction utilisable depuis un autre module
-
nomDuMois( num )
– retourne le nom français du mois n°num
. -
valideMois( mois )
– retourne le nom français et le n° demois
(nom français, abrégé, anglais, ou nombre entre 1 et 12). -
determinationMois( mois, frame )
- similaire à valideMois, mais le numéro du mois n'est pas limité (14 → février), et peut même être une expréssion si un objet frame est fourni ( 6 + 3 → septembre ) -
do_dayRank(arguments)
- Rang du jour dans l'année. Paramètre arguments = { année, mois, jour } ou { year = année, month = mois, day = jour } -
isLeapYear(year)
- retourne true si year est une année bisextile dans le calendrier grégorien. -
toRoman(number)
- transforme number en une chaine le représentant en « chiffres romains ». -
age( an, mn, jn, ac, mc, jc )
- similaire à modeleAge, mais les paramètres ne sont pas dans une table -
julianDay( year, month, day, hour, minute, second )
- retourne le jour julien de la date transmise, suivant le calendrier grégorien astronomique (avec année 0) -
julianDayJulian( year, month, day, hour, minute, second )
- retourne le jour julien d'une date du calendrier julien astronomique (avec année 0) -
jullianDayToGregorian( jd )
- retourne trois variable année, mois, jour représentant la date du calendrier grégorien astronomique correspondant à ce jour julien. -
jullianToGregorian( year, month, day )
- transforme une date du calendrier julien en date du calendrier grégorien.
Modules externes et autres éléments dont ce module a besoin pour fonctionner :
-
Date/Data
- Base de donnée permettant de ne pas tester les pages que l'on sait existante, ou n'existant pas. -
TableBuilder
– Utilise.insert
et.concat
pour simplifier la syntaxe.
modeleDate( frame )
Paramètres
-
1
- jour ou vide - numérique, exeption possible pour 1er ou 1er. -
2
- mois ou jour - numérique ou nom français ou anglais, éventuellement une abréviation courante. -
3
- année ou mois - Un nombre sera considéré comme année. Les années sont considérées comme suivant le calendrier grégorien depuis le 14 octobre 1582 (sauf si julien = 'oui') et le calendrier julien auparavant, sans année 0. -
4
- qualificatif ou année - texte correspondant à une page type « en photographie » pour « 2008 en photographie » -
5
- qualificatif -
age
ouâge
- non vide pour afficher l'age (aucun age n'est affiché pour les date dans le futur) -
julien
- 'oui' pour que la date soit considérée suivant le calendrier julien après le 14 otobre 1582. La date sera affiché suivant les deux calendrier. -
avJC
- 'non' pour ne pas affiché 'av. J.-C.' après l'année si elle représente une année anvant Jésus Chirst. Utile pour éviter les répétitions.
fonctionnement
- Le modèle cherche à afficher la date avec des liens vers les pages liè au qualificatif. s'il n'y a pas de page lié au qualificatif un lien sera fait vers la page générale.
- le premier paramètre est vide et le troisième correspond à un mois (texte uniquement), tous les paramètres sont considérés comme décalé et l'année ne sera pas affichée.
- S'il n'y a pas de page spécifique pour ce mois-année, le mois sera affiché liè avec le jour à l'éphéméride. Priorité est donné à l'éphéméride du qualificatif sur le lien mois-année sans qualificatif.
- Le modèle s'aide de la base de donnée Date/Data pour éviter d'utiliser la fonction mw.title (équivalent du parser #ifexist:).
- Cette base permet de remplacer le qualificatif par une catégorie plus générique. Si le qualificatif est « en tennis », l'éphéméride et la page mensuelle sera liè au qualificatif « en sport ».
Fonction modeleDate comparée aux modèles existant
Comparaison avec {{date}}
motif testé | chaine testée | Modèle Date | Module | fonctions couteuses modèle / module |
---|---|---|---|---|
date récente | 14|octobre|2001 | 1 / 0 | ||
date ancienne (1700 - 1943), jour =1 | 1|octobre|1842 | 1 / 1 | ||
date très ancienne (<1700), jour = 1er | 1er|janvier|537 | 1 / 0 | ||
qualificatif qui n'est pas dans la base | 14|octobre|2010|en animation asiatique | 4 / 1 | ||
date ancienne, qualificatif qui n'est pas dans la base | 14|octobre|1842|en animation asiatique | 4 / 2 | ||
avec qualificatif | 14|Octobre|2001|en astronautique | 3 / 0 | ||
avec qualificatif avec éphémérides | 14|octobre|2005|dans les chemins de fer | 4 / 0 | ||
pas de jour | |octobre|2001 | 1 / 0 | ||
pas de jour avec qualificatif | |Octobre|2001|en astronautique | 3 / 0 | ||
qualificatif avec page annuelle qui pourrait exister | 14|octobre|2006|en Égypte | 4 / 1 | ||
qualificatif avec page mensuelle existante | 14|octobre|2008|en France | 3 / 0 | ||
qualificatif avec page mensuelle qui pourrait exister | 14|octobre|2012|en France | 4 / 1 | ||
qualificatif avec page annuelle et mensuelle qui pourrait exister | 14|octobre|2012|en économie | 4 / 2 | ||
date ancienne avec qualificatif | 14|octobre|1845|en aéronautique | 4 / 1 | ||
décalage | |25|octobre|2006 | Année invalide (octobre) | Année invalide (octobre) | 3 / 0 |
décalage et qualificatif | |25|octobre|2006|en sport | Année invalide (octobre) | Année invalide (octobre) | 3 / 0 |
date négative | 13|octobre|-63 | 1 / 0 | ||
date av. J.-C; (orthographe de la page) | {{1er}}|octobre|63 av av. J.-C. | 1 / 0 | ||
date avJC (orthographe abrégée) | 13|octobre|63 avJC | 1 / 0 | ||
date négative, paramètre pour cahée av. J.-C. | 13|octobre|-63|avJC=non | 1 / 0 | ||
année invalide | 14|octobre|2001 en sport | Année invalide (2001 en sport) | Année invalide (2001 en sport) | 1 / 0 |
jour + mois avec majuscule | 14|Octobre|2001 | 1 / 0 | ||
mois en abrégé | 14|oct.|2001 | 1 / 0 | ||
mois en chiffre | 14|10|2001 | 1 / 0 | ||
mois invalide | 14|otcobre|2001 | Mois invalide (otcobre) | Mois invalide (otcobre) | 1 / 0 |
jour invalide | jeudi 14|octobre|2001 | 1 / 0 | ||
jour invalide (trop grand pour le mois) | 31|septembre|2001 | Jour invalide (31 septembre) | Jour invalide (31 septembre) | 1 / 0 |
uniquement l’année | ||2001 | 1 / 0 | ||
uniquement l’année avec qualificatif | ||2001|en littérature | 1 / 0 | ||
sans année | 14|octobre | 0 / 0 | ||
jour uniquement | 14 | 0 / 0 | ||
mois uniquement | |Octobre | Octobre | Octobre | 0 / 0 |
décalage sans jour | ||Octobre|2001 | Année invalide (Octobre) | Année invalide (Octobre) | 0 / 0 |
sans argument | 0 / 0 | |||
date du calendrier julien | 14|octobre|2001|julien=oui | |||
date du calendrier julien fin déc. | 25|dec|2001|julien=oui | |||
date de naissance | 14|octobre|2001|age=oui |
Comparaison avec {{date de naissance}}
- Les fonctions couteuses sont les même que celle du modèle Date
- sans l'age, voir comparaison avec {{Date}}
motif testé | chaine testée | Modèle Date de naissance | Module |
---|---|---|---|
simple | 1|8|2006|âge=oui | ||
avec qualificatif | 1|août|2006|en Suisse|age=oui | ||
date ancienne | 2|1|598|age=oui | ||
l'an dernier | 2|1|2012|age=oui | ||
cette année | 2|1|2013|age=oui | ||
l'an prochain | 2|1|2014|age=oui | ||
sans jour | |8|2006|âge=oui | ||
annee seule | ||2006|âge=oui |
Comparaison avec {{date sport}}
- lorsqu'il n'y a pas de qualificatif, « en sport » et ajouté pour tester le module.
motif testé | chaine testée | Modèle Date sport | Module | fonctions couteuses modèle / module |
---|---|---|---|---|
simple | 1|2|1980 | 1 / 0 | ||
avec qualificatif | 12|2|1980|en gymnastique | 2 / 0 | ||
qualificatif avec page possible pour cette année | 12|2|1977|en gymnastique | 3 / 1 | ||
avec qualificatif et age | 12|2|1980|en gymnastique|âge=oui | 2 / 0 | ||
date ancienne | 12|2|1843 | 1 / 0 | ||
date récente avec page mensuelle | 12|2|2006 | 1 / 0 | ||
date récente avec page mensuelle et qualif | 12|2|2006|en gymnastique | 2 / 0 | ||
date trop récente sans page mensuelle | 1|8|2013 | 1 / 1 | ||
date trop récente sans page mensuelle et qualif avec page annuelle possible |
1|8|2013|en gymnastique | 3 / 2 |