Joomla - search module

In this chapter, we will study the search module in Joomla. The search module is used to display a search box where the user enters a specific name to search the site.

Search module

Following are the simple steps to edit an existing search module in Joomla.

Step 1 − Click Extension → Module Manager in Joomla Admin Control Panel, you will get the following screen −

Step 2 − Next, click on the New button and the following screen will appear. Next select Module Type as Search on this screen.

Step 3 − After clicking the Search button, the existing search module will be displayed as shown below.

By default, the Module tab is displayed . The module displays a search box. Below we have mentioned the details of the fields provided in the Module tab .

• Title - Displays the title of the module.

• Window label - text will appear in the search box.

• Field Width - Sets the width of the search box. The default value is 20.

• Text in field - text to view in the search box.

• Search Button - The search button is displayed. The default value is No.

• Button Position - Sets the position of the search button, e.g. left , right , bottom , top .

• Image search button - Insert an image as a button. Image must be in template/template name/image/

• Button Text - The text to display on the search button.

• Autodiscover OpenSearch - Added browser support for site search. The default is set to Yes.

• OpenSearch header. When a site is added as a search provider, the text is displayed in a supported browser.

• Set ItemID - To display the search result, the itemID is assigned by selecting a menu item.

• Show Title - Displays the title of the module at the front.

• Position - selects the position of the module to display.

• Status - Displays the status of the article, such as Published, Unpublished, and Trash .

• Start Posting - Posting starts at the scheduled date and time.

• End Publishing - Ends the publication at the scheduled date and time.

• Access − It allows only selected users from the drop down list such as Guest, Public, Super Users, Registered and Special Options to view the items.

• Order − Displays a drop down list of all modules present in the position.

• Language - defines the language of the site. It provides either ALL or English (UK) options.

• Note. Used to enter text information.

Title - Displays the title of the module.

Window label - text will appear in the search box.

Field Width - Sets the width of the search box. The default value is 20.

Text in field - text to view in the search box.

Search Button - The search button is displayed. The default value is No.

Button Position - Sets the position of the search button, e.g. left , right , bottom , top .

Image search button - Insert an image as a button. Image must be in template/template name/image/

Button Text - The text to display on the search button.

Autodiscover OpenSearch - Added browser support for site search. The default is set to Yes.

OpenSearch header. When a site is added as a search provider, the text is displayed in a supported browser.

Set ItemID - To display the search result, the itemID is assigned by selecting a menu item.

Show Title - Displays the title of the module at the front.

Position - selects the position of the module to display.

Status - Displays the status of the article, such as Published, Unpublished, and Trash .

Start Posting - Posting starts at the scheduled date and time.

End Publishing - Ends the publication at the scheduled date and time.

Access − It allows only selected users from the drop down list such as Guest, Public, Super Users, Registered and Special Options to view the items.

Order − Displays a drop down list of all modules present in the position.

Language - defines the language of the site. It provides either ALL or English (UK) options.

Note. Used to enter text information.

Step 4 − Click on Menu Assignment tab , you will get a screen as shown below.

• Module Destination - Select an option to view the item from the drop-down list, such as All Pages, No Pages, Only Selected Pages, or All Pages Except Selected .

• Menu selection - After selecting the option, only the selected pages or all pages except those selected will display all the menu items present in Joomla. This allows the module to be assigned to some rather than all pages.

Module Destination - Select an option to view the item from the drop-down list, such as All Pages, No Pages, Only Selected Pages, or All Pages Except Selected .

Menu selection - After selecting the option, only the selected pages or all pages except those selected will display all the menu items present in Joomla. This allows the module to be assigned to some rather than all pages.

Step 5 − The Module Permissions tab has three actions to choose from. It controls the module permission setting for user groups, as shown in the following screen.

• Delete - Allows users in the group to delete the content present in the module.

• Edit - Allows users in the group to edit the content present in the module.

• Edit State - Allows users in the group to change the state of the content present in the module.

Delete - Allows users in the group to delete the content present in the module.

Edit - Allows users in the group to edit the content present in the module.

Edit State - Allows users in the group to change the state of the content present in the module.

Step 6 − The Advanced tab is used to make advanced search settings. The additional tab screen is shown below.

• Alternate layout - select the layout to be used for this module, which you have already defined as one or more layouts for a module in Joomla or a template.

• Module Class Suffix - Setting this option causes Joomla to either add a new CSS class or change the existing CSS class for the div element for that particular module.

• Caching - Caching the contents of the module. Use Global is used to cache settings from the global configuration. Caching is not used, whether the contents of the module are cached or not.

• Cache time - Specify the time in minutes before the module is cached again.

• Module Tag - Specify the HTML tag for modules.

• Bootstrap Size - Choose the width of the module embedded in bootstrap.

• Header Tag − Modules use HTML header tags.

• Header class − Additional CSS headers are added to the header of the module.

• Module Style - Overrides the template style for its position.

Alternate layout - select the layout to be used for this module, which you have already defined as one or more layouts for a module in Joomla or a template.

Module Class Suffix - Setting this option causes Joomla to either add a new CSS class or change the existing CSS class for the div element for that particular module.

Caching - Caching the contents of the module. Use Global is used to cache settings from the global configuration. Caching is not used, whether the contents of the module are cached or not.

Cache time - Specify the time in minutes before the module is cached again.

Module Tag - Specify the HTML tag for modules.

Bootstrap Size - Choose the width of the module embedded in bootstrap.

Header Tag − Modules use HTML header tags.

Header class − Additional CSS headers are added to the header of the module.

Module Style - Overrides the template style for its position.

Toolbar

Following are the details of the toolbar function tabs provided in the search module.

Save - saves your modules.

Save and Close - Saves modules and closes the current screen.

Save & New - saves modules and opens a new module creation screen.

Cancel - cancel created modules in Joomla.