Targeted Search Link macro key and configuration options

Key

targeted-search-link

ParameterDescriptionExpected InputExample Value(s)
Link/Button TextCall-to-action text that appears for the link or button.Text string
  • Search our collection
  • Find more
Display as ButtonToggles between displaying the link as text or as a button.Check mark 
Search TermsA word or phrase to submit to the search engine.Text string
  • community outreach
Show Filter Group(s)

Displays only the specified filter group(s) in the sidebar of the search results page after the user clicks the link.

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
  • Initiatives, Region
  • [no selection]
Hide Filter Group(s)

Hides the specified filters group(s) in the sidebar of the search results page after the user clicks the link.

Most useful when Show Filter Group(s) parameter is left blank. Overrides any filter group(s) specified in Show Filter Group(s) parameter.

Filter group name(s); comma-separated if more than one
  • Team Members
Search Against Spaces

Limits the search scope to spaces with the specified keys or category labels.

Leave blank to search in all spaces.

Space category label(s) and/or key(s); comma-separated if more then one
  • PUBLIC, partner
  • [no selection]
Show Space Categories

Toggles the visibility of space categories in the sidebar of the search results page after the user clicks the link.

Check mark 
Search Against FiltersNarrows the search results to content labeled with at least one of the specified filters/labels.Filter name(s) or label(s); comma-separated if more than one
  • funded, in_progress
Results Must Contain One FilterToggles the search scope between all content, whether labeled or unlabeled (unselected), and only content containing at least one filter label from any filter group (selected).Check mark 
Exclude Content

Excludes from the search results any content that is labeled with at least one specified filter/label.

<p><a href="https://support.brikit.com/browse/SEARCH-630" target="_blank">SEARCH-630</a>; <a href="https://support.brikit.com/browse/SEARCH-631" target="_blank">SEARCH-631</a></p>
Filter name(s) or label(s); comma-separated if more than one
  • Internal Comm, 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
  • LASTDAY
  • LASTTWODAYS
  • LASTWEEK
  • LASTMONTH
  • LASTSIXMONTHS
  • LASTYEAR
  • LASTTWOYEARS
  • [no selection]
Maximum Search ResultsLimits the total number of search results to the specified number. (Default: 200)Positive integer
  • 20
Button Width

Defines the width of the search link button.

Applies only when the Display as Button option above is selected.

Pixels or percentage of the width of the page, Confluence section, or block (if using Theme Press)
  • 35%
  • 50px