Skip to content

Commit 3197d49

Browse files
author
Richard Jones
committed
Some more information regarding customising the schema.
1 parent 2c7170e commit 3197d49

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

doc/index.html

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -751,6 +751,10 @@ <h2><a name="config">Instance Configuration</a></h2>
751751
</pre>
752752

753753
<h2><a name="custinst">Instance Schema</a></h2>
754+
<b>Note:</b> if you modify the schema, you'll most likely need to
755+
<a href="#schemarepurcussions">
756+
web interface to reflect your changes</a>.
757+
<p>
754758
An instance schema defines what data is stored in the instance's database.
755759
The two schemas shipped with Roundup turn it into a typical software bug
756760
tracker (the extended schema allowing for support issues as well as bugs).
@@ -918,6 +922,20 @@ <h2><a name="custweb">Web Interface</a></h2>
918922
newitem views. The newitem view is optional - the item view will be used if
919923
the newitem view doesn't exist.
920924

925+
<h3><a name="schemarepurcussions">Repurcussions of changing the instance schema</a></h3>
926+
927+
If you choose to <a href="custinst">change the instance schema</a> you will need to
928+
ensure the web interface knows about it:
929+
<ol>
930+
<li>Index, item and filter pages for the relevant classes may need to have properties
931+
added or removed,
932+
<li>The default page header relies on the existence of, and some values of the
933+
priority, status, assignedto and activity classes. If you change any of these (specifically
934+
if you remove any of the classes or their default values) you will need to implement your
935+
own pagehead() method in your instance's interfaces.py module.
936+
</ol>
937+
938+
921939
<h3>Displaying Properties</h3>
922940

923941
<p>
@@ -1285,8 +1303,7 @@ <h1><a name="ack">Acknowledgements</a></h1>
12851303

12861304
<p>&nbsp;</p>
12871305
<hr>
1288-
$Id: index.html,v 1.25 2002-01-16 03:04:03 richard Exp $
1306+
$Id: index.html,v 1.26 2002-01-16 04:54:27 richard Exp $
12891307
<p>&nbsp;</p>
12901308

12911309
</body></html>
1292-

0 commit comments

Comments
 (0)