Last edited one month ago
by Anonymous user

AutoDoc:BlueSpiceExtendedSearch: Difference between revisions

hw>Unknown user
No edit summary
imported>Unknown user
No edit summary
 
(7 intermediate revisions by 6 users not shown)
Line 13: Line 13:
|mediawiki = {{AutoDocVersion
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|name = MediaWiki
|version = 1.35.0
|version = 1.39.0
}}
}}
|extensions = {{AutoDocVersion
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|name = BlueSpiceFoundation
|version = 4.0
|version = 4.3
}}
}}
}}
}}
Line 23: Line 23:
{{AutoDocIntegratesInto
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|into = {{AutoDocListItem
|item = BlueSpiceArticleInfo
}}
{{AutoDocListItem
|item = BlueSpiceExtendedSearch
|item = BlueSpiceExtendedSearch
}}
}}
Line 42: Line 39:
{{AutoDocListItem
{{AutoDocListItem
|item = BlueSpiceVisualEditorConnector
|item = BlueSpiceVisualEditorConnector
}}
{{AutoDocListItem
|item = ContentDroplets
}}
}}
{{AutoDocListItem
{{AutoDocListItem
Line 110: Line 110:
|name = ESBackendHost
|name = ESBackendHost
|value = <nowiki>'127.0.0.1'</nowiki>
|value = <nowiki>'127.0.0.1'</nowiki>
}}
{{AutoDocOption
|name = ESBackendPassword
|value = <nowiki>''</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 117: Line 121:
{{AutoDocOption
{{AutoDocOption
|name = ESBackendTransport
|name = ESBackendTransport
|value = <nowiki>'http'</nowiki>
|value = <nowiki>'https'</nowiki>
}}
{{AutoDocOption
|name = ESBackendUsername
|value = <nowiki>''</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = ESCompactAutocomplete
|name = ESCompactAutocomplete
|value = <nowiki>false</nowiki>
|value = <nowiki>true</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 134: Line 142:
|name = ESEnableTypeFilter
|name = ESEnableTypeFilter
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ESExcludeNamespaces
|value = <nowiki>array (
  'autocomplete' =>
  array (
  ),
  'search' =>
  array (
  ),
)</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 139: Line 158:
|value = <nowiki>array (
|value = <nowiki>array (
)</nowiki>
)</nowiki>
}}
{{AutoDocOption
|name = ESIndexPrefix
|value = <nowiki>''</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 247: Line 270:
|name = ESSearchInRawWikitext
|name = ESSearchInRawWikitext
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ESSharedUploadsIndexPrefix
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 285: Line 312:
|name = ESSubpageMasterFilterUseRootOnly
|name = ESSubpageMasterFilterUseRootOnly
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ESUseSharedUploads
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 295: Line 326:
   4 => ')',
   4 => ')',
   5 => '~',
   5 => '~',
  6 => ' -',
)</nowiki>
)</nowiki>
}}
}}
Line 303: Line 335:
   1 => '.',
   1 => '.',
   2 => ';',
   2 => ';',
   3 => '-',
   3 => '_',
  4 => '_',
)</nowiki>
)</nowiki>
}}
}}
Line 347: Line 378:
{{AutoDocHooks
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSInsertMagicAjaxGetData BSInsertMagicAjaxGetData]
|callback = BS\ExtendedSearch\Hook\BSInsertMagicAjaxGetData\AddTagSearch::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFBeforeCreatePDF BSUEModulePDFBeforeCreatePDF]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFBeforeCreatePDF BSUEModulePDFBeforeCreatePDF]
|callback = \BS\ExtendedSearch\Hook\BSUEModulePDFBeforeCreatePDF\RemoveTagSearch::callback
|callback = \BS\ExtendedSearch\Hook\BSUEModulePDFBeforeCreatePDF\RemoveTagSearch::callback
Line 357: Line 384:
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = BS\ExtendedSearch\Hook\BeforePageDisplay\AddResources::callback
|callback = BS\ExtendedSearch\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChameleonSkinTemplateOutputPageBeforeExec ChameleonSkinTemplateOutputPageBeforeExec]
|callback = BS\ExtendedSearch\Setup::onSkinTemplateOutputPageBeforeExec
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 368: Line 391:
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = BS\ExtendedSearch\Hook\LoadExtensionSchemaUpdates\AddRelevanceTable::callback, BS\ExtendedSearch\Hook\LoadExtensionSchemaUpdates\AddHistoryTable::callback
|callback = BS\ExtendedSearch\Hook\LoadExtensionSchemaUpdates\AddRelevanceTable::callback, BS\ExtendedSearch\Hook\LoadExtensionSchemaUpdates\AddHistoryTable::callback, BS\ExtendedSearch\Hook\LoadExtensionSchemaUpdates\AddTraceTable::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
|callback = extendedsearchform
|callback = extendedsearchform
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeRunJobsTriggerRegisterHandlers MWStakeRunJobsTriggerRegisterHandlers]
|callback = \BS\ExtendedSearch\Hook\MWStakeRunJobsTriggerRegisterHandlers\RegisterExternalFileUpdater::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 388: Line 415:
|item = 0
|item = 0
}}
}}
}}
==Composer requirements==
{{AutoDocComposer requirements
|opensearch-project/opensearch-php = ~2
|mwstake/mediawiki-component-datastore = ~1
|all-packages = opensearch-project/opensearch-php,mwstake/mediawiki-component-datastore
}}
}}



