Difference between revisions of "Manual:Extension/BlueSpiceTagCloud"
[unchecked revision] | [unchecked revision] |
Fbaeckmann (talk | contribs) (→Examples) (Tag: 2017 source edit) |
(Tag: 2017 source edit) |
Contents
- 1 What is TagCloudBlueSpiceTagCloud?
- 2 Embed TagCloud Inserting BlueSpiceTagCloud
- 3 Parameters
- 4 Examples 5
- Configuration
- 4 See also
What is TagCloudBlueSpiceTagCloud?[edit | edit source]
TagCloud can visualize a category overview graphically.
Embed TagCloudBlueSpiceTagCloud displays a tag cloud based on categories or search terms. It is used for visualizing most searched terms or viewed pages.
Inserting BlueSpiceTagCloud[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>
<bs:tagcloud />
can be inserted to the page directly in wikitext or using "Insert magic" menu of VisualEditor. For more information on how to insert magic words, see BlueSpiceInsertMagic.
Configuration[edit | edit source]
If tag is added using VisualEditor, after inserting it, a configuration window (inspector) will appear. It shows configurations in two tabs:
- Common
- Advanced
Common configuration[edit | edit source]
The TagCloud can be configured using various parameters:
Parameter | Display name | Description |
---|
renderer |
true
false
defines how many categories are shown
number
40
(show all categories = -1)
rendererchanges 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 sourcecategory = displays categories
searchstats = displays search results (only if BlueSpiceExtendedSearch is installed)
categorysearchstats
category minsize minimal font size number maxsize maximal font size numberExamples[edit | edit source]
<bs:tagcloud/>
<bs:tagcloud width=800px float=right count=15/>
<bs:tagcloud viewtype=canvas3d width=600px count=10/>
<bs:tagcloud viewtype=list showcount=true count=10/>
Type |
Mode of rendering the cloud
|
|
width | Width | Percent of the page width taken by the cloud |
showcount | Show count | Whether to show 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 |
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 to exclude from the cloud, separated by comma - "Page1, Page2, Page3" |
See also[edit | edit source]
Our reference Reference page for this extension.
<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/><code><nowiki><bs:tagcloud width=800px 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=600px 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]]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]] 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 ===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 of the page width taken by the cloud |- |showcount |Show count |Whether to show 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 |- |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 to exclude from the cloud, separated by comma - "Page1, Page2, Page3" |} [[File:TagCloud3.png|thumb|Tag cloud on page in view mode]] ==See also== [[Reference:TagCloud|Reference page]] for this extension.
Line 3: | Line 3: | ||
__TOC__ | __TOC__ | ||
− | ==What is | + | ==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]]. | ||
− | Tag: | + | ==Configuration== |
+ | [[File:TagCloud2.png|thumb|Tag cloud configuration in edit mode]] | ||
+ | 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 | |
− | {| class=" | + | ===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 of the page width taken by the cloud | |
− | |||
|- | |- | ||
− | | | + | |showcount |
− | || | + | |Show count |
− | | | + | |Whether to show 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 | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | |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 to exclude from the cloud, separated by comma - "Page1, Page2, Page3" | |
− | | | ||
|} | |} | ||
− | + | [[File:TagCloud3.png|thumb|Tag cloud on page in view mode]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==See also== | ==See also== | ||
− | + | [[Reference:TagCloud|Reference page]] for this extension. |