You are here

README.txt in Commerce Donate 7

-- SUMMARY --

This module provides a donation line item type along with a donation product and
product display. This is partially based on Randy Fay's excellent screencast at
http://commerceguys.com/blog/using-custom-line-items-provide-donation-feature-drupal-commerce

It uses the Select or Other module (http://drupal.org/project/select_or_other)
to provide the donation amount form field. If you need to modify the default
donation option values, the install the Commerce Customizable Products module
(http://drupal.org/project/commerce_custom_product) in order to modify the line
item type form settings.

In addition to being able to create a donation product, this module also provides
a donation checkout pane, allowing customers to add a donation to their order as
part of the checkout process.

-- REQUIREMENTS --

Drupal Commerce - http://drupal.org/project/commerce
Rules - http://drupal.org/project/rules
Select or Other - http://drupal.org/project/select_or_other

Optional:
Commerce Customizable Products - http://drupal.org/project/commerce_custom_product

-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Create a donation product at Administration » Store » Products

* (Optional) If you want to display the donation product in your shop's product
  catalog, then create a donation product display node for the product you just
  created at Add content » Donation

* (Optional) If you want to capture donations during the checkout process, then

  - ensure the "Donation form" checkout pane is enabled at Store » Configuration
    » Checkout settings

  - configure the "Donation form" checkout pane with the donation product you
    created


-- CUSTOMIZATION --

* To override the default donation amount options:

  1) Install the "Commerce Customizable Products" module

  2) Edit the "Amount" field at Administration » Store » Configuration » Line
    iitem types » Donation and alter the default options there.

* To override the donation amount options visible in checkout:

  1) Edit the "Donation form" checkout pane at Store » Configuration
      » Checkout settings

  2) Enable the "Override available options" option

  3) Enter the new values in key|label format in the "Available options"
     textarea.

-- FAQ --

Q: When the commerce donate module is enabled, the checkout pane does not
   appear.  Why?

A: First you need to create a donation product at Administration » Store »
   Products and then edit the "Donation form" checkout pane at Store »
   Configuration » Checkout settings and configure it to use this donation
   product.


-- CONTACT --

Current maintainers:
* Stella Power (stella) - http://drupal.org/user/66894

This project has been sponsored by:
* Annertech
  Specialized in consulting and development of Drupal powered sites, Annertech
  offers design, development, theming, customization and training services.
  Visit http://www.annertech.com for more information.


-- CREDIT --

Thanks to Randy Fay (rfay : http://drupal.org/user/30906) for his excellent
screencast on creating donation products for Drupal Commerce:
http://commerceguys.com/blog/using-custom-line-items-provide-donation-feature-drupal-commerce

File

README.txt
View source
  1. -- SUMMARY --
  2. This module provides a donation line item type along with a donation product and
  3. product display. This is partially based on Randy Fay's excellent screencast at
  4. http://commerceguys.com/blog/using-custom-line-items-provide-donation-feature-drupal-commerce
  5. It uses the Select or Other module (http://drupal.org/project/select_or_other)
  6. to provide the donation amount form field. If you need to modify the default
  7. donation option values, the install the Commerce Customizable Products module
  8. (http://drupal.org/project/commerce_custom_product) in order to modify the line
  9. item type form settings.
  10. In addition to being able to create a donation product, this module also provides
  11. a donation checkout pane, allowing customers to add a donation to their order as
  12. part of the checkout process.
  13. -- REQUIREMENTS --
  14. Drupal Commerce - http://drupal.org/project/commerce
  15. Rules - http://drupal.org/project/rules
  16. Select or Other - http://drupal.org/project/select_or_other
  17. Optional:
  18. Commerce Customizable Products - http://drupal.org/project/commerce_custom_product
  19. -- INSTALLATION --
  20. * Install as usual, see http://drupal.org/node/70151 for further information.
  21. -- CONFIGURATION --
  22. * Create a donation product at Administration » Store » Products
  23. * (Optional) If you want to display the donation product in your shop's product
  24. catalog, then create a donation product display node for the product you just
  25. created at Add content » Donation
  26. * (Optional) If you want to capture donations during the checkout process, then
  27. - ensure the "Donation form" checkout pane is enabled at Store » Configuration
  28. » Checkout settings
  29. - configure the "Donation form" checkout pane with the donation product you
  30. created
  31. -- CUSTOMIZATION --
  32. * To override the default donation amount options:
  33. 1) Install the "Commerce Customizable Products" module
  34. 2) Edit the "Amount" field at Administration » Store » Configuration » Line
  35. iitem types » Donation and alter the default options there.
  36. * To override the donation amount options visible in checkout:
  37. 1) Edit the "Donation form" checkout pane at Store » Configuration
  38. » Checkout settings
  39. 2) Enable the "Override available options" option
  40. 3) Enter the new values in key|label format in the "Available options"
  41. textarea.
  42. -- FAQ --
  43. Q: When the commerce donate module is enabled, the checkout pane does not
  44. appear. Why?
  45. A: First you need to create a donation product at Administration » Store »
  46. Products and then edit the "Donation form" checkout pane at Store »
  47. Configuration » Checkout settings and configure it to use this donation
  48. product.
  49. -- CONTACT --
  50. Current maintainers:
  51. * Stella Power (stella) - http://drupal.org/user/66894
  52. This project has been sponsored by:
  53. * Annertech
  54. Specialized in consulting and development of Drupal powered sites, Annertech
  55. offers design, development, theming, customization and training services.
  56. Visit http://www.annertech.com for more information.
  57. -- CREDIT --
  58. Thanks to Randy Fay (rfay : http://drupal.org/user/30906) for his excellent
  59. screencast on creating donation products for Drupal Commerce:
  60. http://commerceguys.com/blog/using-custom-line-items-provide-donation-feature-drupal-commerce