Difference between revisions of "AutoDoc:BlueSpiceRating"

m (1 revision imported)
m (1 revision imported)
 

DescriptionMsg[edit source]

Provides a rating system

License[edit source]

GPL-3.0-only

Requirements[edit source]

  • MediaWiki: 1.31
  • BlueSpiceFoundation: 3.2

IntegratesInto[edit source]

  • BlueSpicePrivacy
  • BlueSpiceRating

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]

==DescriptionMsg==
        
        {{AutoDocDescriptionMsg
        
        |name = BlueSpiceRating
        
        |desc = {{int:bs-rating-extension-description
        
        }}
        
        }}
        
        ==License==
        
        {{AutoDocLicense
        
        |name = GPL-3.0-only
        
        }}
        
        ==Requirements==
        
        {{AutoDocRequirements
        
        |mediawiki = {{AutoDocVersion
        
        |name = MediaWiki
        
        |version = 1.31
        
        }}
        
        |extensions = {{AutoDocVersion
        
        |name = BlueSpiceFoundation
        
        |version = 3.2
        
        }}
        
        }}
        
        ==IntegratesInto==
        
        {{AutoDocIntegratesInto
        
        |into = {{AutoDocListItem
        
        |item = BlueSpicePrivacy
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceRating
        
        }}
        
        }}
        
        ==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 = [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\GetDoubleUnderscoreIDs\AddNoRating::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates 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 = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
        
        |callback = BlueSpice\Rating\Hook\NamespaceManagerEditNamespace\SetRatingValues::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields]
        
        |callback = BlueSpice\Rating\Hook\NamespaceManagerGetMetaFields\RegisterMetaFields::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration]
        
        |callback = BlueSpice\Rating\Hook\NamespaceManagerWriteNamespaceConfiguration\WriteToConfiguration::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
        
        |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
        
        }}
        
        }}
(No difference)

Attachments

Discussions