Interactive Search Macro Parameters and Key
Interactive Search macro key and configuration options
Key
| 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 |
|
| 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 |
|
| 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 |
|
| 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 option is also selected. Has an OR (search-broadening)* relationship with the other content types that may be selected. If the Show Content Types option is on, user will have the ability to remove and add this filter as they wish. If the Show Content Types option is not selected, this filter cannot be removed and will apply to all searches. | Check mark | |
| Search Blogposts | Toggles the option of including blog posts in the search scope. If selected, search scope will be limited to blog posts only unless the Search Pages and/or Search Attachments option is also selected. Has an OR (search-broadening)* relationship with the other content types that may be selected. If the Show Content Types option is on, user will have the ability to remove and add this filter as they wish. If the Show Content Types option is not selected, this filter cannot be removed and will apply to all searches. | Check mark |
|
| Search Attachments | Toggles the option of including attachments in the search scope. If selected, search scope will be limited to attachments only unless the Search Pages and/or Search Blogposts option is also selected. Has an OR (search-broadening)* relationship with the other content types that may be selected. If the Show Content Types option is on, user will have the ability to remove and add this filter as they wish. If the Show Content Types option is not selected, this filter cannot be removed and will apply to all searches. | Check mark | |
| Show Last Modified | Toggles the display of a "Last Modified" drop-down filter menu from which the user can select a time frame for when content was last modified to narrow their search. | Check mark | |
| Last Modified Date | Limits the search scope to content that was last modified within the specified time frame. Can be overridden if the Show Last Modified option is on and the user selects a different time frame from the Last Modified drop-down menu. Leave blank to include content that was last modified at any time. | Drop-down menu selection |
|
| Do Not Search On Page Load | Toggles search execution and display of search results when the page is first displayed. | Check mark | |
| Display Rich Links | Toggles the use of social media-like rich links instead of simple text links in the list of search results. Rich Links are only available with Brikit Theme Press. | Check mark | |
| Load More Results | Grants the ability to fill the page with additional search results beyond the number specified in the Maximum Results parameter. User can access additional results via a button or by scrolling. Applies only when Display Rich Links option is on. | Drop-down menu selection |
|
| load-more-button-text | Default value: Load More Applies only when Display Rich Links option is on. | ||
| Hide Rich Links Site Icon | Toggles the appearance of the small site or space icon in rich links. Applies only when Display Rich Links option is on. | Check mark | |
| Hide Rich Links Site Name | Toggles the appearance of the site URL or space name in rich links. Applies only when Display Rich Links option is on. | Check mark |
*OR relationships among search criteria broaden the scope of the search, resulting in more potential search results with every added criterion.
Example: If you search for documents that have the label "cats" OR "dogs" OR "snakes", you will get all documents that have at least one of these labels attached.
AND relationships among search criteria narrow the scope of the search, resulting in fewer potential search results with every added criterion.
Example: If you search for documents that have the labels "cats" AND "dogs" AND "snakes", you will get only documents that have all of these labels attached.
