Actions

Difference between revisions of "Smart Search quickstart guide"

From Joomla! Documentation

m
 
(5 intermediate revisions by one user not shown)
Line 1: Line 1:
==Preparing Search Plug-ins==
+
{{version|2.5}}
 +
==Enabling the Smart Search content plug-in==
 +
Smart Search is not enabled by default in Joomla 2.5.  To start using Smart Search you will need to enable the Smart Search content plug-in, which can be done using the following procedure:
  
For content to be displayed in search results it must first be indexed by one of the Finder Search Plug-ins. Before starting the indexer, it is recommended that you review the available plug-ins and disable any that will not be necessary for your site.
+
# Log in to the Administrator.
 +
# Click on the Extensions -> Plug-in Manager menu item.
 +
# Filter the plug-in list so that only content plug-ins are shown by selecting "content" from the "Select Type" filter drop-down.
 +
# Find "Content - Smart Search" on the list of plug-ins.
 +
# Click on the red circle icon in the Status column for the Smart Search plug-in.  The red circle should change to a green tick indicating that the plug-in is now enabled.
  
To review the available plug-ins log in to the Joomla Administrator interface and use the Components menu to navigate to Finder. Once in the Finder interface, click on the "Search Plug-ins" link in the submenu. Disable any plug-ins that will not be necessary for your site by clicking the checkbox next to the plugin name and then pressing the Unpublish button in the toolbar.
+
'''IMPORTANT NOTE'''  Be aware that if you have content items that are not available for public view then the auto-completion feature will still show terms contained in those content items. The content items themselves cannot be viewed and will not be listed in search results, but if revealing the presence of a word or phrase in a restricted content item is of concern then you should disable auto-completion. To disable auto-completion use the following procedure:
Running the Indexer
+
  
After the search plugins have been reviewed, it is time to start the Finder indexer. Use the Components menu to navigate to Finder. Click on the Index button in the toolbar to start the indexer. This will cause a modal window to load with some indexer status information and a progress bar. Depending on the size of your site, this can take a few minutes to a few hours to complete. The indexer uses AJAX requests to complete the overall process in small chunks so as to avoid timeouts and memory problems. Indexing is complete when the progress bar disappears and you see a message indicating that it is not safe to close the modal window.
+
# Log in to the Administrator.
 +
# Click on Components -> Smart Search.
 +
# Click on the Options toolbar button.
 +
# Change "Search Suggestions" from "Show" to "Hide".
 +
# Click Save and Close.
  
Once all of the indexer is finished, closing the modal window will cause the Indexed Content screen in the background to refresh with an updated list of all the indexed content. If you would prefer that specific items not be displayed in search results, you can unpublish them from the Finder database by selecting the checkbox next to the title of the item and then pressing the Unpublish button. For more information on the Indexed Content screen, see: Managing Indexed Content.
+
==Preparing Smart Search plug-ins==
 +
For content to be displayed in search results it must first be indexed by one of the Smart Search plug-ins. Before starting the indexer, it is recommended that you review the available plug-ins and disable any that will not be necessary for your site. To review the available Smart Search plug-ins use the following procedure:
  
==Exposing Finder to site Users==
+
# Log in to the Administrator.
 +
# Click on the Extensions -> Plug-in Manager menu item.
 +
# Filter the plug-in list so that only Smart Search plug-ins are shown by selecting "finder" from the "Select Type" filter drop-down.
 +
# Review the list of plug-ins and disable any that will not be necessary for your site by clicking on the green tick icon in the Status column for the plug-in.  This should change to a red circle to indicate that the plug-in is disabled.
  
Now that the Finder database is prepared and ready, you need to expose Finder to your Web site's users. Finder offers two ways to do this:
+
==Running the Indexer==
The Module Interface
+
After you have reviewed the search plug-ins, it is time to start the Smart Search indexer. This will scan the content on your website and build an index that will enable fast and intelligent searching by your site visitors. To run the indexer use the following procedure:
  
Finder comes with a module named mod_finder that can be enabled to display a simple search form on any page in virtually any position. To enable mod_finder:
+
# Log in to the Administrator.
 +
# Click on the Components -> Smart Search menu item.
 +
# Click on the Index button in the toolbar to start the indexer. This will cause a modal window to load with some indexer status information and a progress bar. Depending on the size of your site, this can take a few minutes to a few hours to complete. The indexer uses AJAX requests to complete the overall process in small chunks so as to avoid timeouts and memory problems. Indexing is complete when the progress bar disappears and you see a message indicating that it is now safe to close the modal window.
  
