Actions

Help32

Difference between revisions of "Extensions Module Manager Search"

From Joomla! Documentation

(introduced how-to-access-module)
m (Description: fixing)
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 +
==Description==
 +
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==
 
{{Chunk30:ModuleManager-How-to-acces-module|module=Search}}
 
{{Chunk30:ModuleManager-How-to-acces-module|module=Search}}
  
=Description=
+
{{Chunk30:Help-3x-module-site-search}}
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=
+
===Common Details===
[[Image:Help30-Extensions-Module-Manager-Search-screen.png]]
+
{{Chunk30:Module Details}}
  
=Toolbar=
+
===Common Tabs===
 +
{{Chunk30:Help-3x-module-site-common-tabs}}
 +
 
 +
==Toolbar==
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
  
=Details=
+
==Quick Tips==
 
+
=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=
+
 
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>

Latest revision as of 14:13, 11 December 2013

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.

How to Access

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.

Screenshot

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

Details

  • Title: Module must have a title

Module

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

Help30-module-manager-details-screenshot.png

  • Title. The title of the module. This is also the title displayed in the front end for the module depending on the Show Title Form Field
  • Show Title. (Show/Hide) Choose whether to show or hide the modules title in the front end. The title will be the one in the Form Field above.
  • Module Position. Choose the module position you wish this module to be displayed in. A custom module position can be entered for use with the load position plugin or the position button can be pressed to select a module position from the template.
  • Status. (Published/Unpublished/Trashed) The published status of the item.
  • Access. The viewing level access for this item.
  • Module Ordering. This shows a drop down 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 front end as well as in the Module Manager.
  • 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).
  • Language. Item language.
  • Note. Item note. This is normally for the site administrator's use (for example, to document information about this item) and does not show in the front end of the site.

Common Tabs

Menu Assignment

Help30-module-manager-menu-assignment-screenshot.png

On this tab there is a list of menu items. You can choose between On All Pages, No Pages, Only on the pages selected and On all pages except those selected from the List.

If the latter two options are selected a list will show with all the menu items on as shown in the screenshot above. This allows you to assign modules to some but not all pages, and by selecting the menu links that you want the module associated with you can customize on what pages modules appear/don't appear. See How do you assign a module to specific pages? for more information

Module Permissions

Help30-module-manager-menu-permissions-screenshot.png

  • Delete: (Inherited/Allowed/Denied). Allow or deny Delete for users in the Public group. Delete Allows users in the group to delete any content in this extension.
  • Edit: (Inherited/Allowed/Denied). Allow or deny Edit for users in the Public group. Edit Allows users in the group to edit any content in this extension.
  • Edit State: (Inherited/Allowed/Denied). Allow or deny Edit State for users in the Public group. Edit State Allows users in the group to change the state of any content in this extension.

Advanced

Help30-module-manager-advanced-options-screenshot.png

  • Alternative 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. See Layout Overrides in Joomla 2.5 for more information about alternative layouts.
  • 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! for more information.
  • 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.
  • Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements can also be used.
  • Bootstrap Size. (Values 0 to 12) This allows you to choose the width of the module via the span element built into bootstrap. For more information see the bootstrap documentation.
  • Header Tag. The HTML tag to use for the modules header or title this can be either a h1-h6 tag or a p tag.
  • Header Class. Here you can add optional CSS classes to add to the modules header or title element.
  • Module Style. You can use this option to override the templates style for its position.

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.

Quick Tips

No tips have been added for the Search module.