X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2FFAQ.txt;h=f03e86682d6ced0cc889f5e1e177fbfcd6508c3d;hb=a1e34f0acaeb885e6b847dc7827775a91f1ca146;hp=3b5dbecea8d4cef8ab26fb4d7dd30b3c7ab41637;hpb=10aca513a28ea50e4fdfac6e274850e600aaf477;p=roundup.git

diff --git a/doc/FAQ.txt b/doc/FAQ.txt
index 3b5dbec..f03e866 100644
--- a/doc/FAQ.txt
+++ b/doc/FAQ.txt
@@ -1,115 +1,135 @@
+===========
 Roundup FAQ
+===========
 
-  '$Date: 2002-02-14 11:11:36 $'
+:Version: $Revision: 1.9 $
+
+NOTE: This is just a grabbag, most of this should go into documentation.
+
+.. contents::
 
-  NOTE: This is just a grabbag, most of this should go into documentation.
 
 Changing HTML layout
+--------------------
 
-  Note changes to the files in html take place immediatly without
-  restart, even when running roundup-server.
+Note changes to the files in html take place immediatly without
+restart, even when running roundup-server.
 
-  Displaying whole messages not only the summary
+Displaying whole messages not only the summary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Modify instance/html/msg.index change::
+Modify instance/html/msg.index change::
 
-      <td><display call="plain('summary')"></td>
+   <td><display call="plain('summary')"></td>
 
-    to::
+to::
 
-      <td><pre><display call="plain('content')"></pre></td>
+   <td><pre><display call="plain('content')"></pre></td>
 
-    displays the whole message not only the first line and 'pre'
-    prevents the browser from reformatting. 
+displays the whole message not only the first line and 'pre'
+prevents the browser from reformatting. 
 
-  Getting the nosy list picker instead of textfield.
+Getting the nosy list picker instead of textfield
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    In classic template there is plenty of space below the text field.
-    So one could modify instance/html/issue.item to use it.
+In classic template there is plenty of space below the text field.
+So one could modify instance/html/issue.item to use it.
 
-    At the file top set 'border=1' to see cell boundaries, then
-    replace::
+At the file top set 'border=1' to see cell boundaries, then
+replace::
 
-      <td class="form-text"><display call="field('nosy',size=20)"></td>
+  <td class="form-text"><display call="field('nosy',size=20)"></td>
   
-    by::
+by::
 
-      <td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
+  <td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
 
-    and remove the last cell in the next four rows, either by deleting a cell
-    or by reducing colspan.
+and remove the last cell in the next four rows, either by deleting a cell
+or by reducing colspan.
 
-  Want to see the issue id (the number) on the issue item display
+Want to see the issue id (the number) on the issue item display
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    The number is really a central information and not an internal one.
+The number is really a central information and not an internal one.
 
-    In file INSTANCE/html/issue.item displays the creator, so one could add
-    the number to it.::
+In file INSTANCE/html/issue.item displays the creator, so one could add
+the number to it.::
 
-      <td class="form-text"><display call="reldate('creation', pretty=1)">
-          (<display call="plain('creator')">)</td>
+  <td class="form-text"><display call="reldate('creation', pretty=1)">
+      (<display call="plain('creator')">)</td>
 
-    to see::
+to see::
 
-      <td class="form-text"><display call="reldate('creation', pretty=1)">
-          (issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
+  <td class="form-text"><display call="reldate('creation', pretty=1)">
+      (issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
 
 Installation
+------------
+
+Living without a mailserver.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Remove the nosy reactor, means delete the file
+'INSTANCE/detectors/nosyreactor.py'.
 
-  Living without a mailserver.
 
-    Remove the nosy reactor, means delete the file 'INSTANCE/detectors/nosyreactor.py'.
+Rights issues (MISSING)
+~~~~~~~~~~~~~~~~~~~~~~~
 
-  Rights issues (MISSING)
+Different jobs run under different users.
 
-    Different jobs run under different users.
+* Standalone roundup-server is started by whome ?
 
-    * Standalone roundup-server is started by whome ?
+* Running cgi under apache.
 
-    * Running cgi under apache.
+* roundup-mailgw called via .forward from MTA, or running a cron job
+  fetching via pop.
 
-    * roundup-mailgw called via .forward from MTA, or running a cron job
-      fetching via pop.
+see Troubleshooting_.
 
-    see Troubleshooting.
 
 Troubleshooting
+---------------
 
-  
-  AttributeError: '_roundup_instance_1' module has no attribute 'open'
+AttributeError: '_roundup_instance_1' module has no attribute 'open'
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For example submitting issues via roundup-mailgw breaks similar to this::
+
+  Command died with status 1:
+  "/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
+  Command output: Traceback (most recent call last):  
+    File "/usr/local/bin/roundup-mailgw", line 178, in ? 
+       sys.exit(main(sys.argv))
+    File "/usr/local/bin/roundup-mailgw", line 153, in main 
+      db = instance.open('admin')
+       AttributeError: '_roundup_instance_1' module has no attribute 'open'
 
-    Sorry: in html it is not formatted correct.
+Happens if the user which accesses the instance has no read right
+on 'INSTANCE/dbinit.py' or 'pyc'. 
 
-    For example submitting issues via roundup-mailgw breaks similar to this.::
+If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
+but is, of course, unable to add the message. A notification to
+the roundup-admin is sent, with a longer trace ending in::
 
-      Command died with status 1:
-      "/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
-      Command output: Traceback (most recent call last):  
-        File "/usr/local/bin/roundup-mailgw", line 178, in ? 
-           sys.exit(main(sys.argv))
-        File "/usr/local/bin/roundup-mailgw", line 153, in main 
-          db = instance.open('admin')
-           AttributeError: '_roundup_instance_1' module has no attribute 'open'
+  File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
+    return bsddb.hashopen(file, flag, mode)
+  error: (13, 'Keine Berechtigung')
 
-    Happens if the user which accesses the instance has no read right
-    on 'INSTANCE/dbinit.py' or 'pyc'. 
+Replace 'Keine Berechtigung' by 'Not permitted' or ...
 
-    If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
-    but is, of course, unable to add the message. A notification to
-    the roundup-admin is sent, with a longer trace ending in::
+An easy way to test whether it's a permissions problem, or some other mail
+server configuration problem is to cat an email-formatted text file
+directly to the roundup-mailgw script as the roundup user.::
 
-      File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
-        return bsddb.hashopen(file, flag, mode)
-      error: (13, 'Keine Berechtigung')
+  cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
 
-    Replace 'Keine Berechtigung' by 'Not permitted' or ...
+If that doesn't raise any errors, the problem is the permissions of the
+MTA. 
 
-    An easy way to test whether it's a permissions problem, or some other mail
-    server configuration problem is to cat an email-formatted text file
-    directly to the roundup-mailgw script as the roundup user.::
+-----------------
 
-      cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
+Back to `Table of Contents`_
 
-    If that doesn't raise any errors, the problem is the permissions of the
-    MTA. 
+.. _`Table of Contents`: index.html