Changes between Version 4 and Version 5 of Public/Docs/CinnamonUsingQuickSearch


Ignore:
Timestamp:
Mar 24, 2020, 12:04:25 PM (5 years ago)
Author:
Administrator
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Public/Docs/CinnamonUsingQuickSearch

    v4 v5  
    11= Quick search
     2== General notes
    23[wiki:Public/Docs/CDCplus CDCplus] offers quick search functionality that lets the user search the repository based on a string entered into a text field.
     4
     5== Using quick search
     6* Enter the search term into the text field shown in the screenshot.
     7 
    38[[Image(wiki:Public/Docs/CinnamonUsingQuickSearch:QuickSearch.png)]]
     9** Quick search **
     10
     11* Press Enter or click on the search button to the right of the text field.
     12* Cinnamon searches certain fields for the search term entered and shows the result in a new window.
     13
     14== Notes
     15* Search is case-insensitive. The terms {{{Cinnamon}}}, {{{cinnamon}}} and {{{CinnaMON}}} all produce the same results.
     16* For performance reasons, the fields only match if they begin with the entered term.
     17 * {{{any}}} will match {{{any}}} and {{{anyone}}} but not {{{epiphany}}}.
     18 * Multi-value fields like {{{content}}} will match if **any** of the contained tokens (words) matches.
     19 * Only the latest versions of the results are returned.
     20 * The result set size is, by default, limited to 100 to avoid huge result sets on very unspecific searches (like searching for {{{a}}}). If there are more than 100 results, the user receives a message and can decide to see all results.
     21
     22== Configuration
     23Like all searches in Cinnamon, quick search is based on fields. Quick search is configurable. In the [wiki:Public/Docs/CinnamonClientConfiguration client configuration], the administrator can define the fields to be searched.
     24
     25The default configuration is:
     26{{{
     27<quick_search_config maxpagesize="100">
     28  <fieldname>name</fieldname>
     29  <fieldname>title</fieldname>
     30  <fieldname>content</fieldname>
     31</quick_search_config>
     32}}}
     33
     34Therefore, by default, quick search searches the name, the title and the content. Administrators can change the configuration to search more fields, icluding custom fields in the metadata like product assignment or target group of a bit of documentation. This is simply done by editing the {{{fieldname}}} elements inside the {{{quick_search_config}}} element.
     35
     36The default configuration
     37