Update readme.txt, translation setup, etc. (General preparation for release)

92222d26 · Reinhold Kainhofer · 9d864005 · 92222d26 · 92222d26 · 92222d26
Commit 92222d26 authored 9 years ago by Reinhold Kainhofer
--- a/includes/rules_shipping_framework_woocommerce.php
+++ b/includes/rules_shipping_framework_woocommerce.php
 <?php
 /**
- * Shipping by Rules generic helper class (Joomla/VM-specific)
+ * Shipping by Rules generic helper class (WP/WooCommerce-specific)
 * Reinhold Kainhofer, Open Tools, office@open-tools.net
- * @copyright (C) 2012-2015 - Reinhold Kainhofer
+ * @copyright (C) 2012-2016 - Reinhold Kainhofer
 * @license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 **/
@@ -36,7 +36,7 @@ class RulesShippingFrameworkWooCommerce extends RulesShippingFramework {
 	function _construct() {
 		parent::_construct();
-		load_plugin_textdomain('opentools-shippingrules', false, basename( dirname( __FILE__ ) ) . '/languages' );
+		load_plugin_textdomain('woocommerce-shipping-by-rules', false, basename( dirname( __FILE__ ) ) . '/languages' );
 	}
 	static function getHelper() {
 		static $helper = null;

--- a/includes/rules_shipping_framework_woocommerce_advanced.php
+++ b/includes/rules_shipping_framework_woocommerce_advanced.php
 <?php
 /**
- * Shipping by Rules generic helper class (Joomla/VM-specific)
+ * Shipping by Rules generic helper class (WP/WooCommerce-specific)
 * Reinhold Kainhofer, Open Tools, office@open-tools.net
- * @copyright (C) 2012-2015 - Reinhold Kainhofer
+ * @copyright (C) 2012-2016 - Reinhold Kainhofer
 * @license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 **/

--- a/readme-adv.txt
+++ b/readme-adv.txt
 === WooCommerce Basic Ordernumbers ===
 Contributors: opentools
-Tags: WooCommerce, Order numbers, orders
+Tags: WooCommerce, Shipment, Shipping
 Requires at least: 4.0
-Tested up to: 4.1.1
+Tested up to: 4.4.1
-Stable tag: trunk
+Stable tag: 1.0
 License: GPLv3 or later
 License URI: http://www.gnu.org/licenses/gpl.html
-Customize order numbers for WooCommerce. The order numbers can contain arbitrary text, a running counter and the current year.
+Describe shipping costs with general rules on the order properties. Very complex shipping cost structures (depending on the amount, postal code, weight, number of products and/or articles etc.) can be easily implemented.
 == Description ==
-The most flexible and complete solution for your WooCommerce webshop to customize your order numbers!
+Determine shipping costs according to general conditions (bounds on the order properties). Shipping costs can depend on e.g.:
+* Total amount of the order
-By default, WooCommerce uses the WordPress post ID of the order, which result in gaps between the order numbers. With this plugin you can configure the order numbers to have consecutive counters. Furthermore, the order number can contain the year, and the counter can be configured to reset each year.
+* Total weight of the order
+* Number of articles or different products in the order
-The number format is a simple string, where # indicates the counter and [year] or [year2] indicate the year. 
+* Volume or minimal and maximal extensions of the products
-To get order numbers like "WC-2015-1", "WC-2015-2", etc., simply set the format to "WC-[year]-#".
+* Postal code of the delivery address (the Advanced version also supports alphanumeric postal codes from the UK, Canana and Netherlands)
+* Coupon Code (Advanced version only)
-The plugin comes in two flavors:
+The plugin exists in two different versions, this free version, which supports fixed bounds for all properties, and a paid version, which allows all conditions and shipping rules to contain arbitrary mathematical expressions (like an OR operator, multiplication, addition, subtraction, functions like rounding etc.). See the documentation for all the differences. 
-*   This **free basic version**, which provides **sequential numbers** and allows the **year in the order number**
-*   The **paid advanced version**, with lots of **additional features**:
+Each rule is described as one line of text with an easy structure (semicolons separate the parts of the rule). For example:
-	* Counter formatting: initial value, counter increments, number padding
-	* Lots of variables to be used in the formats
+    Name=Free Shipping; 100<=Amount; 0
-		- date/time: year, month, day, hour, etc.
+    Name=Domestic Small; Articles<5; Amount<100; Shipping=1.50
-		- address: customer country, zip, name, etc.
+    Name=Domestic Standard; Amount<100; Shipping=3.50
-		- order-specific: Number of articles, products, order total etc.
-		- product categories, shipping method
+This set of rules describes three shipping costs: Orders of 100€ and more are free, otherwise orders with less than five articles have shipping costs of 1.5€, all others 3.50€.
-	* Custom variable definitions (with conditions on available variables)
-	* Multiple concurrent counters (e.g. numbering per country, per day, per ZIP, ...)
+=== Limitations and common misconceptions ===
-	* Different order numbers for free orders (e.g. "FREE-01" for free orders)
-	* Different number format for e.g. certain IP addresses (for testing)
+* The plugin is not designed to calculte shipping costs on a per-product level (e.g. it is not possible that Article A has shipping costs of 3€, Article B 5€ and if you order both you pay 8€ shipping)
-	* Different number format depending on products, product categories, shipping classes
+* The plugin allows only limited support for category-based shipping. You can only find out if an article from a particular category is in the order, but NOT how many articles from a given category (e.g. it is not possible to have all articles from Category X ship for 3€ and all articles from Category Y ship for 5€)
-	* Customize invoice numbers (only for the "WooCommerce PDF Invoices and Package Slips" plugin)
+* The plugin does NOT sum the results of all rules, but uses the FIRST matching rule it finds.
+* The plugin does NOT use the lowest result of all rules, but it uses the FIRST matching rule it finds. (In particular, if you want to provide free shipping under certain conditions, you usually need to place the rule for free shipping FIRST rather than last, because the last rule will only be used if none of the other rules matches).
 For the full documentation of both the basic and the advanced ordernumbers plugin for WooCommerce, see:
-http://open-tools.net/documentation/advanced-order-numbers-for-woocommerce.html
+http://open-tools.net/documentation/advanced-shipping-by-rules-for-woocommerce.html
@@ -46,16 +47,12 @@ http://open-tools.net/documentation/advanced-order-numbers-for-woocommerce.html
 	1. use WordPress' plugin manager to find it in the WordPress plugin directory and directly install it from the WP plugin manager, or
 	1. use WordPress' plugin manager to upload the plugin's zip file.
 1. After installation, activate the plugin through the 'Plugins' menu in WordPress
-1. Enable the plugin's functionality in the WooCommerce settings (tab "Checkout" -> "Order numbers")
+1. Go to WooCommerce's shipment configuration page, open the "Shipping by Rules" method and set up a your rule-based methods there
 == Frequently Asked Questions ==
-= How can I create nice order numbers for existing orders? =
-This plugin is intended for future orders. You can, however, create order numbers for existing orders in the order view in the WordPress admin section. In the top right "Order Actions" box select "Assign a new order number" and click "Save Order". Notice, however, that this will create an order number as if the order was created at that very moment.
 = What about invoice numbers? =
 The Advanced Ordernumbers for WooCommerce plugin supports some invoicing plugins. This functionality is not available in the free version, though.
@@ -63,7 +60,6 @@ The Advanced Ordernumbers for WooCommerce plugin supports some invoicing plugins
 == Screenshots ==
-1. 
 == Changelog ==
@@ -72,5 +68,5 @@ The Advanced Ordernumbers for WooCommerce plugin supports some invoicing plugins
 == Upgrade Notice ==
-To install the Advanced Ordernumbers for WooCommerce package, proceed as described in the Installation section.
+To install the Shipping by Rules plugin for WooCommerce, proceed as described in the Installation section.
-No upgrades yet. 
+Upgrades to new versions are automatically offered in the WordPress plugin page.
--- a/readme.txt
+++ b/readme.txt
 === WooCommerce Basic Ordernumbers ===
 Contributors: opentools
-Tags: WooCommerce, Order numbers, orders
+Tags: WooCommerce, Shipment, Shipping
 Requires at least: 4.0
-Tested up to: 4.2.2
+Tested up to: 4.4.1
-Stable tag: 1.1
+Stable tag: 1.0
 License: GPLv3 or later
 License URI: http://www.gnu.org/licenses/gpl.html
-Customize order numbers for WooCommerce. The order numbers can contain arbitrary text and a running counter.
+Describe shipping costs with general rules on the order properties. Very complex shipping cost structures (depending on the amount, postal code, weight, number of products and/or articles etc.) can be easily implemented.
 == Description ==
-The most flexible and complete solution for your WooCommerce webshop to customize your order numbers!
+Determine shipping costs according to general conditions (bounds on the order properties). Shipping costs can depend on e.g.:
+* Total amount of the order
-By default, WooCommerce uses the WordPress post ID of the order, which result in gaps between the order numbers. With this plugin you can configure the order numbers to have consecutive counters. Furthermore, the order number can contain the year, and the counter can be configured to reset each year.
+* Total weight of the order
+* Number of articles or different products in the order
-The number format is a simple string, where # indicates the counter. 
+* Volume or minimal and maximal extensions of the products
-To get order numbers like "WC-376", "WC-377", "WC-378", etc., simply set the format to "WC-#".
+* Postal code of the delivery address (the Advanced version also supports alphanumeric postal codes from the UK, Canana and Netherlands)
+* Coupon Code (Advanced version only)
-The plugin comes in two flavors:
+The plugin exists in two different versions, this free version, which supports fixed bounds for all properties, and a paid version, which allows all conditions and shipping rules to contain arbitrary mathematical expressions (like an OR operator, multiplication, addition, subtraction, functions like rounding etc.). See the documentation for all the differences. 
-*   This **free basic version**, which provides **sequential numbers** and allows arbitrary text (prefix / postfix) in the numbers
-*   The **paid advanced version**, with lots of **additional features**:
+Each rule is described as one line of text with an easy structure (semicolons separate the parts of the rule). For example:
-	* Counter __formatting__: initial value, counter increments, number padding
-	* Flexible __counter resets__
+    Name=Free Shipping; 100<=Amount; 0
-	* Lots of __variables__ to be used in the formats
+    Name=Domestic Small; Articles<5; Amount<100; Shipping=1.50
-		- date/time: year, month, day, hour, etc.
+    Name=Domestic Standard; Amount<100; Shipping=3.50
-		- address: customer country, zip, name, etc.
-		- order-specific: Number of articles, products, order total etc.
+This set of rules describes three shipping costs: Orders of 100€ and more are free, otherwise orders with less than five articles have shipping costs of 1.5€, all others 3.50€.
-		- product categories, shipping method
-	* Custom variable definitions (with conditions on available variables)
+=== Limitations and common misconceptions ===
-	* Multiple concurrent counters (e.g. numbering per country, per day, per ZIP, ...)
-	* Different order numbers for free orders (e.g. "FREE-01" for free orders)
+* The plugin is not designed to calculte shipping costs on a per-product level (e.g. it is not possible that Article A has shipping costs of 3€, Article B 5€ and if you order both you pay 8€ shipping)
-	* Different number format for e.g. certain IP addresses (for testing)
+* The plugin allows only limited support for category-based shipping. You can only find out if an article from a particular category is in the order, but NOT how many articles from a given category (e.g. it is not possible to have all articles from Category X ship for 3€ and all articles from Category Y ship for 5€)
-	* Different number format depending on products, product categories, shipping classes
+* The plugin does NOT sum the results of all rules, but uses the FIRST matching rule it finds.
-	* Customize invoice numbers (only for the "WooCommerce PDF Invoices and Package Slips" plugin)
+* The plugin does NOT use the lowest result of all rules, but it uses the FIRST matching rule it finds. (In particular, if you want to provide free shipping under certain conditions, you usually need to place the rule for free shipping FIRST rather than last, because the last rule will only be used if none of the other rules matches).
 For the full documentation of both the basic and the advanced ordernumbers plugin for WooCommerce, see:
-http://open-tools.net/documentation/advanced-order-numbers-for-woocommerce.html
+http://open-tools.net/documentation/advanced-shipping-by-rules-for-woocommerce.html
@@ -47,20 +47,12 @@ http://open-tools.net/documentation/advanced-order-numbers-for-woocommerce.html
 	1. use WordPress' plugin manager to find it in the WordPress plugin directory and directly install it from the WP plugin manager, or
 	1. use WordPress' plugin manager to upload the plugin's zip file.
 1. After installation, activate the plugin through the 'Plugins' menu in WordPress
-1. Enable the plugin's functionality in the WooCommerce settings (tab "Checkout" -> "Order numbers")
+1. Go to WooCommerce's shipment configuration page, open the "Shipping by Rules" method and set up a your rule-based methods there
 == Frequently Asked Questions ==
-= How can I create nice order numbers for existing orders? =
-This plugin is intended for future orders. You can, however, create order numbers for existing orders in the order view in the WordPress admin section. In the top right "Order Actions" box select "Assign a new order number" and click "Save Order". Notice, however, that this will create an order number as if the order was created at that very moment.
-= How can I start the counter at a value higher than 1? =
-The easiest way is to configure the plugin, make one test order and then modify the counter in the plugin configuration to the value you desire. 
 = What about invoice numbers? =
 The Advanced Ordernumbers for WooCommerce plugin supports some invoicing plugins. This functionality is not available in the free version, though.
@@ -71,14 +63,10 @@ The Advanced Ordernumbers for WooCommerce plugin supports some invoicing plugins
 == Changelog ==
-= 1.1 =
-* Some smaller bugfixes
-* Removed variable definition for year
 = 1.0 =
 * Initial release
 == Upgrade Notice ==
-To install the Advanced Ordernumbers for WooCommerce package, proceed as described in the Installation section.
+To install the Shipping by Rules plugin for WooCommerce, proceed as described in the Installation section.
-No upgrades yet. 
+Upgrades to new versions are automatically offered in the WordPress plugin page.
--- a/woocommerce-advanced-shipping-by-rules.php
+++ b/woocommerce-advanced-shipping-by-rules.php
 <?php
 /**
 * Plugin Name: WooCommerce Advanced Shipping By Rules
- * Plugin URI: http://open-tools.net/woocommerce/
+ * Plugin URI: http://open-tools.net/woocommerce/advanced-shipping-by-rules-for-woocommerce.html
 * Description: Define Shipping cost by very general and flexible (text-based) rules. The advanced version also provides mathematical expressions and functions
 * Version: 1.0.0
 * Author: Open Tools, Reinhold Kainhofer
 * Author URI: http://open-tools.net
 * Text Domain: woocommerce-advanced-shipping-by-rules
- * Domain Path: 
+ * Domain Path: woocommerce-shipping-by-rules
 * License: GPL2+
 * WC requires at least: 2.2
 * WC tested up to: 2.4