Difference between revisions of "X-Cart:X-HotProducts"

Latest revision as of 09:42, 15 November 2018

X-Cart 4.4or above

1 Overview
2 System requirements and installation
- 2.1 System requirements
- 2.2 Installation and removal
3 Enabling the modules of the X-HotProducts package
4 Configuring the modules of the X-HotProducts package
- 4.1 New Arrivals module configuration settings
- 4.2 On Sale module configuration settings

Overview

X-HotProducts is a software package that includes three independent X-Cart modules: New Arrivals, On Sale and Previously Ordered Products.

New Arrivals module

New Arrivals is a module that allows you to showcase the latest additions to your store's product catalog. If your store's assortment is updated regularly, this module will help you to highlight and promote your newest products. The module will be especially useful to your returning customers, who will be able to find the items added since their last visit more easily.

With the New Arrivals module installed and enabled, your store will have a special page where your store's latest products will be shown - the 'New Arrivals' page:

Your customers will be able to access this page at the URL of your store with /new_arrivals.php added at the end. For example, if your store's URL is http://example.com, the 'New Arrivals' page will be available at the address http://example.com/new_arrivals.php.

The module can be configured to include a link to the 'New Arrivals' page into the Special section of your store's Customer area:

In addition to the 'New Arrivals' page, the list of recently added products can be displayed on the Home page:

in the product list section (main column) of your store's category pages:

and in the New Arrivals section of the Customer area sidebar (menu column):

You do not have to worry about adding your new products to the new arrivals list: the new arrivals list is formed automatically of products added to the database during a specified number of days before current time (The number of days can be adjusted in the module settings.). It is possible to control the length of the new arrivals list by setting a limit on the number of products that can be shown.

Note that the contents of the new arrivals list varies depending on the location where the list is displayed: the new arrivals lists shown on the 'Home' and 'New Arrivals' pages are formed of new arrivals from the entire product catalog, whereas the new arrivals lists that appear on specific category pages are formed exclusively of the newest products that belong in the category being viewed (Depending on the module settings, this may or may not include products from the subcategories of the current category).

It is possible to adjust the display mode for the products in the new arrivals list; new arrivals can be shown like ordinary products on any of your store's product list pages (like in this screenshot) or use a more compact presentation:

The following features was added to X-Cart Gold v4.5.3+ and X-Cart Goldplus/Platinum v4.5.5+:

New settings:

Show products marked as new for N days
Show "Date added" row on the product list
Show manually added products first

Ability to mark any product as new:

Date when a product was added is displayed at the product modify page:

"Search by date" option added to the product search page in the admin area:

Sort by date on the product list page in the admin area:

Ability to select categories in which the new arrivals will be shown (added only to X-Cart Gold v4.5.3+):

On Sale module

The On Sale module povides a method for promoting specific products in your store by putting them on sale. Putting a product on sale presupposes highlighting the product by entering it into the store's 'On Sale' list and adding bright sale labels to its thumbnail and main images so it can be easily found by the visitors looking for hot deals.

Products can be put on sale by the store's administrator. The process is as easy as selecting the 'On sale' check box on the product's details page (also known as the 'product modify page') in the Admin area and applying the changes:

After some products have been put on sale, they appear on a special page in the store's Customer area - the 'On Sale' page:

Your customers will be able to access this page at the URL of your store with /on_sale.php added at the end. For example, if your store's URL is http://example.com, the 'On Sale' page will be available at the address http://example.com/on_sale.php.

Note that the module can be configured to include a link to the 'On Sale' page into the Special section of the Customer area (menu column):

In addition to the 'On Sale' page, the list of products currently on sale can be made visible on your store's Home page (main column):

If you wish, you may also adjust the module to take your products' "on sale" property into account for sorting purposes: on product list pages using the Default sort order, products put on sale will be displayed first in the list. Your customers will know they are on sale by the red 'Sale' labels attached to their images.

The 'Sale' label image is stored in the file /skin/common_files/modules/On_Sale/images/on_sale.png. If you wish, you can replace this image by an image of your own. The current size of the 'Sale' label image is 48x48 pixels.

Previously Ordered Products module

