Mercurial > p > roundup > code
diff doc/index.html @ 602:c242455d9b46 config-0-4-0-branch
Brought the config branch up to date with HEAD
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 06 Feb 2002 04:05:55 +0000 |
| parents | d35e51360175 |
| children |
line wrap: on
line diff
--- a/doc/index.html Wed Feb 06 03:47:17 2002 +0000 +++ b/doc/index.html Wed Feb 06 04:05:55 2002 +0000 @@ -751,6 +751,10 @@ </pre> <h2><a name="custinst">Instance Schema</a></h2> +<b>Note:</b> if you modify the schema, you'll most likely need to +<a href="#schemarepurcussions"> +web interface to reflect your changes</a>. +<p> An instance schema defines what data is stored in the instance's database. The two schemas shipped with Roundup turn it into a typical software bug tracker (the extended schema allowing for support issues as well as bugs). @@ -918,6 +922,20 @@ newitem views. The newitem view is optional - the item view will be used if the newitem view doesn't exist. +<h3><a name="schemarepurcussions">Repurcussions of changing the instance schema</a></h3> + +If you choose to <a href="custinst">change the instance schema</a> you will need to +ensure the web interface knows about it: +<ol> +<li>Index, item and filter pages for the relevant classes may need to have properties +added or removed, +<li>The default page header relies on the existence of, and some values of the +priority, status, assignedto and activity classes. If you change any of these (specifically +if you remove any of the classes or their default values) you will need to implement your +own pagehead() method in your instance's interfaces.py module. +</ol> + + <h3>Displaying Properties</h3> <p> @@ -991,11 +1009,7 @@ For other properties, link to this node with the property as the text. <p> <em>Options:</em><br> -property (property name) - the property to use in the second case.<br> -is_download (boolean) - to be used for links te <em>file</em> class nodes - -this indicates that the URL should have the specified property (usually -<em>name</em>) appended so that the download has the correct name (instead -of the node designator.) +property (property name) - the property to use in the second case. </td></tr> <tr><td valign="top"><strong>count</strong></td> @@ -1019,8 +1033,13 @@ </td></tr> <tr><td valign="top"><strong>download</strong></td> -<td>Show a Link("file") or Multilink("file") -property using links that allow you to download files. +<td>For a Link or Multilink property, display the names of the linked +nodes, hyperlinked to the item views on those nodes. +<p> +For other properties, link to this node with the property as the text. +<p> +In all cases, append the name (key property) of the item to the path so it +is the name of the file being downloaded. <p> <em>Arguments:</em><br> property (property name) - the property to use. @@ -1125,10 +1144,12 @@ tags are included or omitted depending on whether the view specifier requests a filter for a particular property. +<p>A property must appear in the filter template for it to be available +as a filter. + <p>Here's a simple example of a filter template. -<blockquote><pre><small -><property name=status> +<blockquote><pre><small><property name=status> <display call="checklist('status')"> </property> <br> @@ -1157,8 +1178,7 @@ <p>Here's a simple example of an index template. -<blockquote><pre><small -><tr> +<blockquote><pre><small><tr> <property name=title> <td><display call="plain('title', max=50)"></td> </property> @@ -1195,8 +1215,7 @@ <p>Here's an example of a basic editor template. -<blockquote><pre><small -><table> +<blockquote><pre><small><table> <tr> <td colspan=2> <display call="field('title', size=60)"> @@ -1285,8 +1304,7 @@ <p> </p> <hr> -$Id: index.html,v 1.23 2001-12-31 03:07:04 richard Exp $ +$Id: index.html,v 1.23.2.1 2002-02-06 04:05:53 richard Exp $ <p> </p> </body></html> -
