Module:Date/Documentation

De Wikonsult
< Module:Date
Révision datée du 22 septembre 2018 à 10:31 par w.fr>Od1n (→‎Fonctions utilisables depuis un modèle : mise à jour suite à 115884171)
(diff) ← Version précédente | Voir la version actuelle (diff) | Version suivante → (diff)
Sauter à la navigation Sauter à la recherche

Ceci est la page de documentation pour Module:Date

Utilisation

Fonctions utilisables depuis un modèle

  • modeleDate(frame) – affiche une date avec les liens les plus pertinents (précisions ci-dessous).
  • dateISO(frame) – similaire à modeleInscriptionDate mais la date est au format aaaa-mm-jj. Paramètres nommés année, mois, jour. Pour respecter l'ISO 8601 qui définit la date uniquement selon le calendrier grégorien, cette fonction ne retourne rien pour les dates avant 1583.
  • dateInfobox(frame) affiche une date avec les liens pertinents, gère correctement les paramètres contenant déjà un modèle date, ou avec du texte suivant la date (précisions ci-dessous). Prévu pour être utilisé dans les Infobox.
  • 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'âge (nombre d'années) 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 pages annuelle et mensuelle pour faciliter les mises à jour de Date/Data. Paramètres 1=cat, mois=liste de mois si 'oui', alias = liste tous les alias si 'oui'

Fonctions utilisables depuis un autre module

  • valideMois( mois ) – retourne le nom français et le n° de mois (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 expression 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 bissextile 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)
  • julianDayToGregorian( jd ) - retourne trois variables année, mois, jour représentant la date du calendrier grégorien astronomique correspondant à ce jour julien.
  • julianDayToJulian( jd ) - retourne trois variables année, mois, jour représentant la date du calendrier julien correspondant à ce jour julien.
  • julianToGregorian( year, month, day ) - transforme une date du calendrier julien en date du calendrier grégorien.
  • gregorianToJulian( year, month, day ) - transforme une date du calendrier grégorien en date du calendrier julien.

Modules externes dont ce module a besoin pour fonctionner

  • Date/Data - Base de donnée permettant de ne pas tester les pages que l'on sait existantes, ou n'existant pas.
  • TableBuilder – Utilise .insert et .concat pour simplifier la syntaxe.

modeleDate( frame )

Paramètres

  • 1 - jour ou vide - numérique, exception 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 après le 14 octobre 1582 (sauf si julien = 'oui') et le calendrier julien avant, 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'âge (aucun âge n'est affiché pour les dates dans le futur)
  • julien - 'oui' pour que la date soit considérée comme suivant le calendrier julien après le 14 octobre 1582. La date grégorienne avec liens est affichée suivie de la date julienne entre parenthèses.
  • avJC - 'non' pour ne pas afficher 'av. J.-C.' après l'année si elle représente une année avant Jésus-Christ. Utile pour éviter les répétitions.
  • paramètres page - Si un modèle {{date}} contient ce paramètre, les paramètres julien, avJC et qualificatif seront appliqués à toutes les dates de la page, sauf si une autre valeur de ces paramètres est indiquée. Le modèle date qui contient ce paramètre n'a pas besoin d'être affiché par le module Date, et peut être en commentaire dans la page. La page doit être purgée pour que ce paramètre soit pris en compte.
  • qualificatif - qualificatif à appliquer sur toute la page. Ne fonctionne qu'en liaison avec le paramètre paramètres page

Fonctionnement

  • le modèle cherche à afficher la date avec des liens vers les pages liées au qualificatif. S'il n'y a pas de page liée 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és 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ée à 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ée au qualificatif « en sport ».
  • pour éviter de répéter le même qualificatif sur toutes les dates de la page, il suffit d'avoir quelque part dans le texte de la page, même en commentaire mais pas amené par un modèle, le texte {{Date|paramètres page= |qualificatif= mon qualificatif}}. Le modèle peut contenir d'autre paramètres. Seul le premier modèle date contenant ce paramètre sera pris en compte.

Fonction modeleDate

