Actions

Help25

Difference between revisions of "Extensions Module Manager Search"

From Joomla! Documentation

(Basic Options)
m (removing needs images)
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
{{RightTOC}}{{page|needs images}}
+
{{RightTOC}}
 
==How to Access==
 
==How to Access==
 
To ''''add'''' a new Search Module or ''''edit'''' an existing Search Module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:  
 
To ''''add'''' a new Search Module or ''''edit'''' an existing Search Module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:  
Line 25: Line 25:
 
*'''Box Text.''' Default text to display in the Search box. If left blank, the "MOD_SEARCH_SEARCHBOX_TEXT" string from the language file will be used.
 
*'''Box Text.''' Default text to display in the Search box. If left blank, the "MOD_SEARCH_SEARCHBOX_TEXT" string from the language file will be used.
 
*'''Search button.''' (Yes/No) Whether or not to display a Search button. If no button is displayed, the user starts the search by pressing Enter.
 
*'''Search button.''' (Yes/No) Whether or not to display a Search button. If no button is displayed, the user starts the search by pressing Enter.
*'''Button Position.''' (Right/Left/Top/Bottom) Position of the Search button.
+
{{Chunk25:colheader|Button Position}}
 
*'''Search button image.''' (Yes/No) 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.
 
*'''Search button image.''' (Yes/No) 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 "MOD_SEARCH_SEARCHBUTTON_TEXT" string from the language file will be used.
 
*'''Button Text.''' The text to display in the Search button. If left blank, the "MOD_SEARCH_SEARCHBUTTON_TEXT" string from the language file will be used.

Latest revision as of 14:31, 10 April 2013

Contents

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 an Search Modules Title or click the Search Modules check box and then click the Edit button in the Toolbar.

Description

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

Screenshot

Help25-module-manager-search-screenshot.png

Details and Options

Details

Help25-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/Archived/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.

Basic Options

Help25-module-manager-search-basic-options-screenshot.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 Label. The text that appears in the label for the search box. If left blank, the "MOD_SEARCH_LABEL_TEXT" string from the language file will be used.
  • 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 left blank, the "MOD_SEARCH_SEARCHBOX_TEXT" string from the language file will be used.
  • Search button. (Yes/No) Whether or not to display a Search button. If no button is displayed, the user starts the search by pressing Enter.
  • Button Position. (Right/Left/Top/Bottom) Position of the Search button.
  • Search button image. (Yes/No) 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 "MOD_SEARCH_SEARCHBUTTON_TEXT" string from the language file will be used.
  • OpenSearch Autodiscovery. (Yes/No) Allow some browsers to add support for your site's search.
  • OpenSearch Title. The title to be displayed in the web browsers when adding your site as an search provider.
  • Set Item ID Assign an ItemID when no specific menu item for Com_search exists.

Advanced Options

Help25-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. Setting this parameter causes Joomla! to either add a new CSS class or modify the existing CSS class for the div element for this specific module. See here for more information
  • Caching. (Use Global/No Caching) Choose whether you wish to cache the contents of the module.
  • Cache Time. The time before a module is recached.

Menu Assignment

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

On the left there is a list of menu items. You can chose between None, All and Select Menu Item(s) from the List. To assign to some but not all pages choose the third option and select the menu links that you want the module associated with. See How do you assign a module to specific pages? for more information

Toolbar

At the top right you will see the toolbar:

Help25-Toolbar-Save-SaveClose-SaveNew-SaveCopy-Close-Help.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.

Front End Screenshot

Example Front End Site images are generic images using Joomla! core installation supplied free Front End Templates. The actual view can depend on the installed custom template used and the template's style for those views on a Joomla! website. Search module shown:

Help25-module-manager-search-frontend-screenshot.png

The Module Type name for this Module is "mod_search". It is not related to any other component.