Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"

<bs:bookshelf src="Book:User manual" />
        
        
        
        __TOC__
        
        
        
        ==What is TagCloud?==
        
        
        
        '''TagCloud''' can visualize a category overview graphically.
        
        
        
        ==Embed TagCloud==
        
        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: <code><nowiki><bs:tagcloud></bs:tagcloud></nowiki></code>
        
        
        
        ==Parameters==
        
        The TagCloud can be configured using various parameters:
        
        
        
        {| 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
        
        |
        
        |}
        
        
        
        ==Examples==
        
        
        <code><nowiki><bs:tagcloud/></nowiki></code>
        
        ::: [[File:TagCloud_en.PNG|thumb|none|500px|Screenshot: Example for TagCloud with default settings, unconfigured]]
        
        
        
        
        <br/><br/><code><nowiki><bs:tagcloud width=800800px float=right count=15/></nowiki></code>
        
        ::: [[File:TagCloud_2_en.PNG|thumb|none|500px|Screenshot: Example for TagCloud, right-aligned, 15 hits]]
        
        
        
        
        <br/><br/><code><nowiki><bs:tagcloud viewtype=canvas3d width=600600px count=10/></nowiki></code>
        
        ::: [[File:TagCloud_3D_en.PNG|thumb|none|500px|Screenshot: Example for TagCloud, View 3D, 10 hits, Rotating standard view]]
        
        
        
        
        <br/><br/><code><nowiki><bs:tagcloud viewtype=list showcount=true count=10/></nowiki></code>
        
        ::: [[File:TagCloud_list_en.PNG|thumb|none|500px|Screenshot: Example for TagCloud, view Liste]]
        
        
        
        ==See also==
        
        Our [[Reference:TagCloud|reference page]].