You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceReaders"
m (1 revision imported) |
hw>Unknown user |
Contents
DescriptionMsg[edit source]
Creates a list of the people who read a page
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpiceArticleInfo
- BlueSpicePrivacy
SpecialPages[edit source]
- Readers
- RevisionReaders
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| viewreaders | View readers of a page | admin, maintenanceadmin |
| viewrevisionreaders | View readers of single page revisions |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| ReadersNumOfReadersReadersCleanData | 10 false |
| ReadersCleanDataTTL | 1095 |
| ReadersNamespaceBlacklist | array ( 0 => 6, 1 => 7, 2 => 8, 3 => 9, 4 => 14, 5 => 15, ) |
| ReadersCleanDataReadersNumOfReaders | false 10 |
| ReadersCleanDataTTL | 1095 |
ApiModules[edit source]
API Modules[edit source]
- bs-readers-data-store
- bs-readers-users-storebs-readers-page-readers-store
- bs-readers-revision-readers-store
- bs-readers-tasks
- bs-readers-users-store
Hooks[edit source]
Hooks[edit source]
- BeforePageDisplay
- LoadExtensionSchemaUpdates
- SkinTemplateNavigation
- SkinTemplateOutputPageBeforeExec
- BeforePageDisplay
- SkinTemplateNavigation
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceReaders
|desc = {{int:bs-readers-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 = BlueSpiceArticleInfo
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = Readers
|callback = \BlueSpice\Readers\Special\Readers
}}
{{AutoDocCallback
|name = RevisionReaders
|callback = \BlueSpice\Readers\Special\RevisionReaders
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = viewreaders
|type = global
|roles = admin, maintenanceadmin
|desc = {{int:right-viewreaders
}}
}}
{{AutoDocPermission
|name = viewrevisionreaders
|type = global
|roles =
|desc = {{int:right-viewrevisionreaders
}}
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = ReadersNumOfReadersReadersCleanData
|value = <nowiki>10false</nowiki>
}}
{{AutoDocOption
|name = ReadersCleanDataTTL
|value = <nowiki>1095</nowiki>
}}
{{AutoDocOption
|name = ReadersNamespaceBlacklist
|value = <nowiki>array (
0 => 6,
1 => 7,
2 => 8,
3 => 9,
4 => 14,
5 => 15,
)</nowiki>
}}
{{AutoDocOption
|name = ReadersCleanDataReadersNumOfReaders
|value = <nowiki>false10</nowiki>
}}
{{AutoDocOption
|name = ReadersCleanDataTTL
|value = <nowiki>1095</nowiki>
}}
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-readers-data-store
|callback = BSApiReadersDataStore
}}
{{AutoDocCallback
|name = bs-readers-users-page-readers-store
|callback = BSApiReadersUsersStore\BlueSpice\Readers\Api\Store\PageReaders
}}
{{AutoDocCallback
|name = bs-readers-pagerevision-readers-store
|callback = \BlueSpice\Readers\Api\Store\PageReadersRevisionReaders
}}
{{AutoDocCallback
|name = bs-readers-revision-readers-storetasks
|callback = \BlueSpice\Readers\Api\Store\RevisionReadersTask\PageReaders
}}
{{AutoDocCallback
|name = bs-readers-tasksusers-store
|callback = \BlueSpice\Readers\Api\Task\PageReadersBSApiReadersUsersStore
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = LoadExtensionSchemaUpdates
[https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Readers\Hook\LoadExtensionSchemaUpdates\AddReadersTableBeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = SkinTemplateOutputPageBeforeExec
[https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\Readers\Hook\SkinTemplateOutputPageBeforeExec\AddContentActionToBlacklistLoadExtensionSchemaUpdates\AddReadersTable::callback
}}
{{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation SkinTemplateNavigation]
|callback = \BlueSpice\Readers\Hook\BeforePageDisplay\AddResourcesSkinTemplateNavigation\AddReaders::callback
}}
{{AutoDocCallback
|name = SkinTemplateNavigation
[https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = \BlueSpice\Readers\Hook\SkinTemplateNavigation\AddReadersSkinTemplateOutputPageBeforeExec\AddContentActionToBlacklist::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-readers-desc | |desc = {{int:bs-readers-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 = BlueSpiceArticleInfo | |item = BlueSpiceArticleInfo | ||
}} | }} | ||
| Line 44: | Line 45: | ||
|name = viewreaders | |name = viewreaders | ||
|type = global | |type = global | ||
| − | |roles = admin,maintenanceadmin | + | |roles = admin, maintenanceadmin |
|desc = {{int:right-viewreaders | |desc = {{int:right-viewreaders | ||
}} | }} | ||
| Line 59: | Line 60: | ||
{{AutoDocConfig | {{AutoDocConfig | ||
|config = {{AutoDocOption | |config = {{AutoDocOption | ||
| − | |name = | + | |name = ReadersCleanData |
| − | |value = <nowiki> | + | |value = <nowiki>false</nowiki> |
| + | }} | ||
| + | {{AutoDocOption | ||
| + | |name = ReadersCleanDataTTL | ||
| + | |value = <nowiki>1095</nowiki> | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
| Line 74: | Line 79: | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
| − | |name = | + | |name = ReadersNumOfReaders |
| − | |value = <nowiki> | + | |value = <nowiki>10</nowiki> |
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 87: | Line 88: | ||
|name = bs-readers-data-store | |name = bs-readers-data-store | ||
|callback = BSApiReadersDataStore | |callback = BSApiReadersDataStore | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| Line 103: | Line 100: | ||
|name = bs-readers-tasks | |name = bs-readers-tasks | ||
|callback = \BlueSpice\Readers\Api\Task\PageReaders | |callback = \BlueSpice\Readers\Api\Task\PageReaders | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = bs-readers-users-store | ||
| + | |callback = BSApiReadersUsersStore | ||
}} | }} | ||
}} | }} | ||
| Line 108: | Line 109: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = \BlueSpice\Readers\Hook\ | + | |callback = \BlueSpice\Readers\Hook\BeforePageDisplay\AddResources::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates] |
| − | |callback = \BlueSpice\Readers\Hook\ | + | |callback = \BlueSpice\Readers\Hook\LoadExtensionSchemaUpdates\AddReadersTable::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation SkinTemplateNavigation] |
| − | |callback = \BlueSpice\Readers\Hook\ | + | |callback = \BlueSpice\Readers\Hook\SkinTemplateNavigation\AddReaders::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec] |
| − | |callback = \BlueSpice\Readers\Hook\ | + | |callback = \BlueSpice\Readers\Hook\SkinTemplateOutputPageBeforeExec\AddContentActionToBlacklist::callback |
}} | }} | ||
}} | }} | ||