Module:Archives/Documentation

Utilisation

Ce module est conçu pour une utilisation à travers le modèle Modèle:ArchivesLua. Il fournit des fonctions pour la mise en forme automatique des liens vers les archives d'une page de discussion.

Fonctions exportables

• an(frame) – Prend en argument un frame contenant dans l'ordre les paramètres ci-dessous et retourne la liste des liens d'archives d'une page année par année.
  1. page : nom de la page wikipédia dont on veut les archives ;
  2. debut : année des premières archives (par défaut, 2004) ;
  3. fin : année des dernières archives (par défaut, l'année en cours);
  4. separateur : séparateur à utilise entre les liens d'archive (par défaut, pas de séparateur).
• periode(unite, frame) – Prend en argument une chaîne de caractères unite qui adapte la forme des liens d'archive uniquement lorsqu'il vaut "semaine" et un frame contenant dans l'ordre les paramètres ci-dessous et retourne la liste des liens d'archives d'une page, pour une séparation des archives plus complexe que par année.
  1. page : nom de la page wikipédia dont on veut les archives ;
  2. AnneeDebut-PeriodeDebut : date de début des archives avec AnneeDebut et PeriodeDebut des nombres, la période étant un numéro de mois ou de semaine ;
  3. AnneeFin-PeriodeFin : date de fin des archives au même format que la date de début (par défaut, la date du jour) ;
  4. separateur : séparateur à utilise entre les liens d'archive (par défaut, pas de séparateur) ;
  5. format : "nom" ou "abréviation", dans le deuxième cas le nom du mois est tronqué après le troisième caractère (Par défaut, "nom").
• semaine(frame) – Retourne periode("semaine", frame) ;
• mois(frame) – Retourne periode("mois", frame).

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

• mw.text.trim – Enlève les espaces et autres caractères au début et à la fin d'une chaine de caractères ;
• mw.text.truncate – Tronque une chaîne de caractères et y ajoute des points de suspension ;
• mw.ustring.gsub – Retourne une tranche d'une chaîne de caractères ;

• Module:Date – Module fournissant des fonctions de traitement des dates.

Modules lua utilisant ce module

Aucun

Modèles appelant directement ce module

• Modèle:ArchivesLua

Exemples

Dans Modèle:ArchivesLua, ce module est appelé par le code suivant :

{{#invoke:archives
|{{{période|{{{1|an}}}}}}
|{{{page|{{{2|}}}}}}
|{{{début|{{{3|}}}}}}
|{{{fin|{{{4|}}}}}}
|{{{séparateur|{{{5|}}}}}}
|{{{format|{{{6|}}}}}}
}}