Extension:CategoryTree/fr

Manuel des extensions MediaWiki - liste

CategoryTree État de la version : stable
Implémentation	Tag
Description	Génère l'arborescence dynamique d'une catégorie sur une page wiki.
Auteur(s)	Duesentrieb
MediaWiki	1.8 (r16385 ou plus), 1.11 (pour CT depuis r30515), 1.13 (pour CT depuis r36772)
Licence	GPL and GFDL
Téléchargement	Télécharger le snapshot (master Git) Git [?]: résumé base arborescence modifs de code README log
Paramètres $wgCategoryTreeMaxChildren, $wgCategoryTreeAllowTag, $wgCategoryTreeDynamicTag, $wgCategoryTreeDisableCache, $wgCategoryTreeHTTPCache, $wgCategoryTreeOmitNamespace, $wgCategoryTreeMaxDepth, $wgCategoryTreeDefaultMode, $wgCategoryTreeCategoryPageMode
Hooks utilisés SkinTemplateTabs OutputPageParserOutput ArticleFromTitle LanguageGetMagic ParserFirstCallInit

L'extension CategoryTree permet de générer l'arborescence dynamique d'une catégorie, intégrable dans une page wiki standard. Elle utilise AJAX pour dérouler une partie de l'arbre d'un simple clic. CategoryTree fut à l'origine écrite par Daniel Kinzler comme un outil extérieur (voir meta:User:Duesentrieb/CategoryTree) et fut plus tard intégré au logiciel MediaWiki avec l'aide de Tim Starling.

Usage

CategoryTree peut s'utiliser de trois manières:

• directement dans une page de catégorie,
• comme un "custom tag" (ou une "parser function") pour afficher une structure de catégorie au sein d'une page wiki standard,
• et comme une page spéciale.

L'extension CategoryTree ajoute des noeuds [+] aux sous-catégories listées sur les pages catégorie. Si Javascript est désactivé, ces noeuds mènent vers la page de la sous-catégorie (dans les versions précédente, il ne se passait rien dans ce cas).

Le tag <categorytree>

Example:

<categorytree mode=pages>Manual</categorytree>

[−] Manual

[+] Authentication and login

[+] Customization techniques

[+] Data exchange with other systems

[+] Extensions

[+] Installation

[+] Localisation

[+] Localisation/fr

[+] MediaWiki administration

[+] MediaWiki administration/da

[+] MediaWiki components

[+] MediaWiki configuration

[+] MediaWiki for site admins

[+] MediaWiki technical documentation

[+] Personalization

[+] Sitemap

[+] Tools

[+] Tutorials

[+] User interface

[+] Wiki markup

[+] Wiki page URLs

  Manual:Contents

  Manual:Contents/To do

  Project:Manual

  Manual:Account creation

  Manual:External editors: control files

  Manual:FAQ

  Manual:Hashing

  Manual:IP ranges

  Manual:Linked images

  API:Main page

  Manual:Main Page

  Manual:Moving a page

  Manual:Page title

  Manual:Redirects

  Manual talk:Setting user groups in MediaWiki

  Manual:Tools

  Wikimedia technical search

Le tag spécial est appelé <categorytree>. Par exemple, si vous écrivez <categorytree>Foo</categorytree> sur une page wiki, cela va donner le contenu de la catégorie Foo sous forme d'arborescence dynamique sur cette page. (voir exemple à droite). Le tag accepte les attributs suivants, utilisant une syntaxe de type HTML:

mode

détermine quelles pages apparaissent dans l'arborescence. Cet attribut peut être supplanté par l'utilisation de l'option namespaces. Valeurs possibles:

categories

affiche seulement les sous-catégories (configuration constant CT_MODE_CATEGORIES)

pages

affiche les sous-catégories et les pages, à l'exception des images (configuration constant CT_MODE_PAGES)

all

affiche toutes les pages, sous-catégories, images, etc (configuration constant CT_MODE_ALL)

parents

liste les catégories parentes à la place des sous-catégories CT_MODE_PARENTS). Cela bascule CategoryTree dans l'opération "inverse" (supporté depuis rev:36892, Juillet 2008).

depth

détermine combien de niveaux de l'arborescence sont déroulés. La valeur par défaut est 1, 0 signifie l'affichage de la catégorie racine uniquement. La valeur maximum dépend du mode spécifié, et de l'option $wgCategoryTreeMaxDepth. (introduit entre rev:r20410 et rev:20840, Mars 30 2007; totalement fonctionnel même avec $wgCategoryTreeDynamicTag depuis rev:36864, Juillet 2008)

onlyroot

mettre cette option sur "on" pour afficher seulement la catégorie "racine". Équivaut à depth="0". (introduit dans rev:20385, Mars 13 2007) Déprécié depuis rev:36864, Juillet 2008: utiliser depth="0" à la place.

hideroot

mettre ceci à "on" pour cacher la catégorie "racine" de l'arborescence, c.à.d hideroot="on". Dans l'exemple, cela n'affichera pas la catégorie Foo.

hideprefix

détermine quand le préfixe de l'espace de nom doit être caché des entrées de l'arborescence (depuis rev:36864, Juillet 2008). Les valeurs possibles sont :

always

toujours cacher le préfixe. Ne devrait être utilisé que si toutes les pages appartiennent au même espace de nom (configuration constant CT_MODE_CT_HIDEPREFIX_ALWAYS).

never

ne jamais cacher le préfixe, t compris pour les catégories (configuration constant CT_MODE_CT_HIDEPREFIX_NEVER).

auto

cacher le préfixe des catégories, si seules des catégories sont affichées, comme avec mode="categories" (configuration constant CT_MODE_CT_HIDEPREFIX_AUTO); Cela est équivalent à l'ancienne configuration par défaut (avant Juin 2008).

categories

toujours cacher le préfixe des catégories, mais afficher tous les autres préfixes (configuration constant CT_MODE_CT_HIDEPREFIX_CATEGORIES). Cela est la nouvelle configuration par défaut (depuis rev:36864, Juillet 2008).

showcount

afficher le nombre d'entrées des sous-catégories (depuis rev:36864, Juillet 2008). Cette option est désactivée par défaut dans les arborescence insérées dans les pages normales, mais activé par défaut dans les pages de catégorie et dans Special:CategoryTree.

namespaces

liste de nom d'espace dont les pages doivent être affichées dans l'arborescence (depuis rev:36864, Juillet 2008). Les entrées de la liste doivent être des noms d'espaces de noms séparés par des espaces. L'espace de nom principal peut être représenter par "-" ou "0". Cette option suplante l'option mode.

class, style, id, etc

Le tag <categorytree> supporte toutes sortes d'attributs HTML standards pour ses différents éléments (depuis rev:36864, Juillet 2008. Avant cela, seul l'attribut style était supporté).

