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/>{{DISPLAYTITLE:Tag cloud}}
            
            
            
            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.<br /> [[File:Manual:tagcloud-example.png|alt=Tagcloud example|center|750x750px|Tag cloud example]]
            
            ==Inserting a tag cloud==
            
            A tag cloud can be inserted directly in source editing mode with the tag <code><nowiki><bs:tagcloud /></nowiki></code>. To insert a tag cloud with [[Manual:VisualEditor|VisualEditor]], select ''Insert > Magic word > Tag cloud''. 
            
             [[File:TagCloud1.png|Tag cloud tag in "Insert magic" dialog|alt=Inserting a tag cloud with VisualEditor|border|center|450x450px]]
            
            ==Configuration==
            
            If tag is added using VisualEditor, a configuration dialog appears. It shows configuration options in two tabs: ''Common'' and ''Advanced''.<br />
            
            [[File:TagCloud2.png|alt=tag cloud example|border|center|650x650px]]
            
            ===Common configuration===
            
            {| class="wikitable"
            
            |+
            
            !Parameter!!Display name
            
            !Description
            
            |-
            
            |renderer||Type
            
            |Mode of rendering the cloud
            
            
            
            *List
            
            *Text (font size depends on frequency)
            
            *3D: rotating, ineractive view
            
            |-
            
            |width
            
            |Width
            
            |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
            
            |}
            
            ===Advanced configuration===
            
            {| class="wikitable"
            
            |+
            
            !Parameter
            
            !Display name
            
            !Description
            
            |-
            
            |store
            
            |Store
            
            |Source of the data - category or 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 categories to exclude from the cloud, separated by comma - "category1, category2, category3"
            
            |}
            
            ==Examples==
            
            ===Text===
            
            Tag parameters:
            
            
            
            
            <code><nowiki><bs:tagcloud count="10" minsize="12" maxsize="34" exclude="Imported vocabulary, Project" /></nowiki></code>
            
            
            
            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.
            
            [[File:Manual:tagcloud-example-exclude.png|alt=Tag cloud example type text with excluded categoriee|center|650x650px]]
            
            
            
            ===3D canvas===
            
            Tag parameters:
            
            
            
            
        <code><nowiki><bs:tagcloud width=800 float=rightrenderer="canvas3d"  store="category" count=15"15" minsize="12" maxsize="40" showcount="false" /></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=600 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/>
            
            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"'').
            
            [[File:Manual:tagcloud-canvas3D.png|alt=Tag cloud example type 3D without counter|center|350x350px]]
            
            ===List===
            
            Tag parameters:
            
            
            
            
        <code><nowiki><bs:tagcloud viewtype=list showcount=truerenderer="list" store="searchstats" count=10"5" /></nowiki></code>
        
        
        ::: [[File:TagCloud_list_en.PNG|thumb|none|500px|Screenshot: Example for TagCloud, view Liste]]
            
            
            
            ==See also==
            
            Our [[Reference:TagCloud|reference page]].
            
            Output:
            
            
            
            The renderer type ''list'' produces a simple unordered list.
            
            [[File:Manual:tagcloud-list-searchstats.png|alt=tag cloud with search stats type list |center]]
            
            
            
            
            <br />
            
            
            
            The tag cloud of type ''list'' ignores the following parameters: ''minsize'', ''maxsize''
            
            
            
            {{Box Links-en|Topic1=[[Reference:BlueSpiceTagCloud]]}}
            
            
            
            {{Translation}}
            
            [[Category:Content]]