annotate doc/roundup-demo.1 @ 3696:790363e96852

Sorting/grouping by multiple properties. - Implement sorting/grouping by multiple properties for the web interface. I'm now using @sort0/@sortdir0,@sort1/@sortdir1,... and @group0/@groupdir0,... when generating URLs from a search template. These are converted to a list internally. When saving URLs (e.g. when storing queries) I'm using @sort=prop1,prop2,... and @group=... with optional '-' prepended to individual props. This means saved URLs are backward compatible with existing trackers (and yes, this was a design goal). I need the clumsy version with @sort0,@sort1 etc, because I'm currently using several selectors and checkboxes (as the classic template does, too). I don't think there is a way around that in HTML? - Updated (hopefully all) documentation to reflect the new URL format and the consequences in the web-interface. - I've set the number of sort/group properties in the classic template to two -- this can easily be reverted by changing n_sort to 1. Richard, would you look over these changes? I've set a tag before and (will set) after commit, so that it would be easy to merge out. Don't be too scared about the size of the change, most is documentation, the guts are in cgi/templating.py and small changes in the classic template.
author Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
date Wed, 30 Aug 2006 20:28:26 +0000
parents 4992da7c96ae
children 5cd913b94e25
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2795
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 .TH ROUNDUP-SERVER 1 "27 July 2004"
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 .SH NAME
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 roundup-demo \- create a roundup "demo" tracker and launch its web interface
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 .SH SYNOPSIS
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 \fBroundup-demo\fP [\fIbackend\fP [\fBnuke\fP]]
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 .SH OPTIONS
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 .TP
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 \fBnuke\fP
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 Create a fresh demo tracker (deleting the existing one if any). If the
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 additional \fIbackend\fP argument is specified, the new demo tracker will
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 use the backend named (one of "anydbm", "sqlite", "metakit", "mysql" or
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 "postgresql"; subject to availability on your system).
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 .TH DESCRIPTION
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 This command creates a fresh demo tracker for you to experiment with. The
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 email features of Roundup will be turned off (so the nosy feature won't
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 send email). It does this by removing the \fInosyreaction.py\fP module
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 from the demo tracker's \fIdetectors\fP directory.
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 If you wish, you may modify the demo tracker by editing its configuration
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 files and HTML templates. See the \fIcustomisation\fP manual for
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 information about how to do that.
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 Once you've fiddled with the demo tracker, you may use it as a template for
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 creating your real, live tracker. Simply run the \fIroundup-admin\fP
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 command to install the tracker from inside the demo tracker home directory,
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 and it will be listed as an available template for installation. No data
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 will be copied over.
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 .SH AUTHOR
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 This manpage was written by Richard Jones
4992da7c96ae roundup-demo man page
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 <richard@users.sourceforge.net>.

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