La parser function {{#categorytree}}

Depuis rev:25825 (2007-9-13), Il est possible d'utiliser une syntaxe parser function pour placer une arborescence de catégorie dans une page. Cela fonctionne exactement comme le tag <categorytree> en utilisant une syntaxe différente, par exemple {{#categorytree:Foo}}; les options peuvent être spécifiées en utilisant la syntaxe des paramètres nommés de modèles, par exemple {{#categorytree:Foo|hideroot|mode=pages}}.

Utiliser la syntaxe parser function a l'avantage de permettre l'utilisation de mots magiques, de modèles et de paramètres de modèles pour spécifier la catégorie à afficher.

Quelques exemples 

• Utiliser un mot magique pour afficher l'arborescence de "cette page" (peut être utile sur les page de description de catégorie) : {{#categorytree:{{PAGENAME}}}}.
• Utiliser un modèle pour spécifier la catégorie : {{#categorytree:{{catégorie racine}}}} - le nom de la catégorie racine de l'arborescence sera définie par le contenu de la page Modèle:Catégorie_racine.
• Utiliser un paramètre pour spécifier la catégorie, lorsque CategoryTree est utilisé dans un modèle : {{#categorytree:{{{1}}}}} étant le contenu de Modèle:Baz, l'arborescence de la catégorie Foo peut être appelé en utilisant la syntaxe {{Baz|Foo}}

La page Special:CategoryTree

La page spéciale s'appelle Spécial:CategoryTree; Il suffit d'entrer le nom de la catégorie souhaitée et de naviguer ensuite dans son contenu.

Installer CategoryTree

Note: La dernière version de l'extension CategoryTree nécessite MediaWiki 1.13. La première version requiert MediaWiki 1.8 (revision 16385 ou suivantes).

Télécharger les fichiers et les copier dans le répertoire extensions de l'installation MediaWiki. Ajouter ensuite les lignes suivantes au fichier LocalSettings.php (près de la fin):

$wgUseAjax = true;
require_once("{$IP}/extensions/CategoryTree/CategoryTree.php");

Noter que $wgUseAjax = true va autoriser l'utilisation d'ajax dans MediaWiki, ce qui est requis par l'extension CategoryTree. AJAX est un terme désignant l'utilisation de JavaScript pour charger des parties de pages sur demande. Cela est supporté par tous les naviguateurs web récents.

Configuration

Des options peuvent être spécifiées dans le fichier LocalSettings.php:

Cet article ou cette section nécessitent d'être traduits depuis l'article Extension:CategoryTree. Si vous connaissez bien l'anglais, n'hésitez pas ! Merci pour MediaWiki.

$wgCategoryTreeMaxChildren

nombre maximum de branches dans un noeud de l'arborescence. 200 par défaut.

$wgCategoryTreeAllowTag

active le tag <categorytree>. true par défaut.

$wgCategoryTreeDynamicTag

loads the first level of the tree in a <categorytree> dynamically. This way, the cache does not need to be disabled. Default is false.

$wgCategoryTreeDisableCache

disables the parser cache for pages with a <categorytree> tag. Default is true.

$wgCategoryTreeHTTPCache

enable HTTP cache for anon users. Default is false.

$wgCategoryTreeOmitNamespace

do not show the namespace name for pages and categories. Default is false, namespaces are shown unless showing categories only. Deprecated as of rev:36864, July 2008: use $wgCategoryTreeDefaultOptions['hideprefix'] instead.

$wgCategoryTreeMaxDepth

an array defining the maximum depth for each mode, to which the tree may be expanded initially using the depth parameter in a <category> tag. Per default, this is set to 2 for the "categories" mode, and 1 for other modes. To set it to 3 for categories and 2 for other modes, for example, you can use $wgCategoryTreeMaxDepth = array(CT_MODE_PAGES => 2, CT_MODE_ALL => 2, CT_MODE_CATEGORIES => 3);.

$wgCategoryTreeDefaultMode

the default mode to use when no mode attribute is specified in a <categorytree> tag. May be CT_MODE_CATEGORIES (the default), CT_MODE_PAGES, or CT_MODE_ALL.

$wgCategoryTreeCategoryPageMode

the mode to use when rendering trees on category pages. Deprecated as of rev:36864, July 2008: use $wgCategoryTreeCategoryPageOptions['mode'] instead.

$wgCategoryTreeForceHeaders

if true, forces the scripts needed by CategoryTree on every page, instead of on-demand. This may be needed if a CategoryTree is embedded in an unusual way, for example in a custom skin or in a system message (since rev:36888, July 2008).

$wgCategoryTreeSidebarRoot

root category to use for integrating the category tree in the sidebar (since rev:36920, July 2008). If not set, no tree is integrated (this is the default). Integrating a CategoryTree into the sidebar only works with skins based upon SkinTemplate, that is, Modern, Monobook, Chick, Simple, and MySkin, but not Standard, Nostalgia or CologneBlue.

$wgCategoryTreeDefaultOptions

default options to apply, as an array (since rev:36864, July 2008). The available options are described above. Example: $wgCategoryTreeDefaultOptions['mode'] = 'pages';

$wgCategoryTreeCategoryPageOptions

options to use on category pages, as an array (since rev:36864, July 2008).

$wgCategoryTreeSpecialPageOptions

options to use on Special:CategoryTree, as an array (since rev:36864, July 2008).

$wgCategoryTreeSidebarOptions

options to use when showing the tree in the sidebar, as an array (since rev:36920, July 2008).

System messages

categorytree-member-num

By default, when listing subcategories on a category page, each subcategory is followed by an integer, indicating how many subcategories lie beneath it:

My category name (5)

You can change this behavior by overriding the system message MediaWiki:categorytree-member-num. It takes five parameters:

Parameter	Meaning
$1	Number of subcategories
$2	Number of articles (not including category pages or file pages)
$3	Number of uploaded files
$4	Total number of member pages, including category pages and and file pages
$5	(Varies depending on CategoryTree mode.... Can someone describe it?)

The default value is ($5).

Tip: Use the ParserFunctions extension to provide if/then/else logic to display different parts conditionally. For example:

{{#ifeq:$1|0||$1 categories}}

Troubleshooting

Wiki is broken after installing CategoryTree

• Turn on error reporting
• Make sure you have all files installed
• Make sure all of the CategoryTree extension files have mode 644, and the CategoryTree directory has mode 755.

Options in LocalSettings.php have no effect

• Make sure you specify the options after including the extension.

Clicking the [+] has no effect, gives a JavaScript error or just sits on loading

• Note that using the <categorytree> tag in system messages (MediaWiki-Namespace) may not work as expected - this is a known caveat. For a workaround, see #Using CategoryTree in the Sidebar below.
• Make sure you have $wgUseAjax = true; in your LocalSettings.php before including the extension.
• Make sure you are using the latest version of the extension - the bleeding edge is at [1]
• If you are using rewrite rules or aliasing (e.g. to have "very short URLs" - i.e. wiki pages in the document root), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory. Also see below.

Browser reports a bad MIME type for CategoryTree.js and/or CategoryTree.css

• Make sure your Webserver uses the correct mime types for .js and .css files
• Enter the URLs directly into the browser and see if it is serving the pages at all, and not some error page; especially:
• If you are using rewrite rules or aliasing (e.g. to have "very short URLs" - i.e. wiki pages in the document root), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory.

Member counts are wrong, [x] is shown instead of [+]

Since MediaWiki 1.13, CategoryTree can show the number of members of a category, and can show an [x] for tree nodes that do not have any children based on that number. This information is based on the new category table. However, populating that table with the current values does not always work when upgrading to 1.13. In that case, run the populateCategory.php maintenance script, if neccessary with the --force option.

See also

Related problems and solutions on Bugzilla

Note to bot users

Bots and scripts that parse the HTML of category pages can use the notree URL parameter to force the traditional output. However, HTML output is generally not stable, so it is recommended to change your script to use the api.php to fetch category listings and similar.

Hacks

Using CategoryTree in system messages and custom skins

To use the CategoryTree in system messages or the sidebar, that is, to use it as part of the user interface instead of page content, you have to set wgCategoryTreeForceHeaders to true, so that the support scripts are linked on every page (normally, they are only linked "on demand", but that detection does not work for system messages). This works since rev:36888 (July 2008). If you try this without forcing the scripts to be included, you will find that Clicking the [+] has no effect / gives JavaScript error.

In older versions of CategoryTree, you have to modify the code to make this work: find the efCategoryTreeParserOutput function in the file CategoryTree.php, and remove the condition; i.e. it should then look like this:

function efCategoryTreeParserOutput( &$outputPage, &$parserOutput )  {
    CategoryTree::setHeaders( $outputPage );
    return true;
}

Using CategoryTree in the Sidebar

Since rev:36920 (July 2008) with MediaWiki 1.13 (rev:36917), you can integrate a CategoryTree in the sidebar simply by setting $wgCategoryTreeSidebarRoot to the category you want to use as a root. This only works with skins based upon SkinTemplate however, that is, Modern, Monobook, Chick, Simple, and MySkin, but not Standard, Nostalgia or CologneBlue.

If you use $wgHooks['MonoBookTemplateToolboxEnd'][] = 'wfSomeFunc'; in LocalSettings.php to drop your own wikitext article into the Sidebar, and then add CategoryTree items to it, you'll need to set $wgCategoryTreeForceHeaders = true; to ensure that every page works.

For earlier versions of CategoryTree and/or MediaWiki, you'll need to install a mod to MonoBook.php to enable normal wikitext in the sidebar, see Wikitext in side bar --DJ 19:26, 24 January 2008 (UTC)

To append a link "CategoryTree" to your toolbox (sidebar) add following code to the javascript-page (e.g. monobook.js) of your skin and customize the URL "w:en:Special:CategoryTree".

function AppendCategoryTreeToSidebar() {
    try {
        var node = document.getElementById( "p-tb" )
                           .getElementsByTagName('div')[0]
                           .getElementsByTagName('ul')[0];
 
        var aNode = document.createElement( 'a' );
        var liNode = document.createElement( 'li' );
 
        aNode.appendChild( document.createTextNode( 'CategoryTree' ) );
        aNode.setAttribute( 'href' , '[[w:en:Special:CategoryTree]]' );
        liNode.appendChild( aNode );
        liNode.className = 'plainlinks';
        node.appendChild( liNode );
    } catch(e) {
        // lets just ignore what's happened
        return;
    }
}
 
addOnloadHook( AppendCategoryTreeToSidebar );

A more generic version of this code can be found at Manual:Interface/Sidebar#content of sidebar and toolbox (javascript).

Weblinks

• README file
• SVN extensions module
• download area with bundled version (alternative bundle). (NOTE: the bundled versions may not be up to date!)
• Bug Search