Aller au contenu

Module:Infobox/Documentation

Ajouter des liens
Une page de Wikipédia, l'encyclopédie libre.
< Module:Infobox
Ceci est une version archivée de cette page, en date du 18 mars 2013 à 10:51 et modifiée en dernier par Hexasoft (discuter | contributions) (documentation déplacée). Elle peut contenir des erreurs, des inexactitudes ou des contenus vandalisés non présents dans la version actuelle.
(diff) ← Version précédente | Version actuelle (diff) | Version suivante → (diff)

Ceci est la page de documentation de Module:Infobox [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.


Fonction exportée

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

Dépendances

mw.title ; mw.language ; mw.site


Détails et fonctions internes
  • erreur(texte)
    • description : retourne une mise en forme de texte sous forme d'erreur, dans un <span class="error"></span>
  • pagesincat(frame)
    • description : retourne le nombre de pages dans une catégorie
    • paramètres : tous 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 ; cats ; fichiers ; pages. Si non précisé tous 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 ?
 
Ce document provient de « https://fr.wikipedia.org/w/index.php?title=Module:Infobox/Documentation&oldid=90752957 ».