Mercurial > p > roundup > code
annotate doc/FAQ.txt @ 5695:3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
interface and link to rest doc to features page. Add link to xmlrpc
doc to features page. Add rest doc to index. Update rest doc,
hopefully clarify confusing use of parameters in patch action
section. Fix code examples in "Adding new rest endpoints" section. Fix
example adding import of exception.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 07 Apr 2019 20:17:52 -0400 |
| parents | 0df5f9eeefd4 |
| children | 4c0cdfe4f678 |
| 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 | 12 Living without a mailserver |
| 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 | 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 | 19 The cgi-bin is very slow! |
| 20 ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
|
610
8ba4f914de83
reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents:
596
diff
changeset
|
21 |
| 1585 | 22 Yep, it sure is. It has to start up Python and load all of the support |
| 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 | 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 | 32 How do I put Roundup behind Apache |
| 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 | 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 | 47 Then, on the Apache machine (eg. redhat 7.3 with apache 1.3), in |
| 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 | 51 |
| 52 and:: | |
| 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 | 66 Then restart Apache. Now Apache will proxy the request on to the |
| 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 | 97 How do I run Roundup through SSL (HTTPS)? |
| 98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 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 | 112 |
| 113 | |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
114 Templates |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
115 --------- |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
116 |
| 1585 | 117 What is that stuff in the tracker html directory? |
| 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
119 |
| 1585 | 120 This is the template code that Roundup uses to display the various pages. |
| 121 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
|
122 enough, "Zope Page Templates". There's documentation in the Roundup |
| 1585 | 123 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
|
124 |
|
4544
007498b32775
fixed issue2550730: FAQ has broken link to Zope book.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4278
diff
changeset
|
125 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
|
126 |
|
3244
9cecc6c6b297
fix reference to The Zope Book
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
127 specifically chapter 10 "Using Zope Page Templates" and chapter 14 "Advanced |
| 1585 | 128 Page Templates". |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
129 |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
130 |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
131 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
|
132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
133 |
|
4260
493e933f6dfb
small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4036
diff
changeset
|
134 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
|
135 (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
|
136 |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
137 <span tal:replace="structure context/nosy/field" /> |
| 1585 | 138 |
| 139 to:: | |
| 140 | |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
141 <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
|
142 |
|
4260
493e933f6dfb
small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4036
diff
changeset
|
143 For ``assigned to``, this is already done around line 77:: |
| 1585 | 144 |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
145 <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
|
146 |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
147 |
|
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 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
|
150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1585 | 151 |
|
4567
32b24abfe98e
Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents:
4544
diff
changeset
|
152 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
|
153 |
|
4260
493e933f6dfb
small update about SSL (and XMLRPC)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4036
diff
changeset
|
154 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
|
155 |
| 1585 | 156 <span tal:replace="structure context/nosy/field" /> |
| 157 | |
| 158 to:: | |
| 159 | |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
160 <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
|
161 |
| 1585 | 162 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
|
163 |
|
5135
9e8d8cd49f40
removing unneeded whitespace
John Rouillard <rouilj@ieee.org>
parents:
5129
diff
changeset
|
164 I want to link version identifiers from my messages to svn/mercurial/git |
|
5129
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
166 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
167 See: the LinkFormatingExample at: |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
168 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
169 http://www.roundup-tracker.org/cgi-bin/moin.cgi/LinkFormattingExample?highlight=%28local%5C_replace%29 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
170 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
171 There are examples in the devel and responsive templates. Search for |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
172 LocalReplace to find the extension file and the change that has to be |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
173 made to the item template. |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
174 |
|
5268
cc79c0f1651d
Adding a little more doc describing that view access to the labelprop
John Rouillard <rouilj@ieee.org>
parents:
5135
diff
changeset
|
175 I can see values in a multilink but not display the items |
|
cc79c0f1651d
Adding a little more doc describing that view access to the labelprop
John Rouillard <rouilj@ieee.org>
parents:
5135
diff
changeset
|
176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
cc79c0f1651d
Adding a little more doc describing that view access to the labelprop
John Rouillard <rouilj@ieee.org>
parents:
5135
diff
changeset
|
177 |
|
cc79c0f1651d
Adding a little more doc describing that view access to the labelprop
John Rouillard <rouilj@ieee.org>
parents:
5135
diff
changeset
|
178 Make sure that you have allowed the user to view the labelprop for the |
|
cc79c0f1651d
Adding a little more doc describing that view access to the labelprop
John Rouillard <rouilj@ieee.org>
parents:
5135
diff
changeset
|
179 multilink class. Look for the setlabelprop explanation in the Roundup |
|
cc79c0f1651d
Adding a little more doc describing that view access to the labelprop
John Rouillard <rouilj@ieee.org>
parents:
5135
diff
changeset
|
180 customisation_ documentation. |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
181 |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
182 Using Roundup |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
183 ------------- |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
184 |
|
4567
32b24abfe98e
Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents:
4544
diff
changeset
|
185 I got an error and I cannot reload it! |
|
32b24abfe98e
Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents:
4544
diff
changeset
|
186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
187 |
| 1585 | 188 If you're using Netscape/Mozilla, try holding shift and pressing reload. |
| 189 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
|
190 |
|
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
191 |
| 1585 | 192 I keep getting logged out |
| 193 ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
194 |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2897
diff
changeset
|
195 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
|
196 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
|
197 |
|
4278
b7c74999947f
- Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4260
diff
changeset
|
198 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
|
199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
b7c74999947f
- Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4260
diff
changeset
|
200 |
|
b7c74999947f
- Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4260
diff
changeset
|
201 A wrong value for the ``tracker`` -> ``web`` setting may also result in |
|
5610
0df5f9eeefd4
Changed references to http://issues.roundup-tracker.org to https now
John Rouillard <rouilj@ieee.org>
parents:
5268
diff
changeset
|
202 infinite redirects, see https://issues.roundup-tracker.org/issue2537286 |
|
4278
b7c74999947f
- Fix issue2537286 (documentation added to FAQ)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4260
diff
changeset
|
203 |
|
1584
2090f2004ee3
Added some stuff that hit me to the FAQ.txt:
Cameron Blackwood <drkorg@users.sourceforge.net>
parents:
1304
diff
changeset
|
204 |
|
2897
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
205 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
|
206 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
207 |
|
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
208 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
|
209 depending on the properties being sorted on: |
|
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
210 |
|
5067
e424987d294a
Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
211 1. If it's a String, Integer, Number, Date or Interval property, we |
|
e424987d294a
Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
212 just sort the scalar value of the property. Strings are sorted |
|
e424987d294a
Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
213 case-sensitively. |
|
2897
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
214 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
|
215 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
|
216 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
|
217 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
|
218 and so on. |
|
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
219 |
|
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
220 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
|
221 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
|
222 property, or sorting will result in random ordering. |
|
21a0b049fed8
notes about sorting
Richard Jones <richard@users.sourceforge.net>
parents:
2346
diff
changeset
|
223 |
|
5129
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
224 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
225 How do I filter roundup emails? |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
227 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
228 When roundup emails users, it provides an email header:: |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
229 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
230 X-Roundup-(class)-(property): values |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
231 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
232 for every property that is a link or multilink (usually things |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
233 set by a dropdown or selection in the web interface). |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
234 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
235 For example, assume you have a category field for issues in your tracker. |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
236 You respond to issues that fall into the catagories: Network and Security. |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
237 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
238 You will see headers like: |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
239 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
240 X-Roundup-issue-category: Network |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
241 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
242 or |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
243 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
244 X-Roundup-issue-category: Network, Security, Linux |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
245 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
246 Then you can set up a filter looking for X-Roundup-issue-category |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
247 followed by Network or Security in your mail program. Directions on |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
248 using your mail program ae beyond the scope of theis FAQ entry. |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
249 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
250 (If you don't see a header for a multilink or link property, look for |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
251 msg_header_property in the roundup docs. In some cases you have to |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
252 explicitly enable the header.) |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
253 |
|
0786c62edf12
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
254 |
|
1762
4c7f5d925b12
Corrected customizing url (patch [SF#791963]).
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1721
diff
changeset
|
255 .. _`customisation`: customizing.html |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
256 |
