You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceSocial"
m (1 revision imported) |
m (1 revision imported) |
Contents
DescriptionMsg[edit source]
Base extension for social extensions
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundationBlueSpiceExtendedSearch: ~33.2
BlueSpiceExtendedSearchBlueSpiceFoundation: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpiceExtendedSearch
- BlueSpicePrivacy
SpecialPages[edit source]
- Activities
- Timeline
- Activities
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| social-deleteothers | Delete others entries | admin, maintenanceadmin |
| social-editothers | Edit others entries | admin, maintenanceadmin |
| social-source | View the source page | maintenanceadmin |
DefaultUserOptions[edit source]
User options[edit source]
| Name | Value |
|---|---|
| bs-social-datedisplaymode | 'age' |
| bs-social-warnonleave | true |
| echo-subscriptions-web-bs-social-entity-cat | 1 |
ApiModules[edit source]
API Modules[edit source]
- bs-social-tasks
- bs-socialtitlequerysocialentity-store
- bs-socialentitysocialtitlequery-store
Hooks[edit source]
Hooks[edit source]
- BeforePageDisplayBSEntityDeleteComplete
- BSUEModulePDFBeforeAddingStyleBlocksBSEntitySaveComplete
- GetPreferencesBSRSSFeederBeforeGetRecentChanges
- HtmlPageLinkRendererEndBSUEModulePDFBeforeAddingStyleBlocks
- BeforeEchoEventInsertSendWatchlistEmailNotification
- BeforePageDisplayBSEntitySaveComplete
- ChangesListSpecialPageStructuredFiltersBSEntityDeleteComplete
- GetPreferencesSkinBuildSidebar
- HtmlPageLinkRendererEndBSRSSFeederBeforeGetRecentChanges
- SendWatchlistEmailNotificationChangesListSpecialPageStructuredFilters
- SkinBuildSidebar
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceSocial
|desc = {{int:bs-social-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = ~11.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundationBlueSpiceExtendedSearch
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceExtendedSearchBlueSpiceFoundation
|version = ~33.2
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundation
}}
{{AutoDocListItem
|item = BlueSpiceExtendedSearch
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = TimelineActivities
|callback = \BlueSpice\Social\Special\TimelineActivities
}}
{{AutoDocCallback
|name = ActivitiesTimeline
|callback = \BlueSpice\Social\Special\ActivitiesTimeline
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = social-deleteothers
|type = namespace
|roles = admin, maintenanceadmin
|desc = {{int:right-social-deleteothers
}}
}}
{{AutoDocPermission
|name = social-editothers
|type = namespace
|roles = admin, maintenanceadmin
|desc = {{int:right-social-editothers
}}
}}
{{AutoDocPermission
|name = social-source
|type = namespace
|roles = maintenanceadmin
|desc = {{int:right-social-source
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-social-datedisplaymode
|value = <nowiki>'age'</nowiki>
}}
{{AutoDocOption
|name = bs-social-warnonleave
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = echo-subscriptions-web-bs-social-entity-cat
|value = <nowiki>1</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-social-tasks
|callback = \BlueSpice\Social\Api\Task\Entities
}}
{{AutoDocCallback
|name = bs-socialtitlequerysocialentity-store
|callback = \BlueSpice\Social\Api\Store\TitleQueryEntity
}}
{{AutoDocCallback
|name = bs-socialentitysocialtitlequery-store
|callback = \BlueSpice\Social\Api\Store\EntityTitleQuery
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/BSEntityDeleteComplete BSEntityDeleteComplete]
|callback = \BlueSpice\Social\Hook\BeforePageDisplay\AddResourcesBSEntityDeleteComplete\NotifyUsers::callback,\BlueSpice\Social\Hook\BeforePageDisplay\EntitySpawnerUserPermissions::callback,\BlueSpice\Social\Hook\BeforePageDisplay\AddSourceBacklLink::callback
}}
{{AutoDocCallback
|name = BSUEModulePDFBeforeAddingStyleBlocks
|callback = \BlueSpice\Social\Extension::onBSUEModulePDFBeforeAddingStyleBlocks
}}
{{AutoDocCallback
|name = GetPreferences
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntitySaveComplete BSEntitySaveComplete]
|callback = \BlueSpice\Social\Hook\BSEntitySaveComplete\NotifyUsers::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSRSSFeederBeforeGetRecentChanges BSRSSFeederBeforeGetRecentChanges]
|callback = \BlueSpice\Social\Hook\GetPreferences\AddTimeDisplayModeBSRSSFeederBeforeGetRecentChanges\RCRemoveSocial::callback,\BlueSpice\Social\Hook\GetPreferences\AddWarnOnLeave::callback
}}
{{AutoDocCallback
|name = HtmlPageLinkRendererEnd
|callback = \BlueSpice\Social\Hook\HtmlPageLinkRendererEnd\MaskEntityLinks::callback
}}
{{AutoDocCallback
|name = BeforeEchoEventInsert
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFBeforeAddingStyleBlocks BSUEModulePDFBeforeAddingStyleBlocks]
|callback = \BlueSpice\Social\Extension::onBSUEModulePDFBeforeAddingStyleBlocks
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforeEchoEventInsert BeforeEchoEventInsert]
|callback = \BlueSpice\Social\Hook\BeforeEchoEventInsert\DisableOtherNotificationsForEntityPages::callback
}}
{{AutoDocCallback
|name = SendWatchlistEmailNotification
|callback = \BlueSpice\Social\Extension::onSendWatchlistEmailNotification
}}
{{AutoDocCallback
|name = BSEntitySaveComplete
[https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Social\Hook\BeforePageDisplay\AddResources::callback, \BlueSpice\Social\Hook\BeforePageDisplay\EntitySpawnerUserPermissions::callback, \BlueSpice\Social\Hook\BeforePageDisplay\AddSourceBacklLink::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChangesListSpecialPageStructuredFilters ChangesListSpecialPageStructuredFilters]
|callback = \BlueSpice\Social\Hook\BSEntitySaveComplete\NotifyUsersChangesListSpecialPageStructuredFilters\AddSocialEntityFilter::callback
}}
{{AutoDocCallback
|name = BSEntityDeleteComplete
[https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Social\Hook\BSEntityDeleteComplete\NotifyUsersGetPreferences\AddTimeDisplayMode::callback
}}
{{AutoDocCallback
|name = SkinBuildSidebar
, \BlueSpice\Social\Hook\GetPreferences\AddWarnOnLeave::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/HtmlPageLinkRendererEnd HtmlPageLinkRendererEnd]
|callback = \BlueSpice\Social\Hook\SkinBuildSidebar\AddTimelineNavigationItemHtmlPageLinkRendererEnd\MaskEntityLinks::callback
}}
{{AutoDocCallback
|name = BSRSSFeederBeforeGetRecentChanges
|callback = \BlueSpice\Social\Hook\BSRSSFeederBeforeGetRecentChanges\RCRemoveSocial::callback
}}
{{AutoDocCallback
|name = ChangesListSpecialPageStructuredFilters
[https://www.mediawiki.org/wiki/Manual:Hooks/SendWatchlistEmailNotification SendWatchlistEmailNotification]
|callback = \BlueSpice\Social\Extension::onSendWatchlistEmailNotification
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinBuildSidebar SkinBuildSidebar]
|callback = \BlueSpice\Social\Hook\ChangesListSpecialPageStructuredFilters\AddSocialEntityFilterSkinBuildSidebar\AddTimelineNavigationItem::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-social-desc | |desc = {{int:bs-social-desc | ||
}} | }} | ||
| + | }} | ||
| + | ==License== | ||
| + | {{AutoDocLicense | ||
| + | |name = GPL-3.0-only | ||
}} | }} | ||
==Requirements== | ==Requirements== | ||
| Line 9: | Line 13: | ||
|mediawiki = {{AutoDocVersion | |mediawiki = {{AutoDocVersion | ||
|name = MediaWiki | |name = MediaWiki | ||
| − | |version = | + | |version = 1.31 |
}} | }} | ||
|extensions = {{AutoDocVersion | |extensions = {{AutoDocVersion | ||
| − | |name = | + | |name = BlueSpiceExtendedSearch |
| − | |version = | + | |version = 3.2 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
| − | |name = | + | |name = BlueSpiceFoundation |
| − | |version = | + | |version = 3.2 |
}} | }} | ||
}} | }} | ||
| Line 23: | Line 27: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |||
| − | |||
| − | |||
|item = BlueSpiceExtendedSearch | |item = BlueSpiceExtendedSearch | ||
}} | }} | ||
| Line 35: | Line 36: | ||
{{AutoDocSpecialPages | {{AutoDocSpecialPages | ||
|SpecialPages = {{AutoDocCallback | |SpecialPages = {{AutoDocCallback | ||
| + | |name = Activities | ||
| + | |callback = \BlueSpice\Social\Special\Activities | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
|name = Timeline | |name = Timeline | ||
|callback = \BlueSpice\Social\Special\Timeline | |callback = \BlueSpice\Social\Special\Timeline | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 48: | Line 49: | ||
|name = social-deleteothers | |name = social-deleteothers | ||
|type = namespace | |type = namespace | ||
| − | |roles = admin,maintenanceadmin | + | |roles = admin, maintenanceadmin |
|desc = {{int:right-social-deleteothers | |desc = {{int:right-social-deleteothers | ||
}} | }} | ||
| Line 55: | Line 56: | ||
|name = social-editothers | |name = social-editothers | ||
|type = namespace | |type = namespace | ||
| − | |roles = admin,maintenanceadmin | + | |roles = admin, maintenanceadmin |
|desc = {{int:right-social-editothers | |desc = {{int:right-social-editothers | ||
}} | }} | ||
| Line 87: | Line 88: | ||
|name = bs-social-tasks | |name = bs-social-tasks | ||
|callback = \BlueSpice\Social\Api\Task\Entities | |callback = \BlueSpice\Social\Api\Task\Entities | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = bs-socialentity-store | ||
| + | |callback = \BlueSpice\Social\Api\Store\Entity | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
|name = bs-socialtitlequery-store | |name = bs-socialtitlequery-store | ||
|callback = \BlueSpice\Social\Api\Store\TitleQuery | |callback = \BlueSpice\Social\Api\Store\TitleQuery | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 100: | Line 101: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntityDeleteComplete BSEntityDeleteComplete] |
| − | |callback = \BlueSpice\Social\Hook\ | + | |callback = \BlueSpice\Social\Hook\BSEntityDeleteComplete\NotifyUsers::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntitySaveComplete BSEntitySaveComplete] |
| − | |callback = \BlueSpice\Social\ | + | |callback = \BlueSpice\Social\Hook\BSEntitySaveComplete\NotifyUsers::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSRSSFeederBeforeGetRecentChanges BSRSSFeederBeforeGetRecentChanges] |
| − | |callback = \BlueSpice\Social\Hook\ | + | |callback = \BlueSpice\Social\Hook\BSRSSFeederBeforeGetRecentChanges\RCRemoveSocial::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFBeforeAddingStyleBlocks BSUEModulePDFBeforeAddingStyleBlocks] |
| − | |callback = \BlueSpice\Social\ | + | |callback = \BlueSpice\Social\Extension::onBSUEModulePDFBeforeAddingStyleBlocks |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BeforeEchoEventInsert | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforeEchoEventInsert BeforeEchoEventInsert] |
|callback = \BlueSpice\Social\Hook\BeforeEchoEventInsert\DisableOtherNotificationsForEntityPages::callback | |callback = \BlueSpice\Social\Hook\BeforeEchoEventInsert\DisableOtherNotificationsForEntityPages::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = \BlueSpice\Social\ | + | |callback = \BlueSpice\Social\Hook\BeforePageDisplay\AddResources::callback, \BlueSpice\Social\Hook\BeforePageDisplay\EntitySpawnerUserPermissions::callback, \BlueSpice\Social\Hook\BeforePageDisplay\AddSourceBacklLink::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChangesListSpecialPageStructuredFilters ChangesListSpecialPageStructuredFilters] |
| − | |callback = \BlueSpice\Social\Hook\ | + | |callback = \BlueSpice\Social\Hook\ChangesListSpecialPageStructuredFilters\AddSocialEntityFilter::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences] |
| − | |callback = \BlueSpice\Social\Hook\ | + | |callback = \BlueSpice\Social\Hook\GetPreferences\AddTimeDisplayMode::callback, \BlueSpice\Social\Hook\GetPreferences\AddWarnOnLeave::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/HtmlPageLinkRendererEnd HtmlPageLinkRendererEnd] |
| − | |callback = \BlueSpice\Social\Hook\ | + | |callback = \BlueSpice\Social\Hook\HtmlPageLinkRendererEnd\MaskEntityLinks::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SendWatchlistEmailNotification SendWatchlistEmailNotification] |
| − | |callback = \BlueSpice\Social\ | + | |callback = \BlueSpice\Social\Extension::onSendWatchlistEmailNotification |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinBuildSidebar SkinBuildSidebar] |
| − | |callback = \BlueSpice\Social\Hook\ | + | |callback = \BlueSpice\Social\Hook\SkinBuildSidebar\AddTimelineNavigationItem::callback |
}} | }} | ||
}} | }} | ||