Mercurial > p > roundup > code

annotate doc/FAQ.txt @ 5011:d5da643b3d25

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove key_in() from roundup.anypy.dbm_ The key_in() function was just a shim to use the best available option out of 'd.has_key(key)' and 'key in d'. The 'd.has_key(key)' flavour has been deprecated in favour of 'key in d' which based on testing has been available since at least python v2.5 which is the oldest being supported.
author John Kristensen <john@jerrykan.com>
date Fri, 13 Feb 2015 00:20:43 +1100
parents 609edf9de0a5
children e424987d294a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
688
b38f4f95bffd More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents: 686
diff changeset
1 ===========
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
2 Roundup FAQ
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
3 ===========
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
5 .. contents::
4890
609edf9de0a5 docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents: 4656
diff changeset
6 :local:
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
7
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
8
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
9 Installation
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
10 ------------
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
11
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
12 Living without a mailserver
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
14
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3250
diff changeset
15 Remove the nosy reactor - delete the tracker file
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
16 ``detectors/nosyreactor.py`` from your tracker home.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
17
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
19 The cgi-bin is very slow!
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
20 ~~~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
21
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
22 Yep, it sure is. It has to start up Python and load all of the support
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
23 libraries for *every* request.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
24
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3250
diff changeset
25 The solution is to use the built in server (or possibly the mod_python
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3250
diff changeset
26 or WSGI support).
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
27
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
28 To make Roundup more seamless with your website, you may place the built
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3250
diff changeset
29 in server behind apache and link it into your web tree (see below).
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
31
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
32 How do I put Roundup behind Apache
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
34
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
35 We have a project (foo) running on ``tracker.example:8080``.
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
36 We want ``http://tracker.example/issues`` to use the roundup server, so we
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
37 set that up on port 8080 on ``tracker.example`` with the ``config.ini`` line::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
38
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
39 [tracker]
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
40 ...
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
41 web = 'http://tracker.example/issues/'
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
42
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
43 We have a "foo_issues" tracker and we run the server with::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
44
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
45 roundup-server -p 8080 issues=/home/roundup/trackers/issues
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
46
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
47 Then, on the Apache machine (eg. redhat 7.3 with apache 1.3), in
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
48 ``/etc/httpd/conf/httpd.conf`` uncomment::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
49
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
50 LoadModule proxy_module modules/libproxy.so
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
51
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
52 and::
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
53
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
54 AddModule mod_proxy.c
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
55
2346
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
56 Then add::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
57
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
58 # roundup stuff (added manually)
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
59 <IfModule mod_proxy.c>
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
60 # proxy through one tracker
2346
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
61 ProxyPass /issues/ http://tracker.example:8080/issues/
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
62 # proxy through all tracker(*)
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
63 #ProxyPass /roundup/ http://tracker.example:8080/
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
64 </IfModule>
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
65
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
66 Then restart Apache. Now Apache will proxy the request on to the
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
67 roundup-server.
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
68
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
69 Note that if you're proxying multiple trackers, you'll need to use the
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
70 second ProxyPass rule described above. It will mean that your TRACKER_WEB
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
71 will change to::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
72
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
73 TRACKER_WEB = 'http://tracker.example/roundup/issues/'
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
74
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
75 Once you're done, you can firewall off port 8080 from the rest of the world.
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
76
2346
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
77 Note that in some situations (eg. virtual hosting) you might need to use a
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
78 more complex rewrite rule instead of the simpler ProxyPass above. The
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
79 following should be useful as a starting template::
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
80
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
81 # roundup stuff (added manually)
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
82 <IfModule mod_proxy.c>
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
83
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
84 RewriteEngine on
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
85
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
86 # General Roundup
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
87 RewriteRule ^/roundup$ roundup/ [R]
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
88 RewriteRule ^/roundup/(.*)$ http://tracker.example:8080/$1 [P,L]
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
89
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
90 # Handle Foo Issues
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
91 RewriteRule ^/issues$ issues/ [R]
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
92 RewriteRule ^/issues/(.*)$ http://tracker.example:8080/issues/$1 [P,L]
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
93
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
94 </IfModule>
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
95
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
96
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
97 How do I run Roundup through SSL (HTTPS)?
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
99
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
100 The preferred way of using SSL is to proxy through apache and use its
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
101 SSL service. See the previous question on how to proxy through apache.
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
102
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
103 The standalone roundup-server now also has SSL support which is still
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
104 considered experimental. For details refer to the documentation of
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
105 roundup server, in particular to the generated configuration file
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
106 generated with ::
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
107
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
108 roundup-server --save-config
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
109
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
110 that describes the needed option in detail. With the standalone server
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
111 now XMLRPC over SSL works, too.
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
112
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
113
1721
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
114 Roundup runs very slowly on my XP machine when accessed from the Internet
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
116
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
117 The issue is probably related to host name resolution for the client
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
118 performing the request. You can turn off the resolution of the names
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
119 when it's so slow like this. To do so, edit the module
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
120 roundup/scripts/roundup_server.py around line 77 to add the following
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
121 to the RoundupRequestHandler class::
1721
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
122
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
123 def address_string(self):
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
124 return self.client_address[0]
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
125
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
126
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
127 Templates
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
128 ---------
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
129
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
130 What is that stuff in the tracker html directory?
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
132
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
133 This is the template code that Roundup uses to display the various pages.
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
134 This is based upon the template markup language in Zope called, oddly
4656
bce631d8f24d issue2550738: Fixes for various documentation typos, thanks Nathan Russell
John Kristensen <john@jerrykan.com>
parents: 4567
diff changeset
135 enough, "Zope Page Templates". There's documentation in the Roundup
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
136 customisation_ documentation. For more information have a look at:
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
137
4544
007498b32775 fixed issue2550730: FAQ has broken link to Zope book.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4278
diff changeset
138 http://docs.zope.org/zope2/zope2book/
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
139
3244
9cecc6c6b297 fix reference to The Zope Book
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
140 specifically chapter 10 "Using Zope Page Templates" and chapter 14 "Advanced
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
141 Page Templates".
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
142
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
143
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
144 But I just want a select/option list for ....
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
146
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
147 Really easy... edit ``html/issue.item.html``. For ``nosy``, change the line
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
148 (around line 69) from::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
149
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
150 <span tal:replace="structure context/nosy/field" />
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
151
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
152 to::
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
153
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
154 <span tal:replace="structure context/nosy/menu" />
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
155
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
156 For ``assigned to``, this is already done around line 77::
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
157
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
158 <td tal:content="structure context/assignedto/menu">assignedto menu</td>
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
159
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
160
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
161
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
162 Great! But now the select/option list is too big
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
164
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4544
diff changeset
165 That is a little harder (but only a little ;^)
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
166
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
167 Again, edit ``html/issue.item``. For nosy, change line (around line 69) from::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
168
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
169 <span tal:replace="structure context/nosy/field" />
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
170
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
171 to::
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
172
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
173 <span tal:replace="structure python:context.nosy.menu(height=3)" />
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
174
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
175 for more information, go and read about Zope Page Templates.
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
176
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
177
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
178 Using Roundup
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
179 -------------
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
180
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4544
diff changeset
181 I got an error and I cannot reload it!
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4544
diff changeset
182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
183
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
184 If you're using Netscape/Mozilla, try holding shift and pressing reload.
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
185 If you're using IE then install Mozilla and try again ;^)
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
186
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
187
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
188 I keep getting logged out
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
189 ~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
190
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
191 Make sure that the ``tracker`` -> ``web`` setting in your tracker's
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
192 config.ini is set to the URL of the tracker.
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
193
4278
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
194 I'm getting infinite redirects in the browser
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
196
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
197 A wrong value for the ``tracker`` -> ``web`` setting may also result in
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
198 infinite redirects, see http://issues.roundup-tracker.org/issue2537286
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
199
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
200
2897
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
201 How is sorting performed, and why does it seem to fail sometimes?
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
203
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
204 When we sort items in the hyperdb, we use one of a number of methods,
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
205 depending on the properties being sorted on:
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
206
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
207 1. If it's a String, Number, Date or Interval property, we just sort the
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
208 scalar value of the property. Strings are sorted case-sensitively.
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
209 2. If it's a Link property, we sort by either the linked item's "order"
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
210 property (if it has one) or the linked item's "id".
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
211 3. Mulitlinks sort similar to #2, but we start with the first
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
212 Multilink list item, and if they're the same, we sort by the second item,
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
213 and so on.
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
214
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
215 Note that if an "order" property is defined on a Class that is used for
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
216 sorting, all items of that Class *must* have a value against the "order"
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
217 property, or sorting will result in random ordering.
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
218
1762
4c7f5d925b12 Corrected customizing url (patch [SF#791963]).
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1721
diff changeset
219 .. _`customisation`: customizing.html
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
220
Roundup Issue Tracker: http://roundup-tracker.org/