Discussion

Difference between revisions of "AutoDoc:BlueSpiceSMWConnector"

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

DescriptionMsg[edit source]

Integrates SemanticMediaWiki into BlueSpice

License[edit source]

GPL-3.0-only

Requirements[edit source]

  • MediaWiki: ~11.31
  • BlueSpiceFoundation: ~33.2

IntegratesInto[edit source]

  • BlueSpiceBookshelfUI
  • BlueSpiceExtendedSearch
  • BlueSpiceFoundation
  • BlueSpiceBookshelfUI
  • BlueSpiceSMWConnector

Permissions[edit source]

Permissions

Name Description Role
createclass Create new "classes" of pages admin, author, editor, maintenanceadmin
editrestrictedfields Edit restricted form fields admin, editor, maintenanceadmin
geocode Geocode admin, author, editor, maintenanceadmin
smw-admin Access administration tasks (Semantic MediaWiki) admin, maintenanceadmin
viewedittab View "Edit" tab for pages editable by form admin, editor, maintenanceadmin, structuremanager

Config[edit source]

Configuration[edit source]

Name Value
UEModulePDFsmwProperties array ( )
ESSMWPropertyFilter array ( 'type' => 'blacklist', 'props' => array ( ), )
UEModulePDFsmwProperties array ( )

ApiModules[edit source]

API Modules[edit source]

  • bs-smw-connector-smwask-property-store
  • bs-smw-connector-asksmw-property-store
  • bs-smw-connector-tree-ask-store

Hooks[edit source]

Hooks[edit source]

ExtensionFunctions[edit source]

Template:AutoDocExtensionFunctions 

