Mercurial > p > roundup > code

annotate doc/FAQ.txt @ 635:3d61b5d2243e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added popup help for classes using the classhelp html template function. - add <display call="classhelp('priority', 'id,name,description')"> to an item page, and it generates a link to a popup window which displays the id, name and description for the priority class. The description field won't exist in most installations, but it will be added to the default templates.
author Richard Jones <richard@users.sourceforge.net>
date Thu, 21 Feb 2002 06:57:39 +0000
parents 74a7d06449bf
children e429649ed124
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
1 Roundup FAQ
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
3 '$Date: 2002-02-14 11:11:36 $'
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
4
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
5 NOTE: This is just a grabbag, most of this should go into documentation.
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 Changing HTML layout
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 Note changes to the files in html take place immediatly without
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
10 restart, even when running roundup-server.
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
11
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
12 Displaying whole messages not only the summary
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
13
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
14 Modify instance/html/msg.index change::
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
15
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
16 <td><display call="plain('summary')"></td>
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
17
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
18 to::
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
19
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
20 <td><pre><display call="plain('content')"></pre></td>
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
21
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
22 displays the whole message not only the first line and 'pre'
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
23 prevents the browser from reformatting.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
24
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
25 Getting the nosy list picker instead of textfield.
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
27 In classic template there is plenty of space below the text field.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
28 So one could modify instance/html/issue.item to use it.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
29
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
30 At the file top set 'border=1' to see cell boundaries, then
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
31 replace::
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
33 <td class="form-text"><display call="field('nosy',size=20)"></td>
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
34
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
35 by::
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
36
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
37 <td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
38
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
39 and remove the last cell in the next four rows, either by deleting a cell
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
40 or by reducing colspan.
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
42 Want to see the issue id (the number) on the issue item display
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
43
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
44 The number is really a central information and not an internal one.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
45
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
46 In file INSTANCE/html/issue.item displays the creator, so one could add
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
47 the number to it.::
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
48
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
49 <td class="form-text"><display call="reldate('creation', pretty=1)">
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
50 (<display call="plain('creator')">)</td>
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
51
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
52 to see::
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
53
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
54 <td class="form-text"><display call="reldate('creation', pretty=1)">
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
55 (issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
57 Installation
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
58
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
59 Living without a mailserver.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
60
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
61 Remove the nosy reactor, means delete the file 'INSTANCE/detectors/nosyreactor.py'.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
62
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
63 Rights issues (MISSING)
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
65 Different jobs run under different users.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
66
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
67 * Standalone roundup-server is started by whome ?
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
68
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
69 * Running cgi under apache.
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
70
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
71 * roundup-mailgw called via .forward from MTA, or running a cron job
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
72 fetching via pop.
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
73
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
74 see Troubleshooting.
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
75
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
76 Troubleshooting
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
78
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
79 AttributeError: '_roundup_instance_1' module has no attribute 'open'
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
81 Sorry: in html it is not formatted correct.
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
82
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
83 For example submitting issues via roundup-mailgw breaks similar to this.::
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
85 Command died with status 1:
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
86 "/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
87 Command output: Traceback (most recent call last):
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
88 File "/usr/local/bin/roundup-mailgw", line 178, in ?
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
89 sys.exit(main(sys.argv))
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
90 File "/usr/local/bin/roundup-mailgw", line 153, in main
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
91 db = instance.open('admin')
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
92 AttributeError: '_roundup_instance_1' module has no attribute 'open'
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
93
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
94 Happens if the user which accesses the instance has no read right
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
95 on 'INSTANCE/dbinit.py' or 'pyc'.
583
dbcd04d4dd92 another sample in FAQ.txt.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 551
diff changeset
96
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
97 If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
98 but is, of course, unable to add the message. A notification to
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
99 the roundup-admin is sent, with a longer trace ending in::
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
100
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
101 File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
102 return bsddb.hashopen(file, flag, mode)
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
103 error: (13, 'Keine Berechtigung')
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
104
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
105 Replace 'Keine Berechtigung' by 'Not permitted' or ...
583
dbcd04d4dd92 another sample in FAQ.txt.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 551
diff changeset
106
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
107 An easy way to test whether it's a permissions problem, or some other mail
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
108 server configuration problem is to cat an email-formatted text file
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
109 directly to the roundup-mailgw script as the roundup user.::
596
1d9b10b0efb9 how to do without a mailserver.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 589
diff changeset
110
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
111 cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
596
1d9b10b0efb9 how to do without a mailserver.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 589
diff changeset
112
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
113 If that doesn't raise any errors, the problem is the permissions of the
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
114 MTA.
596
1d9b10b0efb9 how to do without a mailserver.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 589
diff changeset
115
Roundup Issue Tracker: http://roundup-tracker.org/