You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceRating"
m (1 revision imported) |
m (1 revision imported) |
Contents
DescriptionMsg[edit source]
Provides a rating system
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundationBlueSpicePrivacy
- BlueSpiceRating
- BlueSpicePrivacy
SpecialPages[edit source]
- Rating
- Recommendations
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| rating-archive | Remove votes from pages | admin, editor, maintenanceadmin |
| rating-read | Read ratings on pages | admin, commenter, editor, maintenanceadmin, reader |
| rating-viewspecialpage | View pages which are protected with the "Rating-Viewspecialpage" right | admin, editor, maintenanceadmin, reader |
| rating-write | Vote on pages | author, commenter, editor, maintenanceadmin |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| RatingArticleEnabledNamespaces | array ( ) |
| RatingArticleLikeEnabledNamespaces | array ( ) |
ApiModules[edit source]
API Modules[edit source]
- bs-rating-tasks
- bs-ratingarticle-store
- bs-ratingarticlelike-store
Hooks[edit source]
Hooks[edit source]
- LoadExtensionSchemaUpdatesBSApiNamespaceStoreMakeData
- BSMigrateSettingsFromDeviatingNames
- BSMigrateSettingsSetNewSettings
- BeforePageDisplaySkinTemplateOutputPageBeforeExec
- GetDoubleUnderscoreIDsBSMigrateSettingsFromDeviatingNames
- LoadExtensionSchemaUpdates
- NamespaceManager::getMetaFieldseditNamespace
- BSApiNamespaceStoreMakeData
- NamespaceManager::editNamespacegetMetaFields
- NamespaceManager::writeNamespaceConfiguration
- GetDoubleUnderscoreIDsSkinTemplateOutputPageBeforeExec
- BSMigrateSettingsSetNewSettings
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceRating
|desc = {{int:bs-rating-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
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundationBlueSpicePrivacy
}}
{{AutoDocListItem
|item = BlueSpiceRating
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = Rating
|callback = \BlueSpice\Rating\Special\Rating
}}
{{AutoDocCallback
|name = Recommendations
|callback = \BlueSpice\Rating\Special\Recommendations
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = rating-archive
|type = namespace
|roles = admin, editor, maintenanceadmin
|desc = {{int:right-rating-archive
}}
}}
{{AutoDocPermission
|name = rating-read
|type = namespace
|roles = admin, commenter, editor, maintenanceadmin, reader
|desc = {{int:right-rating-read
}}
}}
{{AutoDocPermission
|name = rating-viewspecialpage
|type = global
|roles = admin, editor, maintenanceadmin, reader
|desc = {{int:right-rating-viewspecialpage
}}
}}
{{AutoDocPermission
|name = rating-write
|type = namespace
|roles = author, commenter, editor, maintenanceadmin
|desc = {{int:right-rating-write
}}
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = RatingArticleEnabledNamespaces
|value = <nowiki>array (
)</nowiki>
}}
{{AutoDocOption
|name = RatingArticleLikeEnabledNamespaces
|value = <nowiki>array (
)</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-rating-tasks
|callback = \BlueSpice\Rating\Api\Task\Rating
}}
{{AutoDocCallback
|name = bs-ratingarticle-store
|callback = \BlueSpice\Rating\Api\Store\Article
}}
{{AutoDocCallback
|name = bs-ratingarticlelike-store
|callback = \BlueSpice\Rating\Api\Store\ArticleLike
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = LoadExtensionSchemaUpdates
|callback = \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingDatabase::callback,\BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingRemoveArchivedMaintenanceScript::callback,\BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingSetDefaultSubTypeMaintenanceScript::callback,\BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddBSRatingRemoveDuplicateEntriesMaintenanceScript::callback,\BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingMigrateRatedCommentsScript::callback,\BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddMigrateSettingsFromDBMaintenanceScript::callback
}}
{{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/BSApiNamespaceStoreMakeData BSApiNamespaceStoreMakeData]
|callback = BlueSpice\Rating\Hook\BSApiNamespaceStoreMakeData\AddData::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsFromDeviatingNames BSMigrateSettingsFromDeviatingNames]
|callback = \BlueSpice\Rating\Extension::onBSMigrateSettingsFromDeviatingNames
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsSetNewSettings BSMigrateSettingsSetNewSettings]
|callback = \BlueSpice\Rating\Hook\BSMigrateSettingsSetNewSettings\SetGlobals::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Rating\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetDoubleUnderscoreIDs GetDoubleUnderscoreIDs]
|callback = \BlueSpice\Rating\Hook\BeforePageDisplay\AddResourcesGetDoubleUnderscoreIDs\AddNoRating::callback
}}
{{AutoDocCallback
|name = SkinTemplateOutputPageBeforeExec
[https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddArticleRatingLoadExtensionSchemaUpdates\AddRatingDatabase::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddArticleLikeRatingLoadExtensionSchemaUpdates\AddRatingRemoveArchivedMaintenanceScript::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddRatingLoadExtensionSchemaUpdates\AddRatingSetDefaultSubTypeMaintenanceScript::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddRecommendationsGlobalActionLoadExtensionSchemaUpdates\AddBSRatingRemoveDuplicateEntriesMaintenanceScript::callback
}}
{{AutoDocCallback
|name = BSMigrateSettingsFromDeviatingNames
|callback = \BlueSpice\Rating\Extension::onBSMigrateSettingsFromDeviatingNames
}}
{{AutoDocCallback
|name = NamespaceManager::getMetaFields
|callback = BlueSpice\Rating\Hook\NamespaceManagerGetMetaFields\RegisterMetaFields::callback
}}
{{AutoDocCallback
|name = BSApiNamespaceStoreMakeData
, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingMigrateRatedCommentsScript::callback, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddMigrateSettingsFromDBMaintenanceScript::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
|callback = BlueSpice\Rating\Hook\BSApiNamespaceStoreMakeData\AddDataNamespaceManagerEditNamespace\SetRatingValues::callback
}}
{{AutoDocCallback
|name = NamespaceManager::editNamespace
[https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields]
|callback = BlueSpice\Rating\Hook\NamespaceManagerEditNamespace\SetRatingValuesNamespaceManagerGetMetaFields\RegisterMetaFields::callback
}}
{{AutoDocCallback
|name = NamespaceManager::writeNamespaceConfiguration
[https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration]
|callback = BlueSpice\Rating\Hook\NamespaceManagerWriteNamespaceConfiguration\WriteToConfiguration::callback
}}
{{AutoDocCallback
|name = GetDoubleUnderscoreIDs
[https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = \BlueSpice\Rating\Hook\GetDoubleUnderscoreIDs\AddNoRatingSkinTemplateOutputPageBeforeExec\AddArticleRating::callback
}}
{{AutoDocCallback
|name = BSMigrateSettingsSetNewSettings
|callback = \BlueSpice\Rating\Hook\BSMigrateSettingsSetNewSettings\SetGlobals, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddArticleLikeRating::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddRating::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddRecommendationsGlobalAction::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-rating-extension-description | |desc = {{int:bs-rating-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 |
}} | }} | ||
}} | }} | ||
| Line 19: | Line 23: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |item = | + | |item = BlueSpicePrivacy |
}} | }} | ||
{{AutoDocListItem | {{AutoDocListItem | ||
|item = BlueSpiceRating | |item = BlueSpiceRating | ||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 44: | Line 45: | ||
|name = rating-archive | |name = rating-archive | ||
|type = namespace | |type = namespace | ||
| − | |roles = admin,editor,maintenanceadmin | + | |roles = admin, editor, maintenanceadmin |
|desc = {{int:right-rating-archive | |desc = {{int:right-rating-archive | ||
}} | }} | ||
| Line 51: | Line 52: | ||
|name = rating-read | |name = rating-read | ||
|type = namespace | |type = namespace | ||
| − | |roles = admin,commenter,editor,maintenanceadmin,reader | + | |roles = admin, commenter, editor, maintenanceadmin, reader |
|desc = {{int:right-rating-read | |desc = {{int:right-rating-read | ||
}} | }} | ||
| Line 58: | Line 59: | ||
|name = rating-viewspecialpage | |name = rating-viewspecialpage | ||
|type = global | |type = global | ||
| − | |roles = admin,editor,maintenanceadmin,reader | + | |roles = admin, editor, maintenanceadmin, reader |
|desc = {{int:right-rating-viewspecialpage | |desc = {{int:right-rating-viewspecialpage | ||
}} | }} | ||
| Line 65: | Line 66: | ||
|name = rating-write | |name = rating-write | ||
|type = namespace | |type = namespace | ||
| − | |roles = author,commenter,editor,maintenanceadmin | + | |roles = author, commenter, editor, maintenanceadmin |
|desc = {{int:right-rating-write | |desc = {{int:right-rating-write | ||
}} | }} | ||
| Line 101: | Line 102: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSApiNamespaceStoreMakeData BSApiNamespaceStoreMakeData] |
| − | |callback = | + | |callback = BlueSpice\Rating\Hook\BSApiNamespaceStoreMakeData\AddData::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsFromDeviatingNames BSMigrateSettingsFromDeviatingNames] |
| − | |callback = \BlueSpice\Rating\ | + | |callback = \BlueSpice\Rating\Extension::onBSMigrateSettingsFromDeviatingNames |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsSetNewSettings BSMigrateSettingsSetNewSettings] |
| − | |callback = \BlueSpice\Rating\Hook\ | + | |callback = \BlueSpice\Rating\Hook\BSMigrateSettingsSetNewSettings\SetGlobals::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = \BlueSpice\Rating\ | + | |callback = \BlueSpice\Rating\Hook\BeforePageDisplay\AddResources::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetDoubleUnderscoreIDs GetDoubleUnderscoreIDs] |
| − | |callback = BlueSpice\Rating\Hook\ | + | |callback = \BlueSpice\Rating\Hook\GetDoubleUnderscoreIDs\AddNoRating::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates] |
| − | |callback = BlueSpice\Rating\Hook\ | + | |callback = \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingDatabase::callback, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingRemoveArchivedMaintenanceScript::callback, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingSetDefaultSubTypeMaintenanceScript::callback, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddBSRatingRemoveDuplicateEntriesMaintenanceScript::callback, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddRatingMigrateRatedCommentsScript::callback, \BlueSpice\Rating\Hook\LoadExtensionSchemaUpdates\AddMigrateSettingsFromDBMaintenanceScript::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = NamespaceManager::editNamespace | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace] |
|callback = BlueSpice\Rating\Hook\NamespaceManagerEditNamespace\SetRatingValues::callback | |callback = BlueSpice\Rating\Hook\NamespaceManagerEditNamespace\SetRatingValues::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = NamespaceManager:: | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields] |
| − | |callback = BlueSpice\Rating\Hook\ | + | |callback = BlueSpice\Rating\Hook\NamespaceManagerGetMetaFields\RegisterMetaFields::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration] |
| − | |callback = | + | |callback = BlueSpice\Rating\Hook\NamespaceManagerWriteNamespaceConfiguration\WriteToConfiguration::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec] |
| − | |callback = \BlueSpice\Rating\Hook\ | + | |callback = \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddArticleRating::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddArticleLikeRating::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddRating::callback, \BlueSpice\Rating\Hook\SkinTemplateOutputPageBeforeExec\AddRecommendationsGlobalAction::callback |
}} | }} | ||
}} | }} | ||