From 7a3dccd2a7a0ef64b0e0e1fb44c087b907c7a3f9 Mon Sep 17 00:00:00 2001 From: richard Date: Wed, 13 Mar 2002 23:00:48 +0000 Subject: [PATCH] More documentation cleanups: - renamed .stx to .txt so they're identifiable as readable files. - fixed FAQ and announcement formatting git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@671 57a73879-2fb5-44c3-a270-3262357dd7e2 --- README.txt | 68 ++------- doc/FAQ.stx | 125 --------------- doc/FAQ.txt | 144 ++++++++++-------- ...cknoledgements.stx => acknoledgements.txt} | 0 doc/announcement.txt | 27 ++-- doc/{customizing.stx => customizing.txt} | 0 ...etting_started.stx => getting_started.txt} | 0 doc/index.stx | 30 ---- doc/index.txt | 83 ++++++++++ doc/{installation.stx => installation.txt} | 2 +- doc/{user_guide.stx => user_guide.txt} | 0 11 files changed, 188 insertions(+), 291 deletions(-) delete mode 100644 doc/FAQ.stx rename doc/{acknoledgements.stx => acknoledgements.txt} (100%) rename doc/{customizing.stx => customizing.txt} (100%) rename doc/{getting_started.stx => getting_started.txt} (100%) delete mode 100644 doc/index.stx create mode 100644 doc/index.txt rename doc/{installation.stx => installation.txt} (99%) rename doc/{user_guide.stx => user_guide.txt} (100%) diff --git a/README.txt b/README.txt index 57745d3..d9a9642 100644 --- a/README.txt +++ b/README.txt @@ -1,9 +1,17 @@ - Roundup - ======= +Installation +============ +For installation instructions, please see installation.txt / +installation.html in the "doc" directory. -1. License -========== + +Usage and Other Information +=========================== +See the index.txt / index.html file in the "doc" directory. + + +License +======= Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) This module is free software, and you may redistribute it and/or modify @@ -25,55 +33,3 @@ SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. The stylesheet included with this package has been copied from the Zope management interface and presumably belongs to Digital Creations. - -2. Installation -=============== -For installation notes, please see the file INSTALL.TXT - - -3. Usage -======== -See the index.html file in the "doc" directory. - - -3. Design -========= -See the information in the "doc" directory. - - - -4. TODO -======= -Most of the TODO items are captured in comments in the code. In summary: - -in general: - . more unit tests - . more back-ends -hyperdb: - . more efficient reverse lookups -roundup-server: - . check the source file timestamps before reloading -cgi_client - . keep form fields in form on bad submission - only clear it if all ok - - -5. Known Bugs -============= - -date: - . date subtraction doesn't work correctly "if the dates cross leap years, - phases of the moon, ..." - - -6. Author -========= -richard@users.sourceforge.net - - -7. Thanks -========= -Well, Ping, of course ;) - -Anthony Baxter, for some good first-release feedback. And then continuing -support through development on sourceforge. - diff --git a/doc/FAQ.stx b/doc/FAQ.stx deleted file mode 100644 index d66b958..0000000 --- a/doc/FAQ.stx +++ /dev/null @@ -1,125 +0,0 @@ -Roundup FAQ -=========== - - '$Date: 2002-02-21 06:22:00 $' - - 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. - -Displaying whole messages not only the summary -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Modify instance/html/msg.index change:: - - - - to:: - -
- - displays the whole message not only the first line and 'pre' - prevents the browser from reformatting. - -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. - - At the file top set 'border=1' to see cell boundaries, then - replace:: - - - - by:: - - - - 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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - 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.:: - - - () - - to see:: - - - (issue by ) - -Installation ------------- - -Living without a mailserver. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Remove the nosy reactor, means delete the file 'INSTANCE/detectors/nosyreactor.py'. - -Rights issues (MISSING) -~~~~~~~~~~~~~~~~~~~~~~~ - - Different jobs run under different users. - - * Standalone roundup-server is started by whome ? - - * Running cgi under apache. - - * roundup-mailgw called via .forward from MTA, or running a cron job - fetching via pop. - - see Troubleshooting. - -Troubleshooting ---------------- - - -AttributeError: ''_roundup_instance_1'' module has no attribute 'open' -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Sorry: in html it is not formatted correct. - - 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' - - Happens if the user which accesses the instance has no read right - on 'INSTANCE/dbinit.py' or 'pyc'. - - 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:: - - File "/opt/python/lib/python2.2/dbhash.py", line 16, in open - return bsddb.hashopen(file, flag, mode) - error: (13, 'Keine Berechtigung') - - Replace 'Keine Berechtigung' by 'Not permitted' or ... - - 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 - - If that doesn't raise any errors, the problem is the permissions of the - MTA. - diff --git a/doc/FAQ.txt b/doc/FAQ.txt index 3b5dbec..d78da85 100644 --- a/doc/FAQ.txt +++ b/doc/FAQ.txt @@ -1,115 +1,125 @@ Roundup FAQ +=========== - '$Date: 2002-02-14 11:11:36 $' +:Date: $Date: 2002-03-13 23:00:48 $ - NOTE: This is just a grabbag, most of this should go into documentation. +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:: - + - to:: +to:: -
+
- 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:: - + - by:: +by:: - + - 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.:: - - () + + () - to see:: +to see:: - - (issue by ) + + (issue by ) Installation +------------ - Living without a mailserver. +Living without a mailserver. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Remove the nosy reactor, means delete the file 'INSTANCE/detectors/nosyreactor.py'. +Remove the nosy reactor, means delete the file +'INSTANCE/detectors/nosyreactor.py'. - Rights issues (MISSING) - Different jobs run under different users. +Rights issues (MISSING) +~~~~~~~~~~~~~~~~~~~~~~~ - * Standalone roundup-server is started by whome ? +Different jobs run under different users. - * Running cgi under apache. +* Standalone roundup-server is started by whome ? - * roundup-mailgw called via .forward from MTA, or running a cron job - fetching via pop. +* Running cgi under apache. - see Troubleshooting. +* roundup-mailgw called via .forward from MTA, or running a cron job + fetching via pop. -Troubleshooting +see Troubleshooting_. - - AttributeError: '_roundup_instance_1' module has no attribute 'open' - Sorry: in html it is not formatted correct. +Troubleshooting +--------------- + +AttributeError: '_roundup_instance_1' module has no attribute 'open' +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - For example submitting issues via roundup-mailgw breaks similar to this.:: +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' + 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' - Happens if the user which accesses the instance has no read right - on 'INSTANCE/dbinit.py' or 'pyc'. +Happens if the user which accesses the instance has no read right +on 'INSTANCE/dbinit.py' or 'pyc'. - 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:: +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:: - File "/opt/python/lib/python2.2/dbhash.py", line 16, in open - return bsddb.hashopen(file, flag, mode) - error: (13, 'Keine Berechtigung') + File "/opt/python/lib/python2.2/dbhash.py", line 16, in open + return bsddb.hashopen(file, flag, mode) + error: (13, 'Keine Berechtigung') - Replace 'Keine Berechtigung' by 'Not permitted' or ... +Replace 'Keine Berechtigung' by 'Not permitted' or ... - 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.:: +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 + cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup - If that doesn't raise any errors, the problem is the permissions of the - MTA. +If that doesn't raise any errors, the problem is the permissions of the +MTA. diff --git a/doc/acknoledgements.stx b/doc/acknoledgements.txt similarity index 100% rename from doc/acknoledgements.stx rename to doc/acknoledgements.txt diff --git a/doc/announcement.txt b/doc/announcement.txt index d3625fd..0fd0650 100644 --- a/doc/announcement.txt +++ b/doc/announcement.txt @@ -1,4 +1,6 @@ - Roundup 0.4.0 - an issue tracking system +======================================== +Roundup 0.4.0 - an issue tracking system +======================================== If you are upgrading please read MIGRATION.txt. @@ -6,18 +8,17 @@ Roundup requires python 2.1.1 for correct operation. Support for dumbdbm requires python 2.1.2 or 2.2. Big stuff in this release: - - Use of transactions to prevent partial data commits - - Zope Product front-end - - Nicer, more consistent change message generation - - Several bug fixes and more unit tests - - Much, much more: see the CHANGES file for details. + +- Use of transactions to prevent partial data commits +- Zope Product front-end +- Nicer, more consistent change message generation +- Several bug fixes and more unit tests +- Much, much more: see the CHANGES file for details. Source and documentation is available at the website: http://roundup.sourceforge.net/ - Release Info (via download page): http://sourceforge.net/projects/roundup - Mailing lists - the place to ask questions: http://sourceforge.net/mail/?group_id=31577 @@ -34,10 +35,12 @@ Note: Ping is not responsible for this project. The contact for this project is richard@users.sourceforge.net. Roundup manages a number of issues (with flexible properties such as -"description", "priority", and so on) and provides the ability to - (a) submit new issues, - (b) find and edit existing issues, and - (c) discuss issues with other participants. +"description", "priority", and so on) and provides the ability to: + +(a) submit new issues, +(b) find and edit existing issues, and +(c) discuss issues with other participants. + The system will facilitate communication among the participants by managing discussions and notifying interested parties when issues are edited. One of the major design goals for Roundup that it be simple to get going. Roundup diff --git a/doc/customizing.stx b/doc/customizing.txt similarity index 100% rename from doc/customizing.stx rename to doc/customizing.txt diff --git a/doc/getting_started.stx b/doc/getting_started.txt similarity index 100% rename from doc/getting_started.stx rename to doc/getting_started.txt diff --git a/doc/index.stx b/doc/index.stx deleted file mode 100644 index 5734cfd..0000000 --- a/doc/index.stx +++ /dev/null @@ -1,30 +0,0 @@ -*Roundup: an Issue-Tracking System for Knowledge Workers* - -Contents -======== - -- Overview_ -- Installation_ -- `Getting Started`_ -- `User Guide`_ -- `Customising Roundup`_ -- `Roundup's Design Document`_ - -.. _Overview: overview.html -.. _Installation: installation.html -.. _`Getting Started`: getting_started.html -.. _`User Guide`: user_guide.html -.. _`Customising Roundup`: customizing.html -.. _`Roundup's Design Document`: spec.html - - -Acknowledgements -================ - -Go Ping, you rock! Also, go Bizar Software and ekit.com for letting me -implement this system on their time. - -Thanks also to the many people on the mailing list and in the sourceforge -project: Anthony Baxter, Juergen Hermann, Roch'e Compaan, Engelbert Gruber, -Titus Brown, Jeff Blaine and Patrick Ohly. - diff --git a/doc/index.txt b/doc/index.txt new file mode 100644 index 0000000..e940eae --- /dev/null +++ b/doc/index.txt @@ -0,0 +1,83 @@ +*Roundup: an Issue-Tracking System for Knowledge Workers* + +Contents +======== + +- Overview_ +- Installation_ +- `Getting Started`_ +- `User Guide`_ +- `Customising Roundup`_ +- `Roundup's Design Document`_ +- Contact_ +- Acknowledgements_ +- License_ + +.. _Overview: overview.html +.. _Installation: installation.html +.. _`Getting Started`: getting_started.html +.. _`User Guide`: user_guide.html +.. _`Customising Roundup`: customizing.html +.. _`Roundup's Design Document`: spec.html + + +Contact +======= + +For general support enquiries about usage, a mailing list is available: + + roundup-users@sourceforge.net + +If you've got a great idea for roundup, or have found a bug, please +submit +an issue to the tracker at: + + http://sourceforge.net/tracker/?group_id=31577 + +For discussions about developing or enhancing roundup: + + roundup-devel@sourceforge.net + +The admin for this project is Richard Jones: + + richard@users.sourceforge.net + +but he should only be contacted directly when none of the +above avenues of contact are suitable. + + +Acknowledgements +================ + +Go Ping, you rock! Also, go Bizar Software and ekit.com for letting me +implement this system on their time. + +Thanks also to the many people on the mailing list and in the sourceforge +project: Anthony Baxter, Juergen Hermann, Roch'e Compaan, Engelbert Gruber, +Titus Brown, Jeff Blaine and Patrick Ohly. + + +License +======= + +Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) + +This module is free software, and you may redistribute it and/or modify +under the same terms as Python, so long as this copyright message and +disclaimer are retained in their original form. + +IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR +DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OF THIS CODE, EVEN IF BIZAR SOFTWARE PTY LTD HAS BEEN +ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, +BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" +BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, +SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. + + +The stylesheet included with this package has been copied from the Zope +management interface and presumably belongs to Digital Creations. + diff --git a/doc/installation.stx b/doc/installation.txt similarity index 99% rename from doc/installation.stx rename to doc/installation.txt index 1dd5da1..46b4cdb 100644 --- a/doc/installation.stx +++ b/doc/installation.txt @@ -220,4 +220,4 @@ Next: `Getting Started`_ .. _`roundup specification`: spec.html .. _`customising roundup`: customizing.html -$Id: installation.stx,v 1.3 2002-03-09 22:46:52 richard Exp $ +$Id: installation.txt,v 1.1 2002-03-13 23:00:48 richard Exp $ diff --git a/doc/user_guide.stx b/doc/user_guide.txt similarity index 100% rename from doc/user_guide.stx rename to doc/user_guide.txt -- 2.30.2