Jump to content

Extension:WikiCategoryTagCloud

From mediawiki.org
MediaWiki extensions manual
WikiCategoryTagCloud
Release status: stable
Implementation Tag , Skin
Description Allows users 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 Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.39+
PHP 5.5+
Database changes No
License GNU General Public License 2.0 or later
Download
‎<tagcloud>
Quarterly downloads 13 (Ranked 120th)
Public wikis using 1,274 (Ranked 216th)
Translate the WikiCategoryTagCloud extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The WikiCategoryTagCloud extension allows users 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, 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 move the extracted WikiCategoryTagCloud folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikiCategoryTagCloud
  • Add the following code at the bottom of your LocalSettings.php file:
    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.