Minicart - ekmPowershop - Documentation

ekmTags: [ekm:minicart]

This tag enables you to display a mini shopping cart on your store, this enables customers to quickly see what products are in their cart on all pages of your store.

Basic Usage

[ekm:minicart]

style='STYLE1';

[/ekm:minicart]

style can be set to STYLE1, STYLE2, STYLE3 and custom

Full Usage

[ekm:minicart] 

    ' Basic Setup 
    style='custom'; 
    nocartmessage=' '; 
    maxcharacters='35'; 
 
    ' Custom Style Layout 
    output_start='
    <table border="0" cellspacing="5" width="100%">'; 

    output_end='</table>';
    output_contents_start='
    <tr style="font-family:Verdana, Arial,
    Helvetica, 
    sans-serif; font-size:10px; font-weight:bold;"&gt
    <td&gtItem</td&gt<td&gtQty</td&gt
    <td&gtPrice</td&gt </tr&gt<tr>';
    output_contents_end='</tr><tr><td colspan="3">
    <hr size="1" width="100%"></td></tr>';
    output_cart_contents='<tr><td>
    <font face="verdana" size="1">
    [product_name_link]</font></td><td>
    <font face="verdana" size="1">
    [product_qty]</font></td><td>
    <font face="verdana" size="1">
    [product_price]</font></td></tr>';
    output_totals='<tr><td align="right" 
    colspan="3"><table border="0">
    <tr><td align="right">
    <font face="verdana" size="1">SubTotal: </font>  
    </td><td><font face="verdana" size="1">[total_sub]
    </font></td></tr><tr><td align="right">
    <font face="verdana" size="1">
    Delivery: </font></td><td>
    <font face="verdana" size="1">
    [total_delivery]</font></td></tr><tr>
    <td align="right">
    <font face="verdana" size="1">Tax: </font></td>
    <td><font face="verdana" size="1">
    [total_tax]</font></td></tr><tr>
    <td align="right">  
    <font face="verdana" size="1">Total:    
    </font></td><td>
    <font face="verdana" size="1">[total]</font>
    </td></tr></table></td></tr>'; 
 
[/ekm:minicart]

Example Output

Tag Parameters

style

Allows to you specify the format of the mini cart, there are 3 pre-defined styles:

STYLE1, STYLE2, STYLE3 (As Shown Above). You can also set Style to custom and specify your own HTML code to control the layout of the minicart.

Possible Values
auto	Uses STYLE1
STYLE1	As Shown in the Example Output
STYLE2	As Shown in the Example Output
STYLE3	As Shown in the Example Output
custom	Allows you to enter your own Custom HTML layout by using the tags listed below (output_start, output_end, output_contents_start, output_contents_end, output_cart_contents, output_totals)

nocartmessage

When a customer goes to your online shops main shopping cart page the minicart is hidden (as it would potentially conflict with the changes they might make on the cart page). This is the text/html displayed in place of it.

Possible Values
auto	Blank output
user defined	Any text or html

maxcharacters

This allows you to define the maximum length of a product name in the minicart (for design purposes), for example if you added the product 'A Large Apple' and the maxcharacters field was set to 5 the product name would be displayed as 'A Lar'.

Possible Values
auto	50
user defined	A number ranging from 1 to 100

output_start

This is output at the start of the minicart tag before any product or cart data is shown. You can use it to open a table for example.

Possible Values
auto	<table border="0" cellspacing="5" width="100%">
user defined	Any HTML Code or Plain Text

output_contents_start

This is output just before the minicart starts looping through all products in it. Used for opening a table for example.

Possible Values

auto

<tr&gt<td&gt<font face="verdana" size="1"&gt
<b&gtItem</b&gt</font&gt</td&gt<td&gt
<font face="verdana" size="1"&gt
<b&gtQty</b&gt</font&gt</td&gt<td&gt
<font face="verdana" size="1"&gt<b&gtPrice</b&gt
</font&gt</td&gt</tr&gt<tr>

user defined

Any HTML Code or Plain Text

output_cart_contents

This is output for the items in the cart, such as the Product Name, Price, Quantity. This output item will keep looping through all items in the cart.

Possible Values

auto

<tr><td><font face="verdana" size="1">[product_name_link]
</font></td><td><font face="verdana" size="1">
[product_qty]</font></td><td>
<font face="verdana" size="1">[product_price]</font>
</td></tr>

user defined

You can use any HTML or plain text code.

You can use the following tags to create the output_cart_contents...

[product_name]
Outputs the product name

[product_name_link]
Outputs the product name with a link to the products

[product_qty]
Outputs the products quantity

[product_price]
Outputs the products price

Note: You do not need to close 'none EKM:' tags.

An example use of these tags would be...

output_cart_contents=' [product_name]<br />
[quantity]<br />[product_price] ';

output_contents_end

This is output just after the minicart finished looping through all products in it. Used for closing a table for example.

Possible Values
auto	</tr><tr><td colspan="3"><hr size="1" width="100%"> </td></tr>
user defined	Any HTML Code or Plain Text

output_totals

This is output for the all the mini cart totals, such as the total cost of the order, delivery costs, etc.

Possible Values

auto

<tr><td align="right" colspan="3"><table border="0">
<tr><td align="right">
<font face="verdana" size="1">SubTotal: 
</font></td><td>
<font face="verdana" size="1">
[total_sub]</font></td></tr><tr>
<td align="right">
<font face="verdana" size="1">Delivery: </font>
</td><td><font face="verdana" size="1">
[total_delivery]</font></td></tr>
<tr><td align="right">
<font face="verdana" size="1">Tax: 
</font></td><td>
<font face="verdana" size="1">
[total_tax]</font></td></tr><tr>
<td align="right">
<font face="verdana" size="1">Total:
</font></td><td><font face="verdana" size="1">
[total]</font></td></tr></table></td></tr>

user defined

You can use any HTML or plain text code. You can use the following tags to create the output_totals...

[item_count]
Outputs the total number of items in the cart

[product_count]
Outputs the number of products in the cart

[total_discount]
Outputs the Total Discount Amount

[total_sub]
Outputs the Sub Total

[total_delivery]
Outputs the Total Delivery

[total_tax]
Outputs the Total Tax

[total]
Outputs the Total order value

Note: You do not need to close 'none EKM:' tags.

[ekm:custom_tax][total_tax][/ekm:custom_tax]

Hides Tax value if tax is zero (this tag needs closing, and can contain HTML formatting) e.g. [ekm:custom_tax]<tr><td nowrap="nowrap">Tax: </td><td>[total_tax]</td></tr>[/ekm:custom_tax]

An example use of these tags would be...

output_totals='Sub Total: [total_sub]
Delivery: [total_delivery]
Total: [total]';

output_end

This is output at the end of the minicart tag before any product or cart data is shown. You can use it to close a table for example.

Possible Values
auto	</table>
user defined	Any HTML Code or Plain Text

« Back

Retrieved from "http://wiki.ekmpowershop.com/Minicart"