X-Cart:Modules and Add-ons - Revision history

Vladimir Gurinenko: Added version tags

2011-11-08T13:59:20Z

Added version tags

Seyfin: /* Integration with third party modules */

2011-06-27T10:36:13Z

‎Integration with third party modules

Vladimir Gurinenko: Added paragraph on integration with third party modules (BT 0108520)

2011-05-23T13:55:38Z

Added paragraph on integration with third party modules (BT 0108520)

Ivka: /* Installing add-ons */

2010-09-15T05:43:48Z

‎Installing add-ons

Ivka: /* Configuring modules */

2010-09-15T05:43:30Z

‎Configuring modules

Admin at 19:51, 1 February 2010

2010-02-01T19:51:12Z

Admin: Created page with '== Modules == X-Cart is a highly scalable system. Besides the relatively stable core unit providing basic e-commerce functionality, this system includes a number of components w…'

2010-02-01T19:49:32Z

Created page with '== Modules == X-Cart is a highly scalable system. Besides the relatively stable core unit providing basic e-commerce functionality, this system includes a number of components w…'

New page

== Modules ==

X-Cart is a highly scalable system. Besides the relatively stable core unit providing basic e-commerce functionality, this system includes a number of components which can be turned on or off depending on the scope of additional functions needed. These controllable components which can be turned on and off directly after X-Cart is installed are traditionally referred to as modules. Being part of X-Cart distribution package, modules do not require a separate installation procedure. They get installed along with the basic store and all you need to do to start using them is to make sure they are enabled and, if necessary, to configure their settings.

A full list of installed modules is available in the 'Modules' section of the store's Admin area (Administration menu->Modules). Modules that are enabled have checkmarks in the boxes next to them.

===Enabling modules===

To enable a module:

# Find the module name in the list of installed modules in the 'Modules' section.
# Select the check box next to this name.
# Click the '''Update''' button at the bottom of the section to save the changes.

===Configuring modules===

Most modules need to be configured before you can use them. You will know a module requires configuration if a Configure link appears next to its name after the module is enabled.

To configure a module:

# Make sure the module is enabled.
# Follow the Configure link provided next to the module name in the 'Modules' section

or

Click General settings in the Settings menu and go to the appropriate subsection of the 'General settings/Modules options' section.

# Follow the configuration instructions provided in the module's description in this manual (Check out the section [[X-Cart:User manual contents#Modules]]).

===Disabling modules===

Modules which you do not need can be disabled so their elements will not appear in the store interface.

To disable a module:

# Find the module name in the list of installed modules in the 'Modules' section.
# Unselect the check box next to this name.
# Click the '''Update''' button at the bottom of the section to save the changes.

== Add-ons ==
{{XC 4.3|or lower}}
In addition to the functionality delivered by X-Cart's internal modules, an extensive set of features which can be implemented in an X-Cart based store is provided in the form of add-on modules (or, simply, add-ons). These are software components which can be purchased separately, installed in X-Cart root and linked to the system.

===Installing add-ons===

The process of installation is similar for all X-Cart add-ons.

To install an add-on:

# Download the add-on module distribution package from the 'Software distributives' section of your personal X-Cart File area (typically, a .TGZ archive).
# Uncompress the archive and copy the resulting files to the directory where your X-Cart based store is installed (X-Cart root).
# Run the add-on module installation wizard: enter your store URL followed by the module installation script name in your web browser's address line.
# Follow the installation wizard instructions to complete the installation. After the installation is completed, the name of the installed add-on module should be added to the list in the 'Modules' section of X-Cart's Admin area (Administration menu->Modules).

