AutoDoc:BlueSpicePlayer and Reference:BlueSpiceSocialTopics: Difference between pages

(Difference between pages)
hw>Unknown user
No edit summary
 
m (1 revision imported)
 
Line 1: Line 1:
==DescriptionMsg==
{{BSExtensionInfo
{{AutoDocDescriptionMsg
|status=stable
|name = BlueSpicePlayer
|developer=HalloWelt
|desc = {{int:bs-player-extension-description
|type=BlueSpice
}}
|edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
}}
|compatible=BlueSpice
==License==
|category=Communication
{{AutoDocLicense
|features='''SocialTopics''' provides the SocialEntity types ''discussion'' and ''topic''.
|name = GPL-3.0-only
{{Box Note|boxtype=warning|Note text=Pages in the namespaces ''SocialEntity'' and ''User'' are indexed by search engines by default until prior to version 3.1.13. If you run a public wiki with an earlier version, you should [https://www.mediawiki.org/wiki/Help:Controlling_search_engine_indexing exclude these namespaces from being searchable] unless you want these pages to be indexed by public search engines.}}
}}
At the bottom of each content page, the social entities associated with the page are displayed, filtered by the ''topic'' type.
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = 1.31.0
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-showtime-pref-autostart
|value = <nowiki>false</nowiki>
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = ShowtimePrefHeight
|value = <nowiki>240</nowiki>
}}
{{AutoDocOption
|name = ShowtimePrefWidth
|value = <nowiki>320</nowiki>
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSInsertMagicAjaxGetData BSInsertMagicAjaxGetData]
|callback = \BlueSpice\Player\Hook\BSInsertMagicAjaxGetData\AddDescription::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Player\Hook\GetPreferences\Autostart::callback
}}
}}


The discussion page is completely replaced by the page view of the SocialEntity type ''discussion''. It displays a timeline that lists the social entities of type ''topic'' that belong to this discussion. In addition, free text can be entered at the beginning of the discussion page just like on a standard MediaWiki discussion page.}}
===Entry fields for dialogs===
{| class="reference wikitable"
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Name
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |DescriptionD
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Type
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Default value
|-
|discussiontitleid
|ID of the page to which the discussion topic  belongs
|integer/choice field
|current discussion page
|-
|topictitle
|Title of the discussion topic
|str
|empty
|-
|text
|Content of the discussion topic
|WikiText or reduced VisualEditor; reduzierter parser scope
|empty
|}
===Behavior switch===
<br />
{| class="reference wikitable"
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Name
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Beschreibung
|-
|<nowiki>__NODISCUSSION__</nowiki>
|Diskussionen werden auf der seite ausgeblendet
|}
===Configuration===
{| class="reference wikitable"
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Name
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Description
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Type
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Default value
! class="headerSort" role="columnheader button" title="Aufsteigend sortieren" tabindex="0" |Scope
|-
|''bsg''SocialTopicsTalkPageAutoCreate
|Discussion pages are automatically created with a new page. Activating this option si not recommended, because a lot of pages will be created.
|bool
|false
|ConfigManager
|-
|''bsg''SocialTopicsTimelineAfterContentNamespaceBlackList
|Determines in what namespaces the timeline with the latest discussion topics should not be shown.
|array
|[]
|LocalSettings.php
|-
|''bsg''SocialTopicsTimelineAfterContentShow
|Determines if the timeline with the latest discussion topics should be shown at the bottom of a page.
|bool
|true
|LocalSettings.php
|}

Revision as of 12:34, 20 December 2021

Extension: BlueSpiceSocialTopics

all extensions

Overview
Description:

Topic and discussion entities for BlueSpiceSocial

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

Features

SocialTopics provides the SocialEntity types discussion and topic. Template:Box Note At the bottom of each content page, the social entities associated with the page are displayed, filtered by the topic type.

The discussion page is completely replaced by the page view of the SocialEntity type discussion. It displays a timeline that lists the social entities of type topic that belong to this discussion. In addition, free text can be entered at the beginning of the discussion page just like on a standard MediaWiki discussion page.

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

BlueSpiceSocial: 4.1

Integrates into

Special pages

  • Topics

Permissions

Name Description Role
social-topics Create and edit topics commenter, editor, admin, maintenanceadmin
social-topics-comment Comment on topics commenter, editor, admin, maintenanceadmin

Configuration

Name Value
SocialTopicsTalkPageAutoCreate false
SocialTopicsTimelineAfterContentNamespaceBlackList array ( )
SocialTopicsTimelineAfterContentShow true

User options

Name Value
bs-social-topics-skipcreatedialog true

API Modules

  • bs-socialtopics-tasks

Hooks

Entry fields for dialogs

Name DescriptionD Type Default value
discussiontitleid ID of the page to which the discussion topic belongs integer/choice field current discussion page
topictitle Title of the discussion topic str empty
text Content of the discussion topic WikiText or reduced VisualEditor; reduzierter parser scope empty

Behavior switch


Name Beschreibung
__NODISCUSSION__ Diskussionen werden auf der seite ausgeblendet

Configuration

Name Description Type Default value Scope
bsgSocialTopicsTalkPageAutoCreate Discussion pages are automatically created with a new page. Activating this option si not recommended, because a lot of pages will be created. bool false ConfigManager
bsgSocialTopicsTimelineAfterContentNamespaceBlackList Determines in what namespaces the timeline with the latest discussion topics should not be shown. array [] LocalSettings.php
bsgSocialTopicsTimelineAfterContentShow Determines if the timeline with the latest discussion topics should be shown at the bottom of a page. bool true LocalSettings.php

Discussions