Difference between revisions of "AutoDoc:BlueSpiceFlaggedRevsConnector"

m (1 revision imported)
(Tag: 2017 source edit)
 

DescriptionMsg[edit source]

Adds support for FlaggedRevs to a range of other extensions.

License[edit source]

GPL-3.0-only

Requirements[edit source]

  • MediaWiki: 1.31
  • BlueSpiceFoundation: 3.2

IntegratesInto[edit source]

  • BlueSpiceExtendedStatistics
  • BlueSpicePrivacy
  • BlueSpiceReview
  • BlueSpiceSMWConnector

SpecialPages[edit source]

  • QMOverview

Permissions[edit source]

Permissions

Name Description Role
autoreview Have one's own edits automatically marked as "checked" bot, maintenanceadmin
autoreviewrestore Auto-review on rollback bot, maintenanceadmin
movestable Move pages with stable versions admin, editor, maintenanceadmin, reviewer, structuremanager
review Mark revisions as being "checked" admin, maintenanceadmin, reviewer
stablesettings Configure how the stable version is selected and displayed admin, maintenanceadmin, reader
unreviewedpages View the list of unreviewed pages admin, editor, maintenanceadmin, reviewer
validate Mark revisions as being "quality" admin, maintenanceadmin, reviewer

Config[edit source]

Configuration[edit source]

Name Value
FlaggedRevsConnectorBookshelfShowNoFR$bsgFlaggedRevsConnectorBookshelfShowNoFR true FlaggedRevsConnectorBookshelfShowNoStable
$bsgFlaggedRevsConnectorBookshelfShowNoStable true FlaggedRevsConnectorBookshelfShowStable
$bsgFlaggedRevsConnectorBookshelfShowStable true FlaggedRevsConnectorDraftGroups
$bsgFlaggedRevsConnectorDraftGroups array ( 0 => 'user', )
FlaggedRevsConnectorFlaggedPagesStore$bsgFlaggedRevsConnectorFlaggedPagesStore 'BlueSpice\\FlaggedRevsConnector\\Data\\FlaggedPages\\Store'
FlaggedRevsConnectorIndexStableOnly$bsgFlaggedRevsConnectorStabilizeSMWPropertyValues true
$bsgFlaggedRevsConnectorIndexStableOnly false FlaggedRevsConnectorPageApprovedReminderDelay
$bsgFlaggedRevsConnectorPageApprovedReminderDelay 168 FlaggedRevsConnectorUEModulePDFShowFRTag
$bsgFlaggedRevsConnectorUEModulePDFShowFRTag true FlaggedRevsConnectorautoDeleteWorkflow
$bsgFlaggedRevsConnectorautoDeleteWorkflow true

ApiModules[edit source]

API Modules[edit source]

  • bs-flaggedpages-store

ApiModules[edit source]

API Modules[edit source]

  • bs-flaggedpages-store

Hooks[edit source]

Hooks[edit source]

ExtensionFunctions[edit source]

Template:AutoDocExtensionFunctions