# Navigate to the Module Manager in the Joomla! Administrator interface.
+
Once the indexer has finished, closing the modal window will cause the Indexed Content screen in the background to refresh with an updated list of all the indexed content. If you would prefer that specific items not be displayed in search results, you can unpublish them from the Smart Search database by selecting the checkbox next to the title of the item and then pressing the Unpublish button. For more information on the Indexed Content screen see the [[Help25:Components Finder Manage Indexed Content|Manage Indexed Content help screen]].
# Press the New button in the Module Manager toolbar.
+
 
# Select Finder from the list of module types by either clicking on the text or by selecting the radio input next to the module title and pressing the Next button in the toolbar.
+
'''IMPORTANT NOTE''': If your site has a large amount of content, or particularly large content items, or has restricted disk space, you should read about [[Smart Search on large sites]].
# Configure the module by entering a name, selecting the module position, and adjusting the pages for it to display on if desired.
+
 
 +
==Exposing Smart Search to site users==
 +
Now that the Smart Search index is prepared and ready, you need to expose Smart Search to your website's users. Smart Search offers two ways to do this:
 +
 
 +
===The Module Interface===
 +
Smart Search includes a module that can be enabled to display a simple search form on any page in virtually any position. To enable the Smart Search module use the following procedure:
 +
 
 +
# Log in to the Administrator.
 +
# Click on the Extensions -> Module Manager menu item.
 +
# Click the New button in the Module Manager toolbar.
 +
# Select "Smart Search Module" from the list of module types shown.
 +
# Configure the module by (at least) entering a title, selecting the module position, and adjusting the pages for it to display on if desired.  Additional module configuration options are described on the [[Help25:Extensions Module Manager Smart Search|Smart Search module help screen]].
 
# Click on the Save button in the toolbar to publish the module.
 
# Click on the Save button in the toolbar to publish the module.
  
==The Component Interface==
+
===The Component Interface===
 +
Smart Search can also be linked to via a Joomla menu item so that users can navigate directly to the main search form. To create a menu item link to Smart Search use the following procedure:
  
Finder can also be linked to via a Joomla! menu item so that users can navigate directly to the main search form. To create a menu item link to Finder:
+
# Log in to the Administrator.
 +
# Click on the Extensions -> Module Manager menu item.
  
# Navigate to the desired menu under Menus in the Joomla! Administrator interface.
 
 
# Press the New button in the Menu Manager toolbar.
 
# Press the New button in the Menu Manager toolbar.
# Select Finder from the list of Internal Link types by clicking on the text. This will cause the tree to expand. Click on the Search view link in the subtree.
+
# Click the Select button next to the Menu Item Type field.
# Configure the menu item by entering a title and adjusting the parent item if desired.
+
# Click on "Search" under the "Smart Search" entry on the list of menu item types shown.
 +
# Configure the menu item by (at least) entering a Menu Title and adjusting the parent item if desired.
 
# Click on the Save button in the toolbar to publish the menu item.
 
# Click on the Save button in the toolbar to publish the menu item.
  
 
==Testing, Testing, Testing==
 
==Testing, Testing, Testing==
 +
To test Smart Search, navigate to one of the menu items you created and enter a query in the search form or enter a query into one of the instances of Smart Search module. You should be taken to a list of search results if any could be found for the word or phrase you entered. If no results could be found, a message will be displayed indicating that no results could be found. If no results could be found and the system has a search suggestion based on your term, the suggested search phrase will display above the message indicating no results could be found.
  
To test Finder, navigate to one of the menu items you created and enter a query in the search form or enter a query in to one of the instances of mod_finder. You should be taken to a list of search results if any could be found for the word or phrase you entered. If no results could be found, a message will be displayed indicating that no results could be found. If no results could be found and the system has a search suggestion based on your term, the suggested search phrase will display above the message indicating no results could be found.
+
==Finalising the Switch==
 
+
To finalize the switch to Smart Search, you should remove all instances of mod_search and all menu items linking to com_search. Smart Search does not interact with the old Joomla search system and exposing both systems may create a negative user experience by giving inconsistent and confusing search results.
==Finalizing the Switch==
+
 
+
To finalize the switch to Finder, you should remove all instances of mod_search and all menu items linking to com_search. Finder does not interact with the Joomla! Core's search system and exposing both systems will create a negative user experience by giving inconsistent and confusing search results.
+
 
