docs editing from Jean Jordaan

Author: Richard Jones

CHANGES.txt

@@ -9,7 +9,8 @@ Fixed:
 - have Permissions only test the check function if itemid is suppled
 - modify cgi templating system to check item-level permissions in listings
 - enable batching in message and file listings
-- more documentation of security mechanisms
+- more documentation of security mechanisms (incl. sf patches 1117932,
+  1117860)
 - better unit tests for security mechanisms
 
 

doc/customizing.txt

@@ -64,20 +64,19 @@ The ``dbinit.py`` file has been split into two new files,
 ``initial_data.py`` and ``schema.py``. The contents of this file are:
 
 ``initial_data.py``
-  You don't need on of these as your tracker is already initialised.
+  You don't need one of these as your tracker is already initialised.
 
 ``schema.py``
-  The contents of the ``def open(name=None):`` function go in this file.
-
-  Copy the lines of that function (down to the next ``def`` statement) from
-  the ``dbinit.py`` file and *remove* the leading four spaces on each line
-  (if there's 8 leading spaces, only remove 4).
-
-  Remove the first few lines - those starting with ``from roundup.hyperdb
-  import ...`` and the ``db = Database(config, name)`` line.
-
-  Remove the last few lines starting with ``import detectors`` down to
-  ``return db`` inclusive.
+  Copy the body of the ``def open(name=None)`` function from your old
+  tracker's ``dbinit.py`` file to this file. As the lines you're copying
+  aren't part of a function definition anymore, one level of indentation
+  needs to be removed (remove only the leading four spaces on each
+  line). 
+
+  The first few lines -- those starting with ``from roundup.hyperdb
+  import ...`` and the ``db = Database(config, name)`` line -- don't
+  need to be copied. Neither do the last few lines -- those starting
+  with ``import detectors``, down to ``return db`` inclusive.
 
 There's a new way to write extension code for Roundup - the old
 ``interfaces.py`` file will be ignored. See the `customisation

doc/upgrading.txt

@@ -43,7 +43,7 @@ Logging of internal messages
 Roundup's previously ad-hoc logging of events has been cleaned up and is
 now configured in a single place in the tracker configuration file.
 
-The `customisation documentation`_ has more details on how this is
+The `customization documentation`_ has more details on how this is
 configured.
 
 
@@ -102,22 +102,22 @@ In both cases, the value is a valid charset name (eg. ``utf-8`` or
 
 Inside Roundup, all strings are stored and processed in utf-8.
 Unfortunately, some older browsers do not work properly with
-utf8-encoded pages (e.g. Netscape Navigator 4 displays wrong
+utf-8-encoded pages (e.g. Netscape Navigator 4 displays wrong
 characters in form fields).  This version allows to change
 the character set for http transfers.  To do so, you may add
 the following code to your ``page.html`` template::
 
  <tal:block define="uri string:${request/base}${request/env/PATH_INFO}">
-  <a tal:attributes="href python:request.indexargs_href(uri,
+  <a tal:attributes="href python:request.indexargs_url(uri,
    {'@charset':'utf-8'})">utf-8</a>
-  <a tal:attributes="href python:request.indexargs_href(uri,
+  <a tal:attributes="href python:request.indexargs_url(uri,
    {'@charset':'koi8-r'})">koi8-r</a>
  </tal:block>
 
-(substitute ``koi8-r`` with appropriate charset for your language).
+(substitute ``koi8-r`` with the appropriate charset for your language).
 Charset preference is kept in the browser cookie ``roundup_charset``.
 
-Lines ``meta http-equiv`` added to the tracker templates in version 0.6.0
+``meta http-equiv`` lines added to the tracker templates in version 0.6.0
 should be changed to include actual character set name::
 
  <meta http-equiv="Content-Type"
@@ -154,4 +154,4 @@ Web server
   The builtin web server may now perform HTTP Basic Authentication by
   itself.
 
-.. _`customisation documentation`: customizing.html
+.. _`customization documentation`: customizing.html

doc/whatsnew-0.8.txt

@@ -1,4 +1,4 @@
-#$Id: actions.py,v 1.42 2005-01-05 22:10:28 richard Exp $
+#$Id: actions.py,v 1.43 2005-02-12 00:47:17 richard Exp $
 
 import re, cgi, StringIO, urllib, Cookie, time, random
 
@@ -151,7 +151,7 @@ def handle(self):
 
             # The [1:] strips off the '?' character, it isn't part of the
             # query string.
-            url = req.indexargs_href('', {})[1:]
+            url = req.indexargs_url('', {})[1:]
 
             key = self.db.query.getkey()
             if key:
@@ -556,7 +556,7 @@ def handle(self):
             urllib.quote(self.template))
         if self.nodeid is None:
             req = templating.HTMLRequest(self.client)
-            url += '&' + req.indexargs_href('', {})[1:]
+            url += '&' + req.indexargs_url('', {})[1:]
         raise exceptions.Redirect, url
 
 class NewItemAction(EditCommon):

roundup/cgi/actions.py

@@ -39,7 +39,7 @@
       <tr class="navigation">
        <th>
         <a tal:define="prev batch/previous" tal:condition="prev"
-           tal:attributes="href python:request.indexargs_href(request.classname,
+           tal:attributes="href python:request.indexargs_url(request.classname,
            {'@template':'help', 'property': request.form['property'].value,
             'properties': request.form['properties'].value,
             '@startwith':prev.first, '@pagesize':prev.size})"
@@ -53,7 +53,7 @@
        </th>
        <th>
         <a tal:define="next batch/next" tal:condition="next"
-           tal:attributes="href python:request.indexargs_href(request.classname,
+           tal:attributes="href python:request.indexargs_url(request.classname,
            {'@template':'help', 'property': request.form['property'].value,
             'properties': request.form['properties'].value,
             '@startwith':next.first, '@pagesize':next.size})"

templates/classic/html/_generic.help.html

@@ -65,7 +65,7 @@
     <tr class="navigation">
      <th>
       <a tal:define="prev batch/previous" tal:condition="prev"
-         tal:attributes="href python:request.indexargs_href(request.classname,
+         tal:attributes="href python:request.indexargs_url(request.classname,
          {'@startwith':prev.first, '@pagesize':prev.size})"
          i18n:translate="">&lt;&lt; previous</a>
       &nbsp;
@@ -76,7 +76,7 @@
      /></th>
      <th>
       <a tal:define="next batch/next" tal:condition="next"
-         tal:attributes="href python:request.indexargs_href(request.classname,
+         tal:attributes="href python:request.indexargs_url(request.classname,
          {'@startwith':next.first, '@pagesize':next.size})"
          i18n:translate="">next &gt;&gt;</a>
       &nbsp;

templates/classic/html/issue.index.html

@@ -114,7 +114,7 @@ <h2><span metal:define-slot="body_title">body title</span></h2>
    <a tal:attributes="href string:issue?@sort=-activity&@group=priority&@filter=status,assignedto&@columns=id,activity,title,creator,status&status=-1,1,2,3,4,5,6,7&assignedto=${request/user/id}" i18n:translate="">Your Issues</a><br>
    <a tal:attributes="href string:user${request/user/id}"
     i18n:translate="">Your Details</a><br>
-   <a tal:attributes="href python:request.indexargs_href('',
+   <a tal:attributes="href python:request.indexargs_url('',
        {'@action':'logout'})" i18n:translate="">Logout</a>
   </p>
   <p class="userblock">

templates/classic/html/page.html

@@ -24,7 +24,7 @@
     address=admin_email, roles='Admin')
 user.create(username="anonymous", roles='Anonymous')
 
-# add any additional database create steps here - but only if you
+# add any additional database creation steps here - but only if you
 # haven't initialised the database with the admin "initialise" command
 
 

templates/classic/initial_data.py

@@ -39,7 +39,7 @@
       <tr class="navigation">
        <th>
         <a tal:define="prev batch/previous" tal:condition="prev"
-           tal:attributes="href python:request.indexargs_href(request.classname,
+           tal:attributes="href python:request.indexargs_url(request.classname,
            {'@template':'help', 'property': request.form['property'].value,
             'properties': request.form['properties'].value,
             '@startwith':prev.first, '@pagesize':prev.size})"
@@ -53,7 +53,7 @@
        </th>
        <th>
         <a tal:define="next batch/next" tal:condition="next"
-           tal:attributes="href python:request.indexargs_href(request.classname,
+           tal:attributes="href python:request.indexargs_url(request.classname,
            {'@template':'help', 'property': request.form['property'].value,
             'properties': request.form['properties'].value,
             '@startwith':next.first, '@pagesize':next.size})"