Manual:Extension/BlueSpiceExtendedSearch

ExtendedSearch replaces the default MediaWiki search engine. It is based on the OpenSearch engine. Pages and files are indexed immediately and available for searching in real-time.

Usage

The search offers two ways of searching for content:

1. Title search (Quick search or autocomplete search)
2. Fulltext search (Search center)

By default, the search indexes:

• wiki pages: all wiki 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 (if configured): files from arbitrary locations from accessible storage paths (e.g., mounted drives)

Search context

Users always need to be aware of the search context. If the search is started from any regular wiki page, the wiki searches for page titles only. If a user switches to the Search center, the results for the search term are based on a full-text search.

Difference between title search and full text search

	Title search	Full-text search
Search scope	only the page titles are searched	content is also searched. This includes content on wiki pages and also content in files, for example PDFs or Word documents.
Search result	up to 10 "best bet" results are displayed	all results are displayed
Search operators	are not supported	are supported
Namespaces	search can be limited to a namespace	search results can be limited to namespaces (in combination with other filters)
Categories	category pages can be found using the search prefix “Category"	search results can be limited to categories (in combination with other filters)
Subpages	search is automatically limited to subpages if a page name ending with a slash is entered	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.
Books	not supported	search results can be limted to pages in a book (in combination with other filters)

Quick search

Recently viewed

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 x to the right of the page name. Once you start typing, the default suggestions disappear.

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 (=Search center) for that. This can be done by simply pressing the Enter key after entering a search term in the search field.

How the title search works:

1. It is not case-sensitive: "qual" or "Qual" return the same results.
2. Search results are limited to 10 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).
3. Spelling mistakes will usually not return any results: "Qality" does not return "Quality". Based on the version of your wiki, the search might return suggestions ("You might be looking for....").
4. Multiple search terms can be in any order to produce results ("toc download" finds pages just like "download toc").
5. Search operators such as "", OR, ANDre not supported. However, they are supported in the full-text search.
6. 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 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. )
7. The search offers a filter (screenshot annotation 1) to search:
   • in subpages of the page you are on (if it has subpages)
   • in the namespace of the page you are currently on
   • in the book of the page you are currently on (if you are in a book)
   • in the whole wiki
8. A search match shows the following information (screenshot annotation 2)
   1. Page title
   2. Below the page title, the namespace prefix of the page. If the result is a subpage, the subpage path is shown next to the namespace prefix.
   3. If the title match is based on the display title of a page, the original title is shown in parentheses.
   4. If the page is redirected to a different page, the redirect link is shown with a redirect-arrow in front of the target page title. If the target page has a display title, only the display title of the target page is shown. Otherwise the full path of the target page is shown.

Title search

Namespace and subpage "pills"

The search bar supports pills for namespaces and subpages.

Namespace "pill"

If a user types Manual: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 PageName/, 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".

Subpages in namespaces are only found if the namespace prefix is included (assuming you are typing in the direct path to the subpage). For example, the "Images" subpage with the path Manual:Extension/VisualEditor/Images is found when you type:

• "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.

• 
• 

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.

Search Center

By default, the search filters for namespaces and categories are already displayed. You can open them to filter the search results:

Options dialog

Search operators

Important!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.

Search operators have to be written in all-caps.

AND

• admin AND docu: Returns pages that contain the exact term admin as well as the exact term docu
• admin* AND docu: If the term administration should be found, you need to provide a wildcard asterisk (*).

Compare: The search admin docu automatically is a wildcard search. It returns pages that contain both admin* and docu* . This search normally finds more results than the serach admin* AND docu (because in the second case, the exact term docu is returned).

" (apostrophes)

Apostrophes around a search term triggers an AND search for all terms in the query:

• "admin" docu: same result as admin AND docu (i.e., also the precise term docu will be searched).

NOT

• admin* NOT docu*: Returns pages that contain words that start with admin , but that don't contain words that start with docu .

OR

• admin OR docu: Returns pages that contain either the exact term admin or the exact term docu.

* (wildcard)

• admin*: Returns pages that contain words that begin with admin .

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.
• Search actions

  

  Search actions

  • Add a filter - represented by a "funnel" icon - opens a dialog where users can select the filter type(s) that are applied to the search results.
    
  • Search options - represented by a "hamburger menu" 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.

    

    Adding filters

    
    
  • Export search - opens a dialog to export current search results to a dedicated page (only visible to authorized users, by default admin users).

• Filter: Additional filters can be set from the filter button. Available filters vary based on BlueSpice version. Active filters can be removed by clicking on the "x" button in each filter pill.

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 pin symbol in the right corner of each result. Files marked as "favorite" will score higher in future searches. This is not visible immediately, however, since a background process has to finish to update these preferences. One user's pins won't affect other user's searches. Results can be unmarked as "favorite" by clicking on the "pin" 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 exported pages can be added to a book via Mass add> Source: Page collection in the book's edit menu.

Configuration

In the BlueSpiceConfigManager, under settings for the extension BlueSpiceExtendedSearch, the following configuration options are available:

• External file paths: External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix.
  • Physical path: Storage path. For mounted drives, for example: X:\Documents
  • URL prefix: All files indexed from the indexed physical location are prefixed in the search results. It should be used if files are available from a web server. By default, the URL prefix is set to the same value as Physical path.

Examples for external file paths

Example file	Phys. Path	URL Prefix	Link in results list
S:\Sales\Info\glossaryy.pdf	S:\	file:///S:/	file:///S:/Sales/Info/glossary.pdf
		https://sharepoint/Sales/ documents/	https://sharepoint/Sales/ documents/Sales/Info/glossary.pdf
		https://intranet/showdocs inline.aspx?path=	https://intranet/showdocsinline.aspx? path=/Sales/Info/glossary.pdf
/var/www/bluespice/w/mounted_ share/Sales/Info/glossary.pdf	/var/www/bluespice/w/ mounted_share/		https://wiki.company.local/w/mounted_ share/Sales/Info/glossary.pdf

Add an external file path: (1) confirm the checkmark and (2) save the settings.

• Automatically set language filter: The search only returns pages whose language (PageLanguage) is identical to the user language (Language). Users can set their language in their preferences. By default, the language of content pages is the same as the installation language (ContentLanguage) of the wiki. Some extensions can set the language of individual pages independently of the content language of the wiki.. (See: https://www.mediawiki.org/wiki/Manual:Language#Page_content_language). In many wikis, activating this filter has little effect.
  
• Exclude patterns: Files at external file locations can be exluded from search based on regular expression patterns.

Spezialseite "SearchAdmin"

The page Special:SearchAdmin is a page for wiki admins and shows the number and types of indexed documents.{{Box Links-en|Topic1=

Technical Reference: BlueSpiceExtendedSearch

PDF exclude - start

---

To submit feedback about this documentation, visit our community forum.

PDF exclude - end

The display title sets a page title that is different from the page name.

It becomes the preferred page label used in many automatically generated page lists. It can be changed with the visual editor (Options > Advanced settings). The source of the wiki page shows the magic word {{DISPLAYTITLE:My display title}}.