Changes between Version 5 and Version 6 of QueuesPlugin

Timestamp:

Jan 4, 2011, 4:06:06 AM (13 years ago)

Author:

Rob Guttman

Comment:

--

QueuesPlugin

@@ -201 +201 @@
 
 == Tips ==
+=== Position padding ===
+Whether or not you cast the {{position}}} field into an integer for report ordering, you still may want to pad your position numbers so that they sort correctly in any report or custom query in which they appear.  You set this up globally in {{{trac.ini}}}:
+{{{
+[queues]
+pad_length = 2
+}}}
+
+A {{{pad_length}}} of {{{2}}} is the default.  This means that position 1 will become position {{{01}}}, etc.  Position 10 remains {{{10}}}, and 100 remains {{{100}}}.
+
+=== Maximum position ===
+Typically, the further down a queue you go, the less accurate the ordering becomes.  This is natural.  Which means that after a point, ordering doesn't really matter anymore.  One way to help reinforce this is by defining a {{{max_position}}} value:
+{{{
+[queues]
+max_position = 99
+}}}
+
+A {{{max_position}}} of {{{99}}} is the default.  This means that positions 100 and beyond will get set to position {{{99}} whenever they appear in a queue.
+
+=== "Max items per page" ===
+Trac automatically paginates reports longer than the defined "Max items per page".  Depending on your usage of queues, you may want to either set this value lower (or higher) globally in {{{trac.ini}}}:
+{{{
+[report]
+items_per_page = 100
+}}}
+
+.. or bookmark reports setting {{{max=N}}} as desired.  For example, seeing a logn queue can be overwhelming to some, so you may want to encourage them to only look at the first 10 or 20 using this param/argument.  However, note that queue reordering only works on the first page (it's disabled for subsequent pages).  So if you need to reorder items on the second or third pages, increase the "Max items per page" argument as needed.
+
+=== Enhanced user experience ===
 Depending on how you use work queues, several complementary plugins may be beneficial to you: