AutoDoc:BlueSpiceRSSFeeder and Reference:BlueSpiceTagCloud: Difference between pages

(Difference between pages)
m (1 revision imported)
 
m (1 revision imported)
 
Line 1: Line 1:
==DescriptionMsg==
{{BSExtensionInfo
{{AutoDocDescriptionMsg
|status=stable
|name = BlueSpiceRSSFeeder
|developer=HalloWelt
|desc = {{int:bs-rssfeeder-desc
|type=BlueSpice
}}
|edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
}}
|compatible=BlueSpice
==License==
|category=Rich Articles
{{AutoDocLicense
|features=
|name = GPL-3.0-only
'''TagCloud''' displays a tag cloud based on categories or search terms. It is used for visualizing the most popular search terms or pages.
}}
 
==Requirements==
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.]]
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = 1.35.0
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = 4.0
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceRSSFeeder
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = RSSFeeder
|callback = SpecialRSSFeeder
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = RSSUrlNumberOfAllowedRedirects
|value = <nowiki>0</nowiki>
}}
{{AutoDocOption
|name = RSSUrlWhitelist
|value = <nowiki>array (
)</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-rss-standards-pages-store
|callback = ApiRSSStandardsPagesStore
}}
{{AutoDocCallback
|name = bs-rssfeeder-tasks
|callback = BSApiTasksRSSFeeder
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsAdminDashboardPortalConfig BSDashboardsAdminDashboardPortalConfig]
|callback = \BlueSpice\RSSFeeder\Hook\BSDashboardsAdminDashboardPortalConfig\AddConfigs::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsAdminDashboardPortalPortlets BSDashboardsAdminDashboardPortalPortlets]
|callback = \BlueSpice\RSSFeeder\Hook\BSDashboardsAdminDashboardPortalPortlets\AddPortlets::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsUserDashboardPortalConfig BSDashboardsUserDashboardPortalConfig]
|callback = \BlueSpice\RSSFeeder\Hook\BSDashboardsUserDashboardPortalConfig\AddConfigs::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsUserDashboardPortalPortlets BSDashboardsUserDashboardPortalPortlets]
|callback = \BlueSpice\RSSFeeder\Hook\BSDashboardsUserDashboardPortalPortlets\AddPortlets::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\RSSFeeder\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChameleonSkinTemplateOutputPageBeforeExec ChameleonSkinTemplateOutputPageBeforeExec]
|callback = \BlueSpice\RSSFeeder\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddToGlobalActions::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
|callback = common-user-interface
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/TitleReadWhitelist TitleReadWhitelist]
|callback = \BlueSpice\RSSFeeder\Hook\TitleReadWhitelist\AddRSSFeeder::callback
}}
}}
}}
===Configuration===
You can configure the following options:
{| class="reference wikitable"
|-
!|'''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
|
|}

Revision as of 12:34, 20 December 2021

Extension: BlueSpiceTagCloud

all extensions

Overview
Description:

Displays various tag clouds

State: stable Dependency: BlueSpice
Developer: HalloWelt License: GPL-3.0-only
Type: BlueSpice Category: Rich Articles
Edition: BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud Version: 4.1+

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

This information applies to BlueSpice 4. Technical details for BlueSpice Cloud can differ in some cases.

Requirements

  • MediaWiki: 1.36.0
  • BlueSpiceFoundation: 4.1

Integrates into

  • BlueSpiceTagCloud
  • BlueSpiceVisualEditorConnector
  • ContentDroplets

Special pages

Configuration

Name Value
TypeCategoryExclude array ( )

Hooks

Configuration

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
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

Discussions