No edit summary |
No edit summary Tag: 2017 source edit |
||
| Line 11: | Line 11: | ||
When typing in the Quick search bar, an autocomplete popup appears.[[File:Search quicksearch.png|link=https://knowledgebase-2-0-helpdesk.bluespice.cloud/wiki/File:Search%20quicksearch.png|alt=Quick search bar|none|thumb|550x550px|Quick search bar]] | When typing in the Quick search bar, an autocomplete popup appears.[[File:Search quicksearch.png|link=https://knowledgebase-2-0-helpdesk.bluespice.cloud/wiki/File:Search%20quicksearch.png|alt=Quick search bar|none|thumb|550x550px|Quick search bar]] | ||
This popup is divided in two columns. | |||
'''Left column:''' | |||
*'''Primary results:''' These are the results that are direct matches for the search term. The exact matches are shown in bold letters. | |||
*When looking for the term "quality management", it is also possible to type in "qual man" and the search starts looking for matches | |||
*The best match is often shown with a thumbnail preview as a top search result | |||
'''Right column:''' | |||
*T'''ools and secondary results:''' Tools are displayed in the top portion of the right column and contain: | |||
**a button to create the page with the current search term as the title (only if user has permission to create new pages) | |||
**a button to execute full-text search for the current term. Selecting this option leads to the Search Center. | |||
In the bottom portion of the right column, secondary results are displayed. Secondary results are matches that do not directly match the given term, but might be relevant for the user. These show up only in certain contexts: | |||
*If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example) | |||
*If the namespace or subpage pill is present (see next section). In this case, secondary results will show direct matches in other namespaces/pages. | |||
===Namespace and subpage "pills"=== | |||
Autocomplete 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>, a pill for the namespace "Manual" appears and the search for the following term is limited to this namespace. . | |||
Subpage pills work in the same way. If the user types 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". | |||
===Search operators=== | |||
Since the autocomplete search only searches for titles, search operators such as AND or OR are not supported. However, they are supported using the Search Center. | |||
===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=== | |||
To use search operators in the full-text search, the following syntax can be used: | |||
*Sandbox '''AND''' Widgets - returns pages that contain both the term sandbox and the term widgets | |||
*Sandbox '''OR''' Widgets - returns pages that contain either the term sandbox or the term widgets. | |||
*(Sandbox) '''NOT''' (Widgets) - returns pages that contain the term sandbox but not the term widgets..<br /> | |||
The search operators have to be written in uppercase letters. | |||
===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. | |||
Revision as of 10:19, 30 September 2022
Articles and files are indexed immediately and available for searching in real-time.
Types of search
- Quick search: Searches article and file names and titles (no fulltext-search)
- Search center: Completes a full-text search of all articles and files in the wiki. It also searches in Easy Tasks and Projects.
- Easy Tasks/Project: Provides a dedicated search bar to search for articles.
Quick search
The search box in the Header bar with autocomplete functionality is active as long as a user is not on the Search center page. Autocomplete matches only page and file titles and names, but does not provide a full-text search.
When typing in the Quick search bar, an autocomplete popup appears.
This popup is divided in two columns.
Left column:
- Primary results: These are the results that are direct matches for the search term. The exact matches are shown in bold letters.
- When looking for the term "quality management", it is also possible to type in "qual man" and the search starts looking for matches
- The best match is often shown with a thumbnail preview as a top search result
Right column:
- Tools and secondary results: Tools are displayed in the top portion of the right column and contain:
- a button to create the page with the current search term as the title (only if user has permission to create new pages)
- a button to execute full-text search for the current term. Selecting this option leads to the Search Center.
In the bottom portion of the right column, secondary results are displayed. Secondary results are matches that do not directly match the given term, but might be relevant for the user. These show up only in certain contexts:
- If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example)
- If the namespace or subpage pill is present (see next section). In this case, secondary results will show direct matches in other namespaces/pages.
Namespace and subpage "pills"
Autocomplete search bar supports pills for namespaces and subpages.
If a user types Manual:, a pill for the namespace "Manual" appears and the search for the following term is limited to this namespace. .
Subpage pills work in the same way. If the user types 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".
Search operators
Since the autocomplete search only searches for titles, search operators such as AND or OR are not supported. However, they are supported using the Search Center.
Dates as search terms
The search recognizes certain date formats. In the search center, these date formats are treated with surrounding quotation marks.
- Manual:extendedsearch-datum1.png
- Manual:extendedsearch-datum2.png
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.
File:Manual:extendedsearch-searchcenter.png
Search Center
Search operators
To use search operators in the full-text search, the following syntax can be used:
- Sandbox AND Widgets - returns pages that contain both the term sandbox and the term widgets
- Sandbox OR Widgets - returns pages that contain either the term sandbox or the term widgets.
- (Sandbox) NOT (Widgets) - returns pages that contain the term sandbox but not the term widgets..
The search operators have to be written in uppercase letters.
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.File:Manual:extendedsearch3.pngAdding 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.File:Manual:extendedsearch4.pngOptions 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.File:Manual:extendedsearch2.pngEditing 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.