Motif testé Chaîne testée Module Fonctions coûteuses
modèle d'avant / 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 1|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
date négative 13|octobre|-63 1 / 0
date av. J.-C. (orthographe de la page) 1|octobre|63 av. J.-C. 1 / 0
date avJC (orthographe abrégée) 13|octobre|63 avJC 1 / 0
date négative, paramètre pour cacher av. J.-C. 13|octobre|-63|avJC=non 1 / 0
année invalide 14|octobre|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) 1 / 0
jour invalide jeudi 14|octobre|2001 1 / 0
jour invalide (trop grand pour le mois) 31|septembre|2001 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 0 / 0
sans argument 0 / 0
date du calendrier julien 1|octobre|2001|julien=oui 1er octobre 2001 ( dans le calendrier grégorien)
date du calendrier julien (changement de mois) 25|octobre|2001|julien=oui 25 octobre 2001 ( dans le calendrier grégorien)
date du calendrier julien (changement d'année) 25|décembre|2001|julien=oui 25 décembre 2001 ( dans le calendrier grégorien)
date de naissance 14|octobre|2001|age=oui (23 ans)

Comparaison avec {{date de naissance}}

  • les fonctions coûteuses sont les mêmes que celles du modèle Date
  • sans l'âge, voir comparaison avec {{Date}}
Motif testé Chaîne testée Modèle Date de naissance Module
simple 1|8|2006|âge=oui (18 ans) (18 ans)
avec qualificatif 1|août|2006|en Suisse|age=oui (18 ans) (18 ans)
date ancienne 2|1|598|age=oui (1426 ans)
l'an dernier 2|1|2012|age=oui (12 ans) (12 ans)
cette année 2|1|2013|age=oui (11 ans) (11 ans)
l'an prochain 2|1|2014|age=oui (10 ans) (10 ans)
sans jour |8|2006|âge=oui (18 ans) (18 ans)
annee seule ||2006|âge=oui

Comparaison avec {{date sport}}

  • lorsqu'il n'y a pas de qualificatif, « en sport » est ajouté pour tester le module.
Motif testé Chaîne testée Modèle Date sport Module Fonctions coûteuses
modèle / module
simple 1|2|1980 Modèle:Date sport 1 / 0
avec qualificatif 12|2|1980|en gymnastique Modèle:Date sport 2 / 0
qualificatif avec page possible pour cette année 12|2|1977|en gymnastique Modèle:Date sport 3 / 1
avec qualificatif et âge 12|2|1980|en gymnastique|age=oui Modèle:Date sport (44 ans) 2 / 0
date ancienne 12|2|1843 Modèle:Date sport 1 / 0
date récente avec page mensuelle 12|2|2006 Modèle:Date sport 1 / 0
date récente avec page mensuelle et qualif 12|2|2006|en gymnastique Modèle:Date sport 2 / 0
date trop récente sans page mensuelle 1|8|2013 Modèle:Date sport 1 / 1
date trop récente sans page mensuelle
et qualif avec page annuelle possible
1|8|2013|en gymnastique Modèle:Date sport 3 / 2

dateInfobox( frame )

Fonction destinée aux infobox, notamment pour afficher les dates de naissance et de mort les liens présent dans les dates fournies sont automatiquement supprimées pour gérer les cas ou le paramètre contient déjà un modèle date. Le contenu du paramètre situé après la date (par exemple un lieu, une référence) est conservé.

Paramètres

  • 1 : type de date à afficher (naissance / n, mort / m, ou date / d)
  • 2 : Date ou date de naissance
  • 3 : Date de mort si type n ou m
  • qualificatif : suffixe des pages de date à lier (exemple : en musique)
  • nolinks : n'affiche pas de lien
  • préfixe : préfixe à afficher s'il y a un jour (par défaut vide)
  • préfixe sans jour : préfixe à afficher s'il n'y a pas de jour (par défaut vide)

Ces paramètres doivent être directement dans le #invoke appelant la fonction.

Exemples

  • {{#invoke:Date|dateInfobox|date|13 juillet 1927}}
  • {{#invoke:Date|dateInfobox|naissance|13 juillet 1927|}} (97 ans)
  • {{#invoke:Date|dateInfobox|naissance|13 juillet 1927|14 mai 2017}}
  • {{#invoke:Date|dateInfobox|naissance|30 juin 2017-}} (7 ans)
  • {{#invoke:Date|dateInfobox|mort|13 juillet 1927|30 juin 2017}} (à 89 ans)
  • {{#invoke:Date|dateInfobox|mort||30 juin 2017}}
  • {{#invoke:Date|dateInfobox|mort|13 juillet 1927|}}
  • {{#invoke:Date|dateInfobox|date|13 juillet 1927| qualificatif = en France}}
  • {{#invoke:Date|dateInfobox|date|13 juillet 1927| préfixe = le}} → le
  • {{#invoke:Date|dateInfobox|date|13 juillet 1927| préfixe = le | préfixe sans jour = en}} → le
  • {{#invoke:Date|dateInfobox|date|juillet 1927| préfixe = le}}
  • {{#invoke:Date|dateInfobox|date|juillet 1927| préfixe = le | préfixe sans jour = en}} → en
  • {{#invoke:Date|dateInfobox|date|13 juillet [[1927]]}}
  • {{#invoke:Date|dateInfobox|date|13 juillet [[1927 en France|1927]]}} → 13 juillet 1927
  • {{#invoke:Date|dateInfobox|date|{{date|13 juillet 1927|en France}}}}