| Parameter | Description | Expected Input | Example Value(s) |
|---|
| Content Type ("Of type") | Defines one or more types of content to include in search results. | Drop-down menu selection | Page
Blog
Comment
Attachment
Calendars
Space Calendars
|
| Add a Filter | Narrows the search results according to the specified filters and values. | Drop-down menu selection (filter type) → filter value | With ancestor → Current page
Contributor → bob
Created → Last 24 hours
Creator → dcooper
Label → announcements
Last modified → Last week
Mentioning user → bob
With parent → HR Home
In space → HR
Including text → portland
With title → PTO Policy
|
| Sort By | Sorts the list by title, creation date, or modified date. SEARCH-591 | Drop-down menu selection | title
created
modified
[no selection]
|
| Reverse Sort | Toggles between sorting the list in descending or ascending order. | Check mark |
|
| Maximum Results | Limits the number of total search results to the specified number. Defaults to 15. | Positive integer | |
| Title | Displays a heading above the list of returned content. | Text string | News and Announcements
Training Resources
|
| Display | Choose between a list, table, or rich links. Note: table display is only supported when Query After Page Load is selected. | Drop-down menu selection |
|
| Use Full Size Images | Toggles the use of thumbnail images in rich links. Enable to always display full-sized images, which may impact performance. Has no effect unless Rich Links display is selected. | Check mark |
|
| Align | Aligns the search results horizontally on the page or block. | Drop-down menu selection | |
| Show Icons | Toggles the visibility of icons indicating the content type of each returned item. Applicable only when Display Rich Links option is not selected. | Check mark |
|
| Show Labels | Toggles the visibility of labels attached to each returned item. Applicable only when Display Rich Links option is not selected. | Check mark |
|
| Show Space Names | Toggles the visibility of space names associated with each returned item. Applicable only when Display Rich Links option is not selected. | Check mark |
|
| Composed CQL | Defines a hand-coded CQL query which overrides the filters specified above. Omit the ORDER BY keyword and clause when composing your query as this will already be automatically appended to your query. Note that this macro supports searching against spaces by specified criteria. See example query.
| CQL query | |
| Display Rich Links | Toggles the use of social media-like rich links instead of simple text links. Note: deprecated in version 3.3+, replaced with "Display" parameter, noted above. | Check mark | |
| Load More Results | Defines how (user scrolling vs. button) and whether to load more search results if the initial number of returned items exceeds the value of the Maximum Results parameter. Applies only when Display Rich Links option is on. | Drop-down menu selection | |
| Load More Button Text | Call-to-action text when "button" is selected for the Load More Results parameter. (Default: "Load More") Applies only when Display Rich Links option is on. | Call-to-action text | |
| Hide Rich Links Site Icon | DEPRECATED: Use Block settings. Toggles the appearance of the small site or space icon in rich links. | Check mark |
|
| Hide Rich Links Site Name | DEPRECATED: Use Block settings. Toggles the appearance of the site URL or space name in rich links. | Check mark |
|