Help310:Extensions Module Manager Smart Search

Description

Smart Search is an enhanced site search.

How to Access

Add a new module 'Smart Search'

• Select Extensions → Modules from the dropdown menu of the Administrator Panel.

• Click the New button in the toolbar

• Select the Module Type Smart Search.

Edit an existing module 'Smart Search'

• Click on the module's Title in Module.

Screenshot

Form Fields

• Title. The title of the module. This is also the title displayed in the Frontend for the module.

Module

• Search Filter. (- No Filter -) Selecting a Search Filter will limit any searches submitted through this module to use the selected filter.

• Search Suggestions. (Show/Hide) Toggle if automatic search suggestions should be displayed.

• Advanced Search. (Link to Component/Show/Hide) Toggle if users should be able to see advanced search options.
  • Link to Component: Creates a Smart Search link which redirects to the smart search view.
  • Show: The advanced search options will be displayed inline.

• Search Field Size. The width of the search field by character length.

• Search Field Label. (Show/Hide) Show or hide a label for the search field.

• Label Position. (Right/Left/Top/Bottom) The position of the search label relative to the search field.

• Alternative Label. An alternative label for the search field.

• Search Button. (Show/Hide) Show or hide a button for the search form.

• Button Position. (Right/Left/Top/Bottom) Position of the button relative to the search box.

• OpenSearch Autodiscovery. (Yes/No) Some browsers can add support for your site's search if this option is enabled.

• OpenSearch Title. Text displayed in supported Browsers when adding your site as a search provider.
• Set ItemID. (Select a menu item/...) Assign an ItemID by selecting a menu item in the list for the display of the search results if there is no menu item 'Search' and a specific display is desired.

---

• Show Title. (Show/Hide) Show or hide module title on display. Note: Effect will depend on the module style (chrome) in the template.

• Position. You may select a module position from the list of pre-defined positions or enter your own module position by typing the name in the field and pressing enter.

• Status. (Published/Unpublished/Trashed) The published status of the module.

• Start Publishing. Date and time to start publishing. Use this field if you want to enter content ahead of time and then have it published automatically at a future time.

• Finish Publishing. Date and time to finish publishing. Use this field if you want to have content automatically changed to Unpublished state at a future time (for example, when it is no longer applicable).

• Access. Who has access to this module.
  • Public: Everyone has access.
  • Guest: Everyone has access.
  • Registered: Only registered users have access.
  • Special: Only users with author status or higher have access.
  • Super Users: Only super users have access.

• Ordering. This shows a dropdown of every module in the position that the current module is in. This is the order that the modules will display in when displayed on in the Frontend as well as in Modules.

• Language. Select the language for this module. If you are not using the multi-language feature of Joomla, keep the default of All.

• Note. Module note. This is normally for the site administrator's use (for example, to document information about this module) and does not show in the Frontend of the site.

Menu Assignment

• Module Assignment.
  • On all pages: Module is shown on all pages.
  • No pages: Module is not shown on any page.
  • Only on the pages selected: 'Menu Selection' will show with all the menu items on. You can assign modules by selecting the menu links that you want the module associated with on what pages modules appear.
  • On all pages except those selected: 'Menu Selection' list will show with all the menu items on. This allows you to assign modules by selecting the menu links that you want the module associated with on what pages modules don't appear.

  Learn how to assign a module to specific pages.

Advanced

• Layout. If you have defined one or more alternative layouts for a module either in the template or Joomla Core, you can select the layout to use for this module.

• Module Class Suffix. A suffix applied to the CSS class of the module. This allows you to create customized CSS styles that will apply just to this module. You would then modify the template.css or custom.css file of your template to apply styling to this new class.
  • Enter this parameter with a leading space to create a new CSS class for this module.
  • Enter the parameter without a leading space to change the CSS class name for this module.

• Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements (address, article, …) can also be used.

• Bootstrap Size. (0/…/12) This allows you to choose the width of the module via the span element built into bootstrap.

• Header Tag. (h1/h2/h3/h4/h5/h6/p/div) The HTML tag to use for the modules header or title. Note: You must use a module style (chrome) of html5 or add your custom module styles in [yourtemplate]/html/modules.php.

• Header Class. Add optional CSS classes to the modules header or title element.

• Module Style. Override the templates style for its position.

Permissions

Manage the permission settings for user groups.

To change the permissions for this module, do the following.

1. Select the Group by clicking its title located on the left.

2. Find the desired Action. Possible Actions are:

• Delete. Users can delete content of this module.

• Edit. Users can edit content of this module.

• Edit State. Users can change the published state and related information for content of this module.

• Frontend Editing. Allows users in the group to edit in Frontend.

3. Select the desired Permission for the action you wish to change. Possible settings are:

• Inherited: Inherited for users in this Group from the module options permissions of this site.

• Allowed: Allowed for users in this Group. Note that, if this action is Denied at one of the higher levels, the Allowed permission here will not take effect. A Denied setting cannot be overridden.

• Denied: Denied for users in this Group.

4. Click Save in Toolbar at top. When the screen refreshes, the Calculated Setting column will show the effective permission for this Group and Action.

Toolbar

At the top left you will see the toolbar.

The functions are:

• Save. Saves the module and stays in the current screen.

• Save & Close. Saves the module and closes the current screen.

• Save & New. Saves the module and keeps the editing screen open and ready to create another module.

• Save as Copy. Saves your changes to a copy of the current module. Does not affect the current module.
  Note: This toolbar icon is only shown if you edit an existing module.

• Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.

• Help. Opens this help screen.

Related Information

• More about Modules: what is a module position, Description of the default Site and Administrator Modules.

Help Screens

Component	Description
Indexed Content	Provides an overview of the content items that have been indexed on a Joomla site.
Content Maps	Provides an overview of the content maps currently in the Smart Search index.
Search Filters	Provides an overview of the static search filters currently available for use in Smart Search.
Search Filters Edit	This is where you can Add a new Search Filter. Edit an existing Search Filter.
Options	Smart Search Options configuration allows setting of parameters used globally for Smart Search.

Menu Item	Description
Search	Used to create a page for Smart Search Results, which can be used in conjunction with a Smart Search module to control Search Results Page's layout.

Module	Description
Smart Search (this screen)	Smart Search is an enhanced site search.