Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"

[unchecked revision][unchecked revision]
(Examples)
(Tag: 2017 source edit)
(Tag: 2017 source edit)

What is TagCloudBlueSpiceTagCloud?[edit | edit source]

TagCloud can visualize a category overview graphically.

Embed TagCloud

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

Inserting BlueSpiceTagCloud[edit | edit source]

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
Tag cloud tag in "Insert magic" dialog
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.

Configuration[edit | edit source]

Tag cloud configuration in edit mode

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

  • Common
  • Advanced

Common configuration[edit | edit source]

The TagCloud can be configured using various parameters:

Parameter Display name Description
Value
renderer
Default width determins the width of the TagCloud; can be enterd in pixels or percent pixels of percent 100% showcount displays how often a category is used in the wiki

true
false

true count

defines how many categories are shown

number

40

(show all categories = -1)

renderer

changes the visualisation of the TagCloud

list = show an unordered list

canvas3d = 3D display

text = results are shown side by side

list

canvas3d

text

test store defines the data source

category = displays categories

searchstats = displays search results (only if BlueSpiceExtendedSearch is installed)

category

searchstats

category minsize minimal font size number maxsize maximal font size number

Examples[edit | edit source]

<bs:tagcloud/>

Screenshot: Example for TagCloud with default settings, unconfigured<bs:tagcloud width=800px float=right count=15/> Screenshot: Example for TagCloud, right-aligned, 15 hits<bs:tagcloud viewtype=canvas3d width=600px 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
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 view
width Width Percent of the page width taken by the cloud
showcount Show count Whether to show numeric frequency of the term in the cloud


Advanced configuration[edit | edit source]

Parameter Display name Description
store Store Source of the data - category or search terms
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 to exclude from the cloud, separated by comma - "Page1, Page2, Page3"
Tag cloud on page in view mode

See also[edit | edit source]

Our reference Reference page for this extension.


Attachments

Discussions