You are here

Home » API reference » Commerce Invoice Receipt 7.2

README.txt in Commerce Invoice Receipt 7.2

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Known issues
 * Support
 * Troubleshooting
 * Sponsorship


INTRODUCTION
------------

This module provides additional printable and HTML e-mailable views of Commerce
Orders. Firstly it setups up a new display on Commerce Orders which you can use 
to customise how elements are displayed. Secondly it provides a rule which will
email the HTML invoice. You have total control over how your invoice will look
through a template.

REQUIREMENTS
------------

This module requires the Emogrifier (http://drupal.org/project/emogrifier)
module to convert stylesheet rules to inline style attributes.

INSTALLATION
------------

 1. Drop the 'commerce_invoice_receipt' folder into the modules directory
    '/sites/all/modules/'.

 2. In your Drupal site, enable the module under Administration -> Modules
    '?q=/admin/modules'.

 3. Setup new Commerce Order display under Store -> Configuration -> Order
    Settings -> Manage Display '?q=admin/commerce/config/order/display'. Click
    on the 'Invoice/Receipt' tab. Unhide any fields you want to use in your
    invoice.

 4. Setup a rule under Store -> Configuration -> Checkout settings -> Checkout 
    rules '?q=admin/commerce/config/checkout/rules'. Then 'Add a checkout rule',
    you'll find an action called 'Send invoice receipt email' under Commerce
    Order that you can use.

OVERRIDDING THE INVOICE TEMPLATE
--------------------------------

If you want to customize the invoice template, copy one or both of these files:
- theme/commerce-order-invoice-view.tpl.php
- theme/commerce_invoice_receipt.css
Paste them anywhere in your theme and edit per your requirements.

KNOWN ISSUES
------------

 * None


TROUBLESHOOTING
---------------

1. Emails being sent out as plain text: 
   Set the site-wide default to HTMLMailSystem
 
SUPPORT
-------

If the problem is with the module, please file a support request at
http://drupal.org/project/issues/commerce_invoice_receipt


SPONSORSHIP
-----------

This module is currently sponsored by Holy Trinity Brompton 
(http://www.htb.org.uk).

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Known issues

  8.  * Support

  9.  * Troubleshooting

  10.  * Sponsorship

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. This module provides additional printable and HTML e-mailable views of Commerce

  17. Orders. Firstly it setups up a new display on Commerce Orders which you can use 

  18. to customise how elements are displayed. Secondly it provides a rule which will

  19. email the HTML invoice. You have total control over how your invoice will look

  20. through a template.

  21. 

  22. REQUIREMENTS

  23. ------------

  24. 

  25. This module requires the Emogrifier (http://drupal.org/project/emogrifier)

  26. module to convert stylesheet rules to inline style attributes.

  27. 

  28. INSTALLATION

  29. ------------

  30. 

  31.  1. Drop the 'commerce_invoice_receipt' folder into the modules directory

  32.     '/sites/all/modules/'.

  33. 

  34.  2. In your Drupal site, enable the module under Administration -> Modules

  35.     '?q=/admin/modules'.

  36. 

  37.  3. Setup new Commerce Order display under Store -> Configuration -> Order

  38.     Settings -> Manage Display '?q=admin/commerce/config/order/display'. Click

  39.     on the 'Invoice/Receipt' tab. Unhide any fields you want to use in your

  40.     invoice.

  41. 

  42.  4. Setup a rule under Store -> Configuration -> Checkout settings -> Checkout 

  43.     rules '?q=admin/commerce/config/checkout/rules'. Then 'Add a checkout rule',

  44.     you'll find an action called 'Send invoice receipt email' under Commerce

  45.     Order that you can use.

  46. 

  47. OVERRIDDING THE INVOICE TEMPLATE

  48. --------------------------------

  49. 

  50. If you want to customize the invoice template, copy one or both of these files:

  51. - theme/commerce-order-invoice-view.tpl.php

  52. - theme/commerce_invoice_receipt.css

  53. Paste them anywhere in your theme and edit per your requirements.

  54. 

  55. KNOWN ISSUES

  56. ------------

  57. 

  58.  * None

  59. 

  60. 

  61. TROUBLESHOOTING

  62. ---------------

  63. 

  64. 1. Emails being sent out as plain text: 

  65.    Set the site-wide default to HTMLMailSystem

  66.  

  67. SUPPORT

  68. -------

  69. 

  70. If the problem is with the module, please file a support request at

  71. http://drupal.org/project/issues/commerce_invoice_receipt

  72. 

  73. 

  74. SPONSORSHIP

  75. -----------

  76. 

  77. This module is currently sponsored by Holy Trinity Brompton 

  78. (http://www.htb.org.uk).