Модуль:Pagesincat/документація

Це сторінка документації для Модуль:Pagesincat

ВикористанняРедагувати

Liste des fonctions exportées par le module sous la forme :

  • pagesincat(frame) – retourne le nombre de pages dans une catégorie

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

  • mw.title, mw.language, mw.site

Деталі й внутрішні функції


  • erreur(texte) – retourne une mise en forme de texte sous forme d'erreur, dans un <span class="error"></span>
  • pagesincat(frame) – retourne le nombre de pages dans une catégorie
    • paramètres : tous (all) les paramètres issus de frame:getParent().args sauf le paramètre nommé type qui est d'abord testé en provenance du modèle (pour permettre une surcharge) puis seulement de l'appel au modèle.
      • paramètre non nommé (le seul) : le nom de la catégorie dont on veut le nombre de pages, sans l'extension Catégorie:. Si ce paramètre n'est pas indiqué le nom de la page où le modèle est appelé est utilisée. Si cette page n'est pas une catégorie une erreur est générée.
      • type=Type : type de pages à décompter : tous (all); cats ; fichiers (files); pages. Si non précisé tous (all) est utilisé
      • mise en forme=oui : si ce paramètre est non vide le nombre retourné est mis en forme selon les critères de la langue courante (séparateur de miliers)
    • éléments techniques :
      • utilise mw.title.getCurrentTitle() pour connaître l'espace de nom (.namespace) et le nom (.text) de la page courante, si le nom n'est pas passé en paramètre
      • utilise mw.site.stats.pagesInCategory() pour obtenir le compte des pages dans une catégorie
      • utilise mw.getContentLanguage():formatNum() pour formater selon les conventions locales le nombre retourné, si la mise en forme est demandée
      • retourne une erreur si mw.site.stats.pagesInCategory() échoue. Est-ce que cela peut se produire ?