Extension:WikiCategoryTagCloud

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
WikiCategoryTagCloud
Release status: stable
Implementation Tag, Skin
Description Allows to add tag clouds based on categories to a page via the <tagcloud> tag
Author(s)
Latest version 1.3.3 (2017-09-19)
Compatibility policy release branches
MediaWiki 1.23+
PHP 5.3+
Database changes No
License GNU General Public License 2.0 or later
Download
Tags
<tagcloud>
Hooks used
ParserFirstCallInit
PageContentSave
Translate the WikiCategoryTagCloud extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

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).
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.26 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.26 and earlier), instead of wfLoadExtension( 'WikiCategoryTagCloud' );, you need to use:

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