==DescriptionMsg==
        
        {{AutoDocDescriptionMsg
        
        |name = BlueSpiceSMWConnector
        
        |desc = {{int:bs-bssmwconnector-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 = BlueSpiceExtendedSearchBlueSpiceBookshelfUI
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceFoundationBlueSpiceExtendedSearch
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceBookshelfUI
            
            }}
            
            {{AutoDocListItem
            
            |item = BlueSpiceSMWConnector
        
        }}
        
        }}
        
        ==Permissions==
        
        {{AutoDocPermissions
        
        |permissions = {{AutoDocPermission
        
        |name = createclass
        
        |type = global
        
        |roles = admin, author, editor, maintenanceadmin
        
        |desc = {{int:right-createclass
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = editrestrictedfields
        
        |type = global
        
        |roles = admin, editor, maintenanceadmin
        
        |desc = {{int:right-editrestrictedfields
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = geocode
        
        |type = global
        
        |roles = admin, author, editor, maintenanceadmin
        
        |desc = {{int:right-geocode
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = smw-admin
        
        |type = global
        
        |roles = admin, maintenanceadmin
        
        |desc = {{int:right-smw-admin
        
        }}
        
        }}
        
        {{AutoDocPermission
        
        |name = viewedittab
        
        |type = global
        
        |roles = admin, editor, maintenanceadmin, structuremanager
        
        |desc = {{int:right-viewedittab
        
        }}
        
        }}
        
        }}
        
        ==Config==
        
        {{AutoDocConfig
        
        |config = {{AutoDocOption
        
        |name = UEModulePDFsmwProperties
            
            |value = <nowiki>array (
            
            )</nowiki>
            
            }}
            
            {{AutoDocOption
            
            |name = ESSMWPropertyFilter
        
        |value = <nowiki>array (
        
          'type' => 'blacklist',
        
          'props' => 
        
          array (
        
          ),
        
        )</nowiki>
        
        }}
        
        
        }}
            
            
        {{AutoDocOption
            
            |name = UEModulePDFsmwProperties
            
            |value = <nowiki>array (
            
            )</nowiki>
            
            }}
            
            }}
            
            
        ==ApiModules==
        
        {{AutoDocApiModules
        
        |APIModules = {{AutoDocCallback
        
        |name = bs-smw-connector-smw-property-ask-store
        
        |callback = ApiSMWPropertyStore\BlueSpice\SMWConnector\Api\Store\Ask
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-smw-connector-ask-smw-property-store
        
        |callback = \BlueSpice\SMWConnector\Api\Store\AskApiSMWPropertyStore
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-smw-connector-tree-ask-store
        
        |callback = \BlueSpice\SMWConnector\Api\Store\TreeAsk
        
        }}
        
        }}
        
        ==Hooks==
        
        {{AutoDocHooks
        
        |Hooks = {{AutoDocCallback
        
        |name = BeforePageDisplay
            
            |callback = BSSMWConnectorHooks::onBeforePageDisplay,BlueSpice\SMWConnector\Hook\BeforePageDisplay\AddModules::callback
            
            }}
            
            {{AutoDocCallback
            
            |name = PageForms::FormPrinterSetup
            
            |callback = BlueSpice\SMWConnector\Hook\PFFormPrinterSetup\RegisterInputTypes::callback
            
            }}
            
            {{AutoDocCallback
            
            |name = BSBookshelfNodeTag
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/BSApiNamespaceStoreMakeData BSApiNamespaceStoreMakeData]
            
            |callback = BSSMWCNamespaceManager::onGetNamespaceData
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfExportTag BSBookshelfExportTag]
            
            |callback = BSSMWConnectorHooks::onBSBookshelfExportTag
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfNodeTag BSBookshelfNodeTag]
            
            
        |callback = BSSMWConnectorHooks::onBSBookshelfNodeTag
        
        }}
        
        {{AutoDocCallback
        
        |name = BSBookshelfExportTag
            
            |callback = BSSMWConnectorHooks::onBSBookshelfExportTag
            
            }}
            
            {{AutoDocCallback
            
            |name = NamespaceManager::getMetaFields
            
            |callback = BSSMWCNamespaceManager::onGetMetaFields
            
            }}
            
            {{AutoDocCallback
            
            |name = BSApiNamespaceStoreMakeData
            
            |callback = BSSMWCNamespaceManager::onGetNamespaceData
            
            }}
            
            {{AutoDocCallback
            
            |name = NamespaceManager::editNamespace
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageTemplatesBeforeRender BSPageTemplatesBeforeRender]
            
            |callback = BSSMWCPageTemplates::onBSPageTemplatesBeforeRender
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]
            
            |callback = BlueSpice\SMWConnector\Hook\BSUEModulePDFcollectMetaData\AddSemanitcMetaData::callback
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
            
            |callback = BSSMWConnectorHooks::onBeforePageDisplay, BlueSpice\SMWConnector\Hook\BeforePageDisplay\AddModules::callback
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
            
            
        |callback = BSSMWCNamespaceManager::onEditNamespace
        
        }}
        
        {{AutoDocCallback
        
        |name = NamespaceManager::writeNamespaceConfiguration
            
            |callback = BSSMWCNamespaceManager::onWriteNamespaceConfiguration
            
            }}
            
            {{AutoDocCallback
            
            |name = BSPageTemplatesBeforeRender
            
            |callback = BSSMWCPageTemplates::onBSPageTemplatesBeforeRender
            
            }}
            
            {{AutoDocCallback
            
            |name = PageContentSaveComplete
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields]
            
            |callback = BSSMWCNamespaceManager::onGetMetaFields
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration]
            
            |callback = BSSMWCNamespaceManager::onWriteNamespaceConfiguration
            
            }}
            
            {{AutoDocCallback
            
            |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete]
            
            
        |callback = BSSMWConnectorHooks::onPageContentSaveComplete
        
        }}
        
        {{AutoDocCallback
        
        |name = SMW::Store::AfterQueryResultLookupComplete
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/PageForms::FormPrinterSetup PageForms::FormPrinterSetup]
            
            
        |callback = BlueSpice\SMWConnector\Hook\SMWStoreAfterQueryResultLookupComplete\ApplySecurityTrimmingPFFormPrinterSetup\RegisterInputTypes::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = SkinTemplateOutputPageBeforeExec
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit ParserFirstCallInit]
            
            
        |callback = BlueSpice\SMWConnector\Hook\SkinTemplateOutputPageBeforeExec\AddFormEditActionParserFirstCallInit\AsyncAsk::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSUEModulePDFcollectMetaData
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/SMW::Store::AfterQueryResultLookupComplete SMW::Store::AfterQueryResultLookupComplete]
            
            
        |callback = BlueSpice\SMWConnector\Hook\BSUEModulePDFcollectMetaData\AddSemanitcMetaDataSMWStoreAfterQueryResultLookupComplete\ApplySecurityTrimming::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = ParserFirstCallInit
            
            
        [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
            
            
        |callback = BlueSpice\SMWConnector\Hook\ParserFirstCallInit\AsyncAskSkinTemplateOutputPageBeforeExec\AddFormEditAction::callback
        
        }}
        
        }}
        
        ==ExtensionFunctions==
        
        {{AutoDocExtensionFunctions
        
        |ExtensionFunctions = {{AutoDocListItem
        
        |item = 0
        
        }}
        
        {{AutoDocListItem
        
        |item = 1
        
        }}
        
        }}
Line 4: Line 4:
 
|desc = {{int:bs-bssmwconnector-desc
 
|desc = {{int:bs-bssmwconnector-desc
 
}}
 
}}
 +
}}
 +
