probably the best Zen Cart URI Mapping/SEO Module in the world! ...ever!
Overwrite all existing files with the updated/new files from the latest version. 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, 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 the existing version 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 files/admin folder into the store's admin folder, copying across the files/admin folder won't work!
In versions prior to 3.2.0 the example Rewrite Rules given in the documentation were quite restrictive and prior to 3.0.2 an exclusion was missing from the example rewrite rules.
The documentation has been completely rewritten, with a full section on Setting up a Rewrite Rule added to give much more comprehensive information on how to add a working Rewrite Rule for the server.
It is recommended that all stores should have their rewrite rule checked against the new example rules and modified for the server if necessary!
If upgrading from 3.0.2 or a prior version, at the very least every store should make sure the following modification is made...
The following exclusion should be added after the “admin directory” exclusion rule:
# Don't rewrite editors directory
RewriteCond %{REQUEST_URI} !^/editors.* [NC]
This will result in the rule looking like the following (just a small snippet is shown):
...
# Don't rewrite admin directory
RewriteCond %{REQUEST_URI} !/admin.* [NC]
# Don't rewrite editors directory
RewriteCond %{REQUEST_URI} !^/editors.* [NC]
...
If the store is using any Whitespace Replacement Character other than a single dash (“-”), or the Capitalisation setting isn't set to “Convert to lowercase”, then the URI Parts for standard Zen Cart pages related to a Product must be checked and changed accordingly. Copying the files across in step one above may well have overwritten any previous definitions set up for the store!
In versions prior to 3.2.1, the standard Whitespace Replacement Character for auto-generated URIs was an underscore (“_”). From 3.2.1 onwards it is now a dash. (The primary reasons for this are that dashes are easier to find on the keyboard and type in for most people and dashes are more clearly read in underlined links).
Read this section of the configuration documentation, adjusting the URI Parts to match the chosen Whitespace Replacement Character for the store.
Go to Modules > URI Mapping Config in the Zen Cart Admin and the module will be updated automagically!