Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"
[unchecked revision] | [unchecked revision] |
Fbaeckmann (talk | contribs) m (Text replacement - "[[TagCloud" to "[[Reference:TagCloud") |
Fbaeckmann (talk | contribs) (→Parameters) (Tag: 2017 source edit) |
What is TagCloud?[edit | edit source]
TagCloud can visualize a category overview graphically.
Embed TagCloud[edit | edit source]
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: <bs:tagcloud></bs:tagcloud>
Parameters[edit | edit source]
The TagCloud can be configured using various parameters:
Parameter | Description |
Value |
Default | ||
---|---|---|---|---|---|
width determines | determins the width of the TagCloud | number | 300 ; can be enterd in pixels or percent | pixels of percent | 100% |
showcount | Shows the number displays how often the a category is used in the wiki |
true
|
false | ||
float | determines the orientation in the article |
left right |
left | ||
true | |||||
count |
defines the number of displayed categories how many categories are shown |
number |
40 (show all categories = -1) |
||
viewtype renderer |
changes the visualization visualisation of the TagCloud list = show an unordered list viewtype= canvas3d = 3D display text = results are shown side by side |
list viewtype=canvas3d |
simple TagCloud |
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[edit | edit source]
<bs:tagcloud/>
<bs:tagcloud width=800 float=right count=15/>
<bs:tagcloud viewtype=canvas3d width=600 count=10/>
<bs:tagcloud viewtype=list showcount=true count=10/>
See also[edit | edit source]
Our reference page.
<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''' ||determinesdetermins the width of the TagCloud ||number ||300 |- ||'''showcount''' ||Shows the number how often the; 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 ||false |- ||'''float''' ||determines the orientation in the article || left right ||left |- ||'''count''' || defines the number of displayed categories || number || 40 (all categories = -1) |- ||'''viewtype''' || changes the visualization of the list || viewtype=list viewtype=canvas3d ||simple TagCloud |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=800 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=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/><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]].
Line 25: | Line 25: | ||
|- | |- | ||
||'''width''' | ||'''width''' | ||
− | || | + | ||determins the width of the TagCloud; can be enterd in pixels or percent |
− | || | + | ||pixels of percent |
− | || | + | ||100% |
|- | |- | ||
||'''showcount''' | ||'''showcount''' | ||
− | || | + | ||displays how often a category is used in the wiki |
|| | || | ||
− | true<br /> false | + | true<br />false |
− | || | + | ||true |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
||'''count''' | ||'''count''' | ||
|| | || | ||
− | defines | + | defines how many categories are shown |
|| | || | ||
Line 55: | Line 46: | ||
40 | 40 | ||
− | (all categories = -1) | + | (show all categories = -1) |
|- | |- | ||
− | ||''' | + | ||'''renderer''' |
|| | || | ||
− | changes the | + | 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 | ||
+ | | | ||
|} | |} | ||