Difference between revisions of "Reference:BlueSpiceTagCloud"

m (Text replacement - "For detailed description and usage please visit our" to "For detailed description and usage, visit our")
m

Extension: BlueSpiceTagCloud


Overview
Description: Visualize a category overview graphically and in 3D.
State: stable Dependency: BlueSpice
Developer: HalloWelt License: GPL v3 only
Type: Category: Rich Articles
Edition: BlueSpice free

Features[edit source]

Description[edit | edit source]

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

Usage / Featuresfeatures[edit | edit source]

A tag is provided to embed the configurable TagCloud into an article. The tag must be actively inserted into an article in the wiki to make the feature visible and usable. You can manually place the unconfigured tag in the article. This happens in the edit mode of the article. The tag can only be inserted in Wikicode, not in the Visual Editor.

Tag: <bs:tagcloud />

in a content page. The tag <bs:tagcloud /> can be inserted as Wikitext or using the Insert > Magic word menu in VisualEditor.

Technical information[edit | edit source]

Configuration[edit | edit source]

You can configure the following options:

Parameter Description

Value

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


Rights (permissions)[edit | edit source]

This extension does not require any special rights. Users need "read" permission to view TagCloud and "edit" to create one.

Requirements[edit | edit source]

Tag Cloud requires BlueSpiceFoundation.

User manualMore info[edit | edit source]

For detailed description and usage, visit our user manual

Try free our BlueSpice

help page.

Demo[edit | edit source]

You can view and modifiy the tag cloud on the Sandbox page in our BlueSpice Demo.

{{BSExtensionInfobox
        
        |desc=Visualize a category overview graphically and in 3D.
        
        |status=stable
        
        |developer=HalloWelt
        
        |type=BlueSpice
        
        |edition=BlueSpice free
        
        |active=Yes
        
        |compatible=BlueSpice
        
        |category=Rich Articles
        
        |license=GPL v3 only
        
        }}
        
        
        __TOC__
            
            
            
            ==Description==
            
            
            
            '''BlueSpiceTagCloud'''TagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing the most searched popular search terms or viewed pages.
        
        
        
        ==Usage / Featuresfeatures==
        
        
        
        A tag is provided to embed the configurable TagCloud into an article. The tag must be actively inserted into an article in the wiki to make the feature visible and usable. You can manually place the unconfigured tag in the article. This happens in the edit mode of the article. The tag can only be inserted in Wikicode, not in the Visual Editor.
            
            
            
            Tag: <code><nowiki><bs:tagcloud /></nowiki></code>
            
            
            
            
        in a content page. The tag <code><nowiki><bs:tagcloud /></nowiki></code>  can be  inserted as Wikitext or using the ''Insert > Magic word'' menu in [[Reference:VisualEditor|VisualEditor.]]
            
            
            
            
        ==Technical information==
        
        
        
        ===Configuration===
        
        You can configure the following options:
        
        {| class="contenttable" style="width: 869px; height: 202px;" border="0"
        
        |-
        
        !|'''Parameter'''
        
        !|'''Description'''
        
        !|
        
        '''Value'''
        
        
        
        !|'''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<br />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
        
        |
        
        |}
        
        
        
        
        
        ===Rights (permissions)===
        
        This extension does not require any special rights. Users need "read" permission to view TagCloud and "edit" to create one.
        
        
        
        ===Requirements===
        
        Tag Cloud requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]].
        
        
        
        ==User manualMore info==
        
        
        
        For detailed description and usage, visit our [[Manual:Extension/TagCloud|user manual]]
            
            
            
            ==Try free our BlueSpice==
            
            
            
            
        help page.]]
            
            
            
            ==Demo==
            
            
            
            You can view and modifiy the tag cloud on the ''Sandbox'' page in our [https://en.demo.bluespice.com/wiki/Main_Page BlueSpice Demo.]
        
        
        
        {{Translation}}
        
        
        
        [[Category:BlueSpice free]]
        
        [[Category:Extension]]
Line 10: Line 10:
 
|license=GPL v3 only
 
|license=GPL v3 only
 
}}
 
}}
__TOC__
+
'''TagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing the most popular search terms or pages.
  
==Description==
+
==Usage / features==
  
'''BlueSpiceTagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing most searched terms or viewed pages.
+
A tag is provided to embed the configurable TagCloud in a content page. The tag <code><nowiki><bs:tagcloud /></nowiki></code> can be  inserted as Wikitext or using the ''Insert > Magic word'' menu in [[Reference:VisualEditor|VisualEditor.]]
 
 
==Usage / Features==
 
 
 
A tag is provided to embed the configurable TagCloud into an article. The tag must be actively inserted into an article in the wiki to make the feature visible and usable. You can manually place the unconfigured tag in the article. This happens in the edit mode of the article. The tag can only be inserted in Wikicode, not in the Visual Editor.
 
 
 
Tag: <code><nowiki><bs:tagcloud /></nowiki></code>
 
  
 
==Technical information==
 
==Technical information==
Line 26: Line 20:
 
===Configuration===
 
===Configuration===
 
You can configure the following options:
 
You can configure the following options:
{| class="contenttable" style="width: 869px; height: 202px;" border="0"
+
{| class="contenttable" style="width:869px;" border="0"
 
|-
 
|-
 
!|'''Parameter'''
 
!|'''Parameter'''
Line 106: Line 100:
 
Tag Cloud requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]].
 
Tag Cloud requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]].
  
==User manual==
+
==More info==
  
For detailed description and usage, visit our [[Manual:Extension/TagCloud|user manual]]
+
For detailed description and usage, visit our [[Manual:Extension/TagCloud|help page.]]
  
==Try free our BlueSpice==
+
==Demo==
  
[https://en.demo.bluespice.com/wiki/Main_Page BlueSpice Demo.]
+
You can view and modifiy the tag cloud on the ''Sandbox'' page in our [https://en.demo.bluespice.com/wiki/Main_Page BlueSpice Demo.]
  
 
{{Translation}}
 
{{Translation}}

Attachments

Discussions