Mercurial Repository: p/roundup/code: doc/customizing.txt comparison

comparison doc/customizing.txt @ 3039:70c9954f619f maint-0.8

formatting fixes

author	Richard Jones <richard@users.sourceforge.net>
date	Mon, 03 Jan 2005 23:07:03 +0000
parents	714f2a60a97e
children	abdeb9b0e53a

comparison

equal deleted inserted replaced

-:714f2a60a97e
+:70c9954f619f
 ===================
 Customising Roundup
 ===================
-:Version: $Revision: 1.161.2.1 $
+:Version: $Revision: 1.161.2.2 $
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
 .. contents::
 Tracker Schema
 ==============
-Note: if you modify the schema, you'll most likely need to edit the
+.. note::
-`web interface`_ HTML template files and `detectors`_ to reflect
+if you modify the schema, you'll most likely need to edit the
-your changes.
+`web interface`_ HTML template files and `detectors`_ to reflect
+your changes.
 A tracker schema defines what data is stored in the tracker's database.
 Schemas are defined using Python code in the ``schema.py`` module of your
 tracker.
 Database Content
 ================
-Note: if you modify the content of definitional classes, you'll most
+.. note::
-likely need to edit the tracker `detectors`_ to reflect your
+if you modify the content of definitional classes, you'll most
-changes.
+likely need to edit the tracker `detectors`_ to reflect your changes.
 Customisation of the special "definitional" classes (eg. status,
 priority, resolution, ...) may be done either before or after the
 tracker is initialised. The actual method of doing so is completely
 different in each case though, so be careful to use the right one.
 **automatic registration of users in the e-mail gateway**
 By giving the "anonymous" user the "Email Registration" Role, any
 unidentified user will automatically be registered with the tracker
 (with no password, so they won't be able to log in through the web
-until an admin sets their password). Note: this is the default
+until an admin sets their password). This is the default behaviour
-behaviour in the tracker templates that ship with Roundup.
+in the tracker templates that ship with Roundup.
 **anonymous access through the e-mail gateway**
 Give the "anonymous" user the "Email Access" and ("Edit", "issue")
 Roles but do not not give them the "Email Registration" Role. This
 means that when an unknown user sends email into the tracker, they're
 **style.css.html**
 a static file that is served up as-is
 The *classic* template has a number of additional templates.
-Note: Remember that you can create any template extension you want to,
+Remember that you can create any template extension you want to,
 so if you just want to play around with the templating for new issues,
 you can copy the current "issue.item" template to "issue.test", and then
 access the test template using the "@template" URL argument::
 http://your.tracker.example/tracker/issue?@template=test
 http://dev.zope.org/Wikis/DevSite/Projects/ZPT/METAL%20Specification%201.0
 Information available to templates
 ----------------------------------
-Note: this is implemented by
+This is implemented by ``roundup.cgi.templating.RoundupPageTemplate``
-``roundup.cgi.templating.RoundupPageTemplate``
 The following variables are available to templates.
 **context**
 The current context. This is either None, a `hyperdb class wrapper`_
 "context/id".
 Hyperdb class wrapper
 :::::::::::::::::::::
-Note: this is implemented by the ``roundup.cgi.templating.HTMLClass``
+This is implemented by the ``roundup.cgi.templating.HTMLClass``
 class.
 This wrapper object provides access to a hyperb class. It is used
 primarily in both index view and new item views, but it's also usable
 anywhere else that you wish to access information about a class, or the
 Hyperdb item wrapper
 ::::::::::::::::::::
-Note: this is implemented by the ``roundup.cgi.templating.HTMLItem``
+This is implemented by the ``roundup.cgi.templating.HTMLItem``
 class.
 This wrapper object provides access to a hyperb item.
 We allow access to properties. There will be no "id" property. The value
 Hyperdb property wrapper
 ::::::::::::::::::::::::
-Note: this is implemented by subclasses of the
+This is implemented by subclasses of the
 ``roundup.cgi.templating.HTMLProperty`` class (``HTMLStringProperty``,
 ``HTMLNumberProperty``, and so on).
 This wrapper object provides access to a single property of a class. Its
 value may be either:
 The request variable
 ~~~~~~~~~~~~~~~~~~~~
-Note: this is implemented by the ``roundup.cgi.templating.HTMLRequest``
+This is implemented by the ``roundup.cgi.templating.HTMLRequest``
 class.
 The request variable is packed with information about the current
 request.
 The db variable
 ~~~~~~~~~~~~~~~
-Note: this is implemented by the ``roundup.cgi.templating.HTMLDatabase``
+This is implemented by the ``roundup.cgi.templating.HTMLDatabase``
 class.
 Allows access to all hyperdb classes as attributes of this variable. If
 you want access to the "user" class, for example, you would use::
 The templates variable
 ~~~~~~~~~~~~~~~~~~~~~~
-Note: this is implemented by the ``roundup.cgi.templating.Templates``
+This is implemented by the ``roundup.cgi.templating.Templates``
 class.
 This variable doesn't have any useful methods defined. It supports being
 used in expressions to access the templates, and consequently the
 template macros. You may access the templates using the following path
 The utils variable
 ~~~~~~~~~~~~~~~~~~
-Note: this is implemented by the
+This is implemented by the
 ``roundup.cgi.templating.TemplatingUtils`` class, but it may be extended
 as described below.
 =============== ========================================================
 Method          Description
 addition, it has several more attributes:
 =============== ========================================================
 Attribute       Description
 =============== ========================================================
-start           indicates the start index of the batch. *Note: unlike
+start           indicates the start index of the batch. *Unlike
 the argument, is a 1-based index (I know, lame)*
 first           indicates the start index of the batch *as a 0-based
 index*
 length          the actual number of elements in the batch
 sequence_length the length of the original, unbatched, sequence.
 Searching Views
 ---------------
-Note: if you add a new column to the ``@columns`` form variable
+.. note::
-potentials then you will need to add the column to the appropriate
+if you add a new column to the ``@columns`` form variable potentials
-`index views`_ template so that it is actually displayed.
+then you will need to add the column to the appropriate `index views`_
+template so that it is actually displayed.
 This is one of the class context views. The template used is typically
 "*classname*.search". The form on this page should have "search" as its
 ``@action`` variable. The "search" action:
 <a href="issue?:sort=-activity&:group=priority&:filter=status,blockers&
 blockers=-1&:columns=id,activity,title,creator,assignedto,status&
 status=-1,1,2,3,4,5,6,7">Show All</a><br>
-:Note: the above examples are line-wrapped on the trailing & and should
+The above examples are line-wrapped on the trailing & and should
 be unwrapped.
 That's it. You should now be able to set blockers on your issues. Note
 that if you want to know whether an issue has any other issues dependent
 on it (i.e. it's in their blockers list) you can look at the journal
 history at the bottom of the issue page - look for a "link" event to

Mercurial > p > roundup > code

comparison doc/customizing.txt @ 3039:70c9954f619f maint-0.8