Mercurial > p > roundup > code

annotate doc/FAQ.txt @ 4587:a2eb4fb3e6d8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
New Chameleon templating engine, engine is now configurable. We now have two configurable templating engines, the old Zope TAL templates (called zopetal in the config) and the new Chameleon (called chameleon in the config). A new config-option "template_engine" under [main] can take these config-options, the default is zopetal. Thanks to Cheer Xiao for the idea of making this configurable *and* for the actual implementation! Cheer Xiao commit log: - The original TAL engine ported from Zope is thereafter referred to as "zopetal", in speech and in code - A new option "template_engine" under [main] introduced - Zopetal-specific code stripped from cgi/templating.py to form the new cgi/engine_zopetal.py - Interface to Chameleon in cgi/engine_chameleon.py - Engines are supposed to provide a Templates class that mimics the behavior of the old cgi.templating.Templates. The Templates class is preferably subclassed from cgi.templating.TemplatesBase. - New function cgi.templating.get_templates to get the appropriate engine's Templates instance according to the engine name
author Ralf Schlatterbeck <rsc@runtux.com>
date Thu, 23 Feb 2012 18:10:03 +0100
parents 32b24abfe98e
children bce631d8f24d
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::
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
6
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
7
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
8 Installation
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
9 ------------
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
10
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
11 Living without a mailserver
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
12 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
13
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3250
diff changeset
14 Remove the nosy reactor - delete the tracker file
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
15 ``detectors/nosyreactor.py`` from your tracker home.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
16
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
18 The cgi-bin is very slow!
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
19 ~~~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
20
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
21 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
22 libraries for *every* request.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
23
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3250
diff changeset
24 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
25 or WSGI support).
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
26
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
27 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
28 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
29
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
30
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
31 How do I put Roundup behind Apache
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
33
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
34 We have a project (foo) running on ``tracker.example:8080``.
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
35 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
36 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
37
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
38 [tracker]
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
39 ...
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
40 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
41
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
42 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
43
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
44 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
45
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
46 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
47 ``/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
48
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
49 LoadModule proxy_module modules/libproxy.so
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
50
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
51 and::
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
52
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
53 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
54
2346
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
55 Then add::
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
56
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
57 # 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
58 <IfModule mod_proxy.c>
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
59 # 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
60 ProxyPass /issues/ http://tracker.example:8080/issues/
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
61 # proxy through all tracker(*)
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
62 #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
63 </IfModule>
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
64
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
65 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
66 roundup-server.
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
67
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
68 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
69 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
70 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
71
2338
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
72 TRACKER_WEB = 'http://tracker.example/roundup/issues/'
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
73
d9a6918aafd5 simpler proxy instructions
Richard Jones <richard@users.sourceforge.net>
parents: 2054
diff changeset
74 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
75
2346
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
76 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
77 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
78 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
79
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
80 # roundup stuff (added manually)
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
81 <IfModule mod_proxy.c>
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
82
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
83 RewriteEngine on
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
84
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
85 # General Roundup
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
86 RewriteRule ^/roundup$ roundup/ [R]
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
87 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
88
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
89 # Handle Foo Issues
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
90 RewriteRule ^/issues$ issues/ [R]
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
91 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
92
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
93 </IfModule>
87dc03fa9d80 keep the rewrites - some people need to use them
Richard Jones <richard@users.sourceforge.net>
parents: 2338
diff changeset
94
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
95
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
96 How do I run Roundup through SSL (HTTPS)?
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
98
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
99 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
100 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
101
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
102 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
103 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
104 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
105 generated with ::
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
106
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
107 roundup-server --save-config
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
108
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
109 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
110 now XMLRPC over SSL works, too.
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
111
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3244
diff changeset
112
1721
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
113 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
114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 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
117 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
118 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
119 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
120 to the RoundupRequestHandler class::
1721
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
121
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
122 def address_string(self):
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
123 return self.client_address[0]
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
124
ed2c4f5a27da add xp lookup slowness
Richard Jones <richard@users.sourceforge.net>
parents: 1585
diff changeset
125
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
126 Templates
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
127 ---------
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
128
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
129 What is that stuff in the tracker html directory?
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
131
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
132 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
133 This is based upon the template markup language in Zope called, oddly
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
134 enough "Zope Page Templates". There's documentation in the Roundup
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
135 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
136
4544
007498b32775 fixed issue2550730: FAQ has broken link to Zope book.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4278
diff changeset
137 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
138
3244
9cecc6c6b297 fix reference to The Zope Book
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
139 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
140 Page Templates".
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
141
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 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
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
145
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
146 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
147 (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
148
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
149 <span tal:replace="structure context/nosy/field" />
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
150
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
151 to::
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
152
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
153 <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
154
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
155 For ``assigned to``, this is already done around line 77::
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
156
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
157 <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
158
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 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
162 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
163
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4544
diff changeset
164 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
165
4260
493e933f6dfb small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
166 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
167
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
168 <span tal:replace="structure context/nosy/field" />
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
169
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
170 to::
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
171
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
172 <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
173
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
174 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
175
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 Using Roundup
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
178 -------------
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
179
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4544
diff changeset
180 I got an error and I cannot reload it!
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4544
diff changeset
181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
182
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
183 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
184 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
185
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
186
1585
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
187 I keep getting logged out
1cfffe2f54c2 edited FAQ
Richard Jones <richard@users.sourceforge.net>
parents: 1584
diff changeset
188 ~~~~~~~~~~~~~~~~~~~~~~~~~
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
189
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2897
diff changeset
190 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
191 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
192
4278
b7c74999947f - Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4260
diff changeset
193 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
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 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
197 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
198
1584
2090f2004ee3 Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1304
diff changeset
199
2897
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
200 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
201 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 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
204 depending on the properties being sorted on:
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
205
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
206 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
207 scalar value of the property. Strings are sorted case-sensitively.
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
208 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
209 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
210 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
211 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
212 and so on.
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
213
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
214 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
215 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
216 property, or sorting will result in random ordering.
21a0b049fed8 notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents: 2346
diff changeset
217
1762
4c7f5d925b12 Corrected customizing url (patch [SF#791963]).
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1721
diff changeset
218 .. _`customisation`: customizing.html
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
219
Roundup Issue Tracker: http://roundup-tracker.org/