Search

Search module

The search module lists provides a user interface for searching your site. As your users type a search term, a search suggestions display shows the titles of search terms which match your search term. Click a search suggestion or click Search to display search results.

The search module doesn't work on its own. You need a search provider for the search module to use to get search results. There is a basic page search provider built in, and you can install additional search providers for an enhanced search experience.

Search providers are installed separately. The Elastic Search extension includes both a search provider and a search index manager to populate the search index. Some search providers may include only a search provider, or only a search index manager. The built-in page search provider is intended for sites which don't have a need for enhanced search, and only supports searching for pages. Other search providers can search module-specific content and file contents.

You can control the presentation of the full results display in the module settings page.

Settings


Search Provider	Specifies which search provider to use.
Display Mode	Specifies how the search module is displayed. Available settings are Full, Compact and Minimal.
Search Caption	Specifies the label displayed next to the search term text box. This is only displayed when display mode is 'Full'.
Search Button Caption	Specifies the text of the seach button. The search button is not displayed when display mode is 'Minimal'.
Maximum number of suggestions	Specifies the number of search suggestions to display as the user types their search term.
Results Page	Specifies the page to navigate to when the user clicks the search button or presses ENTER. This page should contain a search module. Select (none) to display results on the same page as the search module.
Include Scopes	Use this setting to restrict results to specified scopes, or leave blank to return results from all sources (this is the default). Specify included scopes by entering one or more scopes separated by line feeds. A scope is the URN of the data type which was used to create a search entry (Examples: site pages - urn:nucleus:entities:page, files - urn:nucleus:entities:file, forum posts - urn:nucleus:entities:forum-post). This setting affects both search suggestions and search results. This is an advanced setting which may not be supported by all search providers.
Include Files in Results	Specifies whether to include files in search results.
Show Type	Toggles whether to display the result type (for example: Page, File, Document) in the full results display.
Show Summary	Toggles whether to display the result summary (if the search result has one) in the full results display.
Show Categories	Toggles whether to display categories (if the search result has any) in the full results display.
Show Published Date	Toggles whether to display the published date (if one applies to the result) in the full results display.
Show Url	Toggles whether to display the result Url in the full results display.
Show Size	Toggles whether to display the result size in the full results display.
Show Score	Toggles whether to display the result score in the full results display.

For search providers which support it, the result score is based on how well a specific result matches your search term, relative to all of the results in the index.