Targeted Search Field Macro Parameters and Key
Targeted Search Field macro key and configuration options.
Key
| Parameter | Description | Expected Input | Example Value(s) |
|---|---|---|---|
| Show Filter Categories | Displays the specified filter categories to the left of search results in the sidebar of the search panel after the user enters their search. Use a comma-separated list of filter categories by name. Specified filter group(s) must be visible to the current space. If left blank, all filter groups that are visible to the current space will appear in the search results page sidebar. | Filter group name(s); comma-separated if more than one | Region, DepartmentDocument Type[no selection] |
| Hide Filter Categories | Hides the specified filter categories from those appearing to the left of search results. Use a comma-separated list of filter categories by name. Most useful when Show Filter Categories parameter is left blank. Overrides any filter categories specified in Show Filter Categories parameter. | Filter group name(s); comma-separated if more than one |
|
| Search Space Categories | Limits the search scope to the specified space categories. Use a comma-separated list of space labels. Leave blank for all spaces. Use @currentCategories to use the space categories applied to the current space. | Space category label(s); comma-separated if more than one | sales |
| Search Spaces | Limits the search scope to the specified spaces. Use a comma-separated list of space keys. Leave blank for all spaces. Use @current to use the current space. | Space key(s); comma-separated if more then one |
|
| Show Space Categories | Toggles the visibility of space categories in the sidebar of the search results page after the user enters their search. | Check mark | |
| Search Against Filters | Narrows the search results according to the specified filters. Use a comma-separated list of filter labels or names. | Filter name(s) or label(s); comma-separated if more than one |
|
| Exclude Content | Narrows the search results according to the specified pages, blog posts and/or attachments. Use a comma-separated list of labels. | Filter name(s) or label(s); comma-separated if more than one | private |
| 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 none of the three content types is selected, all three content types will be included in the search scope. | 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 none of the three content types is selected, all three content types will be included in the search scope. | 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 none of the three content types is selected, all three content types will be included in the search scope. | Check mark | |
| Last Modified Date | Limits the search scope to content that was last modified within the specified time frame. Leave blank to include content that was last modified at any time. | Drop-down menu selection |
|
| Quick Search Results | Limits the number of quick search results – the search results that begin to appear as the user beings typing in the search field – to the specified number. (Default: 15) | Positive integer |
|
| Placeholder Text | Prompt to display in the empty search field. (Default: Search) | Text input | Search for Policies |
| Field Width | Defines the width of the search/input field. This value will be overridden if the Replace Confluence Search option below is selected. In that case, this search box will be as wide as the original Confluence search box. Width and other styling options for the Confluence search box can be adjusted in your theme if you have Brikit Theme Press installed. | Pixels or percentage of the width of the page, Confluence section, or block (if using Theme Press) |
|
| Search Against Page Titles (Quick Search) | Toggles between searching against page titles only or all page content. Applies only to quick search results. If selected, search switches back to searching against all page content once the user enters their search and lands on the search results page. | Check mark | |
| Partial Word Search | Toggles between searching for whole words or words beginning with typed search term (wildcard search). | Check mark | |
| Replace Confluence Search | Toggles between showing this search field in its current location (unselected) or in place of the Confluence search box (selected). | Check mark | |
| Align | Aligns the position of the search field horizontally within the block (if using Theme Press) or page. This value will be overridden if the Replace Confluence Search option above is selected. In that case, this search box will be aligned in the same manner as the original Confluence search box. Placement and other styling options for the Confluence search box can be adjusted in your theme if you have Brikit Theme Press installed. | Drop-down menu selection |
|
*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.
