Difference between revisions of "Reference:BlueSpiceExtendedSearch"
Fbaeckmann (talk | contribs) m (Text replacement - "|edition=BlueSpice free |active=Yes" to "|edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |active=Yes") |
(Tag: 2017 source edit) |
Contents
Extension: BlueSpiceExtendedSearch
Overview | |||
---|---|---|---|
Description: | Full-text search in articles and files, faceted search, fuzzy search, spellchecker and sorting as well as search-as-you-type and auto-complete functionality. | ||
State: | stable | Dependency: | BlueSpice |
Developer: | HalloWelt | License: | GPL v3 only |
Type: | BlueSpice | Category: | Search and Navigation |
Edition: | BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud | ||
Features[edit source]
ExtendedSearch replaces the default MediaWiki search engine. It is based on ElasticSearch engine, and provides many improvements over the standard MediaWiki search both in terms of quality of indexed content and user interface.
Usage / Features[edit | edit source]
- Search titles.
- Search the full content.
- Search uploaded or linked files (Office documents and PDFs).
- Search image data.
- Search-as-you-type and auto-complete.
- Ignore upper and lower case (case-insensitive).
- Search with the operators AND, OR, NOT.
- Search with wildcards.
- Search for phrases.
- Fuzzy search.
- Search for sentence fragments.
Technical information[edit | edit source]
Configuration (configuration manager)[edit | edit source]
Some aspects of this extension can be configured on Special:BlueSpiceConfigManager, under section "ExtendedSearch". Here wiki administrators can configure:
- external file paths
- layout of the autocomplete box
- language filter
- exclude patterns
Configuration (server)[edit | edit source]
For boosting by match percent, the following settings are available in the extension itself: "ESMatchPercentBoostFactor": {
"description": "How much to boost the result based on the percent of its title taken up by the search term. Set to 0 to disable",
"public": false,
"value": "0.5"
},
"ESMatchPercentTitleField": {
"description": "Field on which to base the match percent boosting. If empty, default title field of the source will be used",
"public": false,
"value": ""
},
Description:
- ESMatchPercentBoostFactor: The value here is multiplied by the the match percent and by the score of the document. Example: The search term is "Test". The search finds for example "Testpage" and - let's say - assigns a score of 20 to this result. Your search term matches 50 percent of the found name, so its match factor is 0.5. This factor is then multiplied by the value in this setting (by default 0.5), which gives the total boost factor of 0.25. The final score is calculated as "original score + (original score * boost factor)" => 20 + (20 * 0.25 ) = 20 + 5 = 25. This means that because your search term matches 50% of the result, it got boosted by the factor of 5.
- ESMatchPercentTitleField: Field on which the match analysis is performed. Defaults to nothing, so whatever the search lookup sets. It can be set to "prefixed_text" to calculate match percent on the title with namespace prefix, for example, or to something like "basename" to calculate the match percent only on the page name, without the namespace prefix.
Requirements[edit | edit source]
This extension requires BlueSpiceFoundation and Elasticsearch.
More info[edit | edit source]
For detailed description and usage, visit our help page.
Demo[edit | edit source]
Test the search functionality in our BlueSpice Demo.
{{DISPLAYTITLE:ExtendedSearch}} {{BSExtensionInfobox |desc=Full-text search in articles and files, faceted search, fuzzy search, spellchecker and sorting as well as search-as-you-type and auto-complete functionality. |status=stable |developer=HalloWelt |type=BlueSpice |edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |active=Yes |compatible=BlueSpice |category=Search and Navigation |license=GPL v3 only |docu=https://www.mediawiki.org/wiki/Extension:ExtendedSearch }} '''ExtendedSearch''' replaces the default MediaWiki search engine. It is based on ElasticSearch engine, and provides many improvements over the standard MediaWiki search both in terms of quality of indexed content and user interface. ==Usage / Features== *Search titles. *Search the full content. *Search uploaded or linked files (Office documents and PDFs). *Search image data. *Search-as-you-type and auto-complete. *Ignore upper and lower case (case-insensitive). *Search with the operators AND, OR, NOT. *Search with wildcards. *Search for phrases. *Fuzzy search. *Search for sentence fragments. ==Technical information== ===Configuration (configuration manager)=== Some aspects of this extension can be configured on [[Special:BlueSpiceConfigManager]], under section "ExtendedSearch". Here wiki administrators can configure: *external file paths *layout of the autocomplete box *language filter *exclude patterns ===Configuration (server)=== For boosting by match percent, the following settings are available in the extension itself:<syntaxhighlight lang="json"> "ESMatchPercentBoostFactor": { "description": "How much to boost the result based on the percent of its title taken up by the search term. Set to 0 to disable", "public": false, "value": "0.5" }, "ESMatchPercentTitleField": { "description": "Field on which to base the match percent boosting. If empty, default title field of the source will be used", "public": false, "value": "" }, </syntaxhighlight> Description: *'''ESMatchPercentBoostFactor''': The value here is multiplied by the the match percent and by the score of the document. Example: The search term is "Test". The search finds for example "Testpage" and - let's say - assigns a score of 20 to this result. Your search term matches 50 percent of the found name, so its match factor is 0.5. This factor is then multiplied by the value in this setting (by default 0.5), which gives the total boost factor of 0.25. The final score is calculated as "original score + (original score * boost factor)" => 20 + (20 * 0.25 ) = 20 + 5 = 25. This means that because your search term matches 50% of the result, it got boosted by the factor of 5. *'''ESMatchPercentTitleField:''' Field on which the match analysis is performed. Defaults to nothing, so whatever the search lookup sets. It can be set to "prefixed_text" to calculate match percent on the title with namespace prefix, for example, or to something like "basename" to calculate the match percent only on the page name, without the namespace prefix. ===Requirements=== This extension requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]] and [[Setup:Installation Guide/System Preparation/Linux/Elasticsearch|Elasticsearch]]. ==More info== For detailed description and usage, visit our [[Manual:Extension/ExtendedSearch|help page]]. ==Demo== Test the search functionality in our [https://en.demo.bluespice.com/wiki/Main_Page BlueSpice Demo.] [[de:Referenz:{{PAGENAME}}]] [[en:Reference:{{PAGENAME}}]] [[Category:BlueSpice free]] [[Category:Extension]] __FORCETOC__
Line 1: | Line 1: | ||
− | |||
{{BSExtensionInfobox | {{BSExtensionInfobox | ||
|desc=Full-text search in articles and files, faceted search, fuzzy search, spellchecker and sorting as well as search-as-you-type and auto-complete functionality. | |desc=Full-text search in articles and files, faceted search, fuzzy search, spellchecker and sorting as well as search-as-you-type and auto-complete functionality. |