Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"
[unchecked revision] | [quality revision] |
m (Text replacement - "<bs:bookshelf src="Book:User manual" />" to "") |
(Tag: Visual edit) |
Contents
- 1 What is BlueSpiceTagCloud? Inserting a tag cloud
- 2 Inserting BlueSpiceTagCloud 3
-
Configuration
- 3
- 4 See also
BlueSpiceTagCloud displays a tag cloud based on categories or search terms. It is used for visualizing most searched terms or viewed pages.
Inserting BlueSpiceTagCloudInserting a tag cloud[edit | edit source]

A tag cloud can be inserted directly in source editing mode with the tag <bs:tagcloud
/>
. To insert a tag cloud with VisualEditor, select Insert > Magic word > Tag cloud.
Configuration[edit | edit source]

If tag is added using VisualEditor, after inserting it, a configuration window (inspector) will appeardialog appears. It shows configurations configuration options in two tabs: Common
and Advanced.
Common configuration[edit | edit source]
Parameter | Display name | Description |
---|---|---|
renderer | Type | Mode of rendering the cloud
|
width | Width | Percent 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[edit | edit source]
Parameter | Display name | Description |
---|---|---|
store | Store | Source of the data - category or search terms 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 pages categories to exclude from the cloud, separated by comma - "Page1category1, Page2category2, Page3category3" |
See alsoExamples[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 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.
3D canvas[edit | edit source]
Tag parameters:
<bs:tagcloud renderer="canvas3d" store="category" count="15" minsize="12" maxsize="40" showcount="false" />
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").
List[edit | edit source]
Tag parameters:
<bs:tagcloud renderer="list" store="searchstats" count="5" />
Output:
The renderer type list produces a simple unordered list.
The tag cloud of type list ignores the following parameters: minsize, maxsize
Related info
__TOC__ ==What is BlueSpiceTagCloud?== '''BlueSpiceTagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing most searched terms or viewed pages. ==Inserting BlueSpiceTagCloud== [[File:TagCloud1.png|thumb|Tag cloud tag in "Insert magic" dialog]] Tag <pre><bs:tagcloud /></pre> can be inserted to the page directly in wikitext or using "Insert magic" menu of [[Manual:Extension/VisualEditor|VisualEditor]]. For more information on how to insert magic words, see [[Manual:Extension/BlueSpiceInsertMagic|BlueSpiceInsertMagic]]. ==Configuration== [[File:TagCloud2.png|thumb|Tag cloud configuration in edit mode]] {{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 [[Manual:Extension/VisualEditor|VisualEditor]], after inserting it, a configuration window (inspector) will appear. It shows configurations in two tabs: *Common *Advanced 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 - 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 view |- |width |Width |Percent*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 |} [[File:TagCloud3.png|thumb|Tag cloud on page in view mode]] ===Advanced configuration=== {| class="wikitable" |+ !Parameter !Display name !Description |- |store |Store |Source of the data - category or search terms 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 pagescategories to exclude from the cloud, separated by comma - "Page1, Page2, Page3" |} ==See also== [[Reference:TagCloud|Reference page]] for this extension.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 renderer="canvas3d" store="category" count="15" minsize="12" maxsize="40" showcount="false" /></nowiki></code> 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 renderer="list" store="searchstats" count="5" /></nowiki></code> 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]]
(13 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{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]] | |
− | |||
− | ''' | ||
− | |||
− | |||
− | [[File: | ||
− | |||
− | |||
==Configuration== | ==Configuration== | ||
− | + | If tag is added using VisualEditor, a configuration dialog appears. It shows configuration options in two tabs: ''Common'' and ''Advanced''.<br /> | |
− | If tag is added using | + | [[File:TagCloud2.png|alt=tag cloud example|border|center|650x650px]] |
− | |||
− | |||
− | |||
− | |||
===Common configuration=== | ===Common configuration=== | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 27: | Line 17: | ||
|Mode of rendering the cloud | |Mode of rendering the cloud | ||
− | * List | + | *List |
− | * Text | + | *Text (font size depends on frequency) |
− | * 3D | + | *3D: rotating, ineractive view |
|- | |- | ||
|width | |width | ||
|Width | |Width | ||
− | | | + | |Part of the page width taken by the cloud in percent or pixels (e.g., 50%, 150px) |
|- | |- | ||
|showcount | |showcount | ||
|Show count | |Show count | ||
− | |Whether to show numeric frequency of the term in the cloud | + | |Whether to show the numeric frequency of the term in the cloud |
|} | |} | ||
− | |||
− | |||
===Advanced configuration=== | ===Advanced configuration=== | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 50: | Line 38: | ||
|store | |store | ||
|Store | |Store | ||
− | |Source of the data - category or | + | |Source of the data - category or searchstats |
|- | |- | ||
|minsize | |minsize | ||
Line 62: | Line 50: | ||
|exclude | |exclude | ||
|Exclude pages | |Exclude pages | ||
− | |List of | + | |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 renderer="canvas3d" store="category" count="15" minsize="12" maxsize="40" showcount="false" /></nowiki></code> | ||
+ | |||
+ | 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 renderer="list" store="searchstats" count="5" /></nowiki></code> | ||
+ | |||
+ | 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]] |