Installation of the module has been made as simple as possible and shouldn't take long for any stores which have not already modified any of the core files which this module has to modify.
If any of the core files this distribution uses have already been modified (because of another third party module being installed for example) then the changes for the respective files should be applied manually by copying across the appropriate sections of code required for the URI Mapping module. These sections are clearly marked (with “// BEGIN” and “// END” comments) within the sample files provided in this distribution.
These are the new files which make up this module. Copy them all into their respective folders in the Zen Cart installation.
They already have the correct folder structure, so a single drag-and-drop of the folders/files in the files folder into the root directory for the store will put the files in the correct locations.
There's no need to copy the files individually - that often results in files being missed out!
Please Note: If the admin folder for the store is not named “admin”, then care must be taken to place the files from within the files/admin folder into the store's admin folder. Simply copying across the files/admin folder won't work!
A few core Zen Cart admin files must be updated to work with the URI Mapping module.
It is likely that none of these files have been modified for the store already, in which case the pre-modified sample files from this distribution, for the version of Zen Cart being used by the store, should simply be copied over any existing versions of the files.
However, if any of these core files have already been modified for the store, the changes within the sample files included in this distribution must be applied to the previously modified core files.
The changes are clearly marked within the sample files in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge software or the commercial Beyond Compare software) is used.
Instructions on how to copy across the modifications necessary for this module - to version of the respective core files which have previously been modified - can be found in this FAQ.
The modified core files can be found within the modified_core_files folder in the distribution. A list of the files follows.
If any of the “Product Types” (e.g. Document General or Product Book) aren't used by the store, there's no need to copy/modify the files in the respective directories (e.g. document_general or product_book).
If the store's core files haven't been modified then there's no need to copy the files individually - that often results in files being missed out! They already have the correct folder structure, so a single drag-and-drop of the folders/files in the modified_core_files folder (for the exact same version of Zen Cart) into the root directory for the store will put the files in the correct locations.
Please Note: If the admin folder for the store is not named “admin”, then care must be taken to place the files from within the modified_core_files/admin folder into the store's admin folder. Simply copying across the modified_core_files/admin folder won't work!
A few of the standard Zen Cart template files require modifications to work with this module as they weren't built in a way that supports static URIs.
Modifications to existing template files, for static URIs to be able to be used by some of the standard Zen Cart sideboxes and by the product listing filter forms, have been made to “clean” copies of the template files from a “fresh” installation of Zen Cart and are included as “sample” files in this distribution.
If any of these template files haven't already been modified for the store, the sample files included in this distribution can be copied into the store template directory and will then override the standard versions of the files included in the Zen Cart distribution.
If any of these template files have already been modified for the store, then the changes necessary to support the use of static URIs must be made to the store's modified file(s). The changes are clearly marked within the sample files in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent Beyond Compare) is used.
Instructions on how to copy across the modifications necessary for this module - to template files which have previously been modified - can be found in this FAQ.
The sample template files can be found within the template_override_files folder in the distribution. They are:
The database tables required by the module are automatically created by an installation and upgrade script.
This script runs automatically when the configuration utility is accessed. (In the future, if the module is being upgraded, the configuration utility should also be accessed then.)
Simply go to Modules > URI Mapping Config in the Admin and the database tables will be automatically created.
Details of how to configure the URI auto-generation settings and set up the URI mappings for the store are provided in the configuration section.
Details of how to add the necessary rewrite rules for the store are provided in the configuration section.
Now all that has to be done is to configure the module's settings and set up the URI mappings for the store in the Zen Cart Admin.
Details of how to configure the module and how to set up the URI mappings for the store are provided in the configuration section.