Minor syntax fixes.
[project/commerce_invoice_receipt.git] / README.txt
1 CONTENTS OF THIS FILE\r
2 ---------------------\r
3 \r
4  * Introduction\r
5  * Requirements\r
6  * Installation\r
7  * Known issues\r
8  * Support\r
9  * Troubleshooting\r
10  * Sponsorship\r
11 \r
12 \r
13 INTRODUCTION\r
14 ------------\r
15 \r
16 This module provides additional printable and HTML e-mailable views of Commerce\r
17 Orders. Firstly it setups up a new display on Commerce Orders which you can use \r
18 to customise how elements are displayed. Secondly it provides a rule which will\r
19 email the HTML invoice. You have total control over how your invoice will look\r
20 through a template.\r
21 \r
22 REQUIREMENTS\r
23 ------------\r
24 \r
25 This module requires the Emogrifier (http://drupal.org/project/emogrifier)\r
26 module to convert stylesheet rules to inline style attributes.\r
27 \r
28 INSTALLATION\r
29 ------------\r
30 \r
31  1. Drop the 'commerce_invoice_receipt' folder into the modules directory\r
32     '/sites/all/modules/'.\r
33 \r
34  2. In your Drupal site, enable the module under Administration -> Modules\r
35     '?q=/admin/modules'.\r
36 \r
37  3. Setup new Commerce Order display under Store -> Configuration -> Order\r
38     Settings -> Manage Display '?q=admin/commerce/config/order/display'. Click\r
39     on the 'Invoice/Receipt' tab. Unhide any fields you want to use in your\r
40     invoice.\r
41 \r
42  4. Setup a rule under Store -> Configuration -> Checkout settings -> Checkout \r
43     rules '?q=admin/commerce/config/checkout/rules'. Then 'Add a checkout rule',\r
44     you'll find an action called 'Send invoice receipt email' under Commerce\r
45     Order that you can use.\r
46 \r
47 KNOWN ISSUES\r
48 ------------\r
49 \r
50  * None\r
51 \r
52 \r
53 TROUBLESHOOTING\r
54 ---------------\r
55 \r
56 1. Emails being sent out as plain text: \r
57    Set the site-wide default to HTMLMailSystem\r
58  \r
59 SUPPORT\r
60 -------\r
61 \r
62 If the problem is with the module, please file a support request at\r
63 http://drupal.org/project/issues/commerce_invoice_receipt\r
64 \r
65 \r
66 SPONSORSHIP\r
67 -----------\r
68 \r
69 This module is currently sponsored by Holy Trinity Brompton \r
70 (http://www.htb.org.uk).\r