The Previously Ordered Products module allows your customers to quickly find, add to cart and re-order the products they have already ordered at your store.

When this module is installed and enabled, your store's registered customers who already bought something from you can view the list of all the products they have ordered on a separate page - the 'Previously ordered products' page:

This page is available at the URL of your store with /quick_reorder.php added at the end. For example, if your store's URL ishttp://example.com, the address of the 'Previously ordered products' page for your customers is http://example.com/quick_reorder.php.

After signing in, registered customers who have ordered something at your store will see a link to the 'Previously ordered products' page titled 'Quick reorder'. Depending on the skin used by your store, the location of the 'Quick reorder' link can be different. For example, in the 'Ideal Comfort' skin, the link is shown in the site header:

In the 'Vivid Dreams' skin, the 'Quick reorder' link is included into the Special section at the page bottom:

System requirements and installation

Starting with X-Cart version 4.5.3, the X-HotProducts package is available with X-Cart GOLD PLUS and PLATINUM editions; in the said editions, it does not require installation: the modules New Arrivals, On Sale and Previously Ordered Products can be enabled in the Modules section of X-Cart Admin area.

For X-Cart GOLD 4.4.0-4.7.x versions and for X-Cart PRO 4.4.0-4.5.2 versions, the X-HotProducts package can be purchased and installed separately. The following instructions will guide you through the process of installing the X-HotProducts package in your store.

System requirements

To be able to successfully install and use the modules of the X-HotProducts package, you need a working copy of X-Cart GOLD or PRO v4.4.0-4.5.2 or X-Cart Gold v4.5.3 or later installed on your server. Make sure that the version of the X-HotProducts package you are installing is the same as the version of X-Cart on which your store is based.

Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area.

Important: If using PHP4, iconv extension must be enabled.

Installation and removal

To install X-HotProducts:

Obtain the X-HotProducts distribution package by downloading it from the File area section of your X-Cart Account. The distribution package you need is contained in the archive file X-HotProducts-x.y.z-with-installer.tgz where x, y and z stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
Put the distribution package to the X-Cart root directory on your server or hosting account.
- If you use a Windows-based server, or a UNIX-based server without terminal access:
a) Decompress the archive with the X-HotProducts distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).

b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
- If you use a UNIX-based server with terminal access:
a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.

b) Decompress the package using the following command:
```
tar -xzvf X-HotProducts-x.y.z-with-installer.tgz
```
Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten!
In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-hot-products.php, replacing the <YOUR_XCART_DOMAIN> part with the actual domain name of your X-Cart based store.
Enter the Auth code, accept the License Agreement and click the Next button.
The installation script copies the files and activates the modules. Click the Next button to continue the installation.
The installation script generates a new system fingerprint. Click the Next button to complete the installation.
Use the ADMINISTRATOR AREA link to access the Admin area.

To uninstall X-HotProducts:

In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-hot-products.php, replacing the <YOUR_XCART_DOMAIN> part with the actual domain name of your X-Cart based store.
Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.
Once the installation script has removed the files of the X-HotProducts package and deactivated the module, click the Next button to complete the uninstallation.
On the Uninstallation complete screen, click Next to leave the Wizard.

Important: After you have uninstalled X-HotProducts, be sure to remove the X-HotProducts distribution package from your web directory as well.

Enabling the modules of the X-HotProducts package

After the X-HotProducts installation has been completed, the modules you have installed (New Arrivals, On Sale andPreviously Ordered Products) need to be enabled in your store:

In Admin area, go to the Modules section (Settings menu->Modules).
Choose the module(s) you wish to enable by selecting the respective check box(es) on the left.
Click the Apply changes button. This activates the selected module(s).

Configuring the modules of the X-HotProducts package

Two modules of the X-HotProducts package - New Arrivals and On Sale - provide configuration settings which you can adjust according to your preference. After these modules have been enabled in your store, it is a good idea to check and adjust their configuration:

In the Modules section of Admin area (Settings menu->Modules), click the Configure link opposite the name of the module that needs to be configured ('New Arrivals' or 'On Sale').

The module configuration page (titled by the name of the module) opens.

New Arrivals module configuration page:

