You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceDashboards"
m (1 revision imported) |
hw>Unknown user |
Contents
- 1 DescriptionMsg
- 2 Requirements License
- 3 IntegratesInto Requirements
- 4 SpecialPages
- 5 Permissions
- 6 DefaultUserOptions
- 7 ApiModules
- 8 Hooks
DescriptionMsg[edit source]
Provides dashboards for users and administrators
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
SpecialPages[edit source]
- AdminDashboard
- UserDashboard
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| dashboards-viewspecialpage-userdashboard | Access to the special page Special:UserDashboard | accountmanager, admin, author, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager |
DefaultUserOptions[edit source]
User options[edit source]
| Name | Value |
|---|---|
| bs-dashboards-userdashboardonlogo | false |
ApiModules[edit source]
API Modules[edit source]
- bs-dashboards-tasksstore
- bs-dashboards-storetasks
- bs-dashboards-widgets-tasks
Hooks[edit source]
Hooks[edit source]
- GetPreferencesBSDashboardsUserDashboardPortalConfig
- PersonalUrlsBSDashboardsUserDashboardPortalPortlets
- BeforePageDisplayBSDashboardsUserDashboardPortalConfig
- GetPreferences
- BSDashboardsUserDashboardPortalPortlets
- LoadExtensionSchemaUpdates
- PersonalUrls
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceDashboards
|desc = {{int:bs-dashboards-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = ~11.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = ~33.2
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundation
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = AdminDashboard
|callback = SpecialAdminDashboard
}}
{{AutoDocCallback
|name = UserDashboard
|callback = SpecialUserDashboard
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = dashboards-viewspecialpage-userdashboard
|type = global
|roles = accountmanager, admin, author, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager
|desc = {{int:right-dashboards-viewspecialpage-userdashboard
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-dashboards-userdashboardonlogo
|value = <nowiki>false</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-dashboards-tasksstore
|callback = BSApiDashboardTasksBSApiDashboardStore
}}
{{AutoDocCallback
|name = bs-dashboards-storetasks
|callback = BSApiDashboardStoreBSApiDashboardTasks
}}
{{AutoDocCallback
|name = bs-dashboards-widgets-tasks
|callback = BSApiDashboardWidgetsTasks
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = GetPreferences
[https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsUserDashboardPortalConfig BSDashboardsUserDashboardPortalConfig]
|callback = \BlueSpice\Dashboards\Hook\GetPreferences\AddUserDashboardOnLogoUserDashboardPortalConfig\AddConfig::callback
}}
{{AutoDocCallback
|name = PersonalUrls
[https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsUserDashboardPortalPortlets BSDashboardsUserDashboardPortalPortlets]
|callback = \BlueSpice\Dashboards\Hook\PersonalUrls\AddDashboardUrlsUserDashboardPortalPortlets\AddPortlets::callback
}}
{{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Dashboards\Hook\BeforePageDisplay\AddModules::callback
}}
{{AutoDocCallback
|name = BSDashboardsUserDashboardPortalConfig
[https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Dashboards\Hook\UserDashboardPortalConfig\AddConfigGetPreferences\AddUserDashboardOnLogo::callback
}}
{{AutoDocCallback
|name = BSDashboardsUserDashboardPortalPortlets
[https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\Dashboards\Hook\UserDashboardPortalPortlets\AddPortletsLoadExtensionSchemaUpdates\AddDashboardConfigsTable::callback
}}
{{AutoDocCallback
|name = LoadExtensionSchemaUpdates
, \BlueSpice\Dashboards\Hook\LoadExtensionSchemaUpdates\AddClearConfigPostDatabaseUpdateMaintenance::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PersonalUrls PersonalUrls]
|callback = \BlueSpice\Dashboards\Hook\LoadExtensionSchemaUpdates\AddDashboardConfigsTablePersonalUrls\AddDashboardUrls::callback,\BlueSpice\Dashboards\Hook\LoadExtensionSchemaUpdates\AddClearConfigPostDatabaseUpdateMaintenance::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-dashboards-desc | |desc = {{int:bs-dashboards-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 = BlueSpiceFoundation | |name = BlueSpiceFoundation | ||
| − | |version = | + | |version = 3.2 |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 38: | Line 36: | ||
|name = dashboards-viewspecialpage-userdashboard | |name = dashboards-viewspecialpage-userdashboard | ||
|type = global | |type = global | ||
| − | |roles = accountmanager,admin,author,commenter,editor,maintenanceadmin,reader,reviewer,structuremanager | + | |roles = accountmanager, admin, author, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager |
|desc = {{int:right-dashboards-viewspecialpage-userdashboard | |desc = {{int:right-dashboards-viewspecialpage-userdashboard | ||
}} | }} | ||
| Line 53: | Line 51: | ||
{{AutoDocApiModules | {{AutoDocApiModules | ||
|APIModules = {{AutoDocCallback | |APIModules = {{AutoDocCallback | ||
| + | |name = bs-dashboards-store | ||
| + | |callback = BSApiDashboardStore | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
|name = bs-dashboards-tasks | |name = bs-dashboards-tasks | ||
|callback = BSApiDashboardTasks | |callback = BSApiDashboardTasks | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| Line 68: | Line 66: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsUserDashboardPortalConfig BSDashboardsUserDashboardPortalConfig] |
| − | |callback = \BlueSpice\Dashboards\Hook\ | + | |callback = \BlueSpice\Dashboards\Hook\UserDashboardPortalConfig\AddConfig::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSDashboardsUserDashboardPortalPortlets BSDashboardsUserDashboardPortalPortlets] |
| − | |callback = \BlueSpice\Dashboards\Hook\ | + | |callback = \BlueSpice\Dashboards\Hook\UserDashboardPortalPortlets\AddPortlets::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BeforePageDisplay | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
|callback = \BlueSpice\Dashboards\Hook\BeforePageDisplay\AddModules::callback | |callback = \BlueSpice\Dashboards\Hook\BeforePageDisplay\AddModules::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences] |
| − | |callback = \BlueSpice\Dashboards\Hook\ | + | |callback = \BlueSpice\Dashboards\Hook\GetPreferences\AddUserDashboardOnLogo::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates] |
| − | |callback = \BlueSpice\Dashboards\Hook\ | + | |callback = \BlueSpice\Dashboards\Hook\LoadExtensionSchemaUpdates\AddDashboardConfigsTable::callback, \BlueSpice\Dashboards\Hook\LoadExtensionSchemaUpdates\AddClearConfigPostDatabaseUpdateMaintenance::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PersonalUrls PersonalUrls] |
| − | |callback = \BlueSpice\Dashboards\Hook\ | + | |callback = \BlueSpice\Dashboards\Hook\PersonalUrls\AddDashboardUrls::callback |
}} | }} | ||
}} | }} | ||