==DescriptionMsg==
        
        {{AutoDocDescriptionMsg
        
        |name = BlueSpiceFlaggedRevsConnector
        
        |desc = {{int:bs-flaggedrevsconnector-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 = BlueSpiceExtendedStatistics
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpicePrivacy
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceReview
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceSMWConnector
        
        }}
        
        }}
        
        ==SpecialPages==
        
        {{AutoDocSpecialPages
        
        |SpecialPages = {{AutoDocCallback
        
        |name = QMOverview
        
        |callback = \BlueSpice\FlaggedRevsConnector\Special\QMOverview
        
        }}
        
        }}
        
        ==Permissions==
        
        {{AutoDocPermissions
        
        |permissions = {{AutoDocPermission
        
        |name = autoreview
        
        |type = global
        
        |roles = bot, maintenanceadmin
        
        |desc = {{int:right-autoreview
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = autoreviewrestore
        
        |type = global
        
        |roles = bot, maintenanceadmin
        
        |desc = {{int:right-autoreviewrestore
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = movestable
        
        |type = global
        
        |roles = admin, editor, maintenanceadmin, reviewer, structuremanager
        
        |desc = {{int:right-movestable
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = review
        
        |type = global
        
        |roles = admin, maintenanceadmin, reviewer
        
        |desc = {{int:right-review
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = stablesettings
        
        |type = global
        
        |roles = admin, maintenanceadmin, reader
        
        |desc = {{int:right-stablesettings
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = unreviewedpages
        
        |type = global
        
        |roles = admin, editor, maintenanceadmin, reviewer
        
        |desc = {{int:right-unreviewedpages
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = validate
        
        |type = global
        
        |roles = admin, maintenanceadmin, reviewer
        
        |desc = {{int:right-validate
        
        }}
        
        }}
        
        }}
        
        ==Config==
        
        {{AutoDocConfig
        
        |config = {{AutoDocOption
        
        |name = FlaggedRevsConnectorBookshelfShowNoFR$bsgFlaggedRevsConnectorBookshelfShowNoFR
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorBookshelfShowNoStable$bsgFlaggedRevsConnectorBookshelfShowNoStable
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorBookshelfShowStable$bsgFlaggedRevsConnectorBookshelfShowStable
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorDraftGroups$bsgFlaggedRevsConnectorDraftGroups
        
        |value = <nowiki>array (
        
          0 => 'user',
        
        )</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorFlaggedPagesStore$bsgFlaggedRevsConnectorFlaggedPagesStore
        
        |value = <nowiki>'BlueSpice\\FlaggedRevsConnector\\Data\\FlaggedPages\\Store'</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorIndexStableOnly$bsgFlaggedRevsConnectorStabilizeSMWPropertyValues
        
        |value = <nowiki>true</nowiki>
            
            }}
            
            {{AutoDocOption
            
            |name = $bsgFlaggedRevsConnectorIndexStableOnly
            
            |value = <nowiki>false</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorPageApprovedReminderDelay$bsgFlaggedRevsConnectorPageApprovedReminderDelay
        
        |value = <nowiki>168</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorUEModulePDFShowFRTag$bsgFlaggedRevsConnectorUEModulePDFShowFRTag
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = FlaggedRevsConnectorautoDeleteWorkflow$bsgFlaggedRevsConnectorautoDeleteWorkflow
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        }}
        
        ==ApiModules==
        
        {{AutoDocApiModules
        
        |APIModules = {{AutoDocCallback
        
        |name = bs-flaggedpages-store
        
        |callback = \BlueSpice\FlaggedRevsConnector\Api\Store\FlaggedPages
        
        }}
        
        }}
        
        
        ==
            
            ==ApiModules==
            
            {{AutoDocApiModules
            
            |APIModules = {{AutoDocCallback
            
            |name = bs-flaggedpages-store
            
            |callback = \BlueSpice\FlaggedRevsConnector\Api\Store\FlaggedPages
            
            }}
            
            }}
            
            ==Hooks==
        
        {{AutoDocHooks
        
        |Hooks = {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleContentOnDiff ArticleContentOnDiff]
        
        |callback = FRCDiffView::onArticleContentOnDiff
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleViewHeader ArticleViewHeader]
        
        |callback = FRCDiffView::onArticleViewHeader, FRCUEModulePDF::onArticleViewHeader
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSExtendedSearchRepoFileGetRepoFile BSExtendedSearchRepoFileGetRepoFile]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\BSExtendedSearchRepoFileGetRepoFile\GetStableFile::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSExtendedSearchWikipageFetchRevision BSExtendedSearchWikipageFetchRevision]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\BSExtendedSearchWikipageFetchRevision\GetStableRevision::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\BeforePageDisplay\AddResources::callback, \BlueSpice\FlaggedRevsConnector\Hook\BeforePageDisplay\ChangeRevisionForEdit::callback, \BlueSpice\FlaggedRevsConnector\Hook\BeforePageDisplay\HideFileDraftResources::callback, \BlueSpice\FlaggedRevsConnector\Hook\BeforePageDisplay\ChangeRevisionForEdit::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforeParserFetchTemplateAndtitle BeforeParserFetchTemplateAndtitle]
        
        |callback = BlueSpice\FlaggedRevsConnector\Hook\BeforeParserFetchTemplateAndtitle\SetTransclusionVersion::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BlueSpiceEchoConnectorUserLocatorValidUsers BlueSpiceEchoConnectorUserLocatorValidUsers]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\BlueSpiceEchoConnectorUserLocatorValidUsers\LockdownNotifications::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/EditPageGetCheckboxesDefinition EditPageGetCheckboxesDefinition]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\EditPageGetCheckboxesDefinition\ReplaceVisualEditorAutoReview::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/FlaggedRevsRevisionReviewFormAfterDoSubmit FlaggedRevsRevisionReviewFormAfterDoSubmit]
        
        |callback = FRCReview::onFlaggedRevsRevisionReviewFormAfterDoSubmit, \BlueSpice\FlaggedRevsConnector\Hook\FlaggedRevsRevisionReviewFormAfterDoSubmit\RunUpdatesWhenSetStable::callback, \BlueSpice\FlaggedRevsConnector\Hook\FlaggedRevsRevisionReviewFormAfterDoSubmit\UpdateSearchIndexAfterSetStable::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ImagePageFileHistoryLine ImagePageFileHistoryLine]
        
        |callback = BlueSpice\FlaggedRevsConnector\Hook\ImagePageFileHistoryLine\HideDraftVersions::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ImgAuthBeforeStream ImgAuthBeforeStream]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\ImgAuthBeforeStream\LockdownDraft::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\LoadExtensionSchemaUpdates\AddRemoveTMPGroupMaintenanceScript::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/MessageCache::get MessageCache::get]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\MessageCacheGet\ApplyBusinessVocabulary::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageBeforeHTML OutputPageBeforeHTML]
        
        |callback = FRCDiffView::onOutputPageBeforeHTML
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\PageContentSaveComplete\AutoReviewAfterVisualEditorEdit::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageHistoryLineEnding PageHistoryLineEnding]
        
        |callback = FRCHistoryView::onPageHistoryLineEnding
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SMW::RevisionGuard::ChangeRevision SMW::RevisionGuard::ChangeRevision]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\SMWRevisionGuard\ChangeFlaggedRevision::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SMW::RevisionGuard::ChangeRevisionID SMW::RevisionGuard::ChangeRevisionID]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\SMWRevisionGuard\ChangeFlaggedRevisionId::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SMW::RevisionGuard::IsApprovedRevision SMW::RevisionGuard::IsApprovedRevision]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\SMWRevisionGuard\IsApprovedFlaggedRevision::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\SkinTemplateOutputPageBeforeExec\AddFlyout::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SpecialPage_initList SpecialPage_initList]
        
        |callback = \BlueSpice\FlaggedRevsConnector\Hook\SpecialPageInitList\RemoveDefaultFRPages::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = [https://www.mediawiki.org/wiki/Manual:Hooks/checkPageIsReviewable checkPageIsReviewable]
        
        |callback = FRCReview::onCheckPageIsReviewable
        
        }}
        
        }}
        
        ==ExtensionFunctions==
        
        {{AutoDocExtensionFunctions
        
        |ExtensionFunctions = {{AutoDocListItem
        
        |item = 0
        
        }}
        
        }}