On Sale module configuration page:
Adjust the settings on the module configuration page as needed. Detailed information regarding the New Arrivals module configuration settings and On Sale module configuration settings is available below.
Click the Apply changes button to save the changes.

New Arrivals module configuration settings

Number of products in the new arrivals list: Specify the number of products that should be shown in the new arrivals list; this setting affects the new arrivals lists displayed on the store's Home page, category pages and in the New Arrivals section of the Customer area sidebar.
Number of products on the New Arrivals page: Specify the number of products that should be shown on your store's 'New Arrivals' page. Note that the product list on the 'New Arrivals' page will be paginated according to your store's 'Pagination options' settings (Settings->General settings/Appearance).
Show products added in the last N days: Enable this option if you want products added to the database in the last N days to be displayed as new arrivals. A "day" is a 24-hour period. For example, if the value of this field is "3", and the new arrivals list is displayed at 4.26 p.m. on June 26, 2012, the list will include products added to the database after 4.26 p.m. June 23, 2012. If you do not want this type of products to be displayed as new arrivals, set this value to 0 (X-Cart versions 4.7.3 or later) or 0.0001 (earlier X-Cart versions through 4.7.2).
Show the new arrivals list on the Home page: Select the check box to show new arrivals on the Home page.
Show the new arrivals list in the menu column: Select the check box to show new arrivals in the 'New Arrivals' section of the Customer area sidebar.
Show the new arrivals list in the main column: Select the check box to show new arrivals in the product list section of category pages.
Show link to the New Arrivals page in the "Special" section: Select the check box to provide a link to the 'New Arrivals' page in the 'Special' section of the store's Customer area.
View of the new arrivals list: Choose the display mode for the new arrivals list; Full corresponds to displaying your store's new arrivals like ordinary products on any of your store's product list pages; Simple display mode provides a more compact view, where information about each product in the 'New Arrivals' list includes only the product name, product thumbnail image, date of addition to the store's database and price. This setting affects the new arrivals lists displayed on the store's Home page and in the product list section of category pages.
Show products on category page including sub-categories: Enable the option to show new products from subcategories on the new arrivals list of its parent category.
Show products marked as new for N days: Specify the number of days during which products manually marked as new (on the product modify page) will be displayed as new arrivals.
Show "Date added" row on the product list: Enable the option to show additional "Date added" column in the products list in admin area.
Show manually added products first: Tick the check box if you want the products manually marked as new to be displayed first in the products list for the 'Default' sorting method.

On Sale module configuration settings

Show on sale products first in the product list: Select the check box if you want the products put on sale to be displayed first in the products list for the 'Default' sorting method.
Show link to the On Sale page in the "Special" section: Select the check box to provide a link to the 'On Sale' page in the 'Special' section of your store's Customer area.
Show on sale products on the Home page: Select the check box to show on sale products on the Home page.

Difference between revisions of "X-Cart:X-HotProducts"

Latest revision as of 09:42, 15 November 2018

Contents

Overview

New Arrivals module

On Sale module

Previously Ordered Products module

System requirements and installation

System requirements

Installation and removal

Enabling the modules of the X-HotProducts package

Configuring the modules of the X-HotProducts package

New Arrivals module configuration settings

On Sale module configuration settings

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

entry points

Tools

@@ Line 3: / Line 3: @@
 == Overview ==
