Meryam Sahin (talk | contribs)
No edit summary
Meryam Sahin (talk | contribs)
No edit summary
 
Line 1: Line 1:
<br>
<status color="green" light="true">done</status><br>
{{DISPLAYTITLE:Global search}}
{{DISPLAYTITLE:Global search}}
BlueSpice provides three search modes for finding content: title search, full-text search, and search across all wikis.
BlueSpice provides search across page titles and full-text content. Search starts in the search field in the wiki header and can be narrowed to different search contexts. Selecting a search context or pressing Enter opens the '''Search center'''.
== Search options ==
== Header search ==
The search interface provides the following search options:
The search field in the wiki header provides autocomplete suggestions based on page titles. The available search contexts range from the broadest to the most specific:
{| class="wikitable" style="width: 100%;"
{| class="wikitable" style="width: 100%;"
|+Search options
|+Search contexts
! Search option
! Search context
! Availability
! Description
! Description
|-
|-
| Title search
| '''All wikis'''
| Searches page titles and provides autocomplete suggestions.
| Always available
| Searches across all available wikis.
|-
|-
| Full-text search
| '''Whole wiki'''
| Searches the content of wiki pages and indexed files.
| Always available
| Searches the current wiki.
|-
|-
| Search in all wikis
| '''Namespace'''
| Searches page titles and full-text content across all available wikis.
| Always available
| Limits the search to a specific namespace.
|-
| '''Subpages'''
| Available when the search term is part of a page title of a page with subpages
| Limits the search to subpages of pages that contain the search term in their title.
|-
| '''Book'''
| Available when a book is available
| Limits the search to the book.
|}
|}
By default, the search index includes:
[[File:bluespice-extendedsearch-title-search.png|alt=Title search showing matching page titles and search context information|center|thumb|830x830px|Header search]]
* wiki pages, except pages in the MediaWiki namespace
To open the '''Search center''', press Enter or select one of the available search contexts.
* special pages in the '''Special''' namespace
* files uploaded to the wiki. For text-based files such as Word documents and PDFs, the file content and metadata are indexed.
* external files, if configured, from accessible storage locations such as mounted drives
== Title search ==
The title search is available in the search field in the wiki header. It searches page names and display titles. <br>
Enter a search term in the search field to display matching page titles. To start a full-text search, press Enter or select the full-text search option.
=== Recently viewed ===
=== Recently viewed ===
When the search field is opened without a search term, it displays pages accessed through recent searches.
When the search field is opened without a search term, it displays recently viewed pages.
[[File:bluespice-extendedsearch-recent-searches.png|alt=Search field with four recently viewed page suggestions|center|thumb|450x450px|Recently viewed pages]]
[[File:bluespice-extendedsearch-recent-searches.png|alt=Search field with four recently viewed page suggestions|center|thumb|450x450px|Recently viewed pages]]
=== How title search works ===
=== Namespace search ===
The title search has the following characteristics:
* It is not case-sensitive. For example, <code>qual</code> and <code>Qual</code> return the same results.
* Search results are limited to 10 page titles.
* Spelling errors usually do not return matching results. For example, <code>Qality</code> does not return <code>Quality</code>. Depending on the wiki configuration, spelling suggestions may be displayed.
* Multiple search terms can appear in any order. For example, <code>toc download</code> and <code>download toc</code> return the same matching pages.
* Search operators such as <code>"</code>, <code>OR</code>, and <code>AND</code> are not supported.
* Results are sorted based on a combination of title relevance and the page's last edit date. The exact ranking can be affected by configuration in on-premise installations.
* The search can be limited to a specific context using search filters. <br>
A title-search result can show the following information:
* the page title
* the wiki name in a colored pill
* the namespace in bold
* the parent page in regular text
* the original page title in parentheses if the result matches the page's display title
* a redirect indicator and target page if the result is a redirect
[[File:bluespice-extendedsearch-title-search.png|alt=Title search showing matching page titles and search context information|center|thumb|830x830px|Title search]]
=== Namespace and subpage search ===
The search field supports namespace and subpage search using wiki syntax. <br>
To limit a search to a namespace:
To limit a search to a namespace:
# Enter the namespace followed by a colon, for example <code>Controlled Document:</code>.
# Enter the namespace followed by a colon, for example <code>Controlled Document:</code>.
Line 53: Line 41:
# The namespace is added as a search pill.
# The namespace is added as a search pill.
# Enter the search term after the pill. <br>
# Enter the search term after the pill. <br>
The search is then limited to the selected namespace. <br>
The search is then limited to the selected namespace.
To limit a search to a subpage:
[[File:bluespice-extendedsearch-namespace-pill.png|alt=Search field with a namespace search pill|center|thumb|450x450px|Namespace search pill]]
# Enter the parent page followed by a slash, for example <code>TestPage/</code>.
=== Subpage search ===
# Enter the search term.
To limit a search to subpages, enter the parent page followed by a slash. For example:
# The search results are limited to matching subpages of the specified page.<br>
<code>TestPage/</code>
Enter the search term after the slash. The search results are limited to matching subpages of the specified page. <br>
For example, <code>TestPage/Te</code> matches subpages such as <code>TestPage/Test</code> and <code>TestPage/TestSubpage</code>. <br>
For example, <code>TestPage/Te</code> matches subpages such as <code>TestPage/Test</code> and <code>TestPage/TestSubpage</code>. <br>
When searching for a subpage in a namespace, include the namespace prefix in the search path. For example, a page with the path <code>Minutes:JourFixe/2026-09-30</code> can be found with:
When the subpage is in a namespace, include the namespace prefix in the search path. For example, a page with the path <code>Minutes:JourFixe/2026-09-30</code> can be found with:
* <code>Minutes:JourFixe/20</code>
* <code>Minutes:JourFixe/20</code>
* <code>Minutes:JourFixe/</code>
* <code>Minutes:JourFixe/</code>
* <code> Minutes:Jou</code> <br>
* <code>Minutes:Jou</code> <br>
The page is not necessarily found with:
The page is not necessarily found with:
* <code>JourFixe/20</code>
* <code>JourFixe/20</code>
* <code>Jour</code>
* <code>Jour</code>
[[File:bluespice-extendedsearch-namespace-pill.png|alt=Search field with a namespace search pill|center|thumb|450x450px|Namespace search pill]]
=== Search suggestions ===
The header search is not case-sensitive. For example, <code>qual</code> and <code>Qual</code> return the same results. <br>
Search results are limited to 10 page titles. Spelling errors usually do not return matching results. For example, <code>Qality</code> does not return <code>Quality</code>. Depending on the wiki configuration, spelling suggestions may be displayed. <br>Multiple search terms can appear in any order. For example, <code>toc download</code> and <code>download toc</code> return the same matching pages. <br>
Search operators such as <code>"</code>, <code>OR</code>, and <code>AND</code> are not supported in the header search. <br>
Results are sorted based on a combination of title relevance and the page's last edit date. The exact ranking can be affected by configuration in on-premise installations. <br>
A search result can show the following information:
* the page title
* the wiki name in a colored pill
* the namespace in bold
* the parent page in regular text
* the original page title in parentheses if the result matches the page's display title
* a redirect indicator and target page if the result is a redirect
=== Dates as search terms ===
=== Dates as search terms ===
The search recognizes certain date formats. In the '''Search center''', recognized date formats are treated as search terms with surrounding quotation marks.
The search recognizes certain date formats. In the '''Search center''', recognized date formats are treated as search terms with surrounding quotation marks.
Line 73: Line 73:
File:Manual:extendedsearch-datum2.png
File:Manual:extendedsearch-datum2.png
</gallery>
</gallery>
== Full-text search ==
== Search center ==
The '''Search center''' provides full-text search. It searches the rendered content of wiki pages as well as indexed file content and metadata. <br>
The '''Search center''' opens when Enter is pressed in the header search field or when a search context is selected. It provides full-text search and additional options for refining search results. <br>
To start a full-text search:
The full-text search searches the rendered content of wiki pages as well as indexed file content and metadata.
* Press Enter after entering a search term in the search field.
* Select one of the full-text search options.
[[File:bluespice-extendedsearch-search-center.png|alt=Search Center showing full-text search results|center|thumb|402x402px|Search Center]]
[[File:bluespice-extendedsearch-search-center.png|alt=Search Center showing full-text search results|center|thumb|402x402px|Search Center]]
The '''Search center''' provides filters and search options for refining the results.
=== Search filters ===
=== Search filters ===
The available filters depend on the current search context and configuration. Use the filter options to narrow the search results. Active filters can be removed individually.
The available filters depend on the current search context and configuration. Use the filter options to narrow the search results. Active filters can be removed individually.
[[File:bluespice-extendedsearch-filters.png|alt=Search Center with search filters|center|thumb|650x650px|Search filters]]
[[File:bluespice-extendedsearch-filters.png|alt=Search Center with search filters|center|thumb|650x650px|Search filters]]
=== Search operators ===
=== Search operators ===
Search operators are supported in full-text search. They are not supported in title search. <br>
Search operators are supported in full-text search. They are not supported in the header search. Search operators must be written in uppercase. If consecutive words must be searched together, enclose the words in quotation marks.
Search operators must be written in uppercase. <br>
If a search contains consecutive words that must be searched together, enclose the words in quotation marks.
{| class="wikitable" style="width: 100%;"
{| class="wikitable" style="width: 100%;"
|+Search operators
|+Search operators
!Operator
! Operator
!Description
! Description
|-
|-
|AND
| AND
|Use <code>AND</code> to find results that contain both search terms.
| Use <code>AND</code> to find results that contain both search terms.
* <code>admin AND docu</code> returns pages containing the exact terms <code>admin</code> and <code>docu</code>.
* <code>admin AND docu</code> returns pages containing the exact terms <code>admin</code> and <code>docu</code>.
* <code>admin* AND docu</code> returns pages containing words that start with <code>admin</code> and the exact term <code>docu</code>. <br>
* <code>admin* AND docu</code> returns pages containing words that start with <code>admin</code> and the exact term <code>docu</code>.
A search without an operator automatically uses a wildcard search for each term. For example, <code>admin docu</code> searches for words that start with <code>admin</code> and <code>docu</code>.
A search without an operator automatically uses a wildcard search for each term. For example, <code>admin docu</code> searches for words that start with <code>admin</code> and <code>docu</code>.
|-
|-
|Quotation marks
| Quotation marks
|Quotation marks can be used to search for all terms in a query. For example:
| Quotation marks can be used to search for all terms in a query. For example:
* <code>"admin" docu</code> produces the same result as <code>admin AND docu</code>.
* <code>"admin" docu</code> produces the same result as <code>admin AND docu</code>.
|-
|-
|NOT
| NOT
|Use <code>NOT</code> to exclude a search term. For example:
| Use <code>NOT</code> to exclude a search term. For example:
* <code>admin* NOT docu*</code> returns pages containing words that start with <code>admin</code> but not words that start with <code>docu</code>.
* <code>admin* NOT docu*</code> returns pages containing words that start with <code>admin</code> but not words that start with <code>docu</code>.
|-
|-
|OR
| OR
|Use <code>OR</code> to find results containing either search term. For example:
| Use <code>OR</code> to find results containing either search term. For example:
* <code>admin OR docu</code> returns pages containing either <code>admin</code> or <code>docu</code>.
* <code>admin OR docu</code> returns pages containing either <code>admin</code> or <code>docu</code>.
|-
|-
|Wildcard
| Wildcard
|Use <code>*</code> after part of a word to search for words that begin with that character sequence. For example:
| Use <code>*</code> after part of a word to search for words that begin with that character sequence. For example:
* <code>admin*</code> returns pages containing words that begin with <code>admin</code>.
* <code>admin*</code> returns pages containing words that begin with <code>admin</code>.
|}
|}
Line 128: Line 123:
Logged-in users can mark search results as favorites by selecting the pin icon on a result. <br>
Logged-in users can mark search results as favorites by selecting the pin icon on a result. <br>
Favorite results receive a higher ranking in future searches for the same user. The ranking change is applied after the background process updates the search preferences. <br>
Favorite results receive a higher ranking in future searches for the same user. The ranking change is applied after the background process updates the search preferences. <br>
Favorites are user-specific. Marking a result as a favorite does not affect other users' search results. <br>
Favorites are user-specific. Marking a result as a favorite does not affect other users' search results. <br>To remove a result from favorites, select the pin icon again.
To remove a result from favorites, select the pin icon again.
=== AI summary ===
=== AI summary ===
In wikis configured for AI usage, an AI summary can be displayed before the search results. The display is controlled by the [[Extension/BlueSpiceConfigManager#ChatBot|ChatBot configuration]].
In wikis configured for AI usage, an AI summary can be displayed before the search results. The display is controlled by the [[Extension/BlueSpiceConfigManager#ChatBot|ChatBot configuration]].
== Search in all wikis ==
== Indexed content ==
The search interface provides an option to search in all available wikis. <br>
By default, the search index includes:
Search in all wikis includes both page titles and full-text content. Search results can therefore include matching pages and indexed files from multiple wikis. <br>​Search results identify the wiki in which each result is located by displaying the wiki name in a colored pill. The wiki color is assigned by an administrator.
* wiki pages, except pages in the MediaWiki namespace
* special pages in the '''Special''' namespace
* files uploaded to the wiki. For text-based files such as Word documents and PDFs, the file content and metadata are indexed.
* external files, if configured, from accessible storage locations such as mounted drives
== Configuration ==
== Configuration ==
In the [[Extension/BlueSpiceConfigManager#BlueSpiceExtendedSearch|BlueSpiceConfigManager]], settings for '''BlueSpiceExtendedSearch''' are available for on-premise installations.
In the [[Extension/BlueSpiceConfigManager#BlueSpiceExtendedSearch|BlueSpiceConfigManager]], settings for '''BlueSpiceExtendedSearch''' are available for on-premise installations.
== Search administration ==
== Search administration ==
The page <code>Special:SearchAdmin</code> provides information about the indexed documents, including their number and type.
The page <code>Special:SearchAdmin</code> provides information about indexed documents, including their number and type.

Latest revision as of 11:24, 9 September 2026

done
BlueSpice provides search across page titles and full-text content. Search starts in the search field in the wiki header and can be narrowed to different search contexts. Selecting a search context or pressing Enter opens the Search center.

The search field in the wiki header provides autocomplete suggestions based on page titles. The available search contexts range from the broadest to the most specific:

Search contexts
Search context Availability Description
All wikis Always available Searches across all available wikis.
Whole wiki Always available Searches the current wiki.
Namespace Always available Limits the search to a specific namespace.
Subpages Available when the search term is part of a page title of a page with subpages Limits the search to subpages of pages that contain the search term in their title.
Book Available when a book is available Limits the search to the book.
Title search showing matching page titles and search context information
Header search

To open the Search center, press Enter or select one of the available search contexts.

Recently viewed

When the search field is opened without a search term, it displays recently viewed pages.

Search field with four recently viewed page suggestions
Recently viewed pages

To limit a search to a namespace:

  1. Enter the namespace followed by a colon, for example Controlled Document:.
  2. Select Enter.
  3. The namespace is added as a search pill.
  4. Enter the search term after the pill.

The search is then limited to the selected namespace.

Search field with a namespace search pill
Namespace search pill

To limit a search to subpages, enter the parent page followed by a slash. For example: TestPage/ Enter the search term after the slash. The search results are limited to matching subpages of the specified page.
For example, TestPage/Te matches subpages such as TestPage/Test and TestPage/TestSubpage.
When the subpage is in a namespace, include the namespace prefix in the search path. For example, a page with the path Minutes:JourFixe/2026-09-30 can be found with:

  • Minutes:JourFixe/20
  • Minutes:JourFixe/
  • Minutes:Jou

The page is not necessarily found with:

  • JourFixe/20
  • Jour

Search suggestions

The header search is not case-sensitive. For example, qual and Qual return the same results.
Search results are limited to 10 page titles. Spelling errors usually do not return matching results. For example, Qality does not return Quality. Depending on the wiki configuration, spelling suggestions may be displayed.
Multiple search terms can appear in any order. For example, toc download and download toc return the same matching pages.
Search operators such as ", OR, and AND are not supported in the header search.
Results are sorted based on a combination of title relevance and the page's last edit date. The exact ranking can be affected by configuration in on-premise installations.
A search result can show the following information:

  • the page title
  • the wiki name in a colored pill
  • the namespace in bold
  • the parent page in regular text
  • the original page title in parentheses if the result matches the page's display title
  • a redirect indicator and target page if the result is a redirect

Dates as search terms

The search recognizes certain date formats. In the Search center, recognized date formats are treated as search terms with surrounding quotation marks.

Search center

The Search center opens when Enter is pressed in the header search field or when a search context is selected. It provides full-text search and additional options for refining search results.
The full-text search searches the rendered content of wiki pages as well as indexed file content and metadata.

Search Center showing full-text search results
Search Center

Search filters

The available filters depend on the current search context and configuration. Use the filter options to narrow the search results. Active filters can be removed individually.

Search Center with search filters
Search filters

Search operators

Search operators are supported in full-text search. They are not supported in the header search. Search operators must be written in uppercase. If consecutive words must be searched together, enclose the words in quotation marks.

Search operators
Operator Description
AND Use AND to find results that contain both search terms.
  • admin AND docu returns pages containing the exact terms admin and docu.
  • admin* AND docu returns pages containing words that start with admin and the exact term docu.

A search without an operator automatically uses a wildcard search for each term. For example, admin docu searches for words that start with admin and docu.

Quotation marks Quotation marks can be used to search for all terms in a query. For example:
  • "admin" docu produces the same result as admin AND docu.
NOT Use NOT to exclude a search term. For example:
  • admin* NOT docu* returns pages containing words that start with admin but not words that start with docu.
OR Use OR to find results containing either search term. For example:
  • admin OR docu returns pages containing either admin or docu.
Wildcard Use * after part of a word to search for words that begin with that character sequence. For example:
  • admin* returns pages containing words that begin with admin.

Search results

The Search center displays information and actions for the current search.

  • Hit count shows the number of matching results. The count can be exact or approximate because permissions are checked dynamically. Some matching results may not be displayed if the current user does not have permission to view them.
  • Add a filter opens the available filters for the search.
  • Search options opens settings for the current search, such as the number of results per page and the sort order.
  • Save as page collection opens a dialog with the current search results. Authorized users can deselect individual results and choose the list format. The page collection is saved as a subpage of MediaWiki:Page collection/.
    • Plain text: saves page names only.
    • Link: saves page names as links to the corresponding pages.
Search actions menu with filter and search options
Search actions

If a result exactly matches the search term, it can be displayed as a featured result. A featured result includes a preview image and a content snippet.
Search results show the wiki name in a colored pill. The color is assigned by the administrator. The namespace is shown in bold, followed by the parent page in regular text.

Favorite results

Logged-in users can mark search results as favorites by selecting the pin icon on a result.
Favorite results receive a higher ranking in future searches for the same user. The ranking change is applied after the background process updates the search preferences.
Favorites are user-specific. Marking a result as a favorite does not affect other users' search results.
To remove a result from favorites, select the pin icon again.

AI summary

In wikis configured for AI usage, an AI summary can be displayed before the search results. The display is controlled by the ChatBot configuration.

Indexed content

By default, the search index includes:

  • wiki pages, except pages in the MediaWiki namespace
  • special pages in the Special namespace
  • files uploaded to the wiki. For text-based files such as Word documents and PDFs, the file content and metadata are indexed.
  • external files, if configured, from accessible storage locations such as mounted drives

Configuration

In the BlueSpiceConfigManager, settings for BlueSpiceExtendedSearch are available for on-premise installations.

Search administration

The page Special:SearchAdmin provides information about indexed documents, including their number and type.