Help310

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

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: No links here.

This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable.

Remember to check if anything links here and the page history before deleting.

Last edit by Sovainfo (talk · contrib) · Last edited on Fri, 06 Dec 2013 19:35:04 +0000


Description[edit]

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[edit]

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

Toolbar[edit]

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: No links here.

This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable.

Remember to check if anything links here and the page history before deleting.

Last edit by Sovainfo (talk · contrib) · Last edited on Fri, 06 Dec 2013 19:35:04 +0000


Details[edit]

Basic Options[edit]

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[edit]

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[edit]

Quick Tips[edit]

No tips have been added for the Search module.