Parameter | Description | Expected Input | Example Value(s) |
---|
Show Search Field | Displays a field for the user to enter search text. | Check mark | |
Search Field Placeholder Text | The dimmed help/placeholder text that is displayed in the search field. Applies only when Show Search Field option is on. | Text string | |
Maximum Results | Limits the initial number of returned search results. Defaults to 15. | Positive integer | |
Show Filter Group(s) | Displays the specified filter group(s) from which the user can select filters/labels to narrow their search results. | Filter group name(s); comma-separated if more than one | |
Search Space Categories | Limits the search scope to spaces with the specified space category label(s). Can be overridden if the Show Space Categories option is on and the user selects a different space category label. Leave blank to include all spaces in the search. | Space category labels; comma-separated if more than one | europe, south_america [no selection]
|
Search Spaces | Limits the search scope to the specified space key(s). Can be overridden if the Show Space Categories option is on and the user selects a space category label that has been applied to other spaces. Leave blank to include all spaces in the search. Use "@current" to limit the scope to the current space. | Space key(s); comma-separated if more than one | HR, ACCOUNTING @current [no selection]
|
Show Space Categories | Toggles the display of a "Space Categories" drop-down filter menu from which the user can select space category labels to narrow or expand their search. | Check mark | |
Search Against Filters | Sets the initial search scope to content with the specified label(s). Only applicable when at least one filter group is specified in the Show Filter Group(s) parameter. Any specified filter/label must belong to one of the filter groups specified in the Show Filter Group(s) parameter. On page load, the filter group(s) will appear with the specified label(s) pre-selected. User will have the ability to remove and add specified filter(s)/label(s) as they wish. | Filter names or labels | Human Resources, Finance employee_onboarding
|
Additional Filters | Restricts initial and all subsequent searches to content that has at least one of the specified labels. User cannot see or remove these filters. Even if a specified filter/label belongs to a filter group specified in the Show Filter Group(s) parameter, it will not appear pre-selected in that field on page load. Nor will the filter be removed from the search query, even if the filter is manually added via the filter group drop-down menu and then removed. These filters have an OR (search-broadening) relationship to one another as well as to any filter/label specified in the Search Against Filters parameter. | Filter names or labels | |
Show Content Types | Toggles the display of a "Type" drop-down filter menu from which the user can select content types to narrow their search. | Check mark | |
Search Pages | Toggles the option of including pages in the search scope. If selected, search scope will be limited to pages only unless the Search Blogposts and/or Search Attachments |