Skip to content

Commit 2a92145

Browse files
author
Richard Jones
committed
More documentation cleanups.
 - renamed .stx to .txt so they're identifiable as readable files. - fixed FAQ and announcement formatting
1 parent 49b3428 commit 2a92145

File tree

11 files changed

+188
-291
lines changed

11 files changed

+188
-291
lines changed

‎README.txt‎

Lines changed: 12 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
Roundup
2-
=======
31

2+
Installation
3+
============
4+
For installation instructions, please see installation.txt /
5+
installation.html in the "doc" directory.
46

5-
1. License
6-
==========
7+
8+
Usage and Other Information
9+
===========================
10+
See the index.txt / index.html file in the "doc" directory.
11+
12+
13+
License
14+
=======
715

816
Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
917
This module is free software, and you may redistribute it and/or modify
@@ -25,55 +33,3 @@ SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
2533
The stylesheet included with this package has been copied from the Zope
2634
management interface and presumably belongs to Digital Creations.
2735

28-
29-
2. Installation
30-
===============
31-
For installation notes, please see the file INSTALL.TXT
32-
33-
34-
3. Usage
35-
========
36-
See the index.html file in the "doc" directory.
37-
38-
39-
3. Design
40-
=========
41-
See the information in the "doc" directory.
42-
43-
44-
45-
4. TODO
46-
=======
47-
Most of the TODO items are captured in comments in the code. In summary:
48-
49-
in general:
50-
. more unit tests
51-
. more back-ends
52-
hyperdb:
53-
. more efficient reverse lookups
54-
roundup-server:
55-
. check the source file timestamps before reloading
56-
cgi_client
57-
. keep form fields in form on bad submission - only clear it if all ok
58-
59-
60-
5. Known Bugs
61-
=============
62-
63-
date:
64-
. date subtraction doesn't work correctly "if the dates cross leap years,
65-
phases of the moon, ..."
66-
67-
68-
6. Author
69-
=========
70-
[email protected]
71-
72-
73-
7. Thanks
74-
=========
75-
Well, Ping, of course ;)
76-
77-
Anthony Baxter, for some good first-release feedback. And then continuing
78-
support through development on sourceforge.
79-

‎doc/FAQ.stx‎

Lines changed: 0 additions & 125 deletions
This file was deleted.

‎doc/FAQ.txt‎

Lines changed: 77 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,125 @@
11
Roundup FAQ
2+
===========
23

3-
'$Date: 2002-02-14 11:11:36 $'
4+
:Date: $Date: 2002-03-13 23:00:48 $
45

5-
NOTE: This is just a grabbag, most of this should go into documentation.
6+
NOTE: This is just a grabbag, most of this should go into documentation.
67

78
Changing HTML layout
9+
--------------------
810

9-
Note changes to the files in html take place immediatly without
10-
restart, even when running roundup-server.
11+
Note changes to the files in html take place immediatly without
12+
restart, even when running roundup-server.
1113

12-
Displaying whole messages not only the summary
14+
Displaying whole messages not only the summary
15+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1316

14-
Modify instance/html/msg.index change::
17+
Modify instance/html/msg.index change::
1518

16-
<td><display call="plain('summary')"></td>
19+
<td><display call="plain('summary')"></td>
1720

18-
to::
21+
to::
1922

20-
<td><pre><display call="plain('content')"></pre></td>
23+
<td><pre><display call="plain('content')"></pre></td>
2124

22-
displays the whole message not only the first line and 'pre'
23-
prevents the browser from reformatting.
25+
displays the whole message not only the first line and 'pre'
26+
prevents the browser from reformatting.
2427

25-
Getting the nosy list picker instead of textfield.
28+
Getting the nosy list picker instead of textfield
29+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2630

27-
In classic template there is plenty of space below the text field.
28-
So one could modify instance/html/issue.item to use it.
31+
In classic template there is plenty of space below the text field.
32+
So one could modify instance/html/issue.item to use it.
2933

30-
At the file top set 'border=1' to see cell boundaries, then
31-
replace::
34+
At the file top set 'border=1' to see cell boundaries, then
35+
replace::
3236

33-
<td class="form-text"><display call="field('nosy',size=20)"></td>
37+
<td class="form-text"><display call="field('nosy',size=20)"></td>
3438

35-
by::
39+
by::
3640

37-
<td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
41+
<td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
3842

39-
and remove the last cell in the next four rows, either by deleting a cell
40-
or by reducing colspan.
43+
and remove the last cell in the next four rows, either by deleting a cell
44+
or by reducing colspan.
4145

42-
Want to see the issue id (the number) on the issue item display
46+
Want to see the issue id (the number) on the issue item display
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4348

44-
The number is really a central information and not an internal one.
49+
The number is really a central information and not an internal one.
4550

