Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 126 lines (90 sloc) 8.955 kb
ea9a812 @deckerweb Initial release on GitHub repository.
authored
1 === WooCommerce Delivery Notes ===
2 Contributors: daveshine
3 Donate link: http://genesisthemes.de/en/donate/
4 Tags: delivery notes, delivery, shipping, print, order, invoice, woocommerce, woo commerce, woothemes, administration, shop, shop manager, deckerweb
8c57e7c @deckerweb Updated plugin to version 1.1
authored
5 Requires at least: 3.3 and WooCommerce 1.4+
6 Tested up to: 3.3.1
45156a8 @piffpaffpuff code optimizations
piffpaffpuff authored
7 Stable tag: 1.1.1
ea9a812 @deckerweb Initial release on GitHub repository.
authored
8
9 This plugin adds Delivery Notes for the WooCommerce Shop Plugin. You can add company info as well as personal notes and policies to the print page.
10
11 == Description ==
12
13 With this plugin you can print out delivery notes for the orders via the WooCommerce Shop Plugin. You can edit the Company/Shop name, Company/Shop postal address and also add personal notes, conditions/policies (like a refund policy) and a footer imprint/branding.
14
15 The plugin adds a new side panel on the order page to allow shop administrators to print out delivery notes. This is useful for a lot of shops that sell goods which need delivery notes for shipping or with added refund policies etc. In some countries (e.g. in the European Union) such refund policies are required so this plugin could help to combine this with the order info for the customer.
16
45156a8 @piffpaffpuff code optimizations
piffpaffpuff authored
17 = Features =
ea9a812 @deckerweb Initial release on GitHub repository.
authored
18 * The plugin comes with an attached template for the delivery note (printing) page - you could also copy this to your theme and customize it to your needs! The plugin will recognize the new place. (See under [FAQ here](http://wordpress.org/extend/plugins/woocommerce-delivery-notes/faq/))
19 * All setting fields on the settings pages are optional - you can leave them empty to not use them at all or only apply what you need.
20 * If the company/shop name field is left empty then the regular website/blog title is used (defined via regular WordPress options)
8c57e7c @deckerweb Updated plugin to version 1.1
authored
21 * If there are added "Customer Notes" (regular WooCommerce feature) for an order these will automatically displayed at the bottom of the delivery note.
ea9a812 @deckerweb Initial release on GitHub repository.
authored
22 * Included contextual help tab system with new WordPress 3.3 standard! (Will also be extended if needed!)
23
24 = Localization =
25 * English (default) - always included
26 * German - always included
8c57e7c @deckerweb Updated plugin to version 1.1
authored
27 * Swedish - user-submitted, thanks to [Christopher Anderton](http://www.deluxive.se/)
ea9a812 @deckerweb Initial release on GitHub repository.
authored
28 * .pot file (`woocommerce-delivery-notes.pot`) for translators is also always included :)
8c57e7c @deckerweb Updated plugin to version 1.1
authored
29 * *Your translation? - [Just send it in](http://genesisthemes.de/en/contact/)*
ea9a812 @deckerweb Initial release on GitHub repository.
authored
30
45156a8 @piffpaffpuff code optimizations
piffpaffpuff authored
31 Credit where credit is due: This plugin here is inspired and based on the work of Steve Clark, Trigvvy Gunderson and the awesome "Jigoshop Delivery Notes" plugin! See below how you can contribute to the further development of both:
ea9a812 @deckerweb Initial release on GitHub repository.
authored
32
33 = Contribute =
34 Since this is a fork I've made the plugin available in a developer repository at GitHub just like the original.
35
d8a8248 @deckerweb Updated readme.txt file
authored
36 * [Forked WooCommerce Delivery Notes repository at GitHub.com](https://github.com/deckerweb/woocommerce-delivery-notes)
ea9a812 @deckerweb Initial release on GitHub repository.
authored
37 * [Original Jigoshop Delivery Notes repository at GitHub.com](https://github.com/piffpaffpuff/jigoshop-delivery-notes)
38 * Thank you in advance for all feedback, suggestions, contributions/commits!
39
40 [A plugin from deckerweb.de and GenesisThemes](http://genesisthemes.de/en/)
41
42 = Feedback =
43 * I am open for your suggestions and feedback - Thank you for using or trying out one of my plugins!
44 * Drop me a line [@deckerweb](http://twitter.com/#!/deckerweb) on Twitter
45 * Follow me on [my Facebook page](http://www.facebook.com/deckerweb.service)
8c57e7c @deckerweb Updated plugin to version 1.1
authored
46 * Or follow me on [+David Decker](http://deckerweb.de/gplus) on Google Plus ;-)
ea9a812 @deckerweb Initial release on GitHub repository.
authored
47
48 = More =
49 * [Also see my other plugins](http://genesisthemes.de/en/wp-plugins/) or see [my WordPress.org profile page](http://profiles.wordpress.org/users/daveshine/)
50 * Tip: [*GenesisFinder* - Find then create. Your Genesis Framework Search Engine.](http://genesisfinder.com/)
51
52 == Installation ==
53
54 1. Upload the entire `woocommerce-delivery-notes` folder to the `/wp-content/plugins/` directory
55 2. Activate the plugin through the 'Plugins' menu in WordPress
56 3. Look under the WooCommerce menu for the entry "Delivery Notes Settings" and adjust them to your needs
57 4. On single order pages you'll find a new meta box on the right side where it says "View & Print Delivery Note" you can open the delivery note for the actual order and print it out directly
58 5. Go and manage your orders - good luck with sales :)
59
8c57e7c @deckerweb Updated plugin to version 1.1
authored
60 **Please note:** You must run WordPress 3.3 or higher and WooCommerce 1.4 or higher in order tun this plugin. This is due to changes in WooCommerc v1.4+!
61
ea9a812 @deckerweb Initial release on GitHub repository.
authored
62 == Frequently Asked Questions ==
63
64 = Can I use a Custom Template for the printing page? =
45156a8 @piffpaffpuff code optimizations
piffpaffpuff authored
65 If you want to use your own template then all you need to do is copy the `/wp-content/plugins/woocommerce-delivery-notes/template/delivery-notes` folder and paste it inside your `/wp-content/themes/your-theme-name/woocommerce` folder (if not there just create it). The folder from the plugin comes with the default template and the basic CSS stylesheet file. You can modifiy this to fit your own needs.
ea9a812 @deckerweb Initial release on GitHub repository.
authored
66
67 *Note:* This works with both single themes and child themes (if you use some framework like Genesis). If your current active theme is a child theme put the custom folder there! (e.g. `/wp-content/themes/your-child-theme-name/woocommerce`)
68
69 = What Template Functions can I use? =
45156a8 @piffpaffpuff code optimizations
piffpaffpuff authored
70 Various functions are available in the template, especially many Delivery Notes specific template functions. Open the `woocommerce-delivery-notes/woocommerce-delivery-notes-print.php` file to see all available functions.
ea9a812 @deckerweb Initial release on GitHub repository.
authored
71
72 *Please note:* This is only intended for developers who know what they do! Please be careful with adding any code/functions! The default template and functions should fit most use cases.
73
8c57e7c @deckerweb Updated plugin to version 1.1
authored
74 = What will actually get printed out? =
75 No worries, the print buttons at the top and the bottom will automatically be hidden on print!
76 The other sections get printed as styled via the packaged template (or your custom template if configured). For the shop/company name and all other notes sections: only these will get printed which are actually configured.
77 Beyond the styling of your template be aware of any special features of your used browser - I highly recommend to use the "Print Preview" feature of your browser which all current versions of Firefox, Chrome and Opera support.
78
79 = Can you update the plugin with feature X or option Y?
80 Mmh. Maybe.
81 The basic intention is to have the plugin at the same time as leightweight and useful as possible. So any feature request needs to ...
82
ea9a812 @deckerweb Initial release on GitHub repository.
authored
83 == Screenshots ==
84
8c57e7c @deckerweb Updated plugin to version 1.1
authored
85 1. Plugin's settings page where you can set up to five fields for the delivery note.
ea9a812 @deckerweb Initial release on GitHub repository.
authored
86 2. Contextual help tabs on the plugin's settings page.
8c57e7c @deckerweb Updated plugin to version 1.1
authored
87 3. Delivery Note printing page with default template - and the five custom sections marked (yellow)
ea9a812 @deckerweb Initial release on GitHub repository.
authored
88
89 == Changelog ==
90
45156a8 @piffpaffpuff code optimizations
piffpaffpuff authored
91 = 1.1.1 =
92 * Restructured classes
93 * Settings are part of the WooCommerce settings
94 * Template folder renaming (custom templates must be renamed to work)
95
8c57e7c @deckerweb Updated plugin to version 1.1
authored
96 = 1.1 =
97 * Maintenance release
98 * UPDATE: Changed product price calculation due to changes in WooCommerce itself -- this led to **new required versions** for this plugin: **at least WordPress 3.3 and WooCommerce 1.4** or higher (Note: If you still have WooCommerc 1.3.x running then use version 1.0 of the Delivery Notes plugin!)
99 * UPDATE: Custom fields on settings page now accept proper `img` tags, so you can add logo images or such via HTML IMG tag (for example: `<img src="your-image-url" width="100" height="100" alt="Logo" title="My Shop" />`)
100 * UPDATE: Corrected readme.txt file
101 * NEW: Added Swedish translation - Thanx to Christopher Anderton
102 * UPDATE: Updated German translations and also the .pot file for all translators!
103
ea9a812 @deckerweb Initial release on GitHub repository.
authored
104 = 1.0 =
105 * Initial release
106 * Forked and extended from original plugin for Jigoshop ("Jigoshop Delivery Notes" at GitHub)
107
108 == Upgrade Notice ==
8c57e7c @deckerweb Updated plugin to version 1.1
authored
109
110 = 1.1 =
111 Several changes: Changed price calculation due to WC 1.4+ changes. Added img tag support for fields on settings page. Corrected readme.txt file, added Swedish translations, also updated .pot file together with German translations.
112
ea9a812 @deckerweb Initial release on GitHub repository.
authored
113 = 1.0 =
114 Just released into the wild.
115
116 == Translations ==
117
118 * English - default, always included
119 * German: Deutsch - immer dabei! [Download auch via deckerweb.de](http://deckerweb.de/material/sprachdateien/woocommerce-und-extensions/#woocommerce-delivery-notes)
8c57e7c @deckerweb Updated plugin to version 1.1
authored
120 * Swedish: Svenska - user-submitted by [Christopher Anderton](http://www.deluxive.se/)
ea9a812 @deckerweb Initial release on GitHub repository.
authored
121
8c57e7c @deckerweb Updated plugin to version 1.1
authored
122 *Note:* All my plugins are localized/ translateable by default. This is very important for all users worldwide. So please contribute your language to the plugin to make it even more useful. For translating I recommend the awesome ["Codestyling Localization" plugin](http://wordpress.org/extend/plugins/codestyling-localization/) and for validating the ["Poedit Editor"](http://www.poedit.net/).
ea9a812 @deckerweb Initial release on GitHub repository.
authored
123
124 == Additional Info ==
125 **Idea Behind / Philosophy:** Just a little plugin for all the WooCommerce shop managers out there to make their daily shop admin life a bit easier.
Something went wrong with that request. Please try again.