Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"

[unchecked revision][unchecked revision]
m (Text replacement - "<bs:bookshelf src="Book:User manual" />" to "")
m
(Tag: 2017 source edit)
What is BlueSpiceTagCloud?

About the tag cloud[edit | edit source]

BlueSpiceTagCloud displays a The tag cloud extension BlueSpiceTagCloud visualizes terms from your wiki based on categories or search terms. It is used for visualizing most searched terms or viewed pages. Inserting BlueSpiceTagCloudimportance. It can be included on any wiki page. The source for the tag cloud terms can be categories or search terms.
Tagcloud example


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 appear. It shows configurations in two tabs: common and advanced.

Common
tag cloud example
  • Advanced
  • 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 :
      tagcloud type list
    • Text (font size depends on frequency)
    • 3D: rotating, ineractive 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
    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
    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"

    See alsoExample outputs[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 content. The smallest possible font-size is 12 pixels (minsize) and the largest possible font-size is 34 pixels. 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" float="right" />

    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="15" showcount="false" />

    Output:

    Possible parameters and their values can be found at Reference:BlueSpiceTagCloud.


    Attachments

    Discussions