46-
In file INSTANCE/html/issue.item displays the creator, so one could add
47-
the number to it.::
51+
In file INSTANCE/html/issue.item displays the creator, so one could add
52+
the number to it.::
4853

49-
<td class="form-text"><display call="reldate('creation', pretty=1)">
50-
(<display call="plain('creator')">)</td>
54+
<td class="form-text"><display call="reldate('creation', pretty=1)">
55+
(<display call="plain('creator')">)</td>
5156

52-
to see::
57+
to see::
5358

54-
<td class="form-text"><display call="reldate('creation', pretty=1)">
55-
(issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
59+
<td class="form-text"><display call="reldate('creation', pretty=1)">
60+
(issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
5661

5762
Installation
63+
------------
5864

59-
Living without a mailserver.
65+
Living without a mailserver.
66+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6067

61-
Remove the nosy reactor, means delete the file 'INSTANCE/detectors/nosyreactor.py'.
68+
Remove the nosy reactor, means delete the file
69+
'INSTANCE/detectors/nosyreactor.py'.
6270

63-
Rights issues (MISSING)
6471

65-
Different jobs run under different users.
72+
Rights issues (MISSING)
73+
~~~~~~~~~~~~~~~~~~~~~~~
6674

67-
* Standalone roundup-server is started by whome ?
75+
Different jobs run under different users.
6876

69-
* Running cgi under apache.
77+
* Standalone roundup-server is started by whome ?
7078

71-
* roundup-mailgw called via .forward from MTA, or running a cron job
72-
fetching via pop.
79+
* Running cgi under apache.
7380

74-
see Troubleshooting.
81+
* roundup-mailgw called via .forward from MTA, or running a cron job
82+
fetching via pop.
7583

76-
Troubleshooting
84+
see Troubleshooting_.
7785

78-
79-
AttributeError: '_roundup_instance_1' module has no attribute 'open'
8086

81-
Sorry: in html it is not formatted correct.
87+
Troubleshooting
88+
---------------
89+
90+
AttributeError: '_roundup_instance_1' module has no attribute 'open'
91+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8292

83-
For example submitting issues via roundup-mailgw breaks similar to this.::
93+
For example submitting issues via roundup-mailgw breaks similar to this::
8494

85-
Command died with status 1:
86-
"/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
87-
Command output: Traceback (most recent call last):
88-
File "/usr/local/bin/roundup-mailgw", line 178, in ?
89-
sys.exit(main(sys.argv))
90-
File "/usr/local/bin/roundup-mailgw", line 153, in main
91-
db = instance.open('admin')
92-
AttributeError: '_roundup_instance_1' module has no attribute 'open'
95+
Command died with status 1:
96+
"/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
97+
Command output: Traceback (most recent call last):
98+
File "/usr/local/bin/roundup-mailgw", line 178, in ?
99+
sys.exit(main(sys.argv))
100+
File "/usr/local/bin/roundup-mailgw", line 153, in main
101+
db = instance.open('admin')
102+
AttributeError: '_roundup_instance_1' module has no attribute 'open'
93103

94-
Happens if the user which accesses the instance has no read right
95-
on 'INSTANCE/dbinit.py' or 'pyc'.
104+
Happens if the user which accesses the instance has no read right
105+
on 'INSTANCE/dbinit.py' or 'pyc'.
96106

97-
If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
98-
but is, of course, unable to add the message. A notification to
99-
the roundup-admin is sent, with a longer trace ending in::
107+
If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
108+
but is, of course, unable to add the message. A notification to
109+
the roundup-admin is sent, with a longer trace ending in::
100110

101-
File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
102-
return bsddb.hashopen(file, flag, mode)
103-
error: (13, 'Keine Berechtigung')
111+
File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
112+
return bsddb.hashopen(file, flag, mode)
113+
error: (13, 'Keine Berechtigung')
104114

105-
Replace 'Keine Berechtigung' by 'Not permitted' or ...
115+
Replace 'Keine Berechtigung' by 'Not permitted' or ...
106116

107-
An easy way to test whether it's a permissions problem, or some other mail
108-
server configuration problem is to cat an email-formatted text file
109-
directly to the roundup-mailgw script as the roundup user.::
117+
An easy way to test whether it's a permissions problem, or some other mail
118+
server configuration problem is to cat an email-formatted text file
119+
directly to the roundup-mailgw script as the roundup user.::
110120

111-
cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
121+
cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
112122

113-
If that doesn't raise any errors, the problem is the permissions of the
114-
MTA.
123+
If that doesn't raise any errors, the problem is the permissions of the
124+
MTA.
115125

doc/acknoledgements.stx renamed to doc/acknoledgements.txt

File renamed without changes.

0 commit comments

Comments
 (0)