+
==Removing Joomla! Search Modules==
+
 
+
# Navigate to the Module Manager in the Joomla! Administrator interface.
+
# Use the module type filter drop down box in right hand part of the screen just above the list of modules to limit the list to instances of mod_search. If mod_search does not appear in the options, there are no instances of mod_search and you can skip this part.
+
# After the page reloads, select the checkbox at the top of the table to select all of the items in the list. Once all the instances of mod_search have been selected, press the Delete button in the Module Manager toolbar. Be careful that you do not accidentally delete any other modules in the process.
+
 
+
==Removing Joomla! Search Menu Items==
+
  
Unfortunately, there is no quick and easy way to remove all links to the Joomla! Search system. To remove all the menu items to the Joomla! Search system, you will have to browse the menu items in each of your site's menus and manually remove the links. To make this process somewhat quick, adjust the order of the table to list menu items by type in reverse alphabetical order. Now scroll down and look for links with type "Search >> Search". Delete those menu items by checking the checkbox to the left of the title and then pressing the Delete button in the Menu Manager toolbar.
+
==Removing Joomla Search Modules==
 +
If you have the old Joomla search still available then you will probably want to remove once you have Smart Search running correctly. To remove old Joomla search modules use the following procedure:
  
==Documentation==
+
# Log in to the Administrator.
 +
# Click on the desired menu under the Menus menu item.
 +
# Filter the modules listed so that only search modules are shown by selecting "Search" from the "Select Type" filter drop-down.  If no such modules are listed then there are no instances of the old search available and you can skip this part.
 +
# Select the checkbox at the top of the table to select all of the items in the list. Once all the instances of the old search have been selected, press the Delete button in the Module Manager toolbar. Be careful that you do not accidentally delete any other modules in the process.
  
