Extension:WikiCategoryTagCloud

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
WikiCategoryTagCloud

Release status:Extension status stable

ImplementationTemplate:Extension#type Tag, Skin
DescriptionTemplate:Extension#description Allows to add tag clouds based on categories to a page via the <tagcloud> tag
Author(s)Template:Extension#username Daniel Friesen
Jack Phoenix
Latest versionTemplate:Extension#version 1.3 (2015-11-19)
MediaWikiTemplate:Extension#mediawiki 1.27+
PHPTemplate:Extension#php 5.3+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GPL v2+
Download
TagsTemplate:Extension#tags
<tagcloud>
Hooks usedTemplate:Extension#hook
ParserFirstCallInit
ArticleSave

Translate the WikiCategoryTagCloud extension if it is available at translatewiki.net

Check usage and version matrix.

The WikiCategoryTagCloud extension allows to add tag clouds based on categories to a page.

Usage[edit]

These in text parameters from the original extension still work the same:

min_count
Only display a tag for a category, if the category contains at least min_count articles. Default value : 0.
min_size
Defines the minimum text size. (Default: 77).
increase_factor
Defines the factor to increase the text size by the number of articles. Default value : 100.
exclude
Defined the categories you do not want to be displayed. Use underscore instead of spaces in category names, use comma to separate the categories, like this:
<tagcloud>exclude=television,television_series,celebrities,food,yoga</tagcloud>

makes "television", "television series", "celebrities", "food" and "yoga" categories not to show up in the categories cloud.

The coloring in text parameters do not work anymore, instead we have XML parameters:

class
Adds CSS classes to the tag cloud itself (The tagcloud class is always included).
style
Adds CSS styles to the style parameter of the tag cloud.
linkclass
Adds CSS classes to the links.
linkstyle
Adds CSS styles to the links' style parameters.

in text parameters are place in between the two tags, and XML parameters are done inside the opening tag. Here's an example use showing where things are placed.

<tagcloud style="background: black;">
min_size=55
exclude=browse
</tagcloud>

Installation[edit]

  • Download and place the file(s) in a directory called WikiCategoryTagCloud in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'WikiCategoryTagCloud' );
  • Optional: Add the pages to invalidate the cache for to MediaWiki:Tagcloudpages (one title per line).
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing extensions using wfLoadExtension(), since MediaWiki 1.25. If you need to install this extension in earlier versions, instead of wfLoadExtension( 'WikiCategoryTagCloud' );, you need to use:

require_once "$IP/extensions/WikiCategoryTagCloud/WikiCategoryTagCloud.php";