[interchange-docs] xmldocs - docelic modified refs/MaxQuantityField

[docs at icdevgroup.org]

User:      docelic
Date:      2008-06-26 09:02:36 GMT
Modified:  refs     MaxQuantityField
Log:
* Document new MaxQF [=?]

Revision  Changes    Path
1.4                  xmldocs/refs/MaxQuantityField


rev 1.4, prev_rev 1.3
Index: MaxQuantityField
===================================================================
RCS file: /var/cvs/xmldocs/refs/MaxQuantityField,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MaxQuantityField	28 Apr 2008 22:50:51 -0000	1.3
+++ MaxQuantityField	26 Jun 2008 09:02:36 -0000	1.4
@@ -11,10 +11,10 @@
 __NAME__ synopsis
 <group choice='plain' rep='repeat'>
 	<arg choice='plain'>
-		<replaceable>table</replaceable>:<replaceable>column</replaceable>
+		[=?]<replaceable>table</replaceable>:<replaceable>column</replaceable>
 	</arg>
 	<arg choice='plain'>
-		<replaceable>column</replaceable>
+		[=?]<replaceable>column</replaceable>
 	</arg>
 </group>
 __END__
@@ -28,14 +28,19 @@
 If the argument contains a colon "<literal>:</literal>", it is treated
 as a <literal><replaceable>TABLE:COLUMN</replaceable></literal> specification.
 Otherwise it indicates the name of the column and the table
-defaults to the first (of possibly more) &conf-ProductFiles; databases.
+defaults to the first &conf-ProductFiles; database.
 </para><para>
 The record with the matching product &glos-SKU; must exist in the 
 target database, or the quantity will be unlimited.
 </para><para>
-It is possible to specify multiple database fields (separated by commas), 
-in which case the maximum quantity allowed is set to the sum of all quantities
+It is possible to specify multiple database fields (separated by commas or
+spaces), in which case the maximum quantity allowed is set to the sum of
+all quantities
 found.
+</para><para>
+As of Jun 26, 2008, a field prefixed with <literal>=</literal> overrides
+any previous value, while a field prefixed with <literal>?</literal>
+overrides previous value only if the new value is greater than zero.
 __END__
 
 __NAME__ notes
@@ -55,10 +60,19 @@
 </programlisting>
 __END__
 
+__NAME__ example: Setting __FILENAME__
+<programlisting>
+MaxQuantityField inventory:quantity, products:in_stock products:on_hand
+</programlisting>
+Notice we can use commas and whitespace interchangeably to separate fields.
+__END__
 
 __NAME__ example: Setting __FILENAME__
+Override any previous value with
+<database class='field'>products:on_hand</database>,
+if it contains a value greater than zero.
 <programlisting>
-MaxQuantityField inventory:quantity, products:on_hand
+MaxQuantityField inventory:quantity ?products:on_hand
 </programlisting>
 __END__