Version: 2.0
Release: Feb 22, 2006
Compatibility: QC v1.0+
Languages: en
Author: Wizzud
Contact: rb@wizzud.com

Basket Summary

Plugin module for Quick.Cart by OpenSolution.org

Synopsis

The Basket Summary plugin is a small piece of code that enables the current value of the basket contents to viewed on any page of the shop, by adding a variable to the appropriate template(s).
* Please note the Prerequisites for running this plugin. For ease of installation it is necessary to use the facilities provided by the Plugin Manager, and if this causes any problems I apologise in advance.

Compatibility

Quick.Cart versions prior to v1.0 : Not compatible.
Quick.Cart versions 1.0 upward : Compatible at the time of writing.
Other Plugins : At the time of release, this plugin has no compatibility problems with any other known plugin.

Prerequisites

Plugin Manager v2.0+ : Uses the Plugin Manager's 'extendTplParser' class extension.
None other, assuming that the Compatibility requirements have been met.

Upgrade

There is no upgrade path, since this is first release available for the compatible Quick.Cart version(s).

Install

Where possible, the release folder is laid out in the correct folder structure to aid installation.
  1. Copy the entire basketSummary folder from the release/plugins/ folder into your Quick.Cart plugins/ folder.
  2. Copy the contents of the release/templates/ folder to your Quick.Cart templates/ folder (2 new files: basketSummary.tpl and basketSummary.css).
  3. The plugin sets up a global variable - $sBasketSummary - which you need to place in one of your template files, wherever it is that you want the summary value to appear.
    My suggestion is to place it next to the 'basket' navigation option in the contents menu, and the code changes below are for doing just that. If you wish to place it somewhere else, you simply need to add $sBasketSummary into the relevant template. You can add it to more than one template. If you want to move the currency symbol or change the styling, simply modify templates/basketSummary.tpl and/or templates/basketSummary.css accordingly.
    To put the summary next to the 'basket' navigation option in the contents menu, edit templates/page.tpl and, at roughly line 46 ...
    Look for the 1 line below
    CODE
    <li><a href="?p=ordersBasket">$lang[basket]</a></li>
    And, by inserting the highlighted code, change it to
    CODE
    <li><a href="?p=ordersBasket">$lang[basket]$sBasketSummary</a></li>
  4. Go to the Configuration - Plugins option on the Admin menu, and enable the basketSummary plugin.

User Guide

There are no configuration settings for this plugin, so as long as you have completed the installation as instructed the summary value should appear wherever you have placed it. Don't forget that other plugins may have their own template files that override the standard Quick.Cart ones, so if the summary does not appear where expected, check these first.
Apart from compatibility, the only difference between this version and previous versions is that the summary value should now be accurate on all pages, including the Basket page when adding, updating or deleting an item.

Language

This plugin uses only digits and the shop's defined currency symbol, so there is no language file involved.
~~ The End ~~