Extension:CategoryTree - MediaWiki

Extension:CategoryTree - MediaWiki
Jump to content
From mediawiki.org
Translate this page
Languages:
Bahasa Indonesia
Türkçe
català
italiano
magyar
polski
português
português do Brasil
čeština
русский
العربية
中文
MediaWiki extensions manual
CategoryTree
Release status:
stable
Implementation
Tag
Parser function
Special page
Description
Provides a dynamic view of the wiki's category structure as a tree.
Author(s)
Daniel Kinzler (
Duesentrieb
talk
Latest version
continuous updates
Compatibility policy
Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki
1.25+
Parameters
$wgCategoryTreeAllowTag
$wgCategoryTreeCategoryPageOptions
$wgCategoryTreePageCategoryOptions
$wgCategoryTreeMaxDepth
$wgCategoryTreeSidebarOptions
$wgCategoryTreeDefaultOptions
$wgCategoryTreeMaxChildren
$wgCategoryTreeSpecialPageOptions
$wgCategoryTreeOmitNamespace
$wgCategoryTreeSidebarRoot
$wgCategoryTreeUseCategoryTable
$wgCategoryTreeCategoryPageMode
$wgCategoryTreeDefaultMode
$wgCategoryTreeDisableCache
$wgCategoryTreeHijackPageCategories
Hooks used
CategoryViewer::doCategoryQuery
CategoryViewer::generateLink
MediaWikiServices
OutputPageRenderCategoryLink
ParserFirstCallInit
SkinAfterPortlet
SkinBuildSidebar
SpecialTrackingCategories::generateCatLink
SpecialTrackingCategories::preprocess
Licence
GNU General Public License 2.0 or later
Download extension
Git
Browse repository
GitHub
Gerrit code review
Git commit log
Download source tarball
README
Translate the CategoryTree extension
if it is available at translatewiki.net
Issues
Open tasks
Report a bug
The
CategoryTree
extension provides a dynamic view of the wiki's category structure as a tree.
It uses
AJAX
to load parts of the tree on demand.
CategoryTree was originally written by Daniel Kinzler as an external tool, but was later integrated into the MediaWiki software with the help of Tim Starling.
Installation
This extension
comes with MediaWiki 1.31
and later, so you do not need to download it. The remaining configuration instructions must still be followed.
and move the extracted
CategoryTree
folder to your
extensions/
directory.
Developers and code contributors should install the extension
from Git
instead, using:
cd
extensions/
git
clone
Add the following code at the bottom of your
LocalSettings.php
file:
wfLoadExtension
'CategoryTree'
);
Done
– Navigate to
Special:Version
on your wiki to verify that the extension is successfully installed.
Usage
CategoryTree can be used in three ways:
directly on the category pages,
as a "custom tag" (or "parser function") to show a category structure in-line on a wiki page,
and as a special page.
The CategoryTree extension adds
"expand" widgets to the subcategories listed on category pages.
The tag
Example. The result can be seen in the box below and on the right:
categorytree
mode
"pages"
Manual
categorytree
The custom tag is called
‎<
categorytree
For example, if you put Foo on a wiki page, it will show the contents of category Foo as a dynamic tree on that page (see example to the right).
The tag accepts the following attributes, using a HTML-like syntax:
mode
determines which pages are shown in the tree. This may be overridden by the use of the
namespaces
option. Possible values:
categories
show subcategories only (configuration constant
pages
show subcategories and pages, except images (configuration constant
10
), limited to 200 pages
all
show all pages, subcategories, images, etc. (configuration constant
20
parents
list parent categories instead of subcategories (configuration constant
100
). This puts CategoryTree into "inverse" operation (supported since
r36892
, July 2008).
depth
determines how many levels of the tree are shown initially. Default is 1. 0 means only the root node. The maximum value depends on the mode specified, and on the
$wgCategoryTreeMaxDepth
option. (Introduced between
r20410
and
r20840
, Mar 30 2007; fully functional even with
$wgCategoryTreeDynamicTag
since
r36864
, July 2008.)
onlyroot
set this to "on" to only show the "root" node of the tree initially. Equivalent to
depth="0"
(Introduced in
r20385
, March 13 2007.)
Deprecated as of
r36864
, July 2008: use
depth="0"
instead.
hideroot
set this to "on" to hide the "root" node of the tree, i.e.
hideroot=on
. For example, it will not display the category name Foo.
hideprefix
determines when the namespace prefix should be hidden from entries in the tree (since
r36864
, July 2008). Possible values are:
always
always hide the prefix. Should be used only if all pages come from the same namespace (configuration constant
10
).
never
never hide the namespace prefix, not even for categories (configuration constant
).
auto
hide the namespace of categories if only categories are shown, as with
mode="categories"
(configuration constant
30
). This is equivalent to the old default behavior (before Jun 2008).
categories
always hide the namespace of categories, but show all other prefixes (configuration constant
20
). This is the new default behavior (since
r36864
, July 2008).
showcount
set this to "on" to show the number of entries in subcategories, i.e.
showcount="on"
(since
r36864
, July 2008). This is disabled per default for category trees inlined on pages, but enabled per default in category listings and on Special:CategoryTree.
notranslations
set this to "on" to hide all translations pages corresponding to the pages pertaining to the category, i.e.
notranslations="on"
(since
Gerrit change 526234
, November 2019). This is disabled by default. If this option is set to "on", instead of the different translations (e.g. Page, Page/en, Page/fr, Page/de) only the standard translation "Page" is displayed and all translations are suppressed.
This doesn't affect "showcount", so still a bug.
namespaces
a list of namespaces from which pages should be shown in the tree (since
r36864
, July 2008). The entries in the list must be namespace names, separated by spaces. The main namespace can be represented by "-" or "0". Subcategories will be shown only if Category namespace is present on the list.
class, style, id,
etc
The
‎<
categorytree
tag supports all standard HTML attributes for block elements (since
r36864
, July 2008; before that, only
style
was supported).
Notes on the 'namespaces' parameter
Category is a namespace.
Categories are shown in all modes by default, but specifying the
namespaces
parameter hides them just like any other namespace not present on the list.
If you want to list pages in a given namespace, including pages in subcategories, simply add Category to the namespace list.
Example:
Listing main namespace pages in Category:Manual:
Manual
API
GDPR (General Data Protection Regulation) and MediaWiki software
README
Wikimedia technical search
categorytree
mode
"pages"
namespaces
"Main"
Manual
categorytree
Listing main namespace pages
and
subcategories in Category:Manual:
Manual
Authentication and login
Customization techniques
Data exchange with other systems
Entry point URLs
Extensions
Installation
Localisation
MediaWiki administration
MediaWiki components
MediaWiki concepts
MediaWiki configuration
MediaWiki technical documentation
Parser manuals
Personalization
Tools
Tutorials
User interface
User Manual
Wiki markup
API
GDPR (General Data Protection Regulation) and MediaWiki software
README
Wikimedia technical search
categorytree
mode
"pages"
namespaces
"Main Category"
Manual
categorytree
The
mode
parameter is overridden by
namespaces
if only Category namespace is asked, it's equivalent to
mode=categories
if file namespace is present on the list, it will imply
mode=all
otherwise
mode=pages
will be used. It means that if the site configuration hasn't been changed, the following are equivalent (the first two are always equivalent, the third only if
$wgCategoryTreeDefaultMode
is the default
CategoryTreeMode
::
CATEGORIES
):
categorytree
mode
"categories"
Manual
categorytree
categorytree
namespaces
"Category"
Manual
categorytree
categorytree
Manual
categorytree
The {{#categorytree}} parser function
Since
r25825
(Sep 13, 2007), you can also use
parser function
syntax to place a category tree on a page. This works just like the tag, using a different syntax, e.g.
{{#categorytree:Foo}}
; options can be specified using the syntax for named template parameters, e.g.
{{#categorytree:Foo|hideroot|mode=pages}}
Using the parser function syntax has the advantage that it allows you to use magic words, templates and template parameters when specifying the category to show. Some examples:
Using a magic variable to show
this page's
category tree (may be useful on category description pages):
{{#categorytree:{{PAGENAME}}}}
Using a template to specify the category:
{{#categorytree:{{root category}}}}
- the name of the root category would be defined by the contents of Template:Root_category.
Using a template parameter to specify the category, when using CategoryTree inside a template:
{{#categorytree:{{{1}}}}}
in Template:Baz can be called using {{Baz|Foo}}.
The Special:CategoryTree page
The special page is called Special:CategoryTree; there you can enter the name of a category and then browse its content.
Configuration
There are some options you can specify in your
LocalSettings.php
file.
You can no longer use CT_* constants in LocalSettings.php. Instead use
for category mode,
10
for pages,
20
for all,
100
for parents.
$wgCategoryTreeMaxChildren
maximum number of children shown in a tree node. Default is 200.
$wgCategoryTreeAllowTag
enable tag. Default is true.
$wgCategoryTreeDynamicTag
loads the first level of the tree in a dynamically. This way, the cache does not need to be disabled. Default is false.
$wgCategoryTreeDisableCache
disables the parser cache for pages with a tag, or provides max cache time in seconds. Default is 21600 which is 6 hours.
$wgCategoryTreeUseCache
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
r36864
, 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 tag. By 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
10
=>
20
=>
=>
100
=>
];
$wgCategoryTreeDefaultMode
the default mode to use when no mode attribute is specified in a tag.
May be
(the default - categories),
10
(pages), or
20
(all).
$wgCategoryTreeCategoryPageMode
the mode to use when rendering trees on category pages.
Deprecated as of
r36864
, July 2008: use
$wgCategoryTreeCategoryPageOptions
'mode'
instead.
$wgCategoryTreeSidebarRoot
root category to use for integrating the category tree in the sidebar (since
r36920
, 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. This is currently broken for MediaWiki 1.35.1 and the vector skin, see
phab:T278306
$wgCategoryTreeDefaultOptions
default options to apply, as an array (since
r36864
, July 2008). The available
options are described above
. Example:
$wgCategoryTreeDefaultOptions
'mode'
'pages'
$wgCategoryTreeCategoryPageOptions
options to use on category pages, as an array (since
r36864
, July 2008).
$wgCategoryTreeSpecialPageOptions
options to use on Special:CategoryTree, as an array (since
r36864
, July 2008).
$wgCategoryTreeSidebarOptions
options to use when showing the tree in the sidebar, as an array (since
r36920
, 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, how many pages it contains, and how many files are in the category (if applicable):
My category name (5 C, 2 P, 1 F)
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 file pages
$5
Something close to ($1 C, $2 P, $3 F) but with anything that is 0 omitted.
More precisely, a comma separated list of the number of pages (
mediawiki:categorytree-num-pages
), subcategories (
mediawiki:categorytree-num-categories
), and files (
mediawiki:categorytree-num-files
) in the category, or empty (
mediawiki:categorytree-num-empty
) in the case the category has no members. In versions prior to those around 1.19 this value was different. See
older version
of these docs.
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}}
A configuration to manage commas and spaces when outputting all info:
Abbreviation
version:
({{#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}}}})
Full name
version:
({{#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}}}})
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 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
git:mediawiki/extensions/CategoryTree
If you are using
rewrite rules or aliasing
(e.g. to have "very short URLs" - i.e. wiki pages in the document root or perhaps redirecting to a www-version of the requested URL), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory. Also see below.
Clicking the
shows
no sub-categories
error
Try to fix this by adding this code to LocalSettings.php:
$wgCategoryTreeDefaultOptions
'namespaces'
NS_CATEGORY
NS_FILE
];
Browser reports a bad MIME type for CategoryTree.js and/or CategoryTree.css
Make sure your web server 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, grey arrows
are shown instead of
Since MediaWiki 1.13, CategoryTree can show the number of members of a category, and can show a grey arrow
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 necessary with the
--force
option.
toggles shown only on the first level of the category tree view
In case you get only one level depth while visualing the tree, try to set in modules/ext.categoryTree.styles.css file
display
none
to
display
inline
important
The JavaScript intended to switch the tag style is somehow buggy.
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
to fetch category listings and similar.
"Category Not Found" message
After you implement the CategoryTree plugin and add the code to show the tree, if you see a message that says
Category Not Found
, you need to add some content in your category pages. The category pages can't be red pages, basically. Click your category names, add some text in the category page, and then your tree should work fine.
Next 200 links do not work with CategoryTree installed
Make sure the right version of this extension is installed, relative to the version of MediaWiki you have installed. In particular, versions of this extension made for versions of MediaWiki prior to 1.17 are not compatible with MediaWiki 1.17 and greater, and will cause issues where all the paging links on category pages are broken.
No pages are shown when using the "namespaces" parameter
See
above
Hacks
Using CategoryTree in system messages and custom skins
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
Using JavaScript
Since
r36920
(July 2008) with MediaWiki 1.13 (
r36917
), 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 want the CategoryTree on a different position in the sidebar, you can reference it on
MediaWiki:Sidebar
as "categorytree-portlet".
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:Special:CategoryTree
".
function
AppendCategoryTreeToSidebar
()
try
var
node
document
getElementById
"p-tb"
getElementsByTagName
'div'
)[
getElementsByTagName
'ul'
)[
];
var
aNode
document
createElement
'a'
);
var
liNode
document
createElement
'li'
);
aNode
appendChild
document
createTextNode
'CategoryTree'
);
aNode
setAttribute
'href'
'[[w:Special:CategoryTree]]'
);
liNode
appendChild
aNode
);
liNode
className
'plainlinks'
node
appendChild
liNode
);
catch
// 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)
Step by step if works easy:
Add these lines to
LocalSettings.php
$wgCategoryTreeSidebarRoot
'Category:article_name'
Using MediaWiki: namespace pages
If you want to create a link that goes to the generic categorytree (displayed as
Category tree
) when you're on a non-category page, and to a particular categorytree (displayed as
View as category tree
, with foo being the name of the category you're viewing) when you're on a category page:
Add to your
MediaWiki:Sidebar
(right above the SEARCH is a good place) a line,
** sidebarcategorytree-url|sidebarcategorytree
Create a [[MediaWiki:Sidebarcategorytree]] with, say:
{{#ifeq: {{NAMESPACE}}|Category|View as category tree|Category tree}}
Create a [[MediaWiki:Sidebarcategorytree-url]] with, say:
{{#ifeq: {{NAMESPACE}}|Category|Special:CategoryTree/{{BASEPAGENAME}}|Special:CategoryTree/Categories}}
See also
Extension:SubpageNavigation
This extension is being used on one or more
Wikimedia projects
. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's
CommonSettings.php
and
InitialiseSettings.php
configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's
Special:Version
page.
This extension is included in the following wiki farms/hosts and/or packages:
BlueSpice
Canasta
Debian
Fandom
Miraheze
MyWikis
ProWiki
semantic::core
ShoutWiki
Telepedia
wiki.gg
Retrieved from "
Categories
Stable extensions
Tag extensions
Parser function extensions
Special page extensions
CategoryViewer::doCategoryQuery extensions
CategoryViewer::generateLink extensions
MediaWikiServices extensions
OutputPageRenderCategoryLink extensions
ParserFirstCallInit extensions
SkinAfterPortlet extensions
SkinBuildSidebar extensions
SpecialTrackingCategories::generateCatLink extensions
SpecialTrackingCategories::preprocess extensions
GPL licensed extensions
Extensions in Wikimedia version control
All extensions
Extensions bundled with MediaWiki 1.31
Extensions used on Wikimedia
Extensions included in BlueSpice
Extensions included in Canasta
Extensions available as Debian packages
Extensions included in Fandom
Extensions included in Miraheze
Extensions included in MyWikis
Extensions included in ProWiki
Extensions included in semantic::core
Extensions included in ShoutWiki
Extensions included in Telepedia
Extensions included in wiki.gg
Category extensions
Tree extensions
Ajax extensions
Hidden categories:
Extensions with release branches compatibility policy
Extensions with manual MediaWiki version
Extension
CategoryTree
Add topic