Difference between revisions of "AutoDoc:BlueSpiceVisualEditorConnector"

hw>Unknown user
 
m (1 revision imported)

DescriptionMsg[edit source]

Connects BlueSpice with VisualEditor

Requirements[edit source]

  • MediaWiki: ~1.31
  • BlueSpiceFoundation: ~3.2

VisualEditor: =0.1.0 OOJSPlus: *

IntegratesInto[edit source]

  • BlueSpiceFoundation
  • BlueSpiceVisualEditorConnector
  • BlueSpiceSimpleFarmer
  • VisualEditor
  • BlueSpiceSaferEdit

Config[edit source]

Configuration[edit source]

Name Value
VisualEditorConnectorEnableVisualEditor true
VisualEditorConnectorUploadDialogType 'original'
VisualEditorConnectorSimpleSaveProcess true
VisualEditorConnectorTableStyleRegistry array ( 'Standard' => 'wikitable', 'Content' => 'contenttable', 'Content (black)' => 'contenttable-black', 'Content (blue)' => 'contenttable-blue', 'Content (darkblue)' => 'contenttable-darkblue', 'Cusco Sky' => 'cuscosky', 'Casablanca' => 'casablanca', 'Greyscale' => 'greyscale', 'Greyscale (narrow)' => 'greyscale-narrow', )
VisualEditorConnectorColorPickerColors array ( 0 => array ( 'class' => 'col-white', 'name' => 'White', ), 1 => array ( 'class' => 'col-blue-light', 'name' => 'Light Blue', ), 2 => array ( 'class' => 'col-blue', 'name' => 'Blue', ), 3 => array ( 'class' => 'col-blue-dark', 'name' => 'Dark Blue', ), 4 => array ( 'class' => 'col-blue-navy', 'name' => 'Navy Blue', ), 5 => array ( 'class' => 'col-orange', 'name' => 'Orange', ), 6 => array ( 'class' => 'col-turquoise', 'name' => 'Turquoise', ), 7 => array ( 'class' => 'col-green', 'name' => 'Green', ), 8 => array ( 'class' => 'col-purple', 'name' => 'Purple', ), 9 => array ( 'class' => 'col-red', 'name' => 'Red', ), 10 => array ( 'class' => 'col-grey-light', 'name' => 'Light Grey', ), 11 => array ( 'class' => 'col-grey-medium', 'name' => 'Medium Grey', ), 12 => array ( 'class' => 'col-grey', 'name' => 'Grey', ), 13 => array ( 'class' => 'col-grey-dark', 'name' => 'Dark Grey', ), 14 => array ( 'class' => 'col-black', 'name' => 'Black', ), )
VisualEditorConnectorColorPickerColorsBackground array ( 0 => array ( 'class' => 'col-white-bg', 'name' => 'White', ), 1 => array ( 'class' => 'col-blue-light-bg', 'name' => 'Light Blue', ), 2 => array ( 'class' => 'col-blue-bg', 'name' => 'Blue', ), 3 => array ( 'class' => 'col-blue-dark-bg', 'name' => 'Dark Blue', ), 4 => array ( 'class' => 'col-blue-navy-bg', 'name' => 'Navy Blue', ), 5 => array ( 'class' => 'col-orange-bg', 'name' => 'Orange', ), 6 => array ( 'class' => 'col-turquoise-bg', 'name' => 'Turquoise', ), 7 => array ( 'class' => 'col-green-bg', 'name' => 'Green', ), 8 => array ( 'class' => 'col-purple-bg', 'name' => 'Purple', ), 9 => array ( 'class' => 'col-red-bg', 'name' => 'Red', ), 10 => array ( 'class' => 'col-grey-light-bg', 'name' => 'Light Grey', ), 11 => array ( 'class' => 'col-grey-medium-bg', 'name' => 'Medium Grey', ), 12 => array ( 'class' => 'col-grey-bg', 'name' => 'Grey', ), 13 => array ( 'class' => 'col-grey-dark-bg', 'name' => 'Dark Grey', ), 14 => array ( 'class' => 'col-black-bg', 'name' => 'Black', ), )
VisualEditorConnectorCellBorderColors array ( 0 => array ( 'code' => '#97bfe7', ), 1 => array ( 'code' => '#5185b9', ), 2 => array ( 'code' => '#0060df', ), 3 => array ( 'code' => '#3e5389', ), 4 => array ( 'code' => '#e49c00', ), 5 => array ( 'code' => '#259596', ), 6 => array ( 'code' => '#3fb34c', ), 7 => array ( 'code' => '#cd41cb', ), 8 => array ( 'code' => '#b73a3a', ), 9 => array ( 'code' => '#d2d2d2', ), 10 => array ( 'code' => '#acacac', ), 11 => array ( 'code' => '#787878', ), 12 => array ( 'code' => '#434343', ), 13 => array ( 'code' => '#000000', ), )
VisualEditorConnectorPasteFilename '{{timestamp}}'
VisualEditorConnectorHelpUrl 'https://en.wiki.bluespice.com/wiki/Manual:Extension/VisualEditor'

