Module:Date/Data/Documentation

Ceci est la page de documentation de Module:Date/Data [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.

Erreur de script : la fonction « erreurModuleData » n’existe pas.

Ce module est une base de données de langues destinée à être chargé par mw.loadData.

Syntaxe

data['<clé>'] = {
    qualificatif = '<qualificatif>',
    cat = '<catégorie>',
    jour = true,
    mois = {
        aucun = 9999,
        tous = { 9999, 9999 },
        seul = { 'mois année', ... }
    },
    annee = {
        aucun = 9999,
        tous = { 9999, 9999 },
        seul = { 9999, ... }
    }
}
data['<alias>'] = data['<clé>']

Paramètres

<clé> - texte : qualificatif ou nom de catégorie de qualificatif.
<qualificatif> - texte qui sera utiliser pour tester si des pages dédiée existent. Exemple : en sport
<catégorie> - texte permettant de regrouper un ensemble de qualificatifs. L'élément ayant pour clé ce texte sera utilisé si aucune page n'existe pour le qualificatif. Exemple : sport
<alias> - texte : qualificatif automatiquement redirigé vers un autre qualificatif.
jour = true - booléen : indique qu'il existe des éphémérides pour ce qualificatif (pour tous les jours de l'année). S'il n'y en a pas, utiliser la valeur false ou omettre ce paramètre.

mois - table contenant les années pour lesquels il sera tester de lié une page mensuelle à ce qualificatif, type [[mois année qualificatif|mois]], par exemple [[juin 2010 en sport|juin]].
- aucun - nombre : toutes les années inférieures ou égale à ce nombre ne seront pas tester, et aucun lien ne sera fait. Exemple : {{{1}}}
- tous - table contenant deux nombres. Pour toutes les années de cet intervale, un lien sera systématiquement fait. Exemple : { 2008, 2011 }
- pour les années qui sont supérieures à aucun et qui ne sont pas dans l'intervale tous, l'existance de la page sera testée par mw.title, l'équivalent de {{#ifexist: et cela sera dans le compteur de fonction couteuse
- seul - table contenant une liste de date (texte mois année) inférieures à aucun pour lesquelles une page existe pour <qualificatif>. exemple : { 'Mai 1968' }

annee - table contenant les années pour lesquels il sera tester de lié une page à ce qualificatif, type [[année qualificatif|année ]], par exemple [[1998 en sport|1998]]. Notez que le nom du paramètre n'a pas d'accent.
- aucun et tous - similaire au paramètres de mois
- seul - table contenant une liste d'année (nombre) inférieures à aucun pour lesquelles une page existe pour <qualificatif>. exemple : { 1836, 1875, 1882 }

Syntaxe générale

les nombres sont saisi sans séparateur de milliers
Les textes sont entourés de guillemets anglais simple ou double (au choix) et peuvent contenir l'autre type. Exemple : "en Côte d'Ivoire"
Les tables sont encadrée par des accolades, chaque paramètre est séparé par une virgule. Le dernier paramètre peut être suivi par une virgule.
les espaces et les différents saut de ligne ne sont pas pris en compte. il ne servent qu'a la présentation.
des commentaires peuvent être ajouté commençant par de signe moins « -- » et se terminant à la fin de la ligne (qui a cette fois de l'importance)

Exemples

data['sport'] = {                                   -- clé = catégorie
    qualificatif = 'en sport',                      -- qualificatif principal de la catégorie
    cat = 'sport',                                  -- cette catégorie doit être reprise pour tous les qualificatif lié au sport.
    jour = true,                                    -- il y a des éphémérides « en sport »
    mois = { aucun = 2004, tous = {2005, 2012} },   -- il n'y a pas de page mensuelles jusqu'en 2004 (inclu)
                                                    -- mais elles existent toute de 2005 à 2012 (incul)
    annee = { aucun = 1849, tous = {1850, 2018} },  -- toute les pages annuelles existent de 1849 à 2018
}                                                   -- fin de la table de la clé « sport »
data['en sport'] = data['sport']                    -- alias de l'élément précédent clé = qualificatif

data['en athlétisme'] = {                           -- clé = qualificatif
    qualificatif = 'en athlétisme', cat = 'sport',  -- cat = sport et pas de jour → utilisera les éphéméride « en sport »
                                                    -- pas de pages mensuelles, utilisera « en sport »
    annee = { aucun = 2000, tous = {2002, 2013} },  -- pour une date de l'année 2000, l'existance de la page [[2000 en athlétisme]] sera tesée
}                                                   -- fin de la table de la clé « athlétisme »

Philosophie de cette base

L'objectif de cette base est de permettre tous les liens vers les pages existantes tout en réduisant sensiblement les appel aux fonction couteuses.

Pour ne pas privée de liens de nouvelles page, aucun doit être positionné de a une année qui a peu de chance de voir une page se crée dans les jour et semaines à venir
Pour réduire l'appel aux fonction couteuse il ne faut pas mettre -500 partout. La vitalité d'un projet, l'état des pages déjà crées et leur date de création doivent guider le choix.
<>seul</> permet de lié quelques page existantes sans trop étendre la plage testée s'il y a peu de chance que ces pages (crée il y a plusieurs années) ai des petites soeurs.
<>tous</> ne permet qu'une plage de date. s'il y en a plusieurs potentielles, choisir celle qui sera le plus souvent présente sur les pages visitées, en général la plage la plus récente.

Mise à jour : checkDataCat

Utilisation

Pour faciliter le repérage des pages qui aurait été créées il y a la fonction checkDataCat

Cette fonction crée une (longue) liste de liens vers les pages annuelles et éventuellement mensuelle pour chaque qualificatif d'une catégorie. Il est alors facile de repérer les pages existante (en bleu) au milieu des pages inexistantes (lien rouge)

La plage de date affichée dépend de la valeur de aucun. L'ordre des qualificatifs est indéterminé.

Syntaxe

{{#invoke:Date|checkDataCat|catégorie|mois=non|alias=non}}

catégorie - nom d'une catégorie de la base. Laissé vide pour avoir les pages sans qualificatif
mois - oui pour afficher la liste des pages mensuelles (beaucoup de rouge et peu de bleu)
alias - oui pour afficher une plage pour tous les alias (utile pour les catégories géographiques)