Purpose

This document is a User Guide for Instant Search and Suggestions module for Magento. It describes how work with the extension.

This module is the fastest advanced search of Magento ever. Pro development has made search results appear immediately, while customers still type. While plenty of settings are for you to make search work exactly the way you want.

System Requirements

The extension works under Magento from 1.4.x and higher.

The extension works with Apache 1.3.x and higher, PHP 5, Linux or IIS.

The extension’s correct work is guaranteed with the following browsers:

• IE7, IE8, IE9
• FireFox 4.x, 5.x
• Google Chrome 15.x
• Safari 5.x

The correct work with other Magento versions, other browsers and Apache/PHP versions is not guaranteed.

Installation

All our Magento extensions and templates are installed via IToris Installer.

Download IToris Installer and un-pack to the root of your website. It will then appear in menu System –>IToris extensions –> IToris Installer.

Open it and you will see all our Magento Extensions and Templates, both installed and available. You can install, update and un-install them with one click now.

Find Homepage Tabs in the list of extensions and press Install button. It will ask for the license key that you will receive after the purchase. Enter the key and submit. The extension will be installed. It will be available in menu System –>IToris extensions –> Instant Seacrh & Suggestions

License

Magento modules developed by IToris are provided with 2 license types - regular and premium.

Regulal license is partially encrypted. This license is website-dependent. By ‘website’ here we understand the website in Magento terms. Under one Magento installation one license key of the extension can activate all stores/storeviews. within one website. If your configuration has several Magento websites - a separate license will be required for each.

One license also supports a number of sub-domains for development/testing purposes in addition to the live website. Please see the full list of available sub-domains and additional information about the license in our Terms and Conditions

Premium license activates one Magento installation. All websites, stores and storeviews under one installation are covered with one license. Premium license is 100% open-source and is recommended for customizations.

You can switch the license from one domain to another – login to IToris website using the credentials you will receive after the purchase. Go to My Downloads area, find your key there and reset it from the current website. Then use it again to activate another website.

The license also includes free life-time updates for the extension.

Settings

To set the module select System –>IToris extensions –> Instant Search & Suggestions

You will see all settings combined on one page. Here you can manage how the module should behave.

General Configuration

This group of settings manages general behavior and look of the module. The following settings are available:

Extension enabled - this setting activates/deactivates the extension for the front-end. You can deactivate it while you set it and then enable it again.

Highlight keyword in all texts - when this setting is enabled, the searched keyword(s) will be highlighted in all search results

Default mode - there are 3 options available for results’ display:

• All sections - search results will include all available areas
• All products - search results will include products and keywords only
• All articles - search results will include only article and keywords

Allow to switch between modes - if you check this checkbox, there will be show all/show less link. Show all mode loads all found products and hides the rest of search results. If there are many products - scrolling will appear in search results area. Show less returns default results’ look. If this checkbox is unchecked - only default results’ look will be displayed.

Search field location - this setting is used for custom layouts.

The width of results bar - set the width of results’ area in pixels

Cache lifetime - for how long the results should stay valid (in minutes)

Settings

To set the module select System –>IToris extensions –> Instant Search & Suggestions

You will see all settings combined on one page. Here you can manage how the module should behave.

Keyword Suggestions

This group of settings manages the keywords’ proposals that are displayed on the top of the results:

Each keyword is a link, they appear while customers type. Customers can click any keyword and it will return the found results.

The following settings are available for this group:

Keyword Suggestion Enabled - you can switch keywords’ display on/off with this setting. If it is switched off - the keywords will not be displayed, search results will start with products or other areas selected

Maximum # of keywords to show - how many keywords to be displayed in the results maximum

Show the # of products/articles for keywords - if this setting is enabled, there is a number of found products in the brackets for each keyword.

Settings

To set the module select System –>IToris extensions –> Instant Search & Suggestions

You will see all settings combined on one page. Here you can manage how the module should behave.

Products Suggestions

This area manages the most popular searched items - products.

Please note, if you have selected to display both products and articles/categories in search results, all products that correspond to the keyword will be found, yet only the set number of them will be displayed by default. There will be Show all link that displays all products and hides the rest of the results.

Products Suggestions Enabled - this setting enables products’ display in search results

Order By - define the order of products’ display. The following options are available:

• Relevancy - the most relevant to the search keyword(s) products go higher
• Alphabetically - products to be displayed in alphabetical order
• Rating - products with (higher) rating go first
• Popularity- more popular products go higher
• Newest First - newer products go higher

Maximum # of products to show - this setting will be applied only if you have selected several search areas to be displayed in results. If products only are selected - then all found products will be shown. If there are plenty of products - scrolling will appear in results’ box.

Show Image - select if products’ main image should be displayed or not. If yes - make sure you have set Image size in pixels.

Show Price - select this setting if you want products’ price to be displayed directly in search results. If there are bundle or configurable products - the price will be displayed with + (please see Computer product below).

Show Description - you can display products’ description or part of it in results. Select how many symbols of description should be displayed in Limit description to X characters, the rest will be hidden with …

Show Rating - this setting displays rating stars when selected

Show Add to Wishlist link, Show Add to Compare link and Show Add to Cart link - these checkboxes add appropriate links to the products, so that customers can add products to compare, to wishlist or to cart directly from search results

Settings

To set the module select System –>IToris extensions –> Instant Search & Suggestions

You will see all settings combined on one page. Here you can manage how the module should behave.

Categories Suggestions

This setting adds found categories to the search results. Al categories are links, clicking a link opens up the category page. If you have all search areas activated, categories will go below the products.

The following settings are available:

Categories Suggestions Enabled - this setting enables categories’ display in search results

Maximum # of categories to show - how many categories to be displayed maximum

Show the # of products for category - if this setting is enabled, each category will contain the number of found products in the brackets.

Settings

To set the module select System –>IToris extensions –> Instant Search & Suggestions

You will see all settings combined on one page. Here you can manage how the module should behave.

Articles Suggestions

This area manages CMS pages’ display in search results. If you have all search areas activated, articles will be displayed below the categories

The following settings are available:

CMS Page Suggestions Enabled - this setting enables articles’ display in search results

Order By

• Relevancy - the most relevant to the search keyword(s) CMS pages go higher
• Alphabetically - CMS pages to be displayed in alphabetical order
• Newest First - newer CMS pages go higher

Maximum # of articles to show - how many CMS pages to be displayed maximum

Show Description - if the article’s text should be displayed or not. If you select yes - make sure you set Limit description to X characters - the rest of the text will be hidden with …

Exclude CMS Pages - select which CMS pages should not be displayed in search results. For example, 401 page or Enable Cookies page.