Actions

Help25

Difference between revisions of "Extensions Module Manager Smart Search"

From Joomla! Documentation

(Created page with "==Toolbar== {{Chunk25:Help_screen_module_manager_edit_toolbar}} <noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>")
 
(Front End Screenshot)
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{RightTOC}}{{page|needs images}}
 +
==How to Access==
 +
To ''''add'''' a new Smart Search Module or ''''edit'''' an existing Smart Search Module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:
 +
* Select {{rarr|Extensions,Module Manager}}
 +
 +
Click the ''''New'''' button and click on Smart Search Module in the modal popup window.
 +
 +
To ''''Edit'''' an existing Smart Search Module, in the Module Manager click on an '''Smart Search Modules Title''' or click the '''Smart Search Modules check box''' and then click the '''Edit''' button in the Toolbar.
 +
 +
==Description==
 +
This Module displays a Smart Search entry field where the user can type in a phrase and press Enter to search the web site.
 +
 +
==Screenshot==
 +
[[File:Help25-module-manager-smart-search-screenshot.png]]
 +
 +
==Details and Options==
 +
===Details===
 +
{{Chunk25:Module Details}}
 +
 +
==Basic Options==
 +
[[File:Help25-module-manager-smart-search-basic-options-screenshot.png]]
 +
{{colheader|Module Class Suffix}}
 +
*'''Search Filter.''' Select a search filter made in the [[Help25:Components_Finder_Manage_Search_Filters|Smart Search Filters Manager]]
 +
*'''Search Suggestions.''' (Show/Hide) Show or hide suggestions for the user before they press the search button.
 +
*'''Advanced Search.''' (Link to Component/Show/Hide) If selected - users can see the advanced options of their search. Link to component means the user is redirected to the Smart Search view of the Smart Search Component.
 +
 +
===Advanced Options===
 +
{{Chunk25:colheader|Module Alternative Layout}}
 +
{{Chunk25:colheader|Module Class Suffix}}
 +
*'''Search Field Size.''' The size of the search box, in characters. Default value is 25.
 +
*''' Alternate Label.''' The text that appears in the label for the search box.
 +
*'''Search Field Label.''' (Show/Hide) Show or hide the label for the search box.
 +
*'''Label Position.''' (Right/Left/Top/Bottom) Position of the Search label.
 +
*'''Search Button.''' (Show/Hide) Show or hide the buttonfor the search box.
 +
{{Chunk25:colheader|Button Position}}
 +
{{Chunk25:colheader|OpenSearch Autodiscovery}}
 +
{{Chunk25:colheader|OpenSearch Title}}
 +
 +
===Menu Assignment===
 +
{{Chunk25:Menu Assignment}}
 +
 
==Toolbar==
 
==Toolbar==
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
 
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
  
<noinclude>{{cathelp|2.5|Module Manager|Extensions}}</noinclude>
+
==Front End Screenshot==
 +
{{Chunk25:Help screen screenshot disclaimer}}
 +
Smart Search module shown:
 +
 
 +
[[Image:Help25-module-manager-smart-search-frontend-screenshot.png]]
 +
 
 +
The Module Type name for this Module is "mod_finder". It is not related to any other component.
 +
 
 +
<noinclude>{{cathelp|2.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Revision as of 08:36, 21 March 2013

Contents

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS IMAGES. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


How to Access

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

  • Select Extensions  Module Manager

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

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

Description

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

Screenshot

Help25-module-manager-smart-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-smart-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.
  • Search Filter. Select a search filter made in the Smart Search Filters Manager
  • Search Suggestions. (Show/Hide) Show or hide suggestions for the user before they press the search button.
  • Advanced Search. (Link to Component/Show/Hide) If selected - users can see the advanced options of their search. Link to component means the user is redirected to the Smart Search view of the Smart Search Component.

Advanced Options

  • 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
  • Search Field Size. The size of the search box, in characters. Default value is 25.
  • Alternate Label. The text that appears in the label for the search box.
  • Search Field Label. (Show/Hide) Show or hide the label for the search box.
  • Label Position. (Right/Left/Top/Bottom) Position of the Search label.
  • Search Button. (Show/Hide) Show or hide the buttonfor the search box.
  • Button Position. (Right/Left/Top/Bottom) Position of the Search button.
  • 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.

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. Smart Search module shown:

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

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