Actions

Help32

Difference between revisions of "Extensions Module Manager Search"

From Joomla! Documentation

m (Quick Tips: categorisation for 3.2 help screens)
(introduced how-to-access-module)
Line 1: Line 1:
=Search Module=
+
{{Chunk30:ModuleManager-How-to-acces-module|module=Search}}
  
==Overview==
+
=Description=
 
+
==How to access==
+
To navigate to the Search module, go to your site back-end.  Using the top menu, go to '''Extensions -> module manager''' and select "new". Then, select Search.  Alternatively, you can open an existing Search Module in the same screen.
+
 
+
==Description==
+
 
This Module displays a Search entry field where the user can type in a phrase and press Enter to search the web site. An example of a
 
This Module displays a Search entry field where the user can type in a phrase and press Enter to search the web site. An example of a
  
==Screenshot==
+
=Screenshot=
 
[[Image:Help30-Extensions-Module-Manager-Search-screen.png]]
 
[[Image:Help30-Extensions-Module-Manager-Search-screen.png]]
  
==Toolbar==
+
=Toolbar=
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
  
==Details==
+
=Details=
  
==Basic Options==
+
=Basic Options=
 
[[Image:Help30-Extensions-Module-Manager-Search-basic-options-parameters.png]]
 
[[Image:Help30-Extensions-Module-Manager-Search-basic-options-parameters.png]]
 
{{colheader|Module Class Suffix}}
 
{{colheader|Module Class Suffix}}
Line 28: Line 23:
 
*'''Set Item ID''' Assign an ItemID when no specific menu item for Com_search exists.
 
*'''Set Item ID''' Assign an ItemID when no specific menu item for Com_search exists.
  
==Advanced Options==
+
=Advanced Options=
 
[[Image:Help30-Extensions-Module-Manager-Search-advanced-options-parameters.png]]
 
[[Image:Help30-Extensions-Module-Manager-Search-advanced-options-parameters.png]]
 
*'''Alternative layout''' Apply an alternative layout or template override
 
*'''Alternative layout''' Apply an alternative layout or template override
Line 35: Line 30:
 
{{colheader|Cache Time}}
 
{{colheader|Cache Time}}
  
==Menu Assignment==
+
=Menu Assignment=
  
==Quick Tips==
+
=Quick Tips=
 
No tips have been added for the Search module.
 
No tips have been added for the Search module.
  
 
<noinclude>{{cathelp|3.0,3.1,3.2|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
 
<noinclude>{{cathelp|3.0,3.1,3.2|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 19:35, 6 December 2013

To 'add' a new Search module or 'edit' an existing Search module, navigate to the Module Manager:

  • Select Extensions  Module Manager

Click the 'New' button and click on Search in the modal popup window.

To 'Edit' an existing Search module, in the Module Manager click on the Search Module's Title or click the Search module's check box and then click the Edit button in the Toolbar.

Contents

Description

This Module displays a Search entry field where the user can type in a phrase and press Enter to search the web site. An example of a

Screenshot

File:Help30-Extensions-Module-Manager-Search-screen.png

Toolbar

At the top left you will see the toolbar:

Help30-Save-SaveClose-SaveNew-SaveCopy-Close-Help-toolbar.png

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. This toolbar icon is not shown if you are creating a new module.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Details

Basic Options

File:Help30-Extensions-Module-Manager-Search-basic-options-parameters.png

  • 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" 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.
    • See the tutorial Using Class Suffixes in Joomla! 1.5/1.6 for more information.
  • Box Width. The size of the search box, in characters. Default value is 20.
  • Box Text. Default text to display in the Search box. If blank, the "search box" field from the language file will be used.
  • Search button. Whether or not to display a Search button. If no button is displayed, the user starts the search by pressing Enter.
  • Button Position. Position of the Search button. Options are Right, Left, Top, or Bottom.
  • Search button image. Whether or not to display the Search button as an image. If yes, the image file must be named "searchButton.gif" and be located in the "images/M_images" folder.
  • Button Text. The text to display in the Search button. If left blank, the "search" string from the language file will be used.
  • Set Item ID Assign an ItemID when no specific menu item for Com_search exists.

Advanced Options

File:Help30-Extensions-Module-Manager-Search-advanced-options-parameters.png

  • Alternative layout Apply an alternative layout or template override
  • Module Class Suffix Apply a CSS suffix to the module
  • Caching. Use Global/No Caching. Whether or not to cache the content of this Module. A setting of "Use Global" will use the Cache Settings from the Global Configuration screen.
  • Cache Time. The length of time, in minutes, before the Module is re-cached.

Menu Assignment

Quick Tips

No tips have been added for the Search module.