Help310

Difference between revisions of "Extensions Module Manager Search"

From Joomla! Documentation

m (→‎Quick Tips: updating Help screens relevant versions)
m (→‎Quick Tips: clean up)
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Search Module=
+
==Description==
 +
This Module displays a Search entry field where the user can type in a phrase and press 'Enter' to search the web site.
  
==Overview==
+
==How to Access==
 +
{{Chunk30:ModuleManager-How-to-acces-module|module=Search}}
  
==How to access==
+
{{Chunk30:Help-3x-module-site-search}}
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==
+
===Common Details===
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
+
{{Chunk30:Module Details}}
  
==Screenshot==
+
===Common Tabs===
[[Image:Help30-Extensions-Module-Manager-Search-screen.png]]
+
{{Chunk30:Help-3x-module-site-common-tabs}}
  
 
==Toolbar==
 
==Toolbar==
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
==Details==
 
 
==Basic Options==
 
[[Image:Help30-Extensions-Module-Manager-Search-basic-options-parameters.png]]
 
{{colheader|Module Class Suffix}}
 
*'''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==
 
[[Image: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
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
 
==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|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
+
<noinclude>{{cathelp|3.0,3.1,3.2,3.3|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 11:27, 30 April 2014

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.

How to Access[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 JoomlaWikiBot (talk · contrib) · Last edited on Wed, 30 Apr 2014 11:27:52 +0000


Screenshot[edit]

Help-3x-modules-site-module-manager-module-search.png

Details[edit]

  • Title: Module must have a title

Module[edit]

This module will display a search box.

  • Box Label: The text that appears in the label of search box. If left blank, it will load 'label' string from your language file.
  • Box Width: Size of the search text box in characters
  • Box Text: The text that appears in the search text box. If left blank, it will load 'searchbox' string from your language file.
  • Search Button: (Yes/No). Display a Search Button
  • Button Position: (Right/Left/Top/Bottom). Position of the button relative to the search box.
  • Search Button Image: (Yes/No). Use an image as button. This image has to be named searchButton.gif and must be located in templates/*your template name*/images/
  • Button Text: The text that appears in the search button. If left blank, it will load the 'searchbutton' string from your language file.
  • 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/Getting Started/Using Joomla!/Using Extensions/Components/Content Component/...). Assign an ItemID by selecting a menu item in the list for the display of the search results if there is no com_search menu and a specific display is desired. If you do not know what this means, you may not need it.

Common Details[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 JoomlaWikiBot (talk · contrib) · Last edited on Wed, 30 Apr 2014 11:27:52 +0000


Common Tabs[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 JoomlaWikiBot (talk · contrib) · Last edited on Wed, 30 Apr 2014 11:27:52 +0000


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 JoomlaWikiBot (talk · contrib) · Last edited on Wed, 30 Apr 2014 11:27:52 +0000


Quick Tips[edit]

No tips have been added for the Search module.