Search results module

A search results module is a module that helps visitors discover assets. The rendered module contains a field for entering keywords, and displays filtering and sorting options your visitor can use. The module also lists the assets matching those keywords and other settings you configure.

For a wire frame example of what this content type can look like on your site, see Search results module design.

Note

This topic describes how to create a shared search results module that you can use in multiple assets. If you want to create a one-off search results module, see Creating a one-off module.

To create a search results module:

1. In the header, click .
2. From the Create list, select Search Results Module.
3. Using the following table as a reference, complete the fields as needed.
4. Complete your site's workflow and publish the search results module.

Search Results module fields

Click each tab below to see a description of the associated fields.

Main

Field	Description
Internal Name	Enter an internal name for this asset. Brightspot uses this name internally, such as in the search panel and recent activity widget. This name is not visible to visitors to your site.
Title	Enter a title for this asset. This title is visible to the visitors to your site.
Search Input Placeholder	Enter placeholder text that appears in the search field before a visitor types in it (for example, you might enter Search here).
Results Per Page	Enter the desired number of search results per page. Previous and next buttons are available to page through the results.
Types	Content types in which this search looks for matching items.
Filters	Select the types of search filters available for visitors on your site, such as date published or content type. Visitors see checkboxes next to each filter in your site search.
Sorting	Select the fields by which visitors can sort the search results. If you specify sorting, Brightspot does not apply boosts.
Filtering Rules	Select the rules by which Brightspot filters the search results. These filtering rules are not visible to visitors to your site.
Stop Words	Enter a list of words that do not count toward search results.

Overrides

Field	Description
Anchor	Modify the anchor to something that would make sense when appearing in an Anchor field's drop-down menu on another asset. This allows you to directly link to this module in another asset. Being specific makes it easier to identify in a list of other anchors.

Advanced

Field	Description
Allow Non Permalinked	Toggle on to allow assets without a permalink to appear in the results of a site search page.
Locales	Select All Locales, Current Locale, or Some Locales to determine the locale in which the module is displayed. This serves as an exclusion filter to prevent items in different locales from inappropriately populating the module.

Spotlights

Field	Description
Dictionary	Choose an existing dictionary to be used in grouping search results together. This setting helps prevent terms in one locale from triggering a search result in another locale. For additional information, see Dictionaries, terms, and spotlights.
Max Spotlights	Enter the numeric value for the maximum number of spotlights permitted on a site search page (e.g., 10). There is no limit to this value. For additional information, see Dictionaries, terms, and spotlights.

Translations

Field	Description
Locale	Sets the content's locale. This setting can also be used to auto-localize content based on the users requested locale.

See also:

• Page
• Tag
• Section
• Understanding relevance and boosting
• Creating a stop-word list
• Using shared modules