Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"

[unchecked revision][quality revision]
m (Text replacement - "<bs:bookshelf src="Book:User manual" />" to "")
 


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.
Tagcloud example

Contents

What is BlueSpiceTagCloud?[edit | edit source]

BlueSpiceTagCloud displays a tag cloud based on categories or search terms. It is used for visualizing most searched terms or viewed pages.

Inserting BlueSpiceTagCloud

Inserting a tag cloud[edit | edit source]

Tag cloud tag in "Insert magic" dialog Tag

A tag cloud can be inserted directly in source editing mode with the tag <bs:tagcloud

/>

can be inserted to the page directly in wikitext or using "Insert magic" menu of VisualEditor. For more information on how to insert magic words, see BlueSpiceInsertMagic.

. To insert a tag cloud with VisualEditor, select Insert > Magic word > Tag cloud.

Inserting a tag cloud with VisualEditor

Configuration[edit | edit source]

Tag cloud configuration in edit mode

If tag is added using VisualEditor, after inserting it, a configuration window (inspector) will appeardialog appears. It shows configurations configuration options in two tabs: Common

and Advanced.

tag cloud example

Common configuration[edit | edit source]

Parameter Display name Description
renderer Type Mode of rendering the cloud
  • List - results will be shown as a list
  • Text - terms will be shown one after another, with font size depending on the frequency
  • 3D - terms will be shown in a modern, interactive
  • Text (font size depends on frequency)
  • 3D: rotating, ineractive view
width Width Percent 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
Tag cloud on page in view mode

Advanced configuration[edit | edit source]

Parameter Display name Description
store Store Source of the data - category or search terms 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 pages categories to exclude from the cloud, separated by comma - "Page1category1, Page2category2, Page3category3"

See alsoExamples[edit | edit source]

Reference page for this extension.

Text[edit | edit source]

Tag parameters:

<bs:tagcloud 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.

Tag cloud example type text with excluded categoriee

3D canvas[edit | edit source]

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").

Tag cloud example type 3D without counter

List[edit | edit source]

Tag parameters:

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

Output:

The renderer type list produces a simple unordered list.

tag cloud with search stats type list


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

Related info


Attachments

Discussions