[Zope-Checkins] CVS: Zope/lib/python/Products/OFSP/help - dtml-in.stx:1.4.8.1

[Shane Hathaway]

Update of /cvs-repository/Zope/lib/python/Products/OFSP/help
In directory cvs.zope.org:/tmp/cvs-serv29115/lib/python/Products/OFSP/help

Modified Files:
      Tag: NR-branch
	dtml-in.stx 
Log Message:
Sync NR-branch with trunk.  Sorry about so many checkin messages...


=== Zope/lib/python/Products/OFSP/help/dtml-in.stx 1.4 => 1.4.8.1 ===
     item is encountered.
 
-    orphan=int -- The desired minimum batch size.
+    orphan=int -- The desired minimum batch size. This controls how
+    sequences are split into batches. If a batch smaller than the
+    orphan size would occur, then no split is performed, and a batch
+    larger than the batch size results.
+
+      For example, if the sequence size is 12, the batch size is 10
+      the orphan size is 3, then the result is one batch with all 12
+      items since splitting the items into two batches would result in
+      a batch smaller than the orphan size.
+
+      The default value is 3.
 
     overlap=int -- The number of items to overlap between batches. The
-    default value is 3.
+    default is no overlap.
 
     previous -- Iterates once if there is a previous batch. Sets batch
     variables for previous sequence.