* [[Finder configuration options]]
+
==Removing Joomla Search Menu Items==
* [[Changes from Finder 2.0.1]]
+
Unfortunately, there is no quick and easy way to remove all links to the old Joomla search system. To remove all the menu items to the old Joomla search system you will have to browse the menu items in each of your site's menus and manually remove the links. To make this process somewhat quicker, adjust the order of the table to list menu items by type in reverse alphabetical order. Now scroll down and look for links with type "Search >> Search". Delete those menu items by checking the checkbox to the left of the title and then pressing the Delete button in the Menu Manager toolbar.
* [[Finder Integration Working Group]]
+
* [https://github.com/joomla/joomla-cms/tree/master/plugins/finder Finder plugins on GitHub]
+
  
[[Category:Finder]]
+
[[Category:Smart Search]]

Latest revision as of 08:34, 18 March 2013

Contents

Enabling the Smart Search content plug-in

Smart Search is not enabled by default in Joomla 2.5. To start using Smart Search you will need to enable the Smart Search content plug-in, which can be done using the following procedure:

  1. Log in to the Administrator.
  2. Click on the Extensions -> Plug-in Manager menu item.
  3. Filter the plug-in list so that only content plug-ins are shown by selecting "content" from the "Select Type" filter drop-down.
  4. Find "Content - Smart Search" on the list of plug-ins.
  5. Click on the red circle icon in the Status column for the Smart Search plug-in. The red circle should change to a green tick indicating that the plug-in is now enabled.

IMPORTANT NOTE Be aware that if you have content items that are not available for public view then the auto-completion feature will still show terms contained in those content items. The content items themselves cannot be viewed and will not be listed in search results, but if revealing the presence of a word or phrase in a restricted content item is of concern then you should disable auto-completion. To disable auto-completion use the following procedure:

  1. Log in to the Administrator.
  2. Click on Components -> Smart Search.
  3. Click on the Options toolbar button.
  4. Change "Search Suggestions" from "Show" to "Hide".
  5. Click Save and Close.

Preparing Smart Search plug-ins

For content to be displayed in search results it must first be indexed by one of the Smart Search plug-ins. Before starting the indexer, it is recommended that you review the available plug-ins and disable any that will not be necessary for your site. To review the available Smart Search plug-ins use the following procedure:

  1. Log in to the Administrator.
  2. Click on the Extensions -> Plug-in Manager menu item.
  3. Filter the plug-in list so that only Smart Search plug-ins are shown by selecting "finder" from the "Select Type" filter drop-down.
  4. Review the list of plug-ins and disable any that will not be necessary for your site by clicking on the green tick icon in the Status column for the plug-in. This should change to a red circle to indicate that the plug-in is disabled.

Running the Indexer

After you have reviewed the search plug-ins, it is time to start the Smart Search indexer. This will scan the content on your website and build an index that will enable fast and intelligent searching by your site visitors. To run the indexer use the following procedure:

  1. Log in to the Administrator.
  2. Click on the Components -> Smart Search menu item.
  3. Click on the Index button in the toolbar to start the indexer. This will cause a modal window to load with some indexer status information and a progress bar. Depending on the size of your site, this can take a few minutes to a few hours to complete. The indexer uses AJAX requests to complete the overall process in small chunks so as to avoid timeouts and memory problems. Indexing is complete when the progress bar disappears and you see a message indicating that it is now safe to close the modal window.

Once the indexer has finished, closing the modal window will cause the Indexed Content screen in the background to refresh with an updated list of all the indexed content. If you would prefer that specific items not be displayed in search results, you can unpublish them from the Smart Search database by selecting the checkbox next to the title of the item and then pressing the Unpublish button. For more information on the Indexed Content screen see the Manage Indexed Content help screen.

IMPORTANT NOTE: If your site has a large amount of content, or particularly large content items, or has restricted disk space, you should read about Smart Search on large sites.

Exposing Smart Search to site users

Now that the Smart Search index is prepared and ready, you need to expose Smart Search to your website's users. Smart Search offers two ways to do this:

The Module Interface

Smart Search includes a module that can be enabled to display a simple search form on any page in virtually any position. To enable the Smart Search module use the following procedure:

  1. Log in to the Administrator.
  2. Click on the Extensions -> Module Manager menu item.
  3. Click the New button in the Module Manager toolbar.
  4. Select "Smart Search Module" from the list of module types shown.
  5. Configure the module by (at least) entering a title, selecting the module position, and adjusting the pages for it to display on if desired. Additional module configuration options are described on the Smart Search module help screen.
  6. Click on the Save button in the toolbar to publish the module.

The Component Interface

Smart Search can also be linked to via a Joomla menu item so that users can navigate directly to the main search form. To create a menu item link to Smart Search use the following procedure:

  1. Log in to the Administrator.
  2. Click on the Extensions -> Module Manager menu item.
  1. Press the New button in the Menu Manager toolbar.
  2. Click the Select button next to the Menu Item Type field.
  3. Click on "Search" under the "Smart Search" entry on the list of menu item types shown.
  4. Configure the menu item by (at least) entering a Menu Title and adjusting the parent item if desired.
  5. Click on the Save button in the toolbar to publish the menu item.

Testing, Testing, Testing

To test Smart Search, navigate to one of the menu items you created and enter a query in the search form or enter a query into one of the instances of Smart Search module. You should be taken to a list of search results if any could be found for the word or phrase you entered. If no results could be found, a message will be displayed indicating that no results could be found. If no results could be found and the system has a search suggestion based on your term, the suggested search phrase will display above the message indicating no results could be found.

Finalising the Switch

To finalize the switch to Smart Search, you should remove all instances of mod_search and all menu items linking to com_search. Smart Search does not interact with the old Joomla search system and exposing both systems may create a negative user experience by giving inconsistent and confusing search results.

Removing Joomla Search Modules

If you have the old Joomla search still available then you will probably want to remove once you have Smart Search running correctly. To remove old Joomla search modules use the following procedure:

  1. Log in to the Administrator.
  2. Click on the desired menu under the Menus menu item.
  3. Filter the modules listed so that only search modules are shown by selecting "Search" from the "Select Type" filter drop-down. If no such modules are listed then there are no instances of the old search available and you can skip this part.
  4. Select the checkbox at the top of the table to select all of the items in the list. Once all the instances of the old search have been selected, press the Delete button in the Module Manager toolbar. Be careful that you do not accidentally delete any other modules in the process.

Removing Joomla Search Menu Items

Unfortunately, there is no quick and easy way to remove all links to the old Joomla search system. To remove all the menu items to the old Joomla search system you will have to browse the menu items in each of your site's menus and manually remove the links. To make this process somewhat quicker, adjust the order of the table to list menu items by type in reverse alphabetical order. Now scroll down and look for links with type "Search >> Search". Delete those menu items by checking the checkbox to the left of the title and then pressing the Delete button in the Menu Manager toolbar.