ApiModules[edit source]

API Modules[edit source]

  • bs-vec-transformtowikitext
  • bs-vec-transformtohtml
  • bs-vec-restbase-mock

Hooks[edit source]

Hooks[edit source]

  • APIAfterExecute
  • BSSocialModuleDepths
  • BSPageTemplatesModifyTargetUrl
  • BeforePageDisplay
  • NamespaceManager::getMetaFields
  • BSApiNamespaceStoreMakeData
  • NamespaceManager::editNamespace
  • NamespaceManager::writeNamespaceConfiguration
  • BSUEModulePDFBeforeAddingStyleBlocks
==DescriptionMsg==
        
        {{AutoDocDescriptionMsg
        
        |name = BlueSpiceVisualEditorConnector
        
        |desc = {{int:bs-visualeditorconnector-desc
        
        }}
        
        }}
        
        ==Requirements==
        
        {{AutoDocRequirements
        
        |mediawiki = {{AutoDocVersion
        
        |name = MediaWiki
        
        |version = ~1.31
        
        }}
        
        |extensions = {{AutoDocVersion
        
        |name = BlueSpiceFoundation
        
        |version = ~3.2
        
        }}
        
        {{AutoDocVersion
        
        |name = VisualEditor
        
        |version = =0.1.0
        
        }}
        
        {{AutoDocVersion
        
        |name = OOJSPlus
        
        |version =
        
        *
        
        }}
        
        }}
        
        ==IntegratesInto==
        
        {{AutoDocIntegratesInto
        
        |into = {{AutoDocListItem
        
        |item = BlueSpiceFoundation
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceVisualEditorConnector
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceSimpleFarmer
        
        }}
        
        {{AutoDocListItem
        
        |item = VisualEditor
        
        }}
        
        {{AutoDocListItem
        
        |item = BlueSpiceSaferEdit
        
        }}
        
        }}
        
        ==Config==
        
        {{AutoDocConfig
        
        |config = {{AutoDocOption
        
        |name = VisualEditorConnectorEnableVisualEditor
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorUploadDialogType
        
        |value = <nowiki>'original'</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorSimpleSaveProcess
        
        |value = <nowiki>true</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorTableStyleRegistry
        
        |value = <nowiki>array (
        
          'Standard' => 'wikitable',
        
          'Content' => 'contenttable',
        
          'Content (black)' => 'contenttable-black',
        
          'Content (blue)' => 'contenttable-blue',
        
          'Content (darkblue)' => 'contenttable-darkblue',
        
          'Cusco Sky' => 'cuscosky',
        
          'Casablanca' => 'casablanca',
        
          'Greyscale' => 'greyscale',
        
          'Greyscale (narrow)' => 'greyscale-narrow',
        
        )</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorColorPickerColors
        
        |value = <nowiki>array (
        
          0 => 
        
          array (
        
            'class' => 'col-white',
        
            'name' => 'White',
        
          ),
        
          1 => 
        
          array (
        
            'class' => 'col-blue-light',
        
            'name' => 'Light Blue',
        
          ),
        
          2 => 
        
          array (
        
            'class' => 'col-blue',
        
            'name' => 'Blue',
        
          ),
        
          3 => 
        
          array (
        
            'class' => 'col-blue-dark',
        
            'name' => 'Dark Blue',
        
          ),
        
          4 => 
        
          array (
        
            'class' => 'col-blue-navy',
        
            'name' => 'Navy Blue',
        
          ),
        
          5 => 
        
          array (
        
            'class' => 'col-orange',
        
            'name' => 'Orange',
        
          ),
        
          6 => 
        
          array (
        
            'class' => 'col-turquoise',
        
            'name' => 'Turquoise',
        
          ),
        
          7 => 
        
          array (
        
            'class' => 'col-green',
        
            'name' => 'Green',
        
          ),
        
          8 => 
        
          array (
        
            'class' => 'col-purple',
        
            'name' => 'Purple',
        
          ),
        
          9 => 
        
          array (
        
            'class' => 'col-red',
        
            'name' => 'Red',
        
          ),
        
          10 => 
        
          array (
        
            'class' => 'col-grey-light',
        
            'name' => 'Light Grey',
        
          ),
        
          11 => 
        
          array (
        
            'class' => 'col-grey-medium',
        
            'name' => 'Medium Grey',
        
          ),
        
          12 => 
        
          array (
        
            'class' => 'col-grey',
        
            'name' => 'Grey',
        
          ),
        
          13 => 
        
          array (
        
            'class' => 'col-grey-dark',
        
            'name' => 'Dark Grey',
        
          ),
        
          14 => 
        
          array (
        
            'class' => 'col-black',
        
            'name' => 'Black',
        
          ),
        
        )</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorColorPickerColorsBackground
        
        |value = <nowiki>array (
        
          0 => 
        
          array (
        
            'class' => 'col-white-bg',
        
            'name' => 'White',
        
          ),
        
          1 => 
        
          array (
        
            'class' => 'col-blue-light-bg',
        
            'name' => 'Light Blue',
        
          ),
        
          2 => 
        
          array (
        
            'class' => 'col-blue-bg',
        
            'name' => 'Blue',
        
          ),
        
          3 => 
        
          array (
        
            'class' => 'col-blue-dark-bg',
        
            'name' => 'Dark Blue',
        
          ),
        
          4 => 
        
          array (
        
            'class' => 'col-blue-navy-bg',
        
            'name' => 'Navy Blue',
        
          ),
        
          5 => 
        
          array (
        
            'class' => 'col-orange-bg',
        
            'name' => 'Orange',
        
          ),
        
          6 => 
        
          array (
        
            'class' => 'col-turquoise-bg',
        
            'name' => 'Turquoise',
        
          ),
        
          7 => 
        
          array (
        
            'class' => 'col-green-bg',
        
            'name' => 'Green',
        
          ),
        
          8 => 
        
          array (
        
            'class' => 'col-purple-bg',
        
            'name' => 'Purple',
        
          ),
        
          9 => 
        
          array (
        
            'class' => 'col-red-bg',
        
            'name' => 'Red',
        
          ),
        
          10 => 
        
          array (
        
            'class' => 'col-grey-light-bg',
        
            'name' => 'Light Grey',
        
          ),
        
          11 => 
        
          array (
        
            'class' => 'col-grey-medium-bg',
        
            'name' => 'Medium Grey',
        
          ),
        
          12 => 
        
          array (
        
            'class' => 'col-grey-bg',
        
            'name' => 'Grey',
        
          ),
        
          13 => 
        
          array (
        
            'class' => 'col-grey-dark-bg',
        
            'name' => 'Dark Grey',
        
          ),
        
          14 => 
        
          array (
        
            'class' => 'col-black-bg',
        
            'name' => 'Black',
        
          ),
        
        )</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorCellBorderColors
        
        |value = <nowiki>array (
        
          0 => 
        
          array (
        
            'code' => '#97bfe7',
        
          ),
        
          1 => 
        
          array (
        
            'code' => '#5185b9',
        
          ),
        
          2 => 
        
          array (
        
            'code' => '#0060df',
        
          ),
        
          3 => 
        
          array (
        
            'code' => '#3e5389',
        
          ),
        
          4 => 
        
          array (
        
            'code' => '#e49c00',
        
          ),
        
          5 => 
        
          array (
        
            'code' => '#259596',
        
          ),
        
          6 => 
        
          array (
        
            'code' => '#3fb34c',
        
          ),
        
          7 => 
        
          array (
        
            'code' => '#cd41cb',
        
          ),
        
          8 => 
        
          array (
        
            'code' => '#b73a3a',
        
          ),
        
          9 => 
        
          array (
        
            'code' => '#d2d2d2',
        
          ),
        
          10 => 
        
          array (
        
            'code' => '#acacac',
        
          ),
        
          11 => 
        
          array (
        
            'code' => '#787878',
        
          ),
        
          12 => 
        
          array (
        
            'code' => '#434343',
        
          ),
        
          13 => 
        
          array (
        
            'code' => '#000000',
        
          ),
        
        )</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorPasteFilename
        
        |value = <nowiki>'{{timestamp}}'</nowiki>
        
        }}
        
        {{AutoDocOption
        
        |name = VisualEditorConnectorHelpUrl
        
        |value = <nowiki>'https://en.wiki.bluespice.com/wiki/Manual:Extension/VisualEditor'</nowiki>
        
        }}
        
        }}
        
        ==ApiModules==
        
        {{AutoDocApiModules
        
        |APIModules = {{AutoDocCallback
        
        |name = bs-vec-transformtowikitext
        
        |callback = BlueSpice\VisualEditorConnector\Api\TransformToWikiText
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-vec-transformtohtml
        
        |callback = BlueSpice\VisualEditorConnector\Api\TransformToHtml
        
        }}
        
        {{AutoDocCallback
        
        |name = bs-vec-restbase-mock
        
        |callback = BlueSpice\VisualEditorConnector\Api\RestbaseMock
        
        }}
        
        }}
        
        ==Hooks==
        
        {{AutoDocHooks
        
        |Hooks = {{AutoDocCallback
        
        |name = APIAfterExecute
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\APIAfterExecute\WrapPreloadText::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSSocialModuleDepths
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\BSSocialModuleDepths\AddVECModules::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSPageTemplatesModifyTargetUrl
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\BSPageTemplatesModifyTargetUrl\UseVisualEditor::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BeforePageDisplay
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\BeforePageDisplay\AddModules::callback,\BlueSpice\VisualEditorConnector\Hook\BeforePageDisplay\AddSaveProcessOverride::callback,\BlueSpice\VisualEditorConnector\Hook\BeforePageDisplay\AddStaticStyles::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = NamespaceManager::getMetaFields
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\NamespaceManagerGetMetaFields\RegisterMetaFields::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSApiNamespaceStoreMakeData
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\BSApiNamespaceStoreMakeData\AddData::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = NamespaceManager::editNamespace
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\NamespaceManagerEditNamespace\SetVisualEditorValues::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = NamespaceManager::writeNamespaceConfiguration
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\NamespaceManagerWriteNamespaceConfiguration\WriteToConfiguration::callback
        
        }}
        
        {{AutoDocCallback
        
        |name = BSUEModulePDFBeforeAddingStyleBlocks
        
        |callback = \BlueSpice\VisualEditorConnector\Hook\BSUEModulePDFBeforeAddingStyleBlock\AddColors::callback
        
        }}
        
        }}
(No difference)

Attachments

Discussions