summaryrefslogtreecommitdiffstats
path: root/README.txt
blob: e3a461da4d926d7927926e3088333f076fcda4f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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).