Difference between revisions of "Draft:X-Cart:X-Showroom"

From X-Cart 4 Classic
Jump to: navigation, search
m
m
Line 8: Line 8:
 
# Check and adjust the module configuration settings:
 
# Check and adjust the module configuration settings:
 
#* [[#XShowroomConfiguration|Configuring the module]]
 
#* [[#XShowroomConfiguration|Configuring the module]]
 
+
# Try creating some interactive banners using the Showroom section of your store's back end.
 +
#* Creating interactive banners
 +
# View and manage the interactive banners you have added using the Showroom section of your store's back end.
 +
#* Managing interactive banners
 
<div id="XShowroomInstallation"> </div>
 
<div id="XShowroomInstallation"> </div>
 
==Installing the module==
 
==Installing the module==
Line 37: Line 40:
 
<div id="XShowroomConfiguration"> </div>
 
<div id="XShowroomConfiguration"> </div>
 
==Configuring the module==
 
==Configuring the module==
After installation and activation, the X-Showroom module runs with the default parameters specified in its configuration settings. If you wish, you can adjust these parameters to better suit your needs; however, it is recommended to avoid using values that are too large or too small, as it may negatively affect the usability of the user interface for the store administrator.<br />
+
After installation and activation, the X-Showroom module runs with the default parameters specified in its configuration settings. If you wish, you can adjust these parameters to better suit your needs; however, it is recommended to avoid using values that are too large or too small as it may negatively affect the usability of the user interface for the store administrator.<br />
  
 
To adjust the module configuration:
 
To adjust the module configuration:
Line 50: Line 53:
 
* '''Max photo width in admin area''' and '''Max photo height in admin area''': These are the maximum pixel dimensions of a banner image displayed on the '''Edit Photo''' page in the Admin area where you tag the banner image with links to specific products:<br />[[File:max_photo_dimensions.png|700px|border]]<br />The default value for both these settings is 820 px.<br /><br />
 
* '''Max photo width in admin area''' and '''Max photo height in admin area''': These are the maximum pixel dimensions of a banner image displayed on the '''Edit Photo''' page in the Admin area where you tag the banner image with links to specific products:<br />[[File:max_photo_dimensions.png|700px|border]]<br />The default value for both these settings is 820 px.<br /><br />
  
==Creating and managing
+
==Creating interactive banners==
 +
Interactive banners are created using the Showroom section ('''Content -> '''Showroom''').<br />
 +
To create a banner, complete the following steps:
 +
# Upload an image to be used in your banner.
 +
# Create a link that will point from an area inside your banner to a certain product (Mark the area of the banner image that you want to be clickable, then select the product to which the link should point). Add more links if necessary.
 +
# Specify the pages of your store on which the banner should be displayed.
 +
# Make sure the banner is active.
 +
===Adding banner images===
 +
In this section you will upload images that will be used as the
 +
 
 +
===Tagging banner images with links to products===
 +
 
 +
==Managing interactive banners==
 +
Management of interactive banners with the help of X-Cart's module X-Showroom takes place in the Showroom section ('''Content -> '''Showroom''').
 +
===Managing banner display locations===
 +
===Activating/Deactivating banners===

Revision as of 18:08, 2 February 2015

Overview

Getting started

  1. Install the X-Showroom module:
  2. Make sure the installed module is active:
  3. Check and adjust the module configuration settings:
  4. Try creating some interactive banners using the Showroom section of your store's back end.
    • Creating interactive banners
  5. View and manage the interactive banners you have added using the Showroom section of your store's back end.
    • Managing interactive banners

Installing the module

Uninstalling the module

Activating the module

If the module X-Showroom is installed, but not active, you can enable (activate) it.

To enable the module:

  1. Go to the Modules section of your store's Admin area (Settings -> Modules).
  2. In the list of your store's installed modules, locate the entry for X-Showroom.
  3. Select the check box on the left of the module name.
    The module will be enabled.

Deactivating the module

It is possible to temporarily disable (deactivate) the installed X-Showroom module. Deactivation stops the module from operation, but it does not remove any settings you made to the module configuration nor clear any data that was generated during the period that the module was in operation. If you wish to completely remove all the data related to using the module, you need to uninstall it. See Uninstalling the module for more info.

To disable the module:

  1. Go to the Modules section of your store's Admin area (Settings -> Modules).
  2. In the list of your store's installed modules, locate the entry for X-Showroom.
  3. Unselect the check box on the left of the module name.
    The module will be disabled.


Configuring the module

After installation and activation, the X-Showroom module runs with the default parameters specified in its configuration settings. If you wish, you can adjust these parameters to better suit your needs; however, it is recommended to avoid using values that are too large or too small as it may negatively affect the usability of the user interface for the store administrator.

To adjust the module configuration:

  1. Go to the Modules section of your store's Admin area (Settings -> Modules).
  2. In the list of your store's installed modules, locate the entry for X-Showroom and click the Configure button next to it. (The Configure button is displayed only when the module is active).
    The X-Showroom module configuration settings page opens:
    Showroom module settings.png

  3. Adjust the module settings as you require. Detailed information regarding the X-Showroom module configuration settings is available below.
  4. Click the Apply changes button to save the changes.

The configuration settings for the X-Showroom module are as follows:

  • Max thumbnail width in admin area and Max thumbnail height in admin area: These are the maximum pixel dimensions of a banner image thumbnail as displayed in the general list of uploaded banner images on the Showroom page (Content ->Showroom) in your store's Admin area:
    Max thumbnail dimensions.png
    The default value for both these settings is 300 px.

  • Max photo width in admin area and Max photo height in admin area: These are the maximum pixel dimensions of a banner image displayed on the Edit Photo page in the Admin area where you tag the banner image with links to specific products:
    Max photo dimensions.png
    The default value for both these settings is 820 px.

Creating interactive banners

Interactive banners are created using the Showroom section (Content -> Showroom).
To create a banner, complete the following steps:

  1. Upload an image to be used in your banner.
  2. Create a link that will point from an area inside your banner to a certain product (Mark the area of the banner image that you want to be clickable, then select the product to which the link should point). Add more links if necessary.
  3. Specify the pages of your store on which the banner should be displayed.
  4. Make sure the banner is active.

Adding banner images

In this section you will upload images that will be used as the

Tagging banner images with links to products

Managing interactive banners

Management of interactive banners with the help of X-Cart's module X-Showroom takes place in the Showroom section (Content -> Showroom).

Managing banner display locations

Activating/Deactivating banners