Discussion

Difference between revisions of "AutoDoc:BlueSpiceReview"

m (1 revision imported)
hw>Unknown user

DescriptionMsg[edit source]

Adds workflow functionality to pages

IntegratesInto[edit source]

  • BlueSpiceFoundation
  • BlueSpiceExtendedStatistics
  • BlueSpicePrivacy
  • BlueSpiceSMWConnector
  • BlueSpiceReview

SpecialPages[edit source]

  • Review
  • ReviewTemplateManager

Permissions[edit source]

Permissions

Name Description Role
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
workflow-delete Delete reviews admin, editor, maintenanceadmin, reviewer, structuremanager
workflow-edit-others ⧼right-workflow-edit-others⧽ admin
workflow-delete-others ⧼right-workflow-delete-others⧽ admin

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
ReviewCheckOwner true
ReviewUseAdditionalPermissions false
ReviewLockdownGroups array ( 0 => 'user', )
ReviewProcessDefaultType 'default'
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', )
ReviewWriteToHistory true
ReviewFinishedReminderDelay 168

ApiModules[edit source]

API Modules[edit source]

  • bs-reviewpossiblereviewers-store
  • bs-review-tasks
  • bs-reviewtemplate-store
  • bs-reviewworkflowhistory-store
  • bs-reviewoverview-store

Hooks[edit source]

Hooks[edit source]

  • LoadExtensionSchemaUpdates
  • BSUsageTrackerRegisterCollectors
  • RevisionAjaxReviewBeforeParams
  • SkinTemplateNavigation
  • ArticleDeleteComplete
  • BSFlaggedRevsConnectorCollectFlagInfo
  • BeforePageDisplay
  • SkinTemplateOutputPageBeforeExec
  • UnitTestsList
  • GetPreferences
  • PageHistoryPager::getQueryInfo
  • PageHistoryLineEnding
==DescriptionMsg==
        
        {{AutoDocDescriptionMsg
        
        |name = BlueSpiceReview
        
        |desc = {{int:bs-review-desc
        
        }}
        
        }}
        
        ==IntegratesInto==
        
        {{AutoDocIntegratesInto
        
        |into = {{AutoDocListItem
        
        |item = BlueSpiceFoundation
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceExtendedStatistics
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpicePrivacy
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceSMWConnector
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceReview
        
        }}
        
        }}
        
        ==SpecialPages==
        
        {{AutoDocSpecialPages
        
        |SpecialPages = {{AutoDocCallback
        
        |name = Review
        
        |callback = BlueSpice\Review\Special\Review
        
        }}
        
        {{AutoDocCallback
        
        |name = ReviewTemplateManager
        
        |callback = BlueSpice\Review\Special\ReviewTemplateManager
        
        }}
        
        }}
        
        ==Permissions==
        
        {{AutoDocPermissions
        
        |permissions = {{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
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = workflow-delete
        
        |type = namespace
        
        |roles = admin,editor,maintenanceadmin,reviewer,structuremanager
        
        |desc = {{int:right-workflow-delete
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = workflow-edit-others
        
        |type = namespace
        
        |roles = admin
        
        |desc = {{int:right-workflow-edit-others
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = workflow-delete-others
        
        |type = namespace
        
        |roles = admin
        
        |desc = {{int:right-workflow-delete-others
        
        }}
        
        }}
        
        }}
        
        ==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 = ReviewCheckOwner
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = ReviewUseAdditionalPermissions
        
        |value = <nowiki>false</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = ReviewLockdownGroups
        
        |value = <nowiki>array (
        
          0 => 'user',
        
        )</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = ReviewProcessDefaultType
        
        |value = <nowiki>'default'</nowiki>
        
        }}
        
        {{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 = ReviewWriteToHistory
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = ReviewFinishedReminderDelay
        
        |value = <nowiki>168</nowiki>
        
        }}
        
        }}
        
        ==ApiModules==
        
        {{AutoDocApiModules
        
        |APIModules = {{AutoDocCallback
        
        |name = bs-reviewpossiblereviewers-store
        
        |callback = BSApiReviewPossibleReviewersStore
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-review-tasks
        
        |callback = BSApiReviewTasks
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-reviewtemplate-store
        
        |callback = BlueSpice\Review\Api\Store\ReviewTemplate
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-reviewworkflowhistory-store
        
        |callback = BlueSpice\Review\Api\Store\WorkflowHistory
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-reviewoverview-store
        
        |callback = BlueSpice\Review\Api\Store\ReviewOverview
        
        }}
        
        }}
        
        ==Hooks==
        
        {{AutoDocHooks
        
        |Hooks = {{AutoDocCallback
        
        |name = LoadExtensionSchemaUpdates
        
        |callback = \BlueSpice\Review\Hook\LoadExtensionSchemaUpdates\AddReviewTables::callback,\BlueSpice\Review\Hook\LoadExtensionSchemaUpdates\AddPostDatabaseUpdateMaintenance::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSUsageTrackerRegisterCollectors
        
        |callback = Review::onBSUsageTrackerRegisterCollectors
        
        }}
        
        {{AutoDocCallback
        
        |name = RevisionAjaxReviewBeforeParams
        
        |callback = Review::onRevisionAjaxReviewBeforeParams
        
        }}
        
        {{AutoDocCallback
        
        |name = SkinTemplateNavigation
        
        |callback = Review::onSkinTemplateNavigation
        
        }}
        
        {{AutoDocCallback
        
        |name = ArticleDeleteComplete
        
        |callback = \BlueSpice\Review\Hook\ArticleDeleteComplete\DeleteOrphanedReviewProcess::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSFlaggedRevsConnectorCollectFlagInfo
        
        |callback = Review::onBSFlaggedRevsConnectorCollectFlagInfo
        
        }}
        
        {{AutoDocCallback
        
        |name = BeforePageDisplay
        
        |callback = Review::onBeforePageDisplay
        
        }}
        
        {{AutoDocCallback
        
        |name = SkinTemplateOutputPageBeforeExec
        
        |callback = \BlueSpice\Review\Hook\SkinTemplateOutputPageBeforeExec\AddToGlobalActions::callback,\BlueSpice\Review\Hook\SkinTemplateOutputPageBeforeExec\AddPersonalToolsLink::callback,\BlueSpice\Review\Hook\SkinTemplateOutputPageBeforeExec\AddFlyout::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = UnitTestsList
        
        |callback = Review::onUnitTestsList
        
        }}
        
        {{AutoDocCallback
        
        |name = GetPreferences
        
        |callback = \BlueSpice\Review\Hook\GetPreferences\EmailNotifyOwner::callback,\BlueSpice\Review\Hook\GetPreferences\EmailNotifyReviewer::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = PageHistoryPager::getQueryInfo
        
        |callback = \BlueSpice\Review\Hook\PageHistoryGetQueryInfo\AddReviewHistory::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = PageHistoryLineEnding
        
        |callback = \BlueSpice\Review\Hook\PageHistoryLineEnding\AddReviewHistory::callback
        
        }}
        
        }}
(No difference)
Retrieved from "https://bs3-en.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceReview&oldid=26238"

Attachments

Discussions