changeset 2898:f203541b1116 maint-0.7

merge from HEAD
author Richard Jones <richard@users.sourceforge.net>
date Thu, 11 Nov 2004 02:53:35 +0000
parents ab9e81b82db9
children 0fe0452338ba
files doc/FAQ.txt doc/customizing.txt
diffstat 2 files changed, 38 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/FAQ.txt	Wed Nov 10 22:29:21 2004 +0000
+++ b/doc/FAQ.txt	Thu Nov 11 02:53:35 2004 +0000
@@ -2,7 +2,7 @@
 Roundup FAQ
 ===========
 
-:Version: $Revision: 1.16 $
+:Version: $Revision: 1.16.2.1 $
 
 .. contents::
 
@@ -160,6 +160,24 @@
 to the URL of the tracker.
 
 
+How is sorting performed, and why does it seem to fail sometimes?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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.
+
 -----------------
 
 Back to `Table of Contents`_
--- a/doc/customizing.txt	Wed Nov 10 22:29:21 2004 +0000
+++ b/doc/customizing.txt	Thu Nov 11 02:53:35 2004 +0000
@@ -548,6 +548,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/