AutoDoc:BlueSpiceExtendedSearch: Difference between revisions

Back to version history
Browse history interactively
← Older editNewer edit →
VisualWikitext
imported>Unknown user
No edit summary
hw>Unknown user
No edit summary
Line 33: Line 33:
{{AutoDocListItem
{{AutoDocListItem
|item = BlueSpiceTagCloud
|item = BlueSpiceTagCloud
}}
{{AutoDocListItem
|item = BlueSpiceVisualEditorConnector
}}
}}
{{AutoDocListItem
{{AutoDocListItem
Line 45: Line 42:
{{AutoDocListItem
{{AutoDocListItem
|item = PDFCreator
|item = PDFCreator
}}
{{AutoDocListItem
|item = VisualEditor
}}
}}
}}
}}
Line 90: Line 84:
|desc = {{int:right-extendedsearch-search-wikipage
|desc = {{int:right-extendedsearch-search-wikipage
}}
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = searchShortcut
|value = <nowiki>true</nowiki>
}}
}}
}}
}}
Line 129: Line 130:
|name = ESBackendUsername
|name = ESBackendUsername
|value = <nowiki>''</nowiki>
|value = <nowiki>''</nowiki>
}}
{{AutoDocOption
|name = ESCompactAutocomplete
|value = <nowiki>true</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 259: Line 256:
{{AutoDocOption
{{AutoDocOption
|name = ESOfferOperatorSuggestion
|name = ESOfferOperatorSuggestion
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ESOverrideSpecialSearch
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
}}
Line 268: Line 269:
|name = ESSearchCenterDefaultFilters
|name = ESSearchCenterDefaultFilters
|value = <nowiki>array (
|value = <nowiki>array (
   0 => 'namespace_text',
   0 => 'namespace',
   1 => 'categories',
   1 => 'categories',
)</nowiki>
)</nowiki>
Line 274: Line 275:
{{AutoDocOption
{{AutoDocOption
|name = ESSearchInRawWikitext
|name = ESSearchInRawWikitext
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = ESSecureResults
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
}}
Line 384: Line 389:
|Hooks = {{AutoDocCallback
|Hooks = {{AutoDocCallback
|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 = addResources
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = BS\ExtendedSearch\Hook\GetPreferences\AddUserPreferredNamespaces::callback
|callback = BS\ExtendedSearch\Hook\GetPreferences\AddUserPreferredNamespaces::callback, BS\ExtendedSearch\Hook\GetPreferences\AddUserPreferenceSearchShortCut::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 397: Line 402:
|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/MWStakeGenericTagHandlerInitTags MWStakeGenericTagHandlerInitTags]
|callback = registerTags
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 405: Line 414:
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceManager::editNamespace NamespaceManager::editNamespace]
|callback = \BS\ExtendedSearch\Hook\NamespaceManagerEditNamespace\ReindexNamespace::callback
|callback = \BS\ExtendedSearch\Hook\NamespaceManagerEditNamespace\ReindexNamespace::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/OpenSearchUrls OpenSearchUrls]
|callback = overrideOpenSearchUrls
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SpecialPage_initList SpecialPage_initList]
|callback = overrideSpecialSearch
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 420: Line 437:
{{AutoDocComposer requirements
{{AutoDocComposer requirements
|opensearch-project/opensearch-php = ~2
|opensearch-project/opensearch-php = ~2
|mwstake/mediawiki-component-datastore = ~1
|mwstake/mediawiki-component-datastore = ~2
|all-packages = opensearch-project/opensearch-php,mwstake/mediawiki-component-datastore
|mwstake/mediawiki-component-generictaghandler = ~1
|all-packages = opensearch-project/opensearch-php,mwstake/mediawiki-component-datastore,mwstake/mediawiki-component-generictaghandler
}}
}}


Revision as of 10:30, 21 November 2025

DescriptionMsg

Elasticsearch search backend

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.43.0
  • BlueSpiceFoundation: 5.0.0

IntegratesInto

  • BlueSpiceExtendedSearch
  • BlueSpiceExtendedStatistics
  • BlueSpicePrivacy
  • BlueSpiceTagCloud
  • BlueSpiceWikiFarm
  • ContentDroplets
  • PDFCreator

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

DefaultUserOptions

User options

Name Value
searchShortcut true

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 ''
ESDefaultSearchOperator 'AND'
ESEnableSearchHistoryTracking true
ESEnableTypeFilter true
ESExcludeNamespaces array ( 'autocomplete' => array ( 0 => 6, 1 => 7, ), '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
ESOverrideSpecialSearch true
ESRecentBoostFactor '0.5'
ESSearchCenterDefaultFilters array ( 0 => 'namespace', 1 => 'categories', )
ESSearchInRawWikitext true
ESSecureResults 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

all-packages opensearch-project/opensearch-php

mwstake/mediawiki-component-datastore

mwstake/mediawiki-component-generictaghandler

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceExtendedSearch&oldid=13379"