Extension: NiceCategoryList3

Manuel des extensions MediaWiki

NiceCategoryList3 État de la version : stable
Implémentation	Balise
Description	Affiche une liste de catégories bien formatée, avec une liste de sous-catégories polyvalente.
Auteur(s)	Kichik JohanTheGhost *Surak* Crafty Coding JLTRY
Dernière version	1.1.2 (2024-06-12)
MediaWiki	1.39.0+
PHP	7.3+
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	github release v1.1.2 GitHub: page du projet URL du dépôt git [aide ] historique des validations Note : Aucune mise à jour de localisation n'est fournie par translatewiki.net .
Exemple	see below
Paramètres $egNiceCategoryListDisableCache $egNiceCategoryListHeadStart $egNiceCategoryListInstallDir $egNiceCategoryListShowFirst
Balises ‎<ncl>

L'extension NiceCategoryList3 affiche une liste de catégories, y compris des sous-catégories, dans un certain nombre de formats utiles. Ceci est destiné à permettre une navigation plus facile d'un arbre de catégories d'un wiki. Il implemente une nouvelle balise, ‎<ncl>, qui génère une liste de toutes les pages et sous-catégories d'une catégorie donnée. La liste peut afficher plusieurs niveaux de sous-catégories et dispose de plusieurs options pour le style d'affichage.

Cette extension a été créée à l'origine par Kichik comme Extension:NiceCategoryList , a été améliorée par JohanTheGhost et *Surak* et Crafty Coding. Ceci a été mis à jour pour fonctionner pour la dernière version de MediaWiki par JLTRY.

Utilisation

Paramètres

L'étiquette ‎<ncl> affiche une liste de catégories:

<ncl [options]>Catégorie:Une catégorie</ncl>

L'étiquette prend les paramètres suivants, qui sont tous facultatifs:

Paramètre	Description	Valeur par défaut
maxdepth=<number>	profondeur maximale de la catégorie à afficher	32
headings=<style>	head pour afficher les titres de catégorie comme titres Wiki; bullet pour affiquer les titres des catégories comme bullet lists	head
showfirst=<bool>	0 pour sauter le titre supérieur, sinon l'afficher	0
headstart=<number>	avec headings=head, le headstart est le niveau de titre pour répertorier les catégories de niveau supérieur avec	2
style=<style>	bullet pour afficher le contenu des catégories sous forme de listes à puces ; compact pour une liste plus compacte	bullet
showcats=<bool>	pas 0 pour afficher des liens sous-catégories dans les catégories "bas" (c.-à-d. maximum de profondeur)	0
showarts=<bool>	pas 0 pour afficher les articles dans les catégories	1
sort=<bool>	pas 0 pour trier la liste par ordre alphabétique; sinon trier la liste selon la clé d'index	0
number=<number>	Pas 0 pour afficher seulement jusqu'au <nombre> d'articles, sinon afficher tous les articles	0
random=<bool>	avec 'number' différent de 0 : afficher un choix aléatoire d'articles si 'random' différent de 0, sinon afficher le premier nombre d'articles	0

Mise en forme CSS

La syntaxe wiki originale créée avec la version 2.2 a été essentiellement conservée, mais toute la mise en forme directe a été supprimée. Au lieu de cela, les éléments discrets sont inclus dans les balises ‎<div> et ‎<span> avec des noms de classe. L'avantage est que vous pouvez appliquer des styles aux éléments, soit dans Common.css, dans le CSS du skin courant ou dans votre CSS utilisateur.

<!-- Sample output for
     <ncl headings=head headstart=2 style=bullet>category</ncl>
-->
<div class="ncl-nicecategorylist>
  <div class="ncl-block ncl-block-head ncl-block-head-0">
    <h2 class="ncl-heading ncl-heading-0">
      Category Name
    </h2>
    <div class="ncl-content ncl-content-bullet ncl-content-bullet-0">
      <ul>
        <li><span class="ncl-subcategory">Subcategory Link</span></li>
        <li><span class="ncl-subcategory">Subcategory Link</span></li>
        <li> ‴ </li>
        <li><span class="ncl-article">Article Link</span></li>
        <li><span class="ncl-article">Article Link</span></li>
        <li> ‴ </li>
      </ul>
    </div>
  </div>
  ‴
</div>

<!-- Sample output for
     <ncl headings=bullet style=compact>category</ncl>
-->
<div class="ncl-nicecategorylist>
  <div class="ncl-block ncl-block-bullet ncl-block-bullet-0">
    <div class="ncl-heading ncl-heading-0">
      <ul><li>Category Link</li></ul>
    </div>
    <div class="ncl-content ncl-content-compact ncl-content-compact-0">
      <p>
        <span class="ncl-subcategory">Subcategory Link</span> •  
        <span class="ncl-subcategory">Subcategory Link</span> •  
        ‴  •
        <span class="ncl-article">Article Link</span> •
        <span class="ncl-article">Article Link</span> •
        ‴  •
        …
      </p>
    </div>
  </div>
  ‴
</div>

L'arbre de catégorie entier est maintenant encapsulé dans un conteneur ‎<div> avec un nom de classe ncl-nicecategorylist.

