You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceReadConfirmation"
m (1 revision imported) |
hw>Unknown user |
Contents
DescriptionMsg[edit source]
Extension to collect read confirmations for a page
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpicePrivacy
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| readconfirmationremind | Remind users that they have to confirm to have read the page | admin, maintenanceadmin |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| Mechanism | 'BlueSpice\\ReadConfirmation\\Mechanism\\NonMinorEdit::factory' |
ApiModules[edit source]
API Modules[edit source]
- bs-readconfirmation-tasks
Hooks[edit source]
Hooks[edit source]
- BSApiExtJSStoreBaseBeforePostProcessDataBSPageStoreDataProviderBeforeAppendRow
- BSApiNamespaceStoreMakeData
- BSPageAssignmentsManager
- BSPageAssignmentsOverviewLoadExtensionSchemaUpdates
- BSPageStoreDataProviderBeforeAppendRow
- BeforePageDisplayPageContentSaveComplete
- LoadExtensionSchemaUpdates
- NamespaceManager::getMetaFieldseditNamespace
- NamespaceManager::editNamespacegetMetaFields
- NamespaceManager::writeNamespaceConfiguration
- BSApiNamespaceStoreMakeDataPageContentSaveComplete
ExtensionFunctions[edit source]
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceReadConfirmation
|desc = {{int:bs-readconfirmation-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
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = readconfirmationremind
|type = global
|roles = admin, maintenanceadmin
|desc = {{int:right-readconfirmationremind
}}
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = Mechanism
|value = <nowiki>'BlueSpice\\ReadConfirmation\\Mechanism\\NonMinorEdit::factory'</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-readconfirmation-tasks
|callback = BSApiReadConfirmationTasks
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = BSApiExtJSStoreBaseBeforePostProcessData
[https://www.mediawiki.org/wiki/Manual:Hooks/BSApiExtJSStoreBaseBeforePostProcessData BSApiExtJSStoreBaseBeforePostProcessData]
|callback = ReadConfirmationPageAssignmentHooks::onBSApiExtJSStoreBaseBeforePostProcessData
}}
{{AutoDocCallback
|name = BSPageStoreDataProviderBeforeAppendRow
|callback = ReadConfirmationPageAssignmentHooks::onBSPageStoreDataProviderBeforeAppendRow
}}
{{AutoDocCallback
|name = BSPageAssignmentsManager
[https://www.mediawiki.org/wiki/Manual:Hooks/BSApiNamespaceStoreMakeData BSApiNamespaceStoreMakeData]
|callback = ReadConfirmationHooks::onBSApiNamespaceStoreMakeData
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageAssignmentsManager BSPageAssignmentsManager]
|callback = ReadConfirmationPageAssignmentHooks::onBSPageAssignmentsSpecialPages
}}
{{AutoDocCallback
|name = BSPageAssignmentsOverview
[https://www.mediawiki.org/wiki/Manual:Hooks/BSPageAssignmentsOverview BSPageAssignmentsOverview]
|callback = ReadConfirmationPageAssignmentHooks::onBSPageAssignmentsSpecialPages
}}
{{AutoDocCallback
|name = LoadExtensionSchemaUpdates
|callback = \BlueSpice\ReadConfirmation\Hook\LoadExtensionSchemaUpdates\AddReadConfirmationDatabase::callback
}}
{{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/BSPageStoreDataProviderBeforeAppendRow BSPageStoreDataProviderBeforeAppendRow]
|callback = ReadConfirmationPageAssignmentHooks::onBSPageStoreDataProviderBeforeAppendRow
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\ReadConfirmation\Hook\BeforePageDisplay\AddManagePageAssignmentsIntegration::callback, \BlueSpice\ReadConfirmation\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = PageContentSaveComplete
|callback = ReadConfirmationHooks::onPageContentSaveComplete
}}
{{AutoDocCallback
|name = NamespaceManager::getMetaFields
|callback = ReadConfirmationHooks::onNamespaceManager_getMetaFields
}}
{{AutoDocCallback
|name = NamespaceManager::editNamespace
|callback = ReadConfirmationHooks::onNamespaceManager_editNamespace
}}
{{AutoDocCallback
|name = NamespaceManager::writeNamespaceConfiguration
[https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\ReadConfirmation\Hook\LoadExtensionSchemaUpdates\AddReadConfirmationDatabase::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
|callback = ReadConfirmationHooks::onNamespaceManager_editNamespace
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields]
|callback = ReadConfirmationHooks::onNamespaceManager_getMetaFields
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration]
|callback = ReadConfirmationHooks::onNamespaceManager_writeNamespaceConfiguration
}}
{{AutoDocCallback
|name = BSApiNamespaceStoreMakeData
|callback = ReadConfirmationHooks::onBSApiNamespaceStoreMakeData[https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete]
|callback = ReadConfirmationHooks::onPageContentSaveComplete
}}
}}
==ExtensionFunctions==
{{AutoDocExtensionFunctions
|ExtensionFunctions = {{AutoDocListItem
|item = 0
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-readconfirmation-desc | |desc = {{int:bs-readconfirmation-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 19: | Line 23: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |||
| − | |||
| − | |||
|item = BlueSpicePrivacy | |item = BlueSpicePrivacy | ||
}} | }} | ||
| Line 30: | Line 31: | ||
|name = readconfirmationremind | |name = readconfirmationremind | ||
|type = global | |type = global | ||
| − | |roles = admin,maintenanceadmin | + | |roles = admin, maintenanceadmin |
|desc = {{int:right-readconfirmationremind | |desc = {{int:right-readconfirmationremind | ||
}} | }} | ||
| Line 52: | Line 53: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = BSApiExtJSStoreBaseBeforePostProcessData | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSApiExtJSStoreBaseBeforePostProcessData BSApiExtJSStoreBaseBeforePostProcessData] |
|callback = ReadConfirmationPageAssignmentHooks::onBSApiExtJSStoreBaseBeforePostProcessData | |callback = ReadConfirmationPageAssignmentHooks::onBSApiExtJSStoreBaseBeforePostProcessData | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSApiNamespaceStoreMakeData BSApiNamespaceStoreMakeData] |
| − | |callback = | + | |callback = ReadConfirmationHooks::onBSApiNamespaceStoreMakeData |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BSPageAssignmentsManager | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageAssignmentsManager BSPageAssignmentsManager] |
|callback = ReadConfirmationPageAssignmentHooks::onBSPageAssignmentsSpecialPages | |callback = ReadConfirmationPageAssignmentHooks::onBSPageAssignmentsSpecialPages | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BSPageAssignmentsOverview | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageAssignmentsOverview BSPageAssignmentsOverview] |
|callback = ReadConfirmationPageAssignmentHooks::onBSPageAssignmentsSpecialPages | |callback = ReadConfirmationPageAssignmentHooks::onBSPageAssignmentsSpecialPages | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageStoreDataProviderBeforeAppendRow BSPageStoreDataProviderBeforeAppendRow] |
| − | |callback = | + | |callback = ReadConfirmationPageAssignmentHooks::onBSPageStoreDataProviderBeforeAppendRow |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BeforePageDisplay | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = \BlueSpice\ReadConfirmation\Hook\BeforePageDisplay\AddManagePageAssignmentsIntegration::callback,\BlueSpice\ReadConfirmation\Hook\BeforePageDisplay\AddResources::callback | + | |callback = \BlueSpice\ReadConfirmation\Hook\BeforePageDisplay\AddManagePageAssignmentsIntegration::callback, \BlueSpice\ReadConfirmation\Hook\BeforePageDisplay\AddResources::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates] |
| − | |callback = | + | |callback = \BlueSpice\ReadConfirmation\Hook\LoadExtensionSchemaUpdates\AddReadConfirmationDatabase::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = NamespaceManager:: | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace] |
| − | |callback = ReadConfirmationHooks:: | + | |callback = ReadConfirmationHooks::onNamespaceManager_editNamespace |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = NamespaceManager:: | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields] |
| − | |callback = ReadConfirmationHooks:: | + | |callback = ReadConfirmationHooks::onNamespaceManager_getMetaFields |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = NamespaceManager::writeNamespaceConfiguration | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration] |
|callback = ReadConfirmationHooks::onNamespaceManager_writeNamespaceConfiguration | |callback = ReadConfirmationHooks::onNamespaceManager_writeNamespaceConfiguration | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete] |
| − | |callback = ReadConfirmationHooks:: | + | |callback = ReadConfirmationHooks::onPageContentSaveComplete |
}} | }} | ||
}} | }} | ||