Index: help/about.html
===================================================================
--- help/about.html	(revision 0)
+++ help/about.html	(revision 0)
@@ -0,0 +1,7 @@
+<!-- $Id$ -->
+
+The UC Discount Framework module utilizes the Ubercart core Conditional Actions module for configuring discounts. For understanding how to configure Conditional Actions visit <a href="http://www.ubercart.org/docs/user/7657/configuring_conditional_actions">Configuring Conditional Actions</a>.
+
+After we understand what a Conditional Action is, we'll take a look at the different <a href="&topic:uc_discount/triggers&">triggers</a>, <a href="&topic:uc_discount/conditions&">conditions</a> and <a href="&topic:uc_discount/actions&">Actions</a> that the UC Discount Framework module provides.
+
+Lastly, we'll take a look at some <a href="&topic:uc_discount/examples&">example discounts</a> and how to configure them.
Index: help/actions.html
===================================================================
--- help/actions.html	(revision 0)
+++ help/actions.html	(revision 0)
@@ -0,0 +1,18 @@
+<!-- $Id$ -->
+
+The UC Discount Framework module makes the following actions available to Conditional Actions:
+
+<ul>
+  <li>
+    <strong>Apply a discount</strong>:
+    Apply a discount to the <strong><em>Order</em></strong> total
+  </li>
+  <li>
+    <strong>Apply a discount to a product</strong>:
+    Apply a discount to a <strong><em>Product</em></strong>
+  </li>
+  <li>
+    <strong>Apply a discount to a line item</strong>:
+    Apply a discount to a <strong><em>Line Item</em></strong>
+  </li>
+</ul>
Index: help/conditions.html
===================================================================
--- help/conditions.html	(revision 0)
+++ help/conditions.html	(revision 0)
@@ -0,0 +1,24 @@
+<!-- $Id$ -->
+
+The evaluation of all conditions must be true before any actions will be taken. The UC Discount Framework module makes the following conditions available to Conditional Actions:
+
+<ul>
+  <li>
+    <strong>Node category</strong>:
+    If the <strong><em>Product</em></strong> belongs to the selected <strong><em>Categories</em></strong>
+  </li>
+  <li>
+    <strong>Node type</strong>:
+    If the <strong><em>Product</em></strong> is of a particular type of <strong><em>Content</em></strong>
+  </li>
+  <li>
+    <strong>Coupon entered</strong>:
+    If a <strong><em>Coupon Code</em></strong> has been <strong><em>Entered and Validated</em></strong>
+  </li>
+  <li>
+    <strong>Shippable Product</strong>:
+    If the <strong><em>Product</em></strong> is <strong><em>Shippable</em></strong>
+  </li>
+</ul>
+
+While these conditions are specific to the UC Discount Framework module, additional conditions are provided by other modules.
Index: help/example01.html
===================================================================
--- help/example01.html	(revision 0)
+++ help/example01.html	(revision 0)
@@ -0,0 +1,81 @@
+When calculating order discounts, if the user is an authenticated user, apply a 10% discount to the order total.
+
+From the <strong>Conditional Actions</strong> admin page (/admin/store/ca):
+<ol>
+  <li>Select the <strong>Add a predicate</strong> tab</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Title
+        <strong>10% Authenticated User Discount</strong>
+      </li>
+      <li>
+        Trigger
+        <strong>Calculate order discounts</strong>
+      </li>
+      <li>
+        Description
+        <strong>When calculating order discounts, if the user is an authenticated user, apply a 10% discount to the order total</strong>
+      </li>
+      <li>
+        Class
+        <strong>Discount</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Save predicate</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Available Conditions
+        <strong>Check the role of the user.</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Add condition</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Roles
+        <strong>Authenticated User</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Save changes</strong> button</li>
+  <li>Select the <strong>Actions</strong> tab</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Available actions
+        <strong>Apply a discount</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Add action</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Title
+        <strong>Authenticated User Discount</strong>
+        This is the discount label that will be used on the cart, checkout and review pages along with the invoices.
+      </li>
+      <li>
+        Operation
+        <strong>Multiply</strong>
+      </li>
+      <li>
+        Ammount
+        <strong>-.1</strong>
+        Although we selected <strong>Multiply</strong> for the operation, we are actually calculating the value we wish to <strong>Add</strong> to the order total.  In this case we want to add (-.1 times the product sell price) to the product sell price.
+      </li>
+    </ul>
+  </li>
+  <li>Select the <strong>Save changes</strong> button</li>
+</ol>
+
+Congratulations, you have completed setting up a %10 Authenticated User Discount. Now lets test it by adding a product to the shopping cart and viewing the checkout page. You should see an <strong>Authenticated User Discount</strong> line in the <strong>Payment method</strong> section of the <strong>Checkout</strong> screen.
Index: help/example02.html
===================================================================
--- help/example02.html	(revision 0)
+++ help/example02.html	(revision 0)
@@ -0,0 +1,77 @@
+When calculating product discounts, if the product is a specified product, apply a $20 discount to the product's sell price.
+
+From the <strong>Conditional Actions</strong> admin page (/admin/store/ca):
+<ol>
+  <li>Select the <strong>Add a predicate</strong> tab</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Title
+        <strong>$20 Product Specific Discount</strong>
+      </li>
+      <li>
+        Trigger
+        <strong>Calculate product discounts</strong>
+      </li>
+      <li>
+        Description
+        <strong>When calculating product discounts, if the product is a specified product, apply a $20 discount to the product's sell price</strong>
+      </li>
+      <li>
+        Class
+        <strong>Discount</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Save predicate</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Available Conditions
+        <strong>Compare a node field value</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Add condition</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Comparison value
+        <strong>This field should be set to the node Id of a product.</strong>
+        To find a products node Id, visit the products page and click the edit tab. The products node Id will be the integer just before /edit in the URL.
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Save changes</strong> button</li>
+  <li>Select the <strong>Actions</strong> tab</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Available actions
+        <strong>Apply a discount to a product</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Add action</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Title
+        <strong>$20 Product Discount</strong>
+        This is the discount label that will be used on the cart, checkout and review pages along with the invoices.
+      </li>
+      <li>
+        Ammount
+        <strong>-20</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Select the <strong>Save changes</strong> button</li>
+</ol>
+
+Congratulations, you have completed setting up a $20 Product Specific Discount. The discount should be reflected in the products <strong>Sell Price</strong> on the product, cart, checkout and review pages as well as on the invoice. You may need to clear Drupal's cache before the changes visible.
Index: help/example03.html
===================================================================
--- help/example03.html	(revision 0)
+++ help/example03.html	(revision 0)
@@ -0,0 +1,86 @@
+When calculating product discounts on the order, if a valid coupon code was entered, apply a 25% discount to the order total.
+
+From the <strong>Conditional Actions</strong> admin page (/admin/store/ca):
+<ol>
+  <li>Select the <strong>Add a predicate</strong> tab</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Title
+        <strong>25% Coupon Code Discount</strong>
+      </li>
+      <li>
+        Trigger
+        <strong>Calculate product discounts on the order</strong>
+      </li>
+      <li>
+        Description
+        <strong>When calculating product discounts on the order, if a valid coupon code was entered, apply a 25% discount to the order total</strong>
+      </li>
+      <li>
+        Class
+        <strong>Discount</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Save predicate</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Available Conditions
+        <strong>Coupon entered</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Add condition</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Operator
+        <strong>equals</strong>
+        Coupon codes are NOT case sensitive.
+      </li>
+      <li>
+        Coupon Code
+        <strong>2010Convention</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Save changes</strong> button</li>
+  <li>Select the <strong>Actions</strong> tab</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Available actions
+        <strong>Apply a discount</strong>
+      </li>
+    </ul>
+  </li>
+  <li>Click the <strong>Add action</strong> button</li>
+  <li>
+    Set the following fields
+    <ul>
+      <li>
+        Title
+        <strong>2010 Convention Discount</strong>
+        This is the discount label that will be used on the cart, checkout and review pages along with the invoices.
+      </li>
+      <li>
+        Operation
+        <strong>Multiply</strong>
+      </li>
+      <li>
+        Ammount
+        <strong>-.25</strong>
+        Although we selected <strong>Multiply</strong> for the operation, we are actually calculating the value we wish to <strong>Add</strong> to the order total.  In this case we want to add (-.25 times the product sell price) to the product sell price.
+      </li>
+    </ul>
+  </li>
+  <li>Select the <strong>Save changes</strong> button</li>
+</ol>
+
+Congratulations, you have completed setting up a %25 Coupon Code Discount. Now lets test it by visiting the checkout page and entering a coupon code. You should see a <strong>2010 Convention Discount</strong> line on the <strong>Review</strong> page.
Index: help/examples.html
===================================================================
--- help/examples.html	(revision 0)
+++ help/examples.html	(revision 0)
@@ -0,0 +1 @@
+Below are a few examples to help you get started creating discounts for your Ubercart store:
Index: help/triggers.html
===================================================================
--- help/triggers.html	(revision 0)
+++ help/triggers.html	(revision 0)
@@ -0,0 +1,22 @@
+<!-- $Id$ -->
+
+A trigger is basically an event that we use to "trigger" when a discount should be applied. The UC Discount Framework module makes the following triggers available to Conditional Actions:
+
+<ul>
+  <li>
+    <strong>Calculate Order Discounts</strong>:
+    When <strong><em>Order</em></strong> discounts that are to be applied to the <strong><em>Order</em></strong> total are being calculated
+  </li>
+  <li>
+    <strong>Calculate Product Discounts</strong>:
+    When <strong><em>Product</em></strong> discounts that are to be applied to the <strong><em>Product</em></strong> are being calculated
+  </li>
+  <li>
+    <strong>Calculate Line Item Discounts</strong>:
+    When <strong><em>Line Item</em></strong> discounts that are to be applied to the <strong><em>Line Item</em></strong> are being calculated
+  </li>
+  <li>
+    <strong>Calculate Products Discounts on the Order</strong>:
+    When <strong><em>Product</em></strong> discounts that are to be applied to the <strong><em>Order</em></strong> total are being calculated
+  </li>
+</ul>
Index: help/uc_discount.help.ini
===================================================================
--- help/uc_discount.help.ini	(revision 0)
+++ help/uc_discount.help.ini	(revision 0)
@@ -0,0 +1,49 @@
+; $Id$
+
+[advanced help settings]
+index name = UC Discount Framework
+line break = TRUE
+navigation = TRUE
+
+[about]
+title = "About UC Discount Framework".
+file = about
+weight = -50
+
+[triggers]
+title = "UC Discount Framework Triggers".
+file = triggers
+weight = -49
+
+[conditions]
+title = "UC Discount Framework Conditions".
+file = conditions
+weight = -48
+
+[actions]
+title = "UC Discount Framework Actions".
+file = actions
+weight = -47
+
+[examples]
+title = "UC Discount Framework Examples".
+file = examples
+weight = -46
+
+[example01]
+title = "10% Authenticated User Discount".
+file = example01
+parent = examples
+weight = -45
+
+[example02]
+title = "$20 Product Discount".
+file = example02
+parent = examples
+weight = -44
+
+[example03]
+title = "25% Coupon Code Discount".
+file = example03
+parent = examples
+weight = -43
Index: README.txt
===================================================================
--- README.txt	(revision 0)
+++ README.txt	(revision 0)
@@ -0,0 +1,47 @@
+$Id
+
+-- SUMMARY --
+
+The UC Discount Framework module is a discount framework for the Ubercart
+modules. It uses the Conditional Actions module to provide hooks that other
+modules may use to add different kinds of discounts when user-configurable
+conditions have been met.
+
+For a full description of the module, visit the project page:
+  http://drupal.org/project/uc_discount
+
+To submit bug reports and feature suggestions, or to track changes:
+  http://drupal.org/project/issues/uc_discount
+
+
+-- DEPENDENCIES --
+
+* Ubercart (http://drupal.org/project/ubercart)
+  - Conditional Actions
+  - Order
+  - Product
+
+
+-- INSTALLATION --
+
+* Install as usual, see http://drupal.org/node/70151 for further information.
+
+
+-- DOCUMENTATION --
+
+* The UC Discount Framework module leverages the power of the Advanced Help
+  module for its documentation. To access the documentation, install the
+  Advanced Help module (http://drupal.org/project/advanced_help) and visit the
+  "/admin/advanced_help/uc_discount" page on your Drupal site.
+
+
+-- MAINTAINERS --
+
+* Island Usurper - http://drupal.org/user/86683
+
+
+-- SPONSORS --
+
+* Documentation sponsored by
+  - AntoineSolutions - http://drupal.org/user/192192
+  - Showers Pass - www.showerspass.com

Property changes on: README.txt
___________________________________________________________________
Added: svn:executable
   + *