Chaque niveau de l'arborescence des catégories est encapsulé dans un conteneur div avec un nom de classe de ncl-block-{headings}-{x}. {headings} signifie l'une des options de headings, soit bullet ou head. {x} désigne une valeur numérique qui commence à zéro et est augmentée à chaque niveau subordonné de la liste de catégories, jusqu'à ce que maxdepth soit atteint.

À l'intérieur de ce contenant supérieur de ‎<div>, il existe deux blocs subordonnés pour l'en-tête et le contenu:

• L'en-tête est couvert par un bloc avec un nom de classe de ncl-heading-{x}. {x} désigne une valeur numérique qui commence à zéro et est augmentée à chaque niveau subordonné de la liste de catégories, jusqu'à ce que maxdepth soit atteint. Si l'option showfirst=0, alors la première en-tête n'est pas affichée. C'est le paramètre par défaut, puisque les versions précédentes de l'extension ne l'affichaient pas. La valeur par défaut peut être écrasée en utilisant $egNiceCategoryListShowFirst = 1; dans LocalSettings.php.
  • Si l'option heading=bullet, le bloc est un bloc ‎<div> affichant la catégorie sous forme de lien vers la page de catégorie sous forme d'élément de liste à puces.
  • Si l'option heading=head, le bloc est un bloc de titres habituel, commençant à <h{n}>. {n} désigne une valeur numérique qui commence à {headstart} et est augmentée à chaque niveau subordonné de la liste de catégories. La valeur par défaut est headstart=2. Elle peut être rétablie à la valeur par défaut des versions précédentes en utilisant $egNiceCategoryListHeadStart = 1; dans LocalSettings.php. Si vous souhaitez activer la première rubrique d'une certaine liste de catégories, vous pouvez utiliser l'option showfirst=1 (ou l'inactiver avec showfirst=0 autrement).

• L'en-tête est couvert par un bloc avec un nom de classe de ncl-content-{style}-{x}. {style} signifie l'une des options de style, soit bullet ou compact. {x} désigne une valeur numérique qui commence à zéro et est augmentée à chaque niveau subordonné de la liste de catégories, jusqu'à ce que maxdepth soit atteint. Il contient des conteneurs de ‎<span> avec les sous-catégories (si showcats=1) et les articles (si showarts=1) de la catégorie concernant.
  • Chaque sous-catégorie est incluse dans un conteneur ‎<span> avec un nom de classe de ncl-subcategory.
  • Chaque article est incluse dans un conteneur de ‎<span> avec un nom de classe de ncl-article.

En plus des classes mentionnées ci-dessus, certaines classes génériques sont définies pour appliquer des styles aux groupes d'éléments :

• ncl-block pour appliquer les styles à tous les éléments avec les noms de classe de ncl-block-bullet-{x} et ncl-block-head-{x}.
• ncl-block-bullet pour appliquer les styles à tous les éléments avec les noms de classe de ncl-block-bullet-{x}.
• ncl-block-head pour appliquer les styles à tous les éléments avec les noms de classe de ncl-block-head-{x}.
• ncl-heading pour appliquer les styles à tous les éléments avec les noms de classe de ncl-heading-{x}.
• ncl-content-compact pour appliquer les styles à tous les éléments avec les noms de classe de ncl-content-bullet-{x}.
• ncl-content-bullet to apply styles to all items with classnames of ncl-content-bullet-{x}.
• ncl-content-compact pour appliquer les styles à tous les éléments avec les noms de classe de ncl-content-compact-{x}.

Exemples

Pour une liste complète et récursive de toutes les catégories relevant d'une catégorie spécifiée, utilisez ceci: <ncl>Category:Some Category</ncl>
For a nice "high-level" category index, use this in a template: <ncl style=compact maxdepth=2 headings=bullet headstart=2 showcats=1 showarts=1>Category:{{PAGENAME}}</ncl> and include it in major category pages to provide a nice 2-level (or however many you like) index of the category.
This: <ncl style=compact headings=bullet headstart=2 showcats=1 showarts=0>Category:Categories</ncl> generates a full category listing, with indentation indicating category containment.

Attention : lorsqu'elle est utilisée dans un modèle, la liste des catégories ne s'actualisera pas immédiatement lors du rechargement ; modifiez et enregistrez l'article pour voir les mises à jour.

Installation

• Télécharger la dernière version depuis GitHub et placez le(s) fichier(s) dans un répertoire appelé NiceCategoryList3 dans votre dossier extensions/.
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'NiceCategoryList3' );
  

• Configurez à votre convenance.
• Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Configuration

Si vous souhaitez désactiver le cache pour les pages utilisant l'extension, utilisez:

$egNiceCategoryListDisableCache = true; // disables page caching

If you want to default the headstart option to something different than 2, use:

$egNiceCategoryListHeadstart = 1; // defaults headstart to 1

Si vous souhaitez que l'affichage du premier titre soit celui par défaut, utilisez :

$egNiceCategoryListShowFirst = 1; // displays first heading

Historique des versions

Version 1.1.1