-<u>X-HotProducts</u> is a software package that includes three independent modules:
+<u>X-HotProducts</u> is a software package that includes three independent X-Cart modules: [[#New Arrivals module|New Arrivals]], [[#On Sale module|On Sale]] and [[#Previously Ordered Products module|Previously Ordered Products]].
-* <u>New Arrivals</u> - allows you to show the latest products added to the database;
-* <u>On Sale</u> - adds the "On Sale" label to the thumbnail and main image of any product;
-* <u>Previously Ordered Products</u> - allows your customers to quickly add products, which they had ordered in the store.
-=== New Arrivals ===
+=== New Arrivals module===
-Depending on the module settings, the list of recently added products can be displayed in the <u>New Arrivals menu</u> in the Customer area sidebar (menu column):
+<u>New Arrivals</u> is a module that allows you to showcase the latest additions to your store's product catalog. If your store's assortment is updated regularly, this module will help you to highlight and promote your newest products. The module will be especially useful to your returning customers, who will be able to find
+the items added since their last visit more easily.
+With the <u>New Arrivals</u> module installed and enabled, your store will have a special page where your store's latest products will be shown - the 'New Arrivals' page:
-: [[Image:new_arrivals_menu_column.png|border]]
+: [[Image:new_arrivals_page.png|border]]
+Your customers will be able to access this page at the URL of your store with <u>/new_arrivals.php</u> added at the end. For example, if your store's URL is http://example.com, the 'New Arrivals' page will be available at the address http://example.com/new_arrivals.php.
-in the <u>product list section</u> (main column):
+The module can be configured to include a link to the 'New Arrivals' page into the <u>Special</u> section of your store's Customer area:
+: [[Image:hot_products_special_section.png|border]]
-: [[Image:new_arrivals_main_column.png|border]]
+In addition to the 'New Arrivals' page, the list of recently added products can be displayed on the Home page:
+: [[Image:new_arrivals_home_page.png|border]]
-and on the <u>Home page</u>:
+in the product list section (main column) of your store's category pages:
+: [[Image:new_arrivals_main_column.png|border]]
-: [[Image:new_arrivals_home_page.png|border]]
+and in the <u>New Arrivals</u> section of the Customer area sidebar (menu column):
+: [[Image:new_arrivals_menu_column.png|border]]
+You do not have to worry about adding your new products to the new arrivals list: the new arrivals list is formed automatically of products added to the database during a specified number of days before current time (The number of days can be adjusted in the module settings.). It is possible to control the length of the new arrivals list by setting a limit on the number of products that can be shown.
-The "<u>Simple</u>" view of the new arrivals list can be set:
+Note that the contents of the new arrivals list varies depending on the location where the list is displayed: the new arrivals lists shown on the 'Home' and 'New Arrivals' pages are formed of new arrivals from the entire product catalog, whereas the new arrivals lists that appear on specific category pages are formed exclusively of the newest products that belong in the category being viewed (Depending on the module settings, this may or may not include products from the subcategories of the current category).
+It is possible to adjust the display mode for the products in the new arrivals list; new arrivals can be shown like ordinary products on any of your store's product list pages (like in [[#NewArrivalsMainColumn |this screenshot]]) or use a more compact presentation:
 : [[Image:new_arrivals_simple_view.png|border]]
+The following features was added to X-Cart Gold v4.5.3+ and X-Cart Goldplus/Platinum v4.5.5+:
-=== On Sale ===
+New settings:
-On Sale products can be visible on the <u>Home page</u> (main column):
+* Show products marked as new for N days
+* Show "Date added" row on the product list
+* Show manually added products first
-: [[Image:on_sale_main_column.png|border]]
+Ability to mark any product as new:
+: [[Image:New_arrivals_mark_as_new_product.png|border]]
-=== Previously Ordered Products ===
+Date when a product was added is displayed at the product modify page:
-Link to the <u>Previously Ordered Products</u> page can be visible in the header of the page:
+: [[Image:New_arrivals_date_added_label.png|border]]
-: [[Image:quick_reorder_header.png|border]]
+"Search by date" option added to the product search page in the admin area:
+: [[Image:New_arrivals_date_added_search.png|border]]
-<u>Previously Ordered Products</u> page:
+Sort by date on the product list page in the admin area:
+: [[Image:New_arrivals_date_added_column.png|border]]
-: [[Image:previously_ordered_products.png|border]]
+Ability to select categories in which the new arrivals will be shown (added only to X-Cart Gold v4.5.3+):
+: [[Image:New_arrivals_show_in_categories_1.png|border]]
-----
+=== On Sale module ===
-Links to the pages with the "New Arrivals" and "On Sale" products can be visible in the "<u>Special</u>" section (menu column):
+The <u>On Sale</u> module povides a method for promoting specific products in your store by putting them on sale. Putting a product on sale presupposes highlighting the product by entering it into the store's 'On Sale' list and adding bright sale labels to its thumbnail and main images so it can be easily found by the visitors looking for hot deals.
-: [[Image:hot_products_special_section.png|border]]
-== Roles in Hot Products module management ==
-If you are an X-Cart GOLD administrator/provider or an X-Cart PRO administrator:
-* You can enable/disable and configure the modules included into the Hot Products;
-* You can set the "on sale" check-box on the <u>product modify page</u> for every product in your store:
+Products can be put on sale by the store's administrator. The process is as easy as selecting the '<u>On sale</u>' check box on the product's details page (also known as the 'product modify page') in the Admin area and applying the changes:
 : [[Image:on_sale_product_modify_page.png|border]]
+After some products have been put on sale, they appear on a special page in the store's Customer area - the 'On Sale' page:
-== System requirements ==
+: [[Image:on_sale_page.png|border]]
-To be able to successfully install and use X-HotProducts module you must have a working copy of X-Cart Gold or X-Cart Pro v4.4.0, 4.4.1, 4.4.2, 4.4.3, 4.4.4 or 4.5.0 already installed on your server. Make sure that the version of the module is the same as the version of the installed copy of X-Cart.
-{{Note1|Note: If you do not remember the version of the installed copy of X-Cart, find it in the <u>Summary/Environment info</u> section of the X-Cart Admin area (<u>Administration menu -> Summary</u>).}}
-{{Note1|Important: if using PHP4, iconv must be enabled.}}
+Your customers will be able to access this page at the URL of your store with <u>/on_sale.php</u> added at the end. For example, if your store's URL is http://example.com, the 'On Sale' page will be available at the address http://example.com/on_sale.php.
-== Installation ==
+Note that the module can be configured to include a link to the 'On Sale' page into the <u>Special</u> section of the Customer area (menu column):
-The instructions on how to install the X-HotProducts module are the same both for X-Cart Gold and X-Cart Pro.
-=== Installation for X-Cart 4.4.x - 4.5.x ===
+: [[Image:on_sale_special_section.png|border]]
-To install the module for X-Cart 4.4.x - 4.5.x:
-. Obtain a distribution package for the X-HotProducts add-on module by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>X-HotProducts-x.y.z-with-installer.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> are the version numbers of the module. Make sure the version of the module is the same as the version of the installed copy of X-Cart.
+In addition to the 'On Sale' page, the list of products currently on sale can be made visible on your store's <u>Home page</u> (main column):
-. Put the distribution package to the X-Cart root directory on your server or hosting account.
+: [[Image:on_sale_main_column.png|border]]
-* If you use a Windows-based server, or a UNIX-based server without terminal access:
-: a) Decompress the archive with the X-HotProducts distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files);
+If you wish, you may also adjust the module to take your products' "on sale" property into account for sorting purposes: on product list pages using the Default sort order, products put on sale will be displayed first in the list. Your customers will know they are on sale by the red 'Sale' labels attached to their images.
-: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
+The 'Sale' label image is stored in the file <u>/skin/common_files/modules/On_Sale/images/on_sale.png</u>. If you wish, you can replace this image by an image of your own. The current size of the 'Sale' label image is 48x48 pixels.
-* If you use a UNIX-based server with terminal access:
+=== Previously Ordered Products module ===
+The <u>Previously Ordered Products</u> module allows your customers to quickly find, add to cart and re-order the products they have already ordered at your store.
-: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account;
+When this module is installed and enabled, your store's registered customers who already bought something from you can view the list of all the products they have ordered on a separate page - the 'Previously ordered products' page:
-: b) Decompress the package using the following commands:
+: [[Image:previously_ordered_products.png|border]]
-<pre>tar -xzvf X-HotProducts-x.y.z-with-installer.tgz</pre>
+This page is available at the URL of your store with <u>/quick_reorder.php</u> added at the end. For example, if your store's URL ishttp://example.com, the address of the 'Previously ordered products' page for your customers is http://example.com/quick_reorder.php.
-{{Note1|Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }}
+After signing in, registered customers who have ordered something at your store will see a link to the 'Previously ordered products' page titled '<u>Quick reorder</u>'. Depending on the skin used by your store, the location of the '<u>Quick reorder</u>' link can be different. For example, in the 'Ideal Comfort' skin, the link is shown in the site header:
-. In a web browser, run the installation script <u>httр://<YOUR_XCART_DOMAIN>/install-hot-products.php</u> replacing the variable <u><YOUR_XCART_DOMAIN></u> with the true name of the domain where X-Cart is installed.
+: [[Image:quick_reorder_header.png|border]]
-. Enter the Auth code, accept the License Agreement and click the '''Next''' button.
-{{Note1|Note: The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it in the <u>Summary</u> section of the X-Cart Admin area (<u>Administration menu -> Summary</u>) before the License info subsection. Another way to know the code is to retrieve the value of the variable <u>$installation_auth_code</u> from the file <u><xcart_dir>include/install.php</u>}}
-. The installation script copies the files and activates the modules. Click the '''Next''' button to continue the installation.
-. The installation script generates a new system fingerprint. Click the '''Next''' button to complete the installation.
-. Use the ADMINISTRATOR AREA link to log in to the Admin area.
-== Enabling and Configuring "New Arrivals" ==
-To begin using the module:
-. Enable <u>New Arrivals</u> module (<u>Administration menu->Modules</u>).
-When the modules is enabled, you can see:
-* the recently added products in the <u>main</u> and <u>menu</u> columns;
-* the <u>New Arrivals</u> link in the <u>Special</u> section menu;
-* the <u>New Arrivals</u> options section in <u>General settings/Modules</u> options.
-. Adjust the <u>New Arrivals</u> module settings via <u>General settings/Modules options->New Arrivals</u> options:
+In the 'Vivid Dreams' skin, the '<u>Quick reorder</u>' link is included into the <u>Special</u> section at the page bottom:
-* <u>Number of products in the new arrivals list</u>: Specify the count of products visible in the new arrivals list on the category page and home page;
-* <u>Number of products on the New Arrivals page</u>: Specify the count of products visible on the "New Arrivals" page;
-* <u>Show products added in the last N days</u>: Only products added in the last N days will be displayed in the New Arrivals sections;
-* <u>Show the new arrivals list on the Home page</u>: Select the checkbox to show new arrivals on the home page of your store;
-* <u>Show the new arrivals list in the menu column</u>: Select the checkbox to show new arrivals in the Customer area sidebar;
-* <u>Show the new arrivals list in the main column</u>: Select the checkbox to show new arrivals section in the main part of the page;
-* <u>Show link to the New Arrivals page in the "Special" section</u>: Select the checkbox to show "New Arrivals" link to the "New Arrivals" page in the "Special" section of the site;
-* <u>View of the new arrivals list</u>: Select how the new arrivals will look: as usual products or in the simple mode;
-* <u>Show products on category page including sub-categories</u>: Select the checkbox to show new arrivals not only from the current category, but also from the sub-categories;
+: [[Image:vivid_dreams_quick_reorder.png]]
-: [[Image:new_arrivals_settings.png|border]]
+== System requirements and installation ==
+Starting with X-Cart version 4.5.3, the <u>X-HotProducts</u> package is available with X-Cart GOLD PLUS and PLATINUM editions; in the said editions, it does not require installation: the modules <u>New Arrivals</u>, <u>On Sale</u> and <u>Previously Ordered Products</u> can be enabled in the <u>Modules</u> section of X-Cart Admin area.
+For X-Cart GOLD 4.4.0-4.7.x versions and for X-Cart PRO 4.4.0-4.5.2 versions, the <u>X-HotProducts</u> package can be purchased and installed separately. The following instructions will guide you through the process of installing the <u>X-HotProducts</u> package in your store.
-. Click the '''Apply''' changes button.
+=== System requirements ===
+To be able to successfully install and use the modules of the <u>X-HotProducts</u> package, you need a working copy of X-Cart GOLD or PRO v4.4.0-4.5.2 or X-Cart Gold v4.5.3 or later installed on your server. Make sure that the version of the <u>X-HotProducts</u> package you are installing is the same as the version of X-Cart on which your store is based.
+{{Note1|Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the <u>Environment info</u> section of the [[X-Cart:Summary_Page|Summary]] page in X-Cart Admin area.}}
+{{Note1|'''Important:''' If using PHP4, iconv extension must be enabled.}}
+=== Installation and removal===
-== Enabling and Configuring "On Sale" ==
+To install <u>X-HotProducts</u>:
-To begin using the module:
-. Enable <u>On Sale</u> module (<u>Administration menu->Modules</u>).
+# Obtain the X-HotProducts distribution package by downloading it from the File area section of your {{QA}}. The distribution package you need is contained in the archive file <u>X-HotProducts-x.y.z-with-installer.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
+# Put the distribution package to the X-Cart root directory on your server or hosting account.
+#* ''If you use a Windows-based server, or a UNIX-based server without terminal access:''
+#: a) Decompress the archive with the X-HotProducts distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
+#: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
+#* ''If you use a UNIX-based server with terminal access:''
+#: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
+#: b) Decompress the package using the following command:
+#: <pre>tar -xzvf X-HotProducts-x.y.z-with-installer.tgz</pre>
+#: {{Note1|'''Important:''' Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }}
+# In a web browser, run the installation script <u>httр://<YOUR_XCART_DOMAIN>/install-hot-products.php</u>, replacing the <u><YOUR_XCART_DOMAIN></u> part with the actual domain name of your X-Cart based store.
+# Enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the '''Next''' button.
+# The installation script copies the files and activates the modules. Click the '''Next''' button to continue the installation.
+# The installation script generates a new system fingerprint. Click the '''Next''' button to complete the installation.
+# Use the ADMINISTRATOR AREA link to access the Admin area.
-When the modules is enabled, you can see:
+To uninstall <u>X-HotProducts</u>:
-* the <u>On Sale</u> icon on the products thumbnail and image;
+# In a web browser, run the installation script <u>httр://<YOUR_XCART_DOMAIN>/install-hot-products.php</u>, replacing the <u><YOUR_XCART_DOMAIN></u> part with the actual domain name of your X-Cart based store.
-* the <u>On Sale</u> link in the <u>Special</u> section menu;
+# Choose the <u>Uninstall the module</u> option, enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the '''Next''' button.
-* the <u>On Sale</u> options section in <u>General settings/Modules</u> options.
+# Once the installation script has removed the files of the X-HotProducts package and deactivated the module, click the '''Next''' button to complete the uninstallation.
+# On the ''Uninstallation complete'' screen, click '''Next''' to leave the Wizard.
-. Adjust the <u>On Sale</u> module settings via <u>General settings/Modules options->On Sale</u> options:
+{{Note1|Important: After you have uninstalled X-HotProducts, be sure to remove the X-HotProducts distribution package from your web directory as well.}}
-* <u>Show on sale products first in the product list</u>: The "On Sale" products will be displayed first for the "Default" sorting method;
-* <u>Show link to the On Sale page in the "Special" section</u>: Select the checkbox to show the "On Sale" link to the "On Sale" page in the "Special" section of the site;
-* <u>Show on sale products on the Home page</u>: Select the checkbox to show on sale products on the home page of your store.
+== Enabling the modules of the X-HotProducts package==
-: [[Image:on_sale_settings.png|border]]
+After the X-HotProducts installation has been completed, the modules you have installed (<u>New Arrivals</u>, <u>On Sale</u> and<u>Previously Ordered Products</u>) need to be enabled in your store:
+# In Admin area, go to the <u>Modules</u> section (<u>Settings menu->Modules</u>).
+# Choose the module(s) you wish to enable by selecting the respective check box(es) on the left.
+# Click the '''Apply changes''' button. This activates the selected module(s).
-. Click the '''Apply''' changes button.
+== Configuring the modules of the X-HotProducts package==
+Two modules of the <u>X-HotProducts</u> package - <u>New Arrivals</u> and <u>On Sale</u> - provide configuration settings which you can adjust according to your preference. After these modules have been enabled in your store, it is a good idea to check and adjust their configuration:
+# In the <u>Modules</u> section of Admin area (<u>Settings menu->Modules</u>), click the <u>Configure</u> link opposite the name of the module that needs to be configured ('New Arrivals' or 'On Sale').
-== Enabling and Configuring "Previously Ordered Products" ==
+The module configuration page (titled by the name of the module) opens.
-To begin using the module:
+#:''<u>New Arrivals</u> module configuration page:''
+#: [[Image:new_arrivals_settings.png|border]]
+#:''<u>On Sale</u> module configuration page'':
+#: [[Image:on_sale_settings.png|border]]
+# Adjust the settings on the module configuration page as needed. Detailed information regarding the [[#NewArrivalsModulesSettings | New Arrivals module configuration settings]] and [[#OnSaleModulesSettings | On Sale module configuration settings]] is available below.
+# Click the '''Apply changes''' button to save the changes.
-. Enable <u>Previously Ordered Products</u> module (<u>Administration menu->Modules</u>).
+===New Arrivals module configuration settings===
+* <u>Number of products in the new arrivals list</u>: Specify the number of products that should be shown in the new arrivals list; this setting affects the new arrivals lists displayed on the store's Home page, category pages and in the <u>New Arrivals</u> section of the Customer area sidebar.
+* <u>Number of products on the New Arrivals page</u>: Specify the number of products that should be shown on your store's 'New Arrivals' page. Note that the product list on the 'New Arrivals' page will be paginated according to your store's 'Pagination options' settings (Settings->General settings/Appearance).
+* <u>Show products added in the last N days</u>: Enable this option if you want products added to the database in the last N days to be displayed as new arrivals. A "day" is a 24-hour period. For example, if the value of this field is "3", and the new arrivals list is displayed at 4.26 p.m. on June 26, 2012, the list will include products added to the database after 4.26 p.m. June 23, 2012. If you do not want this type of products to be displayed as new arrivals, set this value to 0 (X-Cart versions 4.7.3 or later) or 0.0001 (earlier X-Cart versions through 4.7.2).
+* <u>Show the new arrivals list on the Home page</u>: Select the check box to show new arrivals [[#NewArrivalsHomePage |on the Home page]].
+* <u>Show the new arrivals list in the menu column</u>: Select the check box to show new arrivals [[#NewArrivalsMenuColumn | in the 'New Arrivals' section]] of the Customer area sidebar.
+* <u>Show the new arrivals list in the main column</u>: Select the check box to show new arrivals [[#NewArrivalsMainColumn | in the product list section]] of category pages.
+* <u>Show link to the New Arrivals page in the "Special" section</u>: Select the check box to provide a link to the 'New Arrivals' page[[#NewArrivalsSpecialSection | in the 'Special' section]] of the store's Customer area.
+* <u>View of the new arrivals list</u>: Choose the display mode for the new arrivals list; ''Full'' corresponds to displaying your store's new arrivals like ordinary products on any of your store's product list pages; ''Simple'' display mode provides a more compact view, where information about each product in the 'New Arrivals' list includes only the product name, product thumbnail image, date of addition to the store's database and price. This setting affects the new arrivals lists displayed on the store's Home page and in the product list section of category pages.
+* <u>Show products on category page including sub-categories</u>: Enable the option to show new products from subcategories on the new arrivals list of its parent category.
+* <u>Show products marked as new for N days</u>: Specify the number of days during which products manually marked as new (on the product modify page) will be displayed as new arrivals.
+* <u>Show "Date added" row on the product list</u>: Enable the option to show additional "Date added" column in the products list in admin area.
+* <u>Show manually added products first</u>: Tick the check box if you want the products manually marked as new to be displayed first in the products list for the 'Default' sorting method.
-When the modules is enabled, you can see:
+===On Sale module configuration settings===
-* the <u>Quick Reorder</u> link in the header of the page (depends on the used template).
+* <u>Show on sale products first in the product list</u>: Select the check box if you want the products put on sale to be displayed first in the products list for the 'Default' sorting method.
+* <u>Show link to the On Sale page in the "Special" section</u>: Select the check box to provide a link to the 'On Sale' page[[#OnSaleSpecialSection | in the 'Special' section]] of your store's Customer area.
+* <u>Show on sale products on the Home page</u>: Select the check box to show on sale products [[#OnSaleHomePage | on the Home page]].
-. Click the '''Apply''' changes button.
+[[Category:X-Cart modules]]