Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"
[unchecked revision] | [quality revision] |
m (Tag: 2017 source edit) |
(Tag: Visual edit) |
Contents
Contents
About the tag cloud[edit | edit source]
The tag cloud extension BlueSpiceTagCloud 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 search terms.Inserting 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 Common and advanced 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" |
Example outputsExamples[edit | edit source]
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 contentpage 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" float="right" />
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="155" showcount="false" />
Output:
Possible parameters and their values can be found at Reference:BlueSpiceTagCloud. Output:
The renderer type list produces a simple unordered list.
The tag cloud of type list ignores the following parameters: minsize, maxsize
Related info
{{DISPLAYTITLE:Tag cloud}} __TOC__ ==About the tag cloud== The tag cloud extension ''BlueSpiceTagCloud 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 search termssearchstats.<br /> [[File:Manual:tagcloud-example.png|alt=Tagcloud example|center|750x750px|Tag cloud example]] <br /> ==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, after inserting it, a configuration window (inspector) will appear. It shows configurations in two tabs: ''common'' and ''advanceda 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:[[File:Manual:tagcloud-list.png|alt=tagcloud type list|center|150x150px]] *Text (font size depends on frequency) *3D: rotating, ineractive view |- |width |Width |PercentPart 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 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" |} ==Example outputs== 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 contentpage 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" float="right" /></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="15" showcount="false" 5" /></nowiki></code> <bs:tagcloud renderer="list" store="searchstats" count="15" showcount="false" exclude="leitfaden,inhaltliche anforderungen an qualifizierungsdokumente,i.o.,n main,bluespice f, power p" /> Output: Possible parameters and their values can be found at [[Reference:BlueSpiceTagCloud]].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]]
(12 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:Tag cloud}} | {{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== | ==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''. | 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:TagCloud1.png|Tag cloud tag in "Insert magic" dialog|alt=Inserting a tag cloud with VisualEditor|border|center|450x450px]] | ||
==Configuration== | ==Configuration== | ||
− | If tag is added using VisualEditor | + | 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]] | [[File:TagCloud2.png|alt=tag cloud example|border|center|650x650px]] | ||
− | |||
===Common configuration=== | ===Common configuration=== | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 24: | Line 17: | ||
|Mode of rendering the cloud | |Mode of rendering the cloud | ||
− | *List | + | *List |
*Text (font size depends on frequency) | *Text (font size depends on frequency) | ||
*3D: rotating, ineractive view | *3D: rotating, ineractive view | ||
Line 30: | Line 23: | ||
|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=== | ||
Line 45: | Line 38: | ||
|store | |store | ||
|Store | |Store | ||
− | |Source of the data - category or | + | |Source of the data - category or searchstats |
|- | |- | ||
|minsize | |minsize | ||
Line 57: | 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=== | ===Text=== | ||
Tag parameters: | Tag parameters: | ||
Line 68: | Line 60: | ||
Output: | Output: | ||
− | Shows a tag cloud with the 10 (count) categories that have the most | + | 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]] | [[File:Manual:tagcloud-example-exclude.png|alt=Tag cloud example type text with excluded categoriee|center|650x650px]] | ||
Line 74: | Line 66: | ||
Tag parameters: | Tag parameters: | ||
− | <code><nowiki><bs:tagcloud renderer="canvas3d" store="category" count="15" minsize="12" maxsize="40" showcount="false | + | <code><nowiki><bs:tagcloud renderer="canvas3d" store="category" count="15" minsize="12" maxsize="40" showcount="false" /></nowiki></code> |
Output: | Output: | ||
Line 80: | Line 72: | ||
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"''). | 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]] | [[File:Manual:tagcloud-canvas3D.png|alt=Tag cloud example type 3D without counter|center|350x350px]] | ||
− | |||
===List=== | ===List=== | ||
Tag parameters: | Tag parameters: | ||
− | <code><nowiki><bs:tagcloud renderer="list" store="searchstats" count=" | + | |
− | + | <code><nowiki><bs:tagcloud renderer="list" store="searchstats" count="5" /></nowiki></code> | |
Output: | 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]] |