You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceExpiry"
hw>Unknown user |
m (1 revision imported) |
Contents
DescriptionMsg[edit source]
Pages can be marked as expired.
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
BlueSpiceReminder: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpiceEchoConnector
- BlueSpiceReminder
- BlueSpiceSMWConnector
SpecialPages[edit source]
- Expiry
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| expirearticle | Expire pages | admin, editor, maintenanceadmin |
| expiry-delete | Remove expiration from pages | admin, editor, maintenanceadmin |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| ExpiryEnablePDFWatermark | true |
| ExpiryEnablePageWatermark | true |
| ExpiryEnablePrintWatermark | true |
ApiModules[edit source]
API Modules[edit source]
- bs-expiry-tasksstore
- bs-expiry-storetasks
Hooks[edit source]
Hooks[edit source]
- SkinTemplateNavigationBSUEModulePDFBeforeAddingStyleBlocks
- BSUEModulePDFgetPage
- BeforePageDisplaySkinTemplateOutputPageBeforeExec
- LoadExtensionSchemaUpdatesBSUEModulePDFgetPage
- SkinTemplateNavigationBSUEModulePDFBeforeAddingStyleBlocks
- SkinTemplateOutputPageBeforeExec
- wgQueryPages
- LoadExtensionSchemaUpdates
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceExpiry
|desc = {{int:bs-expiry-extension-description
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = ~11.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceReminder
|version = ~33.2
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundation
}}
{{AutoDocListItem
|item = BlueSpiceEchoConnector
}}
{{AutoDocListItem
|item = BlueSpiceReminder
}}
{{AutoDocListItem
|item = BlueSpiceSMWConnector
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = Expiry
|callback = SpecialExpiry
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = expirearticle
|type = namespace
|roles = admin, editor, maintenanceadmin
|desc = {{int:right-expirearticle
}}
}}
{{AutoDocPermission
|name = expiry-delete
|type = namespace
|roles = admin, editor, maintenanceadmin
|desc = {{int:right-expiry-delete
}}
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = ExpiryEnablePDFWatermark
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ExpiryEnablePageWatermark
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ExpiryEnablePrintWatermark
|value = <nowiki>true</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-expiry-tasksstore
|callback = ApiExpiryTasksApiExpiryStore
}}
{{AutoDocCallback
|name = bs-expiry-storetasks
|callback = ApiExpiryStoreApiExpiryTasks
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = SkinTemplateNavigation
[https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFBeforeAddingStyleBlocks BSUEModulePDFBeforeAddingStyleBlocks]
|callback = \BlueSpice\Expiry\Hook\SkinTemplateNavigation\AddExpiryCreateEntryBSUEModulePDFBeforeAddingStyleBlocks\AddPDFWatermarkStyles::callback
}}
{{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage]
|callback = \BlueSpice\Expiry\Hook\BSUEModulePDFgetPage\AddPDFWatermarkClass::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Expiry\Hook\BeforePageDisplay\AddResources::callback, \BlueSpice\Expiry\Hook\BeforePageDisplay\AddPageWatermark::callback, \BlueSpice\Expiry\Hook\BeforePageDisplay\AddPrintWatermark::callback
}}
{{AutoDocCallback
|name = SkinTemplateOutputPageBeforeExec
[https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\Expiry\Hook\SkinTemplateOutputPageBeforeExec\AddToGlobalActionsLoadExtensionSchemaUpdates\AddExpiryTable::callback,\BlueSpice\Expiry\Hook\SkinTemplateOutputPageBeforeExec\AddExpiredInfo::callback
}}
{{AutoDocCallback
|name = BSUEModulePDFgetPage
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation SkinTemplateNavigation]
|callback = \BlueSpice\Expiry\Hook\BSUEModulePDFgetPage\AddPDFWatermarkClassSkinTemplateNavigation\AddExpiryCreateEntry::callback
}}
{{AutoDocCallback
|name = BSUEModulePDFBeforeAddingStyleBlocks
[https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = \BlueSpice\Expiry\Hook\BSUEModulePDFBeforeAddingStyleBlocks\AddPDFWatermarkStylesSkinTemplateOutputPageBeforeExec\AddToGlobalActions::callback
}}
{{AutoDocCallback
|name = wgQueryPages
|callback = ExpiryHooks::onQueryPages
}}
{{AutoDocCallback
|name = LoadExtensionSchemaUpdates
|callback = \BlueSpice\Expiry\Hook\LoadExtensionSchemaUpdates\AddExpiryTable::callback
}}
}}, \BlueSpice\Expiry\Hook\SkinTemplateOutputPageBeforeExec\AddExpiredInfo::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/wgQueryPages wgQueryPages]
|callback = ExpiryHooks::onQueryPages
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-expiry-extension-description | |desc = {{int:bs-expiry-extension-description | ||
}} | }} | ||
| + | }} | ||
| + | ==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 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
|name = BlueSpiceReminder | |name = BlueSpiceReminder | ||
| − | |version = | + | |version = 3.2 |
}} | }} | ||
}} | }} | ||
| Line 23: | Line 27: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |||
| − | |||
| − | |||
|item = BlueSpiceEchoConnector | |item = BlueSpiceEchoConnector | ||
}} | }} | ||
| Line 47: | Line 48: | ||
|name = expirearticle | |name = expirearticle | ||
|type = namespace | |type = namespace | ||
| − | |roles = admin,editor,maintenanceadmin | + | |roles = admin, editor, maintenanceadmin |
|desc = {{int:right-expirearticle | |desc = {{int:right-expirearticle | ||
}} | }} | ||
| Line 54: | Line 55: | ||
|name = expiry-delete | |name = expiry-delete | ||
|type = namespace | |type = namespace | ||
| − | |roles = admin,editor,maintenanceadmin | + | |roles = admin, editor, maintenanceadmin |
|desc = {{int:right-expiry-delete | |desc = {{int:right-expiry-delete | ||
}} | }} | ||
| Line 77: | Line 78: | ||
{{AutoDocApiModules | {{AutoDocApiModules | ||
|APIModules = {{AutoDocCallback | |APIModules = {{AutoDocCallback | ||
| + | |name = bs-expiry-store | ||
| + | |callback = ApiExpiryStore | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
|name = bs-expiry-tasks | |name = bs-expiry-tasks | ||
|callback = ApiExpiryTasks | |callback = ApiExpiryTasks | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 88: | Line 89: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFBeforeAddingStyleBlocks BSUEModulePDFBeforeAddingStyleBlocks] |
| − | |callback = \BlueSpice\Expiry\Hook\ | + | |callback = \BlueSpice\Expiry\Hook\BSUEModulePDFBeforeAddingStyleBlocks\AddPDFWatermarkStyles::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage] |
| − | |callback = \BlueSpice\Expiry\Hook\ | + | |callback = \BlueSpice\Expiry\Hook\BSUEModulePDFgetPage\AddPDFWatermarkClass::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = \BlueSpice\Expiry\Hook\ | + | |callback = \BlueSpice\Expiry\Hook\BeforePageDisplay\AddResources::callback, \BlueSpice\Expiry\Hook\BeforePageDisplay\AddPageWatermark::callback, \BlueSpice\Expiry\Hook\BeforePageDisplay\AddPrintWatermark::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates] |
| − | |callback = \BlueSpice\Expiry\Hook\ | + | |callback = \BlueSpice\Expiry\Hook\LoadExtensionSchemaUpdates\AddExpiryTable::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation SkinTemplateNavigation] |
| − | |callback = \BlueSpice\Expiry\Hook\ | + | |callback = \BlueSpice\Expiry\Hook\SkinTemplateNavigation\AddExpiryCreateEntry::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec] |
| − | |callback = | + | |callback = \BlueSpice\Expiry\Hook\SkinTemplateOutputPageBeforeExec\AddToGlobalActions::callback, \BlueSpice\Expiry\Hook\SkinTemplateOutputPageBeforeExec\AddExpiredInfo::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/wgQueryPages wgQueryPages] |
| − | |callback = | + | |callback = ExpiryHooks::onQueryPages |
}} | }} | ||
}} | }} | ||