diff doc/customizing.txt @ 2897:21a0b049fed8

notes about sorting
author Richard Jones <richard@users.sourceforge.net>
date Thu, 11 Nov 2004 02:46:44 +0000
parents 0998d1b48182
children 5c0e5abcb5e3
line wrap: on
line diff
--- a/doc/customizing.txt	Wed Nov 10 22:29:21 2004 +0000
+++ b/doc/customizing.txt	Thu Nov 11 02:46:44 2004 +0000
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.151 $
+:Version: $Revision: 1.152 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -578,6 +578,25 @@
 in the "definitional" classes like "priority" and "status".
 
 
+A note about ordering
+~~~~~~~~~~~~~~~~~~~~~
+
+When we sort items in the hyperdb, we use one of a number of methods,
+depending on the properties being sorted on:
+
+1. If it's a String, Number, Date or Interval property, we just sort the
+   scalar value of the property. Strings are sorted case-sensitively.
+2. If it's a Link property, we sort by either the linked item's "order"
+   property (if it has one) or the linked item's "id".
+3. Mulitlinks sort similar to #2, but we start with the first Multilink
+   list item, and if they're the same, we sort by the second item, and
+   so on.
+
+Note that if an "order" property is defined on a Class that is used for
+sorting, all items of that Class *must* have a value against the "order"
+property, or sorting will result in random ordering.
+
+
 Examples of adding to your schema
 ---------------------------------
 

Roundup Issue Tracker: http://roundup-tracker.org/