État de la version : stable | |
|---|---|
| Implémentation | Balise,Fonction d'analyseur,Page spéciale |
| Description | Génère l'arborescence dynamique d'une catégorie sur une page wiki. |
| Auteur(s) | Daniel Kinzler (Duesentriebdiscussion) |
| Dernière version | mises à jour continues |
| Politique de compatibilité | Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière. |
| MediaWiki | 1.25+ |
| Licence | Licence publique générale GNU v2.0 ou supérieur |
| Téléchargement | README |
| |
| Traduire l’extension CategoryTree sur translatewiki.net si elle y est disponible | |
| Problèmes | Tâches ouvertes ·Signaler un bogue |
L'extensionCategoryTree fournit une vue dynamique sous forme d'arborescence de la structure des catégories du wiki. Elle utiliseAJAX pour charger les parties de l'arbre à la demande. CategoryTree fut à l'origine écrite par Daniel Kinzler comme un outil externe et fut plus tard intégrée au logiciel MediaWiki avec l'aide de Tim Starling.
CategoryTree dans votre dossierextensions/.cdextensions/gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTreewfLoadExtension('CategoryTree');
CategoryTree peut s'utiliser de trois manières :
L'extension CategoryTree ajoute des widgets d'expansion► aux sous-catégories listées sur les pages de catégorie.
Exemple. Voyez le résultat dans la boîte ci-dessous et sur la droite :
<categorytreemode="pages">Manual</categorytree>
La balise personnalisée est appelée<categorytree>.Par exemple, si vous écrivez <categorytree>Foo</categorytree> sur une page wiki, cela va afficher le contenu de la catégorieFoo sous forme d'arborescence dynamique sur cette page (voir l'exemple à droite).La balise accepte les attributs suivants, en utilisant une syntaxe de type HTML :
namespaces. Valeurs possibles:0)10), limité à 200 pages20)100). Cela bascule CategoryTree dans l'opération "inverse" (pris en charge depuis lar36892, juillet 2008).$wgCategoryTreeDynamicTag depuisr36864, juillet 2008).depth="0"(introduit dansr20385, 13 mars 2007)depth="0".hideroot=on. Par exemple, cela n'affichera pas le nom de catégorieFoo.10).0).mode="categories" (constante de configuration30). Cela est équivalent à l'ancien comportement par défaut (avant juin 2008).20). C'est le nouveau comportement par défaut (depuis larev:36864, juillet 2008).showcount="on", on affiche le nombre d'entrées dans les sous-catégories (depuisr36864, juillet 2008). Cette option est désactivée par défaut dans les arborescences des catégories en ligne dans les pages, mais activée par défaut dans les listings des catégories et dans Special:CategoryTree.notranslations="on" (depuisGerrit change 526234, novembre 2019). Ceci est désactivé par défaut. Lorsque cette option vaut "on", au lieu d'afficher les différentes traductions (par exemple : Page, Page/en, Page/fr, Page/de), seule la traduction standard "Page" est affichée et toutes ses traductions sont supprimées.<categorytree> prend en charge tous les attributs HTML standards pour les éléments de bloc (depuisr36864, juillet 2008. Avant cela, seul l'attributstyle était supporté).Category est un espace de noms.Les catégories sont affichées dans tous les modes par défaut, mais en spécifiant le paramètrenamespaces vous les masquez tout comme n'importe quelle autre espace de noms absent de la liste.Si vous voulez lister les pages d'un espace de noms particulier, y compris les pages des sous-catégories, ajoutez simplement Category à la liste des espaces de noms.
Exemple :
<categorytreemode="pages"namespaces="Main">Manual</categorytree>
<categorytreemode="pages"namespaces="Main Category">Manual</categorytree>
Le paramètremode est écrasé parnamespaces :
mode=categories ;mode=all ;mode=pages sera utilisé. Cela signifie que si la configuration du site n'a pas été modifiée, les éléments suivants sont équivalents (les deux premiers sont toujours équivalents, le troisième uniquement si$wgCategoryTreeDefaultMode est leCategoryTreeMode::CATEGORIES par défaut) :<categorytreemode="categories">Manual</categorytree><categorytreenamespaces="Category">Manual</categorytree><categorytree>Manual</categorytree>
Depuis lar25825 (13/9/2007), il est possible d'utiliser lasyntaxe de la fonction analyseur pour placer une arborescence de catégorie sur une page. Cela fonctionne exactement comme la balise <categorytree> avec une syntaxe différente, par exemple{{#categorytree:Foo}}; les options peuvent être spécifiées en utilisant la syntaxe des paramètres nommés des modèles, par exemple{{#categorytree:Foo|hideroot|mode=pages}}.
Utiliser la syntaxe de la fonction d'analyse a l'avantage de permettre l'utilisation des mots magiques, de modèles et des paramètres de modèles pour spécifier la catégorie à afficher. Quelques exemples :
{{#categorytree:{{PAGENAME}}}}.{{#categorytree:{{root category}}}} - le nom de la catégorie racine de l'arborescence sera défini par le contenu de la page Template:Root_category.{{#categorytree:{{{1}}}}} dans Template:Baz peut être appelé en utilisant la syntaxe {{Baz|Foo}}La page spéciale s'appelle Special:CategoryTree; là vous pouvez entrer le nom d'une catégorie puis parcourir son contenu.
Certaines options peuvent être spécifiées dans le fichierLocalSettings.php :
0 pour le mode de catégorie,10 pour les pages,20 pour tout,100 pour les parents.true par défaut.false par défaut.21600 par défaut, soit 6 heures.false par défaut.false par défaut, les espaces de noms sont affichés sauf s'ils représentent seulement des catégories.$wgCategoryTreeDefaultOptions['hideprefix'].$wgCategoryTreeMaxDepth=[10=>2,20=>2,0=>3,100=>2];.0 (catégories par défaut),10 (pages), ou20 (tout).$wgCategoryTreeCategoryPageOptions['mode'] .$wgCategoryTreeDefaultOptions['mode']='pages';.Par défaut, lorsque vous affichez des sous-catégories sur une page de catégorie, chaque sous-catégorie est suivie d'un nombre entier qui représente la nombre de sous-catégories sous-elle, combien de pages elle contient, et combien de fichiers se trouvent dans la catégorie (s'il y en existe) :
Vous pouvez modifier ce comportement en réécrivant le message systèmeMediaWiki:Categorytree-member-num. Il a cinq paramètres :
| Paramètre | Signification |
|---|---|
| $1 | Nombre de sous-catégories |
| $2 | Nombre d'articles (sans les pages de catégories ni les pages de fichiers) |
| $3 | Nombre de fichiers téléversés |
| $4 | Nombre total de pages membre, y compris les pages de catégorie et les pages de fichiers |
| $5 | Quelque chose comme ($1 C, $2 P, $3 F) sauf pour les éléments où le zéro est omis. Plus précisément, une liste séparée par des virgules du nombre de pages (mediawiki:categorytree-num-pages), sous-catégories (mediawiki:categorytree-num-categories) et fichiers (mediawiki:categorytree-num-files) dans la catégorie, ou vide (mediawiki:categorytree-num-empty) dans le cas où la catégorie n'a pas de membres. Dans les versions antérieures à celles autour de 1.19 cette valeur était différente. Voirancienne version de ces documents. |
La valeur par défaut est($5).
Conseil: utilisez l'extensionParserFunctions pour fournir la logique if/then/else pour l'affichage conditionnel des différentes parties. Par exemple :
{{#ifeq:$1|0||$1 categories}}Une configuration pour gérer les virgules et les espaces lors de la sortie de toutes les informations :
versionabbrégée :
({{#ifeq:$4|0|empty|{{#ifeq:$1|0||$1 C{{#ifeq:{{#expr:$3+$2}}|0||,}}}} {{#ifeq:$2|0||$2 P{{#ifeq:$3|0||,}}}} {{#ifeq:$3|0||$3 F}}}})versionnom complet :
({{#ifeq:$4|0|empty|{{#ifeq:$1|0||$1 categories{{#ifeq:{{#expr:$3+$2}}|0||,}}}} {{#ifeq:$2|0||$2 pages{{#ifeq:$3|0||,}}}} {{#ifeq:$3|0||$3 files}}}})<spancolor:#0645AD;">►_has_no_effect,_gives_a_JavaScript_error_or_just_sits_on_loading">
$wgUseAjax=true; dans votre LocalSettings.phpavant d'inclure l'extension.<spancolor:#0645AD;">►_shows_no_sub-categories_error">
$wgCategoryTreeDefaultOptions['namespaces']=[0,NS_CATEGORY,NS_FILE];<spancolor: #c0c0c0">►_are_shown_instead_of_►">
Depuis MediaWiki 1.13, CategoryTree peut afficher le nombre des membres d'une catégorie, et peut afficher une flèche grise► pour les noeuds de l'arborescence qui n'ont aucun enfant en fonction de ce nombre. Cette information s'appuie sur la nouvelle tablecategory. Néanmoins, remplir cette table avec les valeurs actuelles ne fonctionne pas toujours quand vous passez à la version 1.13. Dans ce cas, exécutez le script de maintenancepopulateCategory.php , si nécessaire avec l'option--force.
<spancolor:#C0C0C0;">►►▼_toggles_shown_only_on_the_first_level_of_the_category_tree_view">
Dans le cas où vous n'obtenez qu'un niveau de profondeur lorsque vous visualisez l'arborescence, essayez de mettre dans le fichier modules/ext.categoryTree.styles.css la ligne suivantedisplay:none; àdisplay:inline!important;.
JavaScript essaie d'interpréter les types des balises en quelque chose de faux.
Les robots et les scripts qui scrutent le HTML des pages de catégorie peuvent utiliser le paramètrenotree dans l'URL pour forcer la sortie tradidionnelle. Néanmoins, le HTML produit n'est généralement pas stable, il est donc recommandé de modifier votre script et d'utiliser l'API pour récupérer les listings des catégories et similaires.
Après que vous ayez implémenté le plugin de CategoryTree et ajouté le code pour afficher l'arborescence, si vous voyez un message disantCategory Not Found (catégorie non trouvée), c'est que vous devez ajouter du contenu à vos pages de catégorie. Ces pages ne peuvent pas être principalement des pages rouges. Cliquez sur les noms de vos catégories, ajouter quelques textes dans les pages des catégories, et votre arbre devrait bien s'afficher.
Assurez-vous que la bonne version de cette extension est installée, en fonction de la version du MediaWiki que vous avez. En particulier, les versions de cette extension faites pour les versions de MediaWiki avant la 1.17 ne sont pas compatibles avec MediaWiki 1.17 et les suivants, et va créer des problèmes où tous les liens des pages vers les pages des catégories seront cassés.
Voirci-dessus.
Dans les versions plus anciennes de CategoryTree, vous devez modifier le code pour que cela fonctionne : trouvez la fonctionefCategoryTreeParserOutput dans le fichier CategoryTree.php, et supprimez la condition; par exemple cela pourrait ensuite ressembler à ceci :
functionefCategoryTreeParserOutput(&$outputPage,&$parserOutput){CategoryTree::setHeaders($outputPage);returntrue;}
Depuis lar36920 (juillet 2008) avec MediaWiki 1.13 (r36917), vous pouvez intégrer un CategoryTree dans la barre latérale simplement en initialisant$wgCategoryTreeSidebarRoot à la catégorie que vous voulez utiliser à la racine. Ceci ne fonctionne qu'avec les habillages basés sur SkinTemplate, c'est à dire les habillages Modern, Monobook, Chick, Simple, et MySkin, mais pas les Standard, Nostalgia ni CologneBlue.
Si vous voulez mettre CategoryTree ailleurs dans la barre latérale, vous pouvez la référencer surMediaWiki:Sidebar en tant que « categorytree-portlet » .
Pour les versions plus anciennes de CategoryTree et/ou de MediaWiki, vous devez installer une modification sur MonoBook.php pour activer le wikicode normal dans la barre latérale, voirWikicode de la barre latérale --DJ 19:26, 24 January 2008 (UTC)
Pour ajouter un lien « CategoryTree » à la (barre latérale) de votre boîte à outils ajoutez le code suivant à la page javascript (par exemplemonobook.js) de votrehabillage et personnalisez l'URL «w:Special:CategoryTree» .
functionAppendCategoryTreeToSidebar(){try{varnode=document.getElementById("p-tb").getElementsByTagName('div')[0].getElementsByTagName('ul')[0];varaNode=document.createElement('a');varliNode=document.createElement('li');aNode.appendChild(document.createTextNode('CategoryTree'));aNode.setAttribute('href','[[w:Special:CategoryTree]]');liNode.appendChild(aNode);liNode.className='plainlinks';node.appendChild(liNode);}catch(e){// lets just ignore what's happenedreturn;}}addOnloadHook(AppendCategoryTreeToSidebar);
Une version plus générique de ce code se trouve surManual:Interface/Sidebar#content of sidebar and toolbox (javascript).
Pas à pas si tout se passe bien :
$wgCategoryTreeSidebarRoot='Category:article_name';
Si vous voulez créer un lien vers le Categorytree générique (affiché commearborescence des catégories) lorsque vous n'êtes pas sur une page de catégorie, et vers une Categorytree particulière (affichée commevue de l'arborescence des catégories, avec foo étant le nom de la catégorie que vous visualisez) lorsque vous êtes sur une page de catégorie :
** sidebarcategorytree-url|sidebarcategorytree{{#ifeq: {{NAMESPACE}}|Category|View as category tree|Category tree}}{{#ifeq: {{NAMESPACE}}|Category|Special:CategoryTree/{{BASEPAGENAME}}|Special:CategoryTree/Categories}}| Cette extension est utilisée par au moins un desprojets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans leCommonSettings.php de Wikimédia et dans le fichier de configurationInitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la pageSpecial:Version de ce wiki. |
| Cette extension est incluse dans les fermes de wikis ou les hôtes suivants et / ou les paquets : |