==License==
 +
{{AutoDocLicense
 +
|name = GPL-3.0-only
 
}}
 
}}
 
==Requirements==
 
==Requirements==
Line 9: Line 13:
 
|mediawiki = {{AutoDocVersion
 
|mediawiki = {{AutoDocVersion
 
|name = MediaWiki
 
|name = MediaWiki
−
|version = ~1.31
+
|version = 1.31
 
}}
 
}}
 
|extensions = {{AutoDocVersion
 
|extensions = {{AutoDocVersion
 
|name = BlueSpiceFoundation
 
|name = BlueSpiceFoundation
−
|version = ~3.2
+
|version = 3.2
 
}}
 
}}
 
}}
 
}}
Line 19: Line 23:
 
{{AutoDocIntegratesInto
 
{{AutoDocIntegratesInto
 
|into = {{AutoDocListItem
 
|into = {{AutoDocListItem
−
|item = BlueSpiceExtendedSearch
+
|item = BlueSpiceBookshelfUI
 
}}
 
}}
 
{{AutoDocListItem
 
{{AutoDocListItem
−
|item = BlueSpiceFoundation
+
|item = BlueSpiceExtendedSearch
−
}}
 
−
{{AutoDocListItem
 
−
|item = BlueSpiceBookshelfUI
 
 
}}
 
}}
 
{{AutoDocListItem
 
{{AutoDocListItem
Line 36: Line 37:
 
|name = createclass
 
|name = createclass
 
|type = global
 
|type = global
−
|roles = admin,author,editor,maintenanceadmin
+
|roles = admin, author, editor, maintenanceadmin
 
|desc = {{int:right-createclass
 
|desc = {{int:right-createclass
 
}}
 
}}
Line 43: Line 44:
 
|name = editrestrictedfields
 
|name = editrestrictedfields
 
|type = global
 
|type = global
−
|roles = admin,editor,maintenanceadmin
+
|roles = admin, editor, maintenanceadmin
 
|desc = {{int:right-editrestrictedfields
 
|desc = {{int:right-editrestrictedfields
 
}}
 
}}
Line 50: Line 51:
 
|name = geocode
 
|name = geocode
 
|type = global
 
|type = global
−
|roles = admin,author,editor,maintenanceadmin
+
|roles = admin, author, editor, maintenanceadmin
 
|desc = {{int:right-geocode
 
|desc = {{int:right-geocode
 
}}
 
}}
Line 57: Line 58:
 
|name = smw-admin
 
|name = smw-admin
 
|type = global
 
|type = global
−
|roles = admin,maintenanceadmin
+
|roles = admin, maintenanceadmin
 
|desc = {{int:right-smw-admin
 
|desc = {{int:right-smw-admin
 
}}
 
}}
Line 64: Line 65:
 
|name = viewedittab
 
|name = viewedittab
 
|type = global
 
|type = global
−
|roles = admin,editor,maintenanceadmin,structuremanager
+
|roles = admin, editor, maintenanceadmin, structuremanager
 
|desc = {{int:right-viewedittab
 
|desc = {{int:right-viewedittab
 
}}
 
}}
Line 72: Line 73:
 
{{AutoDocConfig
 
{{AutoDocConfig
 
|config = {{AutoDocOption
 
|config = {{AutoDocOption
−
|name = UEModulePDFsmwProperties
 
−
|value = <nowiki>array (
 
−
)</nowiki>
 
−
}}
 
−
{{AutoDocOption
 
 
|name = ESSMWPropertyFilter
 
|name = ESSMWPropertyFilter
 
|value = <nowiki>array (
 
|value = <nowiki>array (
Line 83: Line 79:
 
   array (
 
   array (
 
   ),
 
   ),
 +
)</nowiki>
 +
}}
 +
{{AutoDocOption
 +
|name = UEModulePDFsmwProperties
 +
|value = <nowiki>array (
 
)</nowiki>
 
)</nowiki>
 
}}
 
}}
Line 89: Line 90:
 
{{AutoDocApiModules
 
{{AutoDocApiModules
 
|APIModules = {{AutoDocCallback
 
|APIModules = {{AutoDocCallback
 +
|name = bs-smw-connector-ask-store
 +
|callback = \BlueSpice\SMWConnector\Api\Store\Ask
 +
}}
 +
{{AutoDocCallback
 
|name = bs-smw-connector-smw-property-store
 
|name = bs-smw-connector-smw-property-store
 
|callback = ApiSMWPropertyStore
 
|callback = ApiSMWPropertyStore
−
}}
 
−
{{AutoDocCallback
 
−
|name = bs-smw-connector-ask-store
 
−
|callback = \BlueSpice\SMWConnector\Api\Store\Ask
 
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
Line 104: Line 105:
 
{{AutoDocHooks
 
{{AutoDocHooks
 
|Hooks = {{AutoDocCallback
 
|Hooks = {{AutoDocCallback
−
|name = BeforePageDisplay
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSApiNamespaceStoreMakeData BSApiNamespaceStoreMakeData]
−
|callback = BSSMWConnectorHooks::onBeforePageDisplay,BlueSpice\SMWConnector\Hook\BeforePageDisplay\AddModules::callback
+
|callback = BSSMWCNamespaceManager::onGetNamespaceData
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = PageForms::FormPrinterSetup
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfExportTag BSBookshelfExportTag]
−
|callback = BlueSpice\SMWConnector\Hook\PFFormPrinterSetup\RegisterInputTypes::callback
+
|callback = BSSMWConnectorHooks::onBSBookshelfExportTag
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = BSBookshelfNodeTag
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfNodeTag BSBookshelfNodeTag]
 
|callback = BSSMWConnectorHooks::onBSBookshelfNodeTag
 
|callback = BSSMWConnectorHooks::onBSBookshelfNodeTag
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = BSBookshelfExportTag
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageTemplatesBeforeRender BSPageTemplatesBeforeRender]
−
|callback = BSSMWConnectorHooks::onBSBookshelfExportTag
+
|callback = BSSMWCPageTemplates::onBSPageTemplatesBeforeRender
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = NamespaceManager::getMetaFields
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]
−
|callback = BSSMWCNamespaceManager::onGetMetaFields
+
|callback = BlueSpice\SMWConnector\Hook\BSUEModulePDFcollectMetaData\AddSemanitcMetaData::callback
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = BSApiNamespaceStoreMakeData
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
−
|callback = BSSMWCNamespaceManager::onGetNamespaceData
+
|callback = BSSMWConnectorHooks::onBeforePageDisplay, BlueSpice\SMWConnector\Hook\BeforePageDisplay\AddModules::callback
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = NamespaceManager::editNamespace
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
 
|callback = BSSMWCNamespaceManager::onEditNamespace
 
|callback = BSSMWCNamespaceManager::onEditNamespace
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = NamespaceManager::writeNamespaceConfiguration
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::getMetaFields NamespaceManager::getMetaFields]
−
|callback = BSSMWCNamespaceManager::onWriteNamespaceConfiguration
+
|callback = BSSMWCNamespaceManager::onGetMetaFields
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = BSPageTemplatesBeforeRender
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::writeNamespaceConfiguration NamespaceManager::writeNamespaceConfiguration]
−
|callback = BSSMWCPageTemplates::onBSPageTemplatesBeforeRender
+
|callback = BSSMWCNamespaceManager::onWriteNamespaceConfiguration
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = PageContentSaveComplete
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete]
 
|callback = BSSMWConnectorHooks::onPageContentSaveComplete
 
|callback = BSSMWConnectorHooks::onPageContentSaveComplete
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = SMW::Store::AfterQueryResultLookupComplete
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageForms::FormPrinterSetup PageForms::FormPrinterSetup]
−
|callback = BlueSpice\SMWConnector\Hook\SMWStoreAfterQueryResultLookupComplete\ApplySecurityTrimming::callback
+
|callback = BlueSpice\SMWConnector\Hook\PFFormPrinterSetup\RegisterInputTypes::callback
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = SkinTemplateOutputPageBeforeExec
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit ParserFirstCallInit]
−
|callback = BlueSpice\SMWConnector\Hook\SkinTemplateOutputPageBeforeExec\AddFormEditAction::callback
+
|callback = BlueSpice\SMWConnector\Hook\ParserFirstCallInit\AsyncAsk::callback
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = BSUEModulePDFcollectMetaData
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SMW::Store::AfterQueryResultLookupComplete SMW::Store::AfterQueryResultLookupComplete]
−
|callback = BlueSpice\SMWConnector\Hook\BSUEModulePDFcollectMetaData\AddSemanitcMetaData::callback
+
|callback = BlueSpice\SMWConnector\Hook\SMWStoreAfterQueryResultLookupComplete\ApplySecurityTrimming::callback
 
}}
 
}}
 
{{AutoDocCallback
 
{{AutoDocCallback
−
|name = ParserFirstCallInit
+
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
−
|callback = BlueSpice\SMWConnector\Hook\ParserFirstCallInit\AsyncAsk::callback
+
|callback = BlueSpice\SMWConnector\Hook\SkinTemplateOutputPageBeforeExec\AddFormEditAction::callback
 
}}
 
}}
 
}}
 
}}
Retrieved from "https://bs3-en.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceSMWConnector&oldid=26609"

Attachments

Discussions