Difference between revisions of "Reference:BlueSpiceTagCloud"
LukasHoenig (talk | contribs) |
(Tag: 2017 source edit) |
Description[edit | edit source]
With the Extension BlueSpice TagCloud you can visualize a category overview graphically. You can generate clouds and lists with this extension. The representation is hierarchical, out of the most used category. These categories are shown larger or otherwise highlighted.
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>
Permissions[edit | edit source]
Every user who has reading permissions can see the TagCloud. Every user who has editing permissions, can create a TagCloud.
ParametersExtension: BlueSpiceTagCloud
Overview | |||
---|---|---|---|
Description: | Displays various tag clouds | ||
State: | stable | Dependency: | BlueSpice |
Developer: | HalloWelt | License: |
GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process. |
Type: | BlueSpice | Category: | Rich Articles |
Edition: | BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud | ||
Features
TagCloud displays a tag cloud based on categories or search terms. It is used for visualizing the most popular search terms or pages.
A tag is provided to embed the configurable TagCloud in a content page. The tag <bs:tagcloud />
can be inserted as Wikitext or using the Insert > Magic word menu in VisualEditor.
Technical Information[edit source]
This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.
Requirements[edit source]
- MediaWiki: 1.31
- BlueSpiceFoundation: 3.2
Integrates into[edit source]
- BlueSpiceTagCloud
- BlueSpiceVisualEditorConnector
Special pages[edit source]
Hooks[edit source]
Configuration[edit | edit source]
You can configure the following options:
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
|
left
right
lefttrue | |
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 |
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/>
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 |
==Description== With the Extension BlueSpice TagCloud you can visualize a category overview graphically. You can generate clouds and lists with this extension. The representation is hierarchical, out of the most used category. These categories are shown larger or otherwise highlighted. ==Embed TagCloud== {{BSExtensionInfo |status=stable |developer=HalloWelt |type=BlueSpice |edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |compatible=BlueSpice |category=Rich Articles |features= '''TagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing the most popular search terms or pages. A tag is provided to integrateembed 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> ==Permissions== Every user who has reading permissions can see the TagCloud. Every user who has editing permissions, can create a TagCloud. ==Parameters== The TagCloud can be configured using various parameters: {| class="contenttable" style="width: 869px; height: 202px;" border="0" in a content page. The tag <code><nowiki><bs:tagcloud /></nowiki></code> can be inserted as Wikitext or using the ''Insert > Magic word'' menu in [[Reference:VisualEditor|VisualEditor.]] }} ===Configuration=== You can configure the following options: {| class="reference wikitable" |- !|'''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 |} ==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]] [[Category:BlueSpice pro]] [[en:{{FULLPAGENAME}}]][[de: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 | |}
(35 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | == | + | {{BSExtensionInfo |
− | + | |status=stable | |
+ | |developer=HalloWelt | ||
+ | |type=BlueSpice | ||
+ | |edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud | ||
+ | |compatible=BlueSpice | ||
+ | |category=Rich Articles | ||
+ | |features= | ||
+ | '''TagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing the most popular search terms or pages. | ||
− | + | A tag is provided to embed the configurable TagCloud in a content page. The tag <code><nowiki><bs:tagcloud /></nowiki></code> can be inserted as Wikitext or using the ''Insert > Magic word'' menu in [[Reference:VisualEditor|VisualEditor.]] | |
− | + | }} | |
− | + | ===Configuration=== | |
− | A tag is provided to | + | You can configure the following options: |
− | + | {| class="reference wikitable" | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | == | ||
− | |||
− | |||
− | {| class=" | ||
|- | |- | ||
!|'''Parameter''' | !|'''Parameter''' | ||
Line 29: | Line 23: | ||
|- | |- | ||
||'''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 |
|- | |- | ||
||'''count''' | ||'''count''' | ||
|| | || | ||
− | defines | + | defines how many categories are shown |
|| | || | ||
Line 59: | Line 44: | ||
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 | ||
+ | | | ||
+ | |} |