Skip to content

Commit 290b37a

Browse files
author
Richard Jones
committed
formatting fixes
1 parent 0633b59 commit 290b37a

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

doc/customizing.txt

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.161.2.1 $
5+
:Version: $Revision: 1.161.2.2 $
66

77
.. This document borrows from the ZopeBook section on ZPT. The original is at:
88
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -285,9 +285,10 @@ genconfig`` command.
285285
Tracker Schema
286286
==============
287287

288-
Note: if you modify the schema, you'll most likely need to edit the
289-
`web interface`_ HTML template files and `detectors`_ to reflect
290-
your changes.
288+
.. note::
289+
if you modify the schema, you'll most likely need to edit the
290+
`web interface`_ HTML template files and `detectors`_ to reflect
291+
your changes.
291292

292293
A tracker schema defines what data is stored in the tracker's database.
293294
Schemas are defined using Python code in the ``schema.py`` module of your
@@ -692,9 +693,9 @@ is not required).
692693
Database Content
693694
================
694695

695-
Note: if you modify the content of definitional classes, you'll most
696-
likely need to edit the tracker `detectors`_ to reflect your
697-
changes.
696+
.. note::
697+
if you modify the content of definitional classes, you'll most
698+
likely need to edit the tracker `detectors`_ to reflect your changes.
698699

699700
Customisation of the special "definitional" classes (eg. status,
700701
priority, resolution, ...) may be done either before or after the
@@ -901,8 +902,8 @@ Example Scenarios
901902
By giving the "anonymous" user the "Email Registration" Role, any
902903
unidentified user will automatically be registered with the tracker
903904
(with no password, so they won't be able to log in through the web
904-
until an admin sets their password). Note: this is the default
905-
behaviour in the tracker templates that ship with Roundup.
905+
until an admin sets their password). This is the default behaviour
906+
in the tracker templates that ship with Roundup.
906907

907908
**anonymous access through the e-mail gateway**
908909
Give the "anonymous" user the "Email Access" and ("Edit", "issue")
@@ -1332,7 +1333,7 @@ of files in there. The *minimal* template includes:
13321333

13331334
The *classic* template has a number of additional templates.
13341335

1335-
Note: Remember that you can create any template extension you want to,
1336+
Remember that you can create any template extension you want to,
13361337
so if you just want to play around with the templating for new issues,
13371338
you can copy the current "issue.item" template to "issue.test", and then
13381339
access the test template using the "@template" URL argument::
@@ -1586,8 +1587,7 @@ TAL commands may be used freely inside METAL-using tags (so your
15861587
Information available to templates
15871588
----------------------------------
15881589

1589-
Note: this is implemented by
1590-
``roundup.cgi.templating.RoundupPageTemplate``
1590+
This is implemented by ``roundup.cgi.templating.RoundupPageTemplate``
15911591

15921592
The following variables are available to templates.
15931593

@@ -1681,7 +1681,7 @@ item. The only real difference between cases 2 and 3 above are:
16811681
Hyperdb class wrapper
16821682
:::::::::::::::::::::
16831683

1684-
Note: this is implemented by the ``roundup.cgi.templating.HTMLClass``
1684+
This is implemented by the ``roundup.cgi.templating.HTMLClass``
16851685
class.
16861686

16871687
This wrapper object provides access to a hyperb class. It is used
@@ -1737,7 +1737,7 @@ will access the "list" property, rather than the list method.
17371737
Hyperdb item wrapper
17381738
::::::::::::::::::::
17391739

1740-
Note: this is implemented by the ``roundup.cgi.templating.HTMLItem``
1740+
This is implemented by the ``roundup.cgi.templating.HTMLItem``
17411741
class.
17421742

17431743
This wrapper object provides access to a hyperb item.
@@ -1783,7 +1783,7 @@ will access the "journal" property, rather than the journal method.
17831783
Hyperdb property wrapper
17841784
::::::::::::::::::::::::
17851785

1786-
Note: this is implemented by subclasses of the
1786+
This is implemented by subclasses of the
17871787
``roundup.cgi.templating.HTMLProperty`` class (``HTMLStringProperty``,
17881788
``HTMLNumberProperty``, and so on).
17891789

@@ -1920,7 +1920,7 @@ have permission to view the information.
19201920
The request variable
19211921
~~~~~~~~~~~~~~~~~~~~
19221922

1923-
Note: this is implemented by the ``roundup.cgi.templating.HTMLRequest``
1923+
This is implemented by the ``roundup.cgi.templating.HTMLRequest``
19241924
class.
19251925

19261926
The request variable is packed with information about the current
@@ -1996,7 +1996,7 @@ best to know beforehand what you're dealing with.
19961996
The db variable
19971997
~~~~~~~~~~~~~~~
19981998

1999-
Note: this is implemented by the ``roundup.cgi.templating.HTMLDatabase``
1999+
This is implemented by the ``roundup.cgi.templating.HTMLDatabase``
20002000
class.
20012001

20022002
Allows access to all hyperdb classes as attributes of this variable. If
@@ -2015,7 +2015,7 @@ The access results in a `hyperdb class wrapper`_.
20152015
The templates variable
20162016
~~~~~~~~~~~~~~~~~~~~~~
20172017

2018-
Note: this is implemented by the ``roundup.cgi.templating.Templates``
2018+
This is implemented by the ``roundup.cgi.templating.Templates``
20192019
class.
20202020

20212021
This variable doesn't have any useful methods defined. It supports being
@@ -2071,7 +2071,7 @@ Roman Same as roman(), except uppercase.
20712071
The utils variable
20722072
~~~~~~~~~~~~~~~~~~
20732073

2074-
Note: this is implemented by the
2074+
This is implemented by the
20752075
``roundup.cgi.templating.TemplatingUtils`` class, but it may be extended
20762076
as described below.
20772077

@@ -2122,7 +2122,7 @@ addition, it has several more attributes:
21222122
=============== ========================================================
21232123
Attribute Description
21242124
=============== ========================================================
2125-
start indicates the start index of the batch. *Note: unlike
2125+
start indicates the start index of the batch. *Unlike
21262126
the argument, is a 1-based index (I know, lame)*
21272127
first indicates the start index of the batch *as a 0-based
21282128
index*
@@ -2231,9 +2231,10 @@ propname selects the values the item properties given by propname must
22312231
Searching Views
22322232
---------------
22332233

2234-
Note: if you add a new column to the ``@columns`` form variable
2235-
potentials then you will need to add the column to the appropriate
2236-
`index views`_ template so that it is actually displayed.
2234+
.. note::
2235+
if you add a new column to the ``@columns`` form variable potentials
2236+
then you will need to add the column to the appropriate `index views`_
2237+
template so that it is actually displayed.
22372238

22382239
This is one of the class context views. The template used is typically
22392240
"*classname*.search". The form on this page should have "search" as its
@@ -3671,8 +3672,8 @@ resolved. To achieve this:
36713672
blockers=-1&:columns=id,activity,title,creator,assignedto,status&
36723673
status=-1,1,2,3,4,5,6,7">Show All</a><br>
36733674

3674-
:Note: the above examples are line-wrapped on the trailing & and should
3675-
be unwrapped.
3675+
The above examples are line-wrapped on the trailing & and should
3676+
be unwrapped.
36763677

36773678
That's it. You should now be able to set blockers on your issues. Note
36783679
that if you want to know whether an issue has any other issues dependent

0 commit comments

Comments
 (0)