Detailed information on installing X-Cart add-ons is provided in the [[X-Cart:User manual contents#Modules]] section.

===Enabling add-ons===

Before you can start using an installed add-on, you need to enable it.

To enable an add-on:

# Find the name of the add-on in the list of installed modules in the 'Modules' section.
# Select the check box next to this name.
# Click the '''Update''' button at the bottom of the section to save the changes.

===Configuring add-ons===

Most add-ons need to be configured before you can use them. You will know an add-on requires configuration if a Configure link appears next to its name after the add-on is enabled.

To configure an add-on:

# Make sure the add-on is enabled.
# Follow the Configure link provided next to the add-on's name in the 'Modules' section

or

Click General settings in the Settings menu and go to the appropriate subsection of the 'General settings/Modules options' section.

# Follow the configuration instructions provided in the user manual of the add-on.

===Uninstalling add-ons===

Add-ons which you do not need can be uninstalled.

To uninstall an add-on:

# Run the add-on's installation wizard: enter your store URL followed by the module installation script name in your web browser's address line.
# In the installation wizard, select the 'uninstall' option. The script should remove all add-on related data from the store database, as well as the add-on's files from the /skin1 directory.

Please note that the add-on's files in the directory /skin1.original will not be removed. If you wish to remove them, you will have to do it manually.

@@ Line 40: / Line 40: @@
 === Integration with third party modules ===
-In version 4.4.3, the module initialization routine has been changed and optimized. Unlike in versions 4.4.0-4.4.2, the initialization order now does matter. Improperly initialized X-Cart 4.4.3 may even break some 3rd party modules. Here is a [[X-Cart:Integration_with_third_party_modules|quick fix]] to the issue.
+In version 4.4.3, the module initialization routine has been changed and optimized. Unlike in versions 4.4.0-4.4.2, the initialization order now does matter. Improperly initialized X-Cart 4.4.3 may even break some 3rd party modules. Here is a [[X-Cart:New_module_initialization_routine#Peculiarities_of_upgrading_from_versions_4.4.0-4.4.2_to_version_4.4.3_and_newer_with_X-Cart_add-on_modules_or_3rd-party_add-on_modules_installed|quick fix]] to the issue.
 == Add-ons ==

@@ Line 53: / Line 53: @@
 # Follow the installation wizard instructions to complete the installation. After the installation is completed, the name of the installed add-on module should be added to the list in the '<u>Modules</u>' section of X-Cart's Admin area (<u>Administration menu->Modules</u>).
-Detailed information on installing X-Cart add-ons is provided in the [[X-Cart:User manual contents#Modules]] section.
+Detailed information on installing X-Cart add-ons is provided in the [[X-Cart:User manual contents#Modules | Modules]] section.
 ===Enabling add-ons===

@@ Line 26: / Line 26: @@
 Click <u>General settings</u> in the <u>Settings menu</u> and go to the appropriate subsection of the '<u>General settings/Modules options</u>' section.
-# Follow the configuration instructions provided in the module's description in this manual (Check out the section [[X-Cart:User manual contents#Modules]]).
+# Follow the configuration instructions provided in the module's description in this manual (Check out the section [[X-Cart:User manual contents#Modules | Modules]]).
 ===Disabling modules===

← Older revision		Revision as of 19:51, 1 February 2010
Line 90:		Line 90:

	Please note that the add-on's files in the directory <u>/skin1.original</u> will not be removed. If you wish to remove them, you will have to do it manually.		Please note that the add-on's files in the directory <u>/skin1.original</u> will not be removed. If you wish to remove them, you will have to do it manually.
		+
		+	[[Category:X-Cart user manual]]

@@ Line 43: / Line 43: @@
 == Add-ons ==
-{{XC 4.3|or lower}}
+{{XC 4.3|or earlier}}
 In addition to the functionality delivered by X-Cart's internal modules, an extensive set of features which can be implemented in an X-Cart based store is provided in the form of add-on modules (or, simply, add-ons). These are software components which can be purchased separately, installed in X-Cart root and linked to the system.

@@ Line 37: / Line 37: @@
 # Unselect the check box next to this name.
 # Click the '''Update''' button at the bottom of the section to save the changes.
 == Add-ons ==