Premiere version : mise en route du suivi.
[auf_roundup.git] / doc / implementation.txt
1 ====================
2 Implementation notes
3 ====================
4
5 :Version: $Revision: 1.6 $
6
7 [see also the roundup package docstring]
8
9 There have been some modifications to the spec. I've marked these in the
10 source with 'XXX' comments when I remember to.
11
12 In short:
13  Class.find() - may match multiple properties, uses keyword args.
14
15  Class.filter() - isn't in the spec and it's very useful to have at the
16     Class level.
17
18  CGI interface index view specifier layout part - lose the '+' from the
19     sorting arguments (it's a reserved URL character ;). Just made no
20     prefix mean ascending and '-' prefix descending.
21
22  ItemClass - renamed to IssueClass to better match it only having one
23     hypderdb class "issue". Allowing > 1 hyperdb class breaks the
24     "superseder" multilink (since it can only link to one thing, and
25     we'd want bugs to link to support and vice-versa).
26
27  template - the call="link()" is handled by special-case mechanisms in
28     my top-level CGI handler. In a nutshell, the handler looks for a
29     method on itself called 'index%s' or 'item%s' where %s is a class.
30     Most items pass on to the templating mechanism, but the file class
31     _always_ does downloading. It'll probably stay this way too...
32
33  template - call="link(property)" may be used to link "the current item"
34     (from an index) - the link text is the property specified.
35
36  template - added functions that I found very useful: List, History and
37     Submit.
38
39  template - items must specify the message lists, history, etc. Having
40     them by default was sometimes not wanted.
41
42  template - index view determines its default columns from the
43     template's ``tal:condition="request/show/<property>"`` directives.
44
45  template - menu() and field() look awfully similar now .... ;)
46
47  roundup_admin.py - the command-line tool has a lot more commands at its
48     disposal
49
50 -----------------
51
52 Back to `Table of Contents`_
53
54 .. _`Table of Contents`: index.html
55