Manual:Extension/BlueSpiceTagCloud

The extension TagCloud visualizes terms from your wiki based on importance. It can be included on any wiki page. The source for the tag cloud terms can be categories or searchstats.

What is TagCloud?

Inserting a tag cloud

TagCloud can visualize a category overview graphically.

Embed TagCloud

A tag cloud can be inserted directly in source editing mode with the tag <bs:tagcloud />. To insert a tag cloud with VisualEditor, select Insert > Magic word > Tag cloud.

Configuration

A tag is provided to integrate the configurable TagCloud into an article. The tag must be inserted in an article of the wiki to make the function visible and usable. You can place it manually in the diting mode of the article. The tag can only be inserted in the Wikicode, not in the Visual Editor.

Tag: <bs:tagcloud></bs:tagcloud>

Parameters

If tag is added using VisualEditor, a configuration dialog appears. It shows configuration options in two tabs: Common and Advanced.

Common configuration

The TagCloud can be configured using various parameters:

Parameter	Display name	Description

Value

renderer

Default width determines the width of TagCloud number 300 showcount Shows the number how often the category is used in the wiki

true
false

false float determines the orientation in the article

left

right

left count

defines the number of displayed categories

number

40

(all categories = -1)

viewtype

changes the visualization of the list

viewtype=list

viewtype=canvas3d

simple TagCloud

Type	Mode of rendering the cloud List Text (font size depends on frequency) 3D: rotating, ineractive view
width	Width	Part of the page width taken by the cloud in percent or pixels (e.g., 50%, 150px)
showcount	Show count	Whether to show the numeric frequency of the term in the cloud

Advanced configuration

Parameter	Display name	Description
store	Store	Source of the data - category or searchstats
minsize	Min font size	Smallest possible font displayed in the cloud
maxsize	Max font size	Biggest possible font displayed in the cloud
exclude	Exclude pages	List of categories to exclude from the cloud, separated by comma - "category1, category2, category3"

Examples

<bs:tagcloud/>

Screenshot: Example for TagCloud with default settings, unconfigured

Text

Tag parameters:

<bs:tagcloud width=800 float=right count=15/>

Screenshot: Example for TagCloud, right-aligned, 15 hits<bs:tagcloud viewtype=canvas3d width=600 count=10/> Screenshot: Example for TagCloud, View 3D, 10 hits, Rotating standard view<bs:tagcloud viewtype=list showcount=true count=10/> Screenshot: Example for TagCloud, view Liste

count="10" minsize="12" maxsize="34" exclude="Imported vocabulary, Project" />

Output:

Shows a tag cloud with the 10 (count) categories that have the most page associations. The smallest possible font-size is 12 pixels (minsize) and the largest possible font-size is 34 pixels (maxsize). The categories Imported vocabulary and Project have been excluded from the output.Since the data source category is the default for a tag cloud, it is not necessary to specify it in the tag.

3D canvas

Tag parameters:

<bs:tagcloud renderer="canvas3d" store="category" count="15" minsize="12" maxsize="40" showcount="false" />

Output:

The renderer canvas3d produces an interactive tag cloud. The cloud rotates when the cursor hovers over the tag cloud. It shows the 15 (count) most tagged categories. It is important to set the count limit, since the default count is set to 40, wich produces a 3D cloud where the results are hard to distinguish visually. The data source is set to category (store). This is optional, since category is the default store value. The font sizes range from 12 pixels (minsize) to 40 pixels (maxsize). How many pages and files are associated with each category is not shown (showcount="false").

List

Tag parameters:

<bs:tagcloud renderer="list" store="searchstats" count="5" />

Output:

The renderer type list produces a simple unordered list.

The tag cloud of type list ignores the following parameters: minsize, maxsize

Related info

• Reference:BlueSpiceTagCloud