Difference between revisions of "CategoryCloud"

[unchecked revision][unchecked revision]
m (Text replacement - "[[VisualEditor" to "[[Reference:VisualEditor")
 

The extension WikiCategoryTagCloud enables you to automatically create and display a tag cloud with the categories of the wiki. The extension is already included in BlueSpice free.

Technical Background[edit | edit source]

A tag for inserting a tag cloud in a wiki article is provided.

Functionality[edit | edit source]

Every category of the wiki will be displayed. Subcategories are not considered in this output.

The size of the tags is related to the number of articles, which are assigned to a category. A relative size is shown.

Usage[edit | edit source]

Switch to the editing mode and there, if you use the visual editor as standard, to the WikiCode view. Place the cursor at the position the tag cloud should be inserted at. Add the following code there:


to include the tag cloud with the standard configuration.

Adjustments[edit | edit source]

Configuration[edit | edit source]

The extension provides some optional configurations:

Variable Signification Configuration Standard
min_count Only display a tag for the category that contain at least x articles Define the number of assigned articles, from which on a category should be shown in the tag cloud "0"
min_size Defines the minimum text size Set the minimum text size "77"
increase_factor Defines the factor to increase the text size by the number of articles Set the factor for the increase "100"
exclude Excludes categories from being displayed in the tag cloud Name the categories, which should not be shown i the tag cloud, here No definition, all categories will be displayed

Example: min_size=55 exclude=products, templates

Design[edit | edit source]

For defining the output of the tag cloud, XML syntax needs to be used:

Variable Meaning
class

Adds CSS classes to the tag cloud itself

style Adds CSS styles to the style parameter of the tag cloud
linkclass Adds CSS classes to the links
linkstyle Adds CSS styles to the links' style parameters

Example:

Weblinks[edit | edit source]

__TOC__
        
        The extension WikiCategoryTagCloud enables you to automatically create and display a tag cloud with the categories of the wiki. The extension is already included in BlueSpice free.
        

        ==Technical Background==
        
        A tag for inserting a tag cloud in a wiki article is provided.
        

        ==Functionality==
        
        Every category of the wiki will be displayed. Subcategories are not considered in this output.
        

        The size of the tags is related to the number of articles, which are assigned to a category. A relative size is shown.
        

        ==Usage==
        
        Switch to the editing mode and there, if you use the [[Reference:VisualEditor|visual editor]] as standard, to the WikiCode view. Place the cursor at the position the tag cloud should be inserted at. Add the following code there:
        

        to include the tag cloud with the standard configuration.
        

        ==Adjustments==
        
        ===Configuration===
        
        The extension provides some optional configurations:
        

        {| class="contenttable" style="width: 790px; height: 252px;" border="0"
        
        |-
        
        !|'''Variable'''
        
        !|'''Signification'''
        
        !|'''Configuration'''
        
        !|'''Standard'''
        
        |-
        
        ||min_count
        
        ||Only display a tag for the category that contain at least x articles
        
        ||Define the number of assigned articles, from which on a category should be shown in the tag cloud
        
        ||"0"
        
        |-
        
        ||min_size
        
        ||Defines the minimum text size
        
        ||Set the minimum text size
        
        ||"77"
        
        |-
        
        ||increase_factor
        
        ||Defines the factor to increase the text size by the number of articles
        
        ||Set the factor for the increase
        
        ||"100"
        
        |-
        
        ||exclude
        
        ||Excludes categories from being displayed in the tag cloud
        
        ||Name the categories, which should not be shown i the tag cloud, here
        
        ||No definition, all categories will be displayed
        
        |}
        

        '''Example:'''
        <code><nowiki>
        

        min_size=55
        
        exclude=products, templates </nowiki></code>
        

        ==Design==
        
        For defining the output of the tag cloud, XML syntax needs to be used:
        

        {| class="contenttable" style="width: 790px; height: 252px;" border="0"
        
        |-
        
        !|'''Variable'''
        
        !|'''Meaning'''
        
        |-
        
        ||class
        
        ||
        
        Adds CSS classes to the tag cloud itself
        

        |-
        
        ||style
        
        ||Adds CSS styles to the style parameter of the tag cloud
        
        |-
        
        ||linkclass
        
        ||Adds CSS classes to the links
        
        |-
        
        ||linkstyle
        
        ||Adds CSS styles to the links' style parameters
        
        |}
        

        '''Example:'''
        <code><nowiki>
        
</nowiki></code>
        

        ==Weblinks==
        
        * MediaWiki.org: [https://www.mediawiki.org/wiki/Extension:WikiCategoryTagCloud WikiCategoryTagCloud]
Line 11: Line 11:
  
 
==Usage==
 
==Usage==
Switch to the editing mode and there, if you use the [[VisualEditor|visual editor]] as standard, to the WikiCode view. Place the cursor at the position the tag cloud should be inserted at. Add the following code there:
+
Switch to the editing mode and there, if you use the [[Reference:VisualEditor|visual editor]] as standard, to the WikiCode view. Place the cursor at the position the tag cloud should be inserted at. Add the following code there:
  
  

Attachments

Discussions