Line 97: Line 97:
 
{{AutoDocConfig
 
{{AutoDocConfig
 
|config = {{AutoDocOption
 
|config = {{AutoDocOption
|name = FlaggedRevsConnectorBookshelfShowNoFR
+
|name = $bsgFlaggedRevsConnectorBookshelfShowNoFR
 
|value = <nowiki>true</nowiki>
 
|value = <nowiki>true</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorBookshelfShowNoStable
+
|name = $bsgFlaggedRevsConnectorBookshelfShowNoStable
 
|value = <nowiki>true</nowiki>
 
|value = <nowiki>true</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorBookshelfShowStable
+
|name = $bsgFlaggedRevsConnectorBookshelfShowStable
 
|value = <nowiki>true</nowiki>
 
|value = <nowiki>true</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorDraftGroups
+
|name = $bsgFlaggedRevsConnectorDraftGroups
 
|value = <nowiki>array (
 
|value = <nowiki>array (
 
   0 => 'user',
 
   0 => 'user',
Line 115: Line 115:
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorFlaggedPagesStore
+
|name = $bsgFlaggedRevsConnectorFlaggedPagesStore
 
|value = <nowiki>'BlueSpice\\FlaggedRevsConnector\\Data\\FlaggedPages\\Store'</nowiki>
 
|value = <nowiki>'BlueSpice\\FlaggedRevsConnector\\Data\\FlaggedPages\\Store'</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorIndexStableOnly
+
|name = $bsgFlaggedRevsConnectorStabilizeSMWPropertyValues
 +
|value = <nowiki>true</nowiki>
 +
}}
 +
{{AutoDocOption
 +
|name = $bsgFlaggedRevsConnectorIndexStableOnly
 
|value = <nowiki>false</nowiki>
 
|value = <nowiki>false</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorPageApprovedReminderDelay
+
|name = $bsgFlaggedRevsConnectorPageApprovedReminderDelay
 
|value = <nowiki>168</nowiki>
 
|value = <nowiki>168</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorUEModulePDFShowFRTag
+
|name = $bsgFlaggedRevsConnectorUEModulePDFShowFRTag
 
|value = <nowiki>true</nowiki>
 
|value = <nowiki>true</nowiki>
 
}}
 
}}
 
{{AutoDocOption
 
{{AutoDocOption
|name = FlaggedRevsConnectorautoDeleteWorkflow
+
|name = $bsgFlaggedRevsConnectorautoDeleteWorkflow
 
|value = <nowiki>true</nowiki>
 
|value = <nowiki>true</nowiki>
 
}}
 
}}
 
}}
 
}}
 +
==ApiModules==
 +
{{AutoDocApiModules
 +
|APIModules = {{AutoDocCallback
 +
|name = bs-flaggedpages-store
 +
|callback = \BlueSpice\FlaggedRevsConnector\Api\Store\FlaggedPages
 +
}}
 +
}}
 +
 
==ApiModules==
 
==ApiModules==
 
{{AutoDocApiModules
 
{{AutoDocApiModules

Attachments

Discussions