Manual:Extension/BlueSpiceExtendedSearch

<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Extended search}}

'''ExtendedSearch''' replaces the default MediaWiki search engine. It is based on the [https://opensearch.org/ OpenSearch]  (up to BlueSpice 4.3 the Elasticsearch) engine. Pages and files are indexed immediately and available for searching in real-time. 

==Usage==

Extended search offers two ways of searching for content:

#'''Title search''' using the [[Manual:Extension/BlueSpiceExtendedSearch#Quick search|Quick search]]
#'''Fulltext search''' using the [[Manual:Extension/BlueSpiceExtendedSearch#Search Center (extended search)|Search center]]

By default, the search indexes:

Search center]]

By default, the search indexes:

*'''wiki pages''': all content pages, except for pages in the MediaWiki namespace
*'''special pages''': all pages in the namespace ''Special''
*'''repo files''': files uploaded to the wiki - for text files like Word documents and PDFs, this includes content and metadata
*'''external files''': files from arbitrary locations from accessible storage paths (e.g., mounted drives)
*'''social entities:''' entities (=pages) created by the [[Manual:Extension/BlueSpiceSocial|BlueSpiceSocial

===Search context===
If you start the search from the main page, a pure title search will be started. Use the Enter key to switch to the full-text search. These two search functions generally differ as follows:
{| class="wikitable" style="width: 100%;"
|+Difference between title search and full text search
!
! style="width:40%;" |Title search
!Full-text search
|-
!Search scope 
| style="width:40%;" |only the page titles are searched, preferably from content namespaces
|page content is also searched
|-
!Search result 
| style="width:40%;" |up to 7 "best bet" results are displayed
|all results are displayed
|-
![[Manual:Extension/BlueSpiceExtendedSearch#Search operators|Search operators]]
| style="width:40%;" |are not supported
|are supported
|-
![[Manual:Extension/BlueSpiceExtendedSearch#Namespace and subpage .22pills.22|Namespaces]]
| style="width:40%;" | search can be limited to a namespace
|search results can be limited to namespaces (in combination with other filters)
|-
![[Manual:Extension/BlueSpiceExtendedSearch#Namespace and subpage .22pills.22|Categories]]
| style="width:40%;" |category pages can be found using the search prefix “Category:”; these category pages then contain all pages that belong to a category
|search results can be limited to categories (in combination with other filters)
|-
![[Manual:Extension/BlueSpiceExtendedSearch#Subpages|Subpages]]
| style="width:40%;" |search can be limited to the subpages of a page
|the subpage syntax is not recognized in full-text, but works to a limited extent for page titles;
for example, the subpages of the "BlueSpice" page are found via "BlueSpice/*", but cannot be further restricted by using several wildcards.
|}

== Quick search==

===Recently viewed {{Bsvs|bsvFrom=4.4.1}}===
When you place the cursor in the search field, it returns a list of pages that you have  found and accessed through a recent search. Any suggested pages that you are not interested in, you can remove from this view by clicking on the <code>x</code> to the right of the page name. Once you start typing, the default suggestions disappear. 
[[File:BlueSpiceExtendedSearch 1708512053147.png|alt=Search box with a list  of  4 suggested pages|center|thumb|450x450px|Page suggestions for youbased on your recent searches]]

===Title search===
  
The most prominent search feature is the search box in the header of the wiki. If a user has not switched to the search center yet, this field simply looks for a page name or display title that contains the exact search term. The title search does not do a full-text search. You have to switch to the full-text search (=[[Manual:Extension/BlueSpiceExtendedSearch#Search Center (extended search)|Search center]]) for that. This can be done by simply pressing the <code>Enter</code>  key after entering a search term in the Quick Search field.

'''What users should know about this search field  (- you can try the following searches in this helpdesk):'''
#It is '''not case-sensitive''': "qual" or "Qual" return the same results.
#The search term needs to be at the '''beginning of a word''': the search term "ards" will not return pages that contain "cards".
#Search results are '''limited to 7 page titles'''. This is important to understand to have the right expectations. In most cases, the search field is simply used as a springboard to pages that are known to the user (e.g., to jump to a team page or to the page "Processes" or any other known page the user wants to reach quickly).
#'''Spelling mistakes''' will not return any results: "Qality" does not return "Quality".
#Multiple search terms can be in '''any order''' to produce results ("toc download"  finds pages just like "download toc").
# '''Search operators''' such as <code>""</code>, <code>OR</code>, <code>AND</code>re not supported. However, they are supported in the [[Manual:Extension/BlueSpiceExtendedSearch#Search operators|full-text search]].
#The '''sort order''' for the results are based on a combination of best title match and last edit date of the page. (You can find the technical details on the [[Reference:BlueSpiceExtendedSearch|reference page for the extension ExtendedSearch.]] Some configuration changes are possible if the wiki is hosted on premise. There are no configuration options in Cloud wikis. )
[[File:Manual:Autocomplete.png|alt=|center|thumb|366x366px|Search results (up to 7)]]


===Namespace and subpage "pills"===
The search bar supports pills for namespaces and subpages. [[File:extendedsearch-pilleEN.png|thumb|Namespace "pill"|center|link=Special:FilePath/extendedsearch-pilleEN.png]]
If a user types <code>Manual:</code>and clicks "Enter", a  pill for the namespace "Manual" appears and the search for the following term is limited to this namespace. .


==== Subpages ====
Subpage pills work in the same way. If you type in <code>PageName/</code>, any term after that is matched in the context of that page. If you search for "TestPage/Te", for example, the search will match only subpages of "TestPage" that contain "Te" in the title, like "TestPage/Test" and "TestPage/TestSubpage".

Subpage titles in namespaces are only found if the namespace prefix is included.
For example, the "Images" subpage with the path <code>Manual:Extension/VisualEditor/Images</code> is found using the following search terms:

* "Manual:Extension/Imag"
* "Manual:VisualEditor/Imag"
* "Manual:Imag"

The page is not found via:

* "VisualEditor/Imag"
* "Extension/Imag"

===Dates as search terms===
The search recognizes certain date formats. In the search center, these date formats are treated with surrounding quotation marks.  <gallery widths="400" heights="200">
File:Manual:extendedsearch-datum1.png
File:Manual:extendedsearch-datum2.png
</gallery><br />
==Search Center (extended search)==
As soon as you trigger the full-search with the magnifying glass symbol or the ''Enter'' key, the wiki switches to the Search Center. This is a special page that offers the full functionality of the search. The search in the Search Center is carried out using the same search bar that is also used for autocomplete. 
Here, the search engine carries out a full text search, which also includes the metadata of documents. It does not index the wikitext of a wiki page, but rather the rendered content, that is the output by the browser.<br />
[[File:Manual:extendedsearch-searchcenter.png|link=link=Special:FilePath/ExtendedSearch2.png|alt=|center|thumb|402x402px|Search Center]]

===Search operators===
{{Messagebox|boxtype=important|icon=|Note text=Search operators only work in the search center (fulltext search). You cannot use search operators in the title search.


If you are '''searching for contiguous words''', they should be enclosed in quotation marks (") for performance reasons and to support a unique search.
|bgcolor=}}
Search operators have to be written in '''all-caps'''. 
====AND====
*<code>admin AND docu</code>: Returns pages that contain the '''exact term''' <code>admin</code> '''as well as the exact term'''  <code>docu</code>
*<code>admin* AND docu</code>: If the term  <code>administration</code>  should be found, you need to provide a wildcard asterisk (<code>*</code>).
'''Compare''': The search <code>admin docu</code>  automatically is a wildcard search. It returns pages that contain '''both''' <code>admin*</code> '''and''' <code>docu*</code> . This search normally finds more results than the serach  <code>admin* AND docu</code> (because in the second case, the exact term <code>docu</code> is returned).
====<code>"</code> (apostrophes)====
Apostrophes around a search term triggers an <code>AND</code> search for '''all terms''' in the query:
* <code>"admin" docu</code>: same result as <code>admin AND docu</code> (i.e., also the precise term  <code>docu</code>  will be searched).
====NOT====
*<code>admin* NOT docu*</code>: Returns pages that contain words that start with  <code>admin</code> , but that don't contain words that start with <code>docu</code> .
====OR==== 
*<code>admin OR docu</code>: Returns pages that contain '''either the exact term''' <code>admin</code> '''or the exact term''' <code>docu</code>.
====<code>*</code> (wildcard) ====
*<code>'''admin*'''</code>: Returns pages that contain words that begin with <code>admin</code> .

=== Elements===

*'''Hit count''' - shows how many matches a search has returned. It may be exact or approximate. Approximation is due to dynamic check for permissions to view each page in the results, some results may not be shown to the user with no adequate permissions event if it matches the search term.
*'''Tools''' - these are located in the top right as a set of buttons: 
**Create a page - represented by a "plus" button - will create a page with current search term as a title (only visible if user has permission to  create pages)
**Add filters - represented by a "funnel" icon - opens a dialog where users can select the type of filter to apply to the search.<br />[[File:Manual:extendedsearch3.png|link=link=https://en.wiki.bluespice.com/wiki/File:ExtendedSearch3.png|alt=|center|thumb|341x341px|Adding filters]]
**Search options - represented by a "gear" icon - opens a dialog where users can change settings for the current search. It provides options like the number of results per page, sorting field and order.<br />[[File:Manual:extendedsearch4.png|link=link=Special:FilePath/ExtendedSearch5.png|alt=|center|thumb|Options dialog]]
**Export search - represented by the "export" icon - opens a dialog to export current search results to a dedicated page (only visible to authorized users, by default admin users). 

*'''Filter:''' Filters are displayed in form of pills below the results counter. Each filter pill represents a different attribute. Filter values can be changed by clicking on the filter pill and selecting the desired options from the popup that will open. Filter can be removed by clicking on  the "x" button in each pill.<br />[[File:Manual:extendedsearch2.png|link=link=Special:FilePath/ExtendedSearch4.png|alt=|center|thumb|Editing filter]]
*'''Results:''' If current search criteria field any results, a list of results is displayed. The information available in the results is depending on the result type):
**Main title of the result (page title, file name...)
**Result type
**Size and extension (for files)
**Thumb image (for images) or file type icon (for other file types)
**Redirect information
**Original name (for wikipages, if the page display title is different than the actual page title)
**Secondary information like page categories, modification and creation date, author, etc.
**Snippet of the matches in the content of the page (if there are matches in the page content),
**Sections with matches in the content (for wikipages)

In case there is an exact match for a given search term, the result that matches exactly is displayed as a "featured" result. Such a result displays a preview image of the page and always displays the content snippet, regardless of whether there are matches in the content or not.
====Results relevance====
All logged-in users can mark certain results as "favorites" by clicking on the star symbol in the right corner of each result.
Files marked as "favorite" will score higher in future searches - this is not visible immediately, however, but happens over time.
One user's relevance settings won't affect other user's searches. Results can be unmarked as "favorite" by clicking on the "star" symbol again.

====Exporting search results====
After executing the search, administrators can export (save) the results to a specific page using the "Export" command from the "Tools" menu. The list is exported to ''MediaWiki:PageCollection/LISTENNAME.''

Only valid wikipages are exported. The pages contained in a list can be included in a book in the book function via ''Mass add> Source: Page collection.''
[[File:Manual:ExtendedSearch5.png|link=link=Special:FilePath/ExtendedSearch6.png|alt=|center|thumb|Export search]]

==Configuration==
In the [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under settings for the extension ''BlueSpiceExtendedSearch'', the following configuration options are available:<br />

{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}

==SearchAdmin==
''Special:SearchAdmin''<nowiki> is a special page for wiki admins and shows the number and types of indexed documents.{{Box Links-en|Topic1=</nowiki>

{{Translation}}
__FORCETOC__

[[Category:Search]]