Latest revision as of 16:57, 19 March 2025

DescriptionMsg

Elasticsearch search backend

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.39.0
  • BlueSpiceFoundation: 4.3

IntegratesInto

  • BlueSpiceExtendedSearch
  • BlueSpiceExtendedStatistics
  • BlueSpicePrivacy
  • BlueSpiceSimpleFarmer
  • BlueSpiceTagCloud
  • BlueSpiceVisualEditorConnector
  • ContentDroplets
  • VisualEditor

SpecialPages

  • BSSearchAdmin
  • BSSearchCenter

Permissions

Permissions

Name Description Role
extendedsearch-search-externalfile Search for external files accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager
extendedsearch-search-repofile Search for files accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager
extendedsearch-search-specialpage Search for special pages accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager
extendedsearch-search-wikipage Search for pages accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager

Config

Configuration

Name Value
ESAllowIndexingDocumentsWithoutContent true
ESAutoRecognizeSubpages true
ESAutoSetLangFilter false
ESBackendClass '\\BS\\ExtendedSearch\\Backend'
ESBackendHost '127.0.0.1'
ESBackendPassword ''
ESBackendPort '9200'
ESBackendTransport 'https'
ESBackendUsername ''
ESCompactAutocomplete true
ESDefaultSearchOperator 'AND'
ESEnableSearchHistoryTracking true
ESEnableTypeFilter true
ESExcludeNamespaces array ( 'autocomplete' => array ( ), 'search' => array ( ), )
ESExternalFilePaths array ( )
ESIndexPrefix ''
ESLookupModifierRegExPatterns array ( 0 => '[0-9]{2}\\-[0-9]{2}\\-[0-9]{4}', 1 => '[0-9]{4}\\-[0-9]{2}\\-[0-9]{2}', 2 => '[0-9]{2}\\-[0-9]{4}\\-[0-9]{2}', 3 => '[0-9]{2}\\/[0-9]{2}\\/[0-9]{4}', 4 => '[0-9]{4}\\/[0-9]{2}\\/[0-9]{2}', 5 => '[0-9]{2}\\/[0-9]{4}\\/[0-9]{2}', 6 => '[0-9]{2}\\.[0-9]{2}\\.[0-9]{4}', 7 => '[0-9]{4}\\.[0-9]{2}\\.[0-9]{2}', 8 => '[0-9]{2}\\.[0-9]{4}\\.[0-9]{2}', 9 => '[0-9]{2}\\\\[0-9]{2}\\\\[0-9]{4}', 10 => '[0-9]{4}\\\\[0-9]{2}\\\\[0-9]{2}', 11 => '[0-9]{2}\\\\[0-9]{4}\\\\[0-9]{2}', 12 => '[0-9]{1}\\-[0-9]{2}\\-[0-9]{4}', 13 => '[0-9]{4}\\-[0-9]{2}\\-[0-9]{1}', 14 => '[0-9]{1}\\-[0-9]{4}\\-[0-9]{2}', 15 => '[0-9]{4}\\-[0-9]{1}\\-[0-9]{2}', 16 => '[0-9]{2}\\-[0-9]{4}\\-[0-9]{1}', 17 => '[0-9]{2}\\-[0-9]{1}\\-[0-9]{4}', 18 => '[0-9]{1}\\/[0-9]{2}\\/[0-9]{4}', 19 => '[0-9]{4}\\/[0-9]{2}\\/[0-9]{1}', 20 => '[0-9]{1}\\/[0-9]{4}\\/[0-9]{2}', 21 => '[0-9]{4}\\/[0-9]{1}\\/[0-9]{2}', 22 => '[0-9]{2}\\/[0-9]{4}\\/[0-9]{1}', 23 => '[0-9]{2}\\/[0-9]{1}\\/[0-9]{4}', 24 => '[0-9]{1}\\.[0-9]{2}\\.[0-9]{4}', 25 => '[0-9]{4}\\.[0-9]{2}\\.[0-9]{1}', 26 => '[0-9]{1}\\.[0-9]{4}\\.[0-9]{2}', 27 => '[0-9]{4}\\.[0-9]{1}\\.[0-9]{2}', 28 => '[0-9]{2}\\.[0-9]{4}\\.[0-9]{1}', 29 => '[0-9]{2}\\.[0-9]{1}\\.[0-9]{4}', 30 => '[0-9]{1}\\\\[0-9]{2}\\\\[0-9]{4}', 31 => '[0-9]{4}\\\\[0-9]{2}\\\\[0-9]{1}', 32 => '[0-9]{1}\\\\[0-9]{4}\\\\[0-9]{2}', 33 => '[0-9]{4}\\\\[0-9]{1}\\\\[0-9]{2}', 34 => '[0-9]{2}\\\\[0-9]{4}\\\\[0-9]{1}', 35 => '[0-9]{2}\\\\[0-9]{1}\\\\[0-9]{4}', 36 => '[0-9]{2}\\-[0-9]{2}\\-[0-9]{2}', 37 => '[0-9]{2}\\/[0-9]{2}\\/[0-9]{2}', 38 => '[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}', 39 => '[0-9]{2}\\\\[0-9]{2}\\\\[0-9]{2}', 40 => '[0-9]{1}\\-[0-9]{1}\\-[0-9]{4}', 41 => '[0-9]{4}\\-[0-9]{1}\\-[0-9]{1}', 42 => '[0-9]{1}\\-[0-9]{4}\\-[0-9]{1}', 43 => '[0-9]{1}\\/[0-9]{1}\\/[0-9]{4}', 44 => '[0-9]{4}\\/[0-9]{1}\\/[0-9]{1}', 45 => '[0-9]{1}\\/[0-9]{4}\\/[0-9]{1}', 46 => '[0-9]{1}\\.[0-9]{1}\\.[0-9]{4}', 47 => '[0-9]{4}\\.[0-9]{1}\\.[0-9]{1}', 48 => '[0-9]{1}\\.[0-9]{4}\\.[0-9]{1}', 49 => '[0-9]{1}\\\\[0-9]{1}\\\\[0-9]{4}', 50 => '[0-9]{4}\\\\[0-9]{1}\\\\[0-9]{1}', 51 => '[0-9]{1}\\\\[0-9]{4}\\\\[0-9]{1}', 52 => '[0-9]{1}\\-[0-9]{1}\\-[0-9]{2}', 53 => '[0-9]{2}\\-[0-9]{1}\\-[0-9]{1}', 54 => '[0-9]{1}\\-[0-9]{2}\\-[0-9]{1}', 55 => '[0-9]{1}\\/[0-9]{1}\\/[0-9]{2}', 56 => '[0-9]{2}\\/[0-9]{1}\\/[0-9]{1}', 57 => '[0-9]{1}\\/[0-9]{2}\\/[0-9]{1}', 58 => '[0-9]{1}\\.[0-9]{1}\\.[0-9]{2}', 59 => '[0-9]{2}\\.[0-9]{1}\\.[0-9]{1}', 60 => '[0-9]{1}\\.[0-9]{2}\\.[0-9]{1}', 61 => '[0-9]{1}\\\\[0-9]{1}\\\\[0-9]{2}', 62 => '[0-9]{2}\\\\[0-9]{1}\\\\[0-9]{1}', 63 => '[0-9]{1}\\\\[0-9]{2}\\\\[0-9]{1}', 64 => '[0-9]{2}\\-[0-9]{4}', 65 => '[0-9]{2}\\/[0-9]{4}', 66 => '[0-9]{2}\\.[0-9]{4}', 67 => '[0-9]{2}\\\\[0-9]{4}', 68 => '[0-9]{4}\\-[0-9]{2}', 69 => '[0-9]{4}\\/[0-9]{2}', 70 => '[0-9]{4}\\.[0-9]{2}', 71 => '[0-9]{4}\\\\[0-9]{2}', 72 => '[0-9]{2}\\-[0-9]{2}', 73 => '[0-9]{2}\\/[0-9]{2}', 74 => '[0-9]{2}\\.[0-9]{2}', 75 => '[0-9]{2}\\\\[0-9]{2}', )
ESMatchPercentBoostFactor '0.5'
ESMatchPercentTitleField ''
ESOfferOperatorSuggestion true
ESRecentBoostFactor '0.5'
ESSearchCenterDefaultFilters array ( 0 => 'namespace_text', 1 => 'categories', )
ESSearchInRawWikitext true
ESSharedUploadsIndexPrefix false
ESSourceConfig array ( 'wikipage' => array ( 'skip_namespaces' => array ( 0 => 8, 1 => 9, ), ), 'repofile' => array ( 'extension_blacklist' => array ( 0 => 'mp4', ), 'max_size' => 20000000, ), 'externalfile' => array ( 'extension_blacklist' => array ( 0 => 'mp4', ), 'max_size' => 20000000, ), )
ESSubpageMasterFilterPatterns array ( )
ESSubpageMasterFilterUseRootOnly true
ESUseSharedUploads false
ESWildcardingOperators array ( 0 => '+', 1 => '|', 2 => '*', 3 => '(', 4 => ')', 5 => '~', 6 => ' -', )
ESWildcardingSeparators array ( 0 => ',', 1 => '.', 2 => ';', 3 => '_', )
ExtendedSearchExternalFilePathsExcludes array ( )
TagSearchSearchFieldTemplatePath '/resources/templates'

ApiModules

API Modules

  • bs-extendedsearch-autocomplete
  • bs-extendedsearch-query
  • bs-extendedsearch-resultrelevance
  • bs-extendedsearch-stats
  • bs-extendedsearch-triggerupdate
  • bs-extendedsearch-type-store

Hooks

Hooks

ExtensionFunctions

Template:AutoDocExtensionFunctions

Composer requirements

Template:AutoDocComposer requirements