Difference between revisions of "AutoDoc:BlueSpiceReview"
m (1 revision imported) |
hw>Unknown user |
Contents
DescriptionMsg[edit source]
Adds workflow functionality to pages
License[edit source]
GPL-3.0-only
IntegratesInto[edit source]
- BlueSpiceExtendedStatistics
- BlueSpicePrivacy
- BlueSpiceReview
- BlueSpiceSMWConnector
SpecialPages[edit source]
- Review
- ReviewTemplateManager
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| workflow-delete | Delete reviews | admin, editor, maintenanceadmin, reviewer, structuremanager |
| workflow-delete-others | ⧼right-workflow-delete-others⧽ | admin |
| workflow-edit-others | ⧼right-workflow-edit-others⧽ | admin |
| workflowedit | Create and edit review | admin, editor, maintenanceadmin, reviewer, structuremanager |
| workflowlist | View the list of reviews | admin, editor, maintenanceadmin, reviewer |
| workflowview | Access the review interface | admin, author, editor, maintenanceadmin, reader, reviewer |
DefaultUserOptions[edit source]
User options[edit source]
| Name | Value |
|---|---|
| bs-review-pref-emailnotifyowner | true |
| bs-review-pref-emailnotifyreviewer | true |
| echo-subscriptions-web-bs-review-action-cat | 1 |
| echo-subscriptions-web-bs-review-assignment-cat | 1 |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| ReviewBlockActionsPermissionWhiteList | array ( 0 => 'read', 1 => 'workflowedit', 2 => 'workflowview', 3 => 'universalexport-export', 4 => 'uemodulebookpdf-export', 5 => 'uemodulepdf-export', 6 => 'uemodulepdfrecursive-export', 7 => 'uemodulepdfsubpages-export', 8 => 'pageassignable', 9 => 'pageassignments', 10 => 'workflow-delete', 11 => 'workflow-edit-others', 12 => 'workflow-delete-others', ) |
| ReviewCheckOwner | true |
| ReviewFinishedReminderDelay | 168 |
| ReviewLockdownGroups | array ( 0 => 'user', ) |
| ReviewProcessDefaultType | 'default' |
| ReviewUseAdditionalPermissions | false |
| ReviewWriteToHistory | true |
ApiModules[edit source]
API Modules[edit source]
- bs-review-tasks
- bs-reviewoverview-store
- bs-reviewpossiblereviewers-store
- bs-reviewtemplate-store
- bs-reviewworkflowhistory-store
Hooks[edit source]
Hooks[edit source]
- ArticleDeleteComplete
- BSFlaggedRevsConnectorCollectFlagInfo
- BSUsageTrackerRegisterCollectors
- BeforePageDisplay
- GetPreferences
- LoadExtensionSchemaUpdates
- PageHistoryLineEnding
- PageHistoryPager::getQueryInfo
- RevisionAjaxReviewBeforeParams
- SkinTemplateNavigation
- SkinTemplateOutputPageBeforeExec
- UnitTestsList
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceReview
|desc = {{int:bs-review-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceExtendedStatistics
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
{{AutoDocListItem
|item = BlueSpiceReview
}}
{{AutoDocListItem
|item = BlueSpiceSMWConnector
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = Review
|callback = BlueSpice\Review\Special\Review
}}
{{AutoDocCallback
|name = ReviewTemplateManager
|callback = BlueSpice\Review\Special\ReviewTemplateManager
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = workflow-delete
|type = namespace
|roles = admin, editor, maintenanceadmin, reviewer, structuremanager
|desc = {{int:right-workflow-delete
}}
}}
{{AutoDocPermission
|name = workflow-delete-others
|type = namespace
|roles = admin
|desc = {{int:right-workflow-delete-others
}}
}}
{{AutoDocPermission
|name = workflow-edit-others
|type = namespace
|roles = admin
|desc = {{int:right-workflow-edit-others
}}
}}
{{AutoDocPermission
|name = workflowedit
|type = namespace
|roles = admin, editor, maintenanceadmin, reviewer, structuremanager
|desc = {{int:right-workflowedit
}}
}}
{{AutoDocPermission
|name = workflowlist
|type = namespace
|roles = admin, editor, maintenanceadmin, reviewer
|desc = {{int:right-workflowlist
}}
}}
{{AutoDocPermission
|name = workflowview
|type = namespace
|roles = admin, author, editor, maintenanceadmin, reader, reviewer
|desc = {{int:right-workflowview
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-review-pref-emailnotifyowner
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = bs-review-pref-emailnotifyreviewer
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = echo-subscriptions-web-bs-review-action-cat
|value = <nowiki>1</nowiki>
}}
{{AutoDocOption
|name = echo-subscriptions-web-bs-review-assignment-cat
|value = <nowiki>1</nowiki>
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = ReviewBlockActionsPermissionWhiteList
|value = <nowiki>array (
0 => 'read',
1 => 'workflowedit',
2 => 'workflowview',
3 => 'universalexport-export',
4 => 'uemodulebookpdf-export',
5 => 'uemodulepdf-export',
6 => 'uemodulepdfrecursive-export',
7 => 'uemodulepdfsubpages-export',
8 => 'pageassignable',
9 => 'pageassignments',
10 => 'workflow-delete',
11 => 'workflow-edit-others',
12 => 'workflow-delete-others',
)</nowiki>
}}
{{AutoDocOption
|name = ReviewCheckOwner
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ReviewFinishedReminderDelay
|value = <nowiki>168</nowiki>
}}
{{AutoDocOption
|name = ReviewLockdownGroups
|value = <nowiki>array (
0 => 'user',
)</nowiki>
}}
{{AutoDocOption
|name = ReviewProcessDefaultType
|value = <nowiki>'default'</nowiki>
}}
{{AutoDocOption
|name = ReviewUseAdditionalPermissions
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = ReviewWriteToHistory
|value = <nowiki>true</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-review-tasks
|callback = BSApiReviewTasks
}}
{{AutoDocCallback
|name = bs-reviewoverview-store
|callback = BlueSpice\Review\Api\Store\ReviewOverview
}}
{{AutoDocCallback
|name = bs-reviewpossiblereviewers-store
|callback = BSApiReviewPossibleReviewersStore
}}
{{AutoDocCallback
|name = bs-reviewtemplate-store
|callback = BlueSpice\Review\Api\Store\ReviewTemplate
}}
{{AutoDocCallback
|name = bs-reviewworkflowhistory-store
|callback = BlueSpice\Review\Api\Store\WorkflowHistory
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDeleteComplete ArticleDeleteComplete]
|callback = \BlueSpice\Review\Hook\ArticleDeleteComplete\DeleteOrphanedReviewProcess::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSFlaggedRevsConnectorCollectFlagInfo BSFlaggedRevsConnectorCollectFlagInfo]
|callback = Review::onBSFlaggedRevsConnectorCollectFlagInfo
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUsageTrackerRegisterCollectors BSUsageTrackerRegisterCollectors]
|callback = Review::onBSUsageTrackerRegisterCollectors
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = Review::onBeforePageDisplay
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Review\Hook\GetPreferences\EmailNotifyOwner::callback, \BlueSpice\Review\Hook\GetPreferences\EmailNotifyReviewer::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\Review\Hook\LoadExtensionSchemaUpdates\AddReviewTables::callback, \BlueSpice\Review\Hook\LoadExtensionSchemaUpdates\AddPostDatabaseUpdateMaintenance::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageHistoryLineEnding PageHistoryLineEnding]
|callback = \BlueSpice\Review\Hook\PageHistoryLineEnding\AddReviewHistory::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageHistoryPager::getQueryInfo PageHistoryPager::getQueryInfo]
|callback = \BlueSpice\Review\Hook\PageHistoryGetQueryInfo\AddReviewHistory::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/RevisionAjaxReviewBeforeParams RevisionAjaxReviewBeforeParams]
|callback = Review::onRevisionAjaxReviewBeforeParams
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation SkinTemplateNavigation]
|callback = Review::onSkinTemplateNavigation
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = \BlueSpice\Review\Hook\SkinTemplateOutputPageBeforeExec\AddToGlobalActions::callback, \BlueSpice\Review\Hook\SkinTemplateOutputPageBeforeExec\AddPersonalToolsLink::callback, \BlueSpice\Review\Hook\SkinTemplateOutputPageBeforeExec\AddFlyout::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/UnitTestsList UnitTestsList]
|callback = Review::onUnitTestsList
}}
}}(No difference)
|