woocommerce/readme.txt

437 lines
21 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

=== WooCommerce ===
Contributors: woothemes, mikejolley
Tags: ecommerce, e-commerce, commerce, woothemes, wordpress ecommerce, store, shop, shopping, cart, checkout, widgets, reports, shipping, tax, paypal, inventory
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=paypal@woothemes.com&item_name=Donation+for+WooCommerce
Requires at least: 3.3
Tested up to: 3.3
Stable tag: 1.4
WooCommerce is an open-source e-commerce toolkit that helps you sell anything. Beautifully.
== Description ==
Transform your WordPress website into a thorough-bred online store. Delivering enterprise-level quality & features whilst backed by a name you can trust. Say hello to WooCommerce.
[vimeo http://vimeo.com/29198966]
= STRENGTH & FLEXIBILITY =
Built upon core WordPress functionality for stability, with enough hooks and filters to satisfy the most avid theme developer.
= CUSTOMIZABLE =
Your business is unique, as should your online store. Choose one of our themes or build your own and give it a personal touch using the built in shortcodes and widgets.
= SMART DASHBOARD WIDGETS =
Keep a birds-eye view of incoming sales and reviews, stock levels and general store performance and statistics all from the WordPress dashboard.
= FEATURES =
Seriously, WooCommerce has got more features than you can shake a stick at. But dont just take our word for it, try it for yourself.
Read more about the features and benefits of WooCommerce at http://www.woothemes.com/woocommerce/
Checkout and contribute to the source on GitHub at http://github.com/woothemes/woocommerce/
== Installation ==
= Minimum Requirements =
* WordPress 3.1 or greater
* PHP version 5.2.4 or greater
* MySQL version 5.0 or greater
* Some payment gateways require fsockopen support (for IPN access)
= Automatic installation =
Automatic installation is the easiest option as WordPress handles the file transfers itself and you dont even need to leave your web browser. To do an automatic install of WooCommerce log in to your WordPress admin panel, navigate to the Plugins menu and click Add New.
In the search field type “WooCommerce” and click Search Plugins. Once youve found the plugin you can view details about it such as the the point release, rating and description. Most importantly of course, you can install it by simply clicking Install Now. After clicking that link you will be asked if youre sure you want to install the plugin. Click yes and WordPress will automatically complete the installation.
= Manual installation =
The manual installation involves downloading the plugin and uploading it to your webserver via your favourite FTP application.
1. Download the plugin file to your computer and unzip it
2. Using an FTP program, or your hosting control panel, upload the unzipped plugin folder to your WordPress installations wp-content/plugins/ directory.
3. Activate the plugin from the Plugins menu within the WordPress admin.
== Frequently Asked Questions ==
= Where can I find WooCommerce documentation and user guides =
For further documentation on using WooCommerce, please sign up for free at http://www.woothemes.com/. This will provide access to extensive WooCommerce Codex, documentation and tips.
The codex for WooCommerce can be found here: http://www.woothemes.com/woocommerce-codex/
Clients and beginners will appreciate the user guide here: http://www.woothemes.com/woocommerce-codex/woocommerce-user-guide/
= Where can I request new features and extensions? =
You can vote on and request new features and extensions in our WooIdeas board - http://ideas.woothemes.com/forums/133476-woocommerce
= Where can I report bugs or contribute to the project? =
Bugs can be reported either in our support forum or preferably at the WooCommerce GitHub repository (https://github.com/woothemes/woocommerce/issues)
= WooCommerce is awesome! Can I contribute? =
Yes you can! Join in on our GitHub repository :) https://github.com/woothemes/woocommerce/
== Screenshots ==
1. The slick WooCommerce settings panel
2. WooCommerce products admin
3. WooCommerce sales reports
== Changelog ==
= 1.4 =
* Support for multiple and stacked (compound) taxes
* Locale options for country address formatting and checkout fields
* Multiple taxes shown in order total tables
* Rewritten parts + re-organised files for increased performance and decreased memory usage
* Moved many shortcodes (contents) to template files for easier customisation
* Moved template function contents to template files
* Added a simple, basic method of adding woocommerce support to themes using a woocommerce.php file based on page.php containing woocommerce_content()
* Moved woocommerce class into the main file
* Improved roles and capabilities for WooCommerce pages - more caps added for easier configuration
* Category ordering fix
* Made 'product' global, and auto filled when calling the_post - also remove this from the hooks. Certain themes may need to be updated.
* Changed woocommerce_breadcrumb args
* Filters for customer email attachments
* Chosen selects for country/state select inputs (optional)
* Piwik (http://piwik.org/) tracking - requires http://wordpress.org/extend/plugins/wp-piwik/
* Option to hide cart widget if the cart is empty
* Category widget - order by option
* Option to re-order shipping methods
* Coupon entry form on checkout (optional)
* paying_customer user meta when order is complete
* Improved download links in emails
* Replaced quantity selector of grouped downloadable products with a button
* Reworked checkout fields to make them easier to extend
* Added address meta to users panel
* Added address data to edit users screen
* Using 3.3 function is_main_query()
* Fixed price display if taxes disabled
* Backorder notifications show order #
* Product data write panel tweaks
* Enabled product custom fields panel
* Renamed custom fields for product data - upgrade script will run when upgrading. Some themes may be affected if using 'featured' - it is now '_featured'
* woocommerce_product_visibility_options filter for backend
* Shipping method classes/api changed to make rate definition simpler - shipping methods will need updating to stay compatible
* Change textdomain from woothemes to woocommerce
* Free shipping coupons ignore min-amount
* Delete all variations option
* Product category widget option to show current children only
= 1.3.2.1 - 15/12/2011 =
* Category/Ordering fix
* HTTPS download URL fix
= 1.3.2 - 09/12/2011 =
* Fixed error when adding an order manually
* Dumped the orders class (hardly used)
* Shipping classes can be set up without assigning products first
* Product reports: Combines children so grouped products have stats
= 1.3.1 - 08/12/2011 =
* Many Minor bug fixes
* Ability to re-order payment gateways and choose a default
* Added a 'Shipping class' taxonomy for grouping products
* Enhanced Flat Rate shipping to give a flat rate to each shipping class
* Made jQuery UI optional and improved Javascript
* Javascript can be loaded in the footer
* Reworked term ordering system to make it more flexible and easier to manage
* add_to_cart_url shortcode
* French translation
* Customer note field quote fix
* Moved product-category and tag slugs to settings (page)
* % coupon fix
* Tax rates based on shipping address
* Helpers for outputting JS in the footer
* Fixed sale widget
* File download method option so force download can be switched off
* Improved product cat dropdowns
* Czech translation by Martin Nečas
* Turkish translation by Ercan
= 1.3 - 01/12/2011 =
* Minor bug fixes + localisations
* Schema.org markup for products and reviews
* Option to apply coupons before tax (per coupon)
* Rewritten cart tax calculations to support coupons before tax and after tax
* 2 lines of discounts on total tables - 1 for product discounts, 1 for after tax discounts (e.g. store credit)
* Tweaked paypal to work with tax inclusive prices without screwing up rounding
* Stored ex. prices with higher precision to prevent rounding errors
* Rewritten options for tax display - cart items can be shown without tax now
* Fixed ordering of custom attributes in variation select boxes
* Support for ordering attributes with the same ID (but different taxonomies)
* Made catalog ordering filterable
* Enhanced admin with http://harvesthq.github.com/chosen/
* Added ZAR currency
* Fixed product (single) visibility
* Improved orders interface
* On orders screen you can load customer details is on file
* Fixed address_1 address_2 names
* Updated German Lang (formal) thanks @owcv
* Sale date uses current_time('timestamp') instead of strtotime
* Fixed variations loading dimensions
* Product get_attribute function
* Option to clear cart on logout
* Made cheque/bacs gateways reduce stock levels upon ordering
* Continue shopping button when directing user to cart after adding a product to the cart
* Refund/Reverse notification in paypal gateway
* Made stock notifications use email template
* Added dimensions to individual variations
* Added settings API to be used by Shipping Methods and Payment Gateways
* Free shipping/Flat rate uses setting API
* Free shipping coupons
* Ship to billing default option
* Trim zeros off prices (optional)
= 1.2.4 - 18/11/2011 =
* More sale price logic fixes for variations. Now correctly compares variation's prices.
* Clear cache on upgrade/install
* Related product fix when no categories are set
* Fix for price filter + variations with multiple prices
* Grouped product link/quantity fix
* Made record_product_sales trigger once only
* Payment complete only when on-hold/pending
* More logging in paypal gateway
* Feature to prevent admin access to customers (optional)
* Fixed quick edit
* text/html email headers
* Fixed variation issue with quote symbols using esc_html
= 1.2.3 - 17/11/2011 =
* Fix for sale price logic
* Related products array_diff fix
* Fixed Produkt-Kategorie in formal german translation
* Variations limit fix
* Transients cleared on install
* Taxonomies defined before products to prevent 404's
= 1.2.2 - 17/11/2011 =
* Minor fixes and optimisations
* Tweaked 'pay' emails
* Check at top of email templates to make sure they are not accessed directly
* Fixes for hiding order notes from feeds etc
* Added transients to main query to improve performance
* Improved products class and get_related function
* Removed subcats when paged
* Category widget now supports hierarchy/counts
* woocommerce-page body class for all woocommerce pages
* Fix active class in wp_list_pages for shop page
* Ability to register from my account page
* Option to show size/weight on attributes tab
* Added logger class for debugging
* Logs folder added upon install with htaccess added to prevent access
* Ability to make layered nav an "OR" query so you can expand your search rather than filter it
* Tweaked coupon logic. Excluded coupons (for product discounts) don't get a product discount, but valid products do
* Prevent checkout being submitted twice
* Made order notes optional
* PayPal standard stores payer email address
* Added handling for paypal reversal and refunded statuses
* Downloads check order status is completed before allowing access - to do this we've added a new column to the permissions table (order id). Existing rows will be updated upon activation.
* Formatted address shows full state name
* State field shows 'select a state by default'
* Country defaults to base country on checkout
* Fixed upload directory
* Added customer note email notifications
= 1.2.1 - 10/11/2011 =
* Reworked downloadable and virtual products - now variations can be downloadable/virtual too making it more flexible
* My account/login widget
* Added shortcode insertion button to the post editor
* Shortcode for products by category (slug)
* Option to enable/disable ajax add to cart buttons
* Widget for showing onsale products
* Signup/login can be turned off for checkout
* Paypal remote post now has 'sslverify' => false to prevent errors with CURL
* Minor admin settings tidyup
* Dutch translation has been updated
* Cart is now more robust and supports custom data being stored, such as addons
* Fix for 0 quantity
* add_to_cart shortcode
* Improved order search
* Option to unforce SSL checkout
* Support for X-Accel-Redirect / X-Sendfile for downloads
* Customer new account email when signing up from the checkout
* Attributes can be added to nav bar via filter
* External/Affiliate product type
* Added Spanish translation by lluis masachs
* Support for informal/formal localisations
* Directory changed for uploading file downloads - uploads/woocommerce_files
* Download directory created on install as well as htaccess for denying access
* Formal and informal German translations - thanks to stefahn, jessor, Ramoonus , owcv and deckerweb
* Hook for checking cart contents during cart/checkout - used for plugins too
= 1.2 - 03/11/2011 =
* Added quick status change buttons (processing/complete) to orders panel
* Ability to preview email templates
* Option to add logout link to my account menu
* Added ability to show meta (custom fields) on order emails - useful for plugins
* Added order details to thankyou page
* Added basic rss feeds for products and product categories
* Added functions which show tax/vat conditionally
* Made use of transients to store average ratings and improve performance
* Added page installer on installation to make it optional (you may want to import your pages)
* BACS and Cheque gateways now contain payment instructions
* Custom field for product total_sales when sold
* Best sellers widget based on new total_sales field
* Ability to exclude product ids
* Option for the recipient of order/stock emails
* Options to define default attribute selections in variations
* Edit category - image fix
* Order Complete email heading fix
* 100% discount when price excludes tax logic fix
* Download urls use site_url instead of home_url so installs in subdirectories are handled correctly
* Fixed variations - Incorrectly used instead $product_custom_fields of $parent_custom_fields
* Adding cart item resets shipping - so free shipping etc is selected when going over a threshold
* Changes to shipping calc - if no rates are found, but the user did not enter a state/postcode, it asks them to do so.
* Fix for adding sites in multisite
* Dashboard chart now ignores 'pending' orders
* Fixed dashboard report range
* Added hooks to gateway icons
* Added Dutch translation by [Ramoonus](http://www.ramoonus.nl/)
= 1.1.3 - 27/10/2011 =
* Improved Force SSL Setting - now forces https urls for enqueued scripts and styles
* Updated some localisation strings in email subject lines
* Fixed variation coupons
* Fixed edit address via my account
* Support for localisations in wp-content/languages/woocommerce
* Added ability to change email template colors and from name/address from the settings panel
* Added italian translation by Roberto Lioniello
* Added swedish translation by Stefan Johansson
* Made cart page hide the 'no shipping methods found' message unless the user has calculated shipping.
* Given shop_manager role capabilities of an editor
* Fixed menu order when logged in as a shop manager
* Added SKU column to order data
* Removed output buffering from loop
* Add product % coupons
* Filtering hides subcategories
* Lots of other minor fixes
= 1.1.2 - 23/10/2011 =
* Coupons can be applied to variations (by ID)
* Fixed up/cross-sell removal
* Fixed image (zoom) URL after variation selection
* Fixed category filter in admin
* Fixed billing/shipping address on my account page
* Tax fix for prices excluding tax - issue was in the 1.1.1 update
* Option to hide products when sub-cats are shown, and empty cats are shown
* Renamed $columns global for compatibility with certain themes
* Made variation slugs display as term name
* Added a helper function to get the return url (for gateways) - fixes https return url
= 1.1.1 - 16/10/2011 =
* Products need a base, regardless of category settings - added base to prevent pages breaking
* Fixed hard cropping
* Translation fixes
* Moved discount above shipping calc
* Fixed enter key on product edit page
* Typos
* Made custom attributes display 'nicely' in cart widgets, instead of santized
= 1.1 - 12/10/2011 =
* Tested and working with WordPress 3.3 beta-1
* Added a hook for payment complete order status
* Added woocommerce term meta api
* Added ability to upload category thumbnails
* Added option to show sub-categories when browing categories/the shop page
* Zero tax rate fix
* Filters for tax rates
* Fixes to find rate function
* Product dimension fields
* Fixed archives being displayed by woocommerce_show_product_images
* Added 'configure terms' button to attributes page to make it clearer
* Fix for variations when an attribute has been removed
* Fixed some localisation strings
* Hard crop option for images (use regenerate thumbnails after toggling to redo all images)
* Password field type for gateways API
* Front page shop improvements/correct title tags
* Added option for controlling product permalinks
* Shop page title option
* Load admin css only where needed
* Admin JS cleanup
* Removed error message when clicking buttons to view variations/grouped
* Drag and drop term ordering (so variation options can be sorted)
* Pay page after invoicing fix
= 1.0.3 - 06/10/2011 =
* Several minor fixes/tweaks
* Conditionals check for existing function names
* Made image size settings clearer
* Cleaned up coupon code settings/write panel and added a few more hooks
* Fixed 'product ids' setting in coupons
* Fixed notices on shop pages due to WP_QUERY
* Cleaned up discount types and made some helper functions for getting them
* woocommerce_coupon_is_valid hook
* Fixed order tracking completed time
* Sale price affects variable product 'from:' price
* Variation options (frontend) no longer lose your selections when changing an option
* Gallery image field fix
* Image 'insert into' fix
* variable products store min and max variation price, so if they match the 'from' text is not displayed
* Email items list fix
* Reports chart fix
* Fixed category ordering in widgets
* Labels to taxonomies updated
* Query tweak to fix tags/cats
* Order tracking localisation
= 1.0.2 - 02/10/2011 =
* Fix in woocommerce_templates for when a shop is the front-page
* Added esc_html/esc_attribute in review-order.php
* Tweaked localised strings in shortcode-thankyou.php
* Filter added to get_downloadable_products so more advanced rules can be applied.
* Fixed required fields in edit shipping address
* Fixed login link 'jump' on checkout
* Added Turkish lira currency
* Active menu state fix
* Few minor typos/case changes
* Tweaked install script so it only redirects after activation
* Removing attributes fix
* only style mails of WooCommerce - not all mails. This is to prevent conflicts with other plugins.
* unique sku check only checks products
* More security audit tweaks thanks to Mark Jaquith
* cart totals update when adding cross-sells to cart
* Removed the 'resave permalinks message' due to it being done automatically
* Added support to exclude images from product page
= 1.0.1 - 29/09/2011 =
* Fixed notices on product page
* Variation formatting uses item_meta when showing order items
* Javascript fixes in admin + correct enqueuing of scripts
* Added en_GB po file
* Used dbDelta for installation of tables for better table upgrades/installs
* Fix for reviews form when fancybox is turned off
= 1.0 - 27/09/2011 =
* Initial Release. Woo!
== Upgrade Notice ==
= 1.4 =
Major update with plenty of optimisations and new features. Changed to note:
* Requires WP 3.3
* Product data meta has been renamed in this version so that custom-fields can be enabled. Product data is now prepended with an underscore so they are hidden from the custom-field panel. Existing data will be upgraded automatically.
* The shipping method classes have been updated to make rate definition easier. Third party plugins will need updating.
* Textdomain has changed - re-scan your po/mo's
* Tax additions (tax rows, compounds etc) required a change to the way order items are stored. Old orders won't show items when viewed. Order totals should be unaffected.
Please backup your database before upgrading and also ensure you are running the latest versions of any WooCommerce plugins after upgrading.
= 1.3 =
This is a major update and includes improvements to the tax and coupon system in particular - please backup your database before upgrading and also ensure you are running the latest versions of any WooCommerce plugins after upgrading.
= 1.2.3 =
Fixes minor issues in 1.2.2 - please backup your database before upgrading and also ensure you are running the latest versions of any WooCommerce plugins.
= 1.2.2 =
Due to some changes in the plugin, if you are using any of our extensions please ensure you check the changelogs and download any updates from your account - especially if using 2CO, iDeal or authorize.net. This version also updates the download permissions table so please ensure you backup your database before upgrading.
= 1.2.1 =
This version has improved product types - ensure you de/re-activate the theme to ensure existing products get converted correctly.
= 1.2 =
New features, bug fixes and improvements to keep WooCommerce running smoothly.