* WHIP Shipping Module for Joomla! VirtueMart Component ----------------------------------------- **
Filename: WHIP_README.txt
Version: 1.1.3
Release Date: 10//06
Developer: David Hunt
Copyright: 2006 Byrgius Technologies
License: GNU/GPL (http://www.gnu.org/copyleft/gpl.html)
Source: http://software.byrgius.com/
* Package Files --------------------------------------------------------------------------------- **
whip.php
whip.ini
whip_config/whip.default.cfg.php
whip_config/whip.factory_volume.cfg.php
whip_config/whip.factory_weight.cfg.php
WHIP_README.txt
* Overview -------------------------------------------------------------------------------------- **
The WHIP Shipping Module provides customizable shipment algorithms for calculating the
total shipment cost based on Shipment Weight, Shipment Volume, a combination of weight
& volume or neither. The WHIP Shipment Module can be used independantly or with the
Shipper/Rates database to provide multiple Shipper Rate criteria based on Shipment
Quantity, etc...
* v1.1.3 Updates -------------------------------------------------------------------------------- **
1) 'shipping_rate_id' key checking in $d array, improvement on list building
* v1.1.2 Updates -------------------------------------------------------------------------------- **
1) Fixed WHIP_USE_SHIPPER Option Select
* v1.1.1 Updates -------------------------------------------------------------------------------- **
1) JS Field Checks for Algorithms in Admin
2) Added Field Names to Admin Config
3) Check if value is_array before attempting to replace within Algorithm
4) Fixed $_SESSION bug for Checkout Selection
* v1.1.0 Updates -------------------------------------------------------------------------------- **
1) Volume Calculation and Inclusion into Algorithms
2) Multiple Country Configuration options
3) JS managed interface for managing your country configurations
* Golden Nuggets -------------------------------------------------------------------------------- **
1) CHMOD 777 - Write Access is required to the configuration folder:
com_virtuemart/classes/shipping/whip_config/
2) DO NOT DELETE / RENAME:
whip_config/whip.default.cfg.php
whip_config/whip.factory_weight.cfg.php
whip_config/whip.factory_volume.cfg.php
3) Only Countries Edited are Saved, all other countries refer to "Default Configuration"
4) Once a country configuration is saved it is active. To remove the country you must
delete the appropriate configuration file in the whip_config folder.
5) The config file naming convention is:
whip_config/whip.{country_3_code}.cfg.php
* Installation Instructions --------------------------------------------------------------------- **
1) Extract the contents of the .ZIP file into the folder:
/administrator/components/com_virtuemart/classes/shipping
2) Set the permissions on the new shipping sub-folder ( whip_config ) to
be writable ( CHMOD 777 )
* SECURITY NOTE *
Once you have configured the WHIP Shipping Module to the desired settings, it is
good practice to change the permissions on the "whip_config" folder and the
contained configuration files to "Read Only" ( CHMOD 644 )
3) Load your VirtueMart interface and navigate to "Admin -> Configuration "
4) Under the "Shipping" tab, activate the "WHIP Shipping" module & SAVE
5) Navigate to "Store -> Shipping Module List" and select the "Configure Ship Method"
for the "WHIP" module
* Configuring WHIP ----------------------------------------------------------------------------- **
1) At the top you have a Country Selector. The first option is the "Default Configuration."
* NOTE: Undefined Countries refers to the "Default Configuration" *
2) The "Copy Settings" buttons below the Country Selector allow you to copy settings from
the "Default Configuration" into the fields for active country. In addition to copying the
"Default Configuration", there are two "Factory" settings available for correcting mistakes.
3) Below the "Copy Settings" options are the configuration fields for the selected country.
Every configuration value within the dark boreder will be recorded uniquely for each country.
4) Make sure to press the "SAVE" button once you are finished.
* v1.1.0 Screenshot ----------------------------------------------------------------------------- **
* END ------------------------------------------------------------------------------------------- **