Mercurial > p > roundup > code
diff doc/customizing.txt @ 1074:954ad22eb7d9
more doc, more cleanup
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 09 Sep 2002 01:59:43 +0000 |
| parents | cf30c6cdca02 |
| children | 40fc5f8cd55c |
line wrap: on
line diff
--- a/doc/customizing.txt Mon Sep 09 00:45:06 2002 +0000 +++ b/doc/customizing.txt Mon Sep 09 01:59:43 2002 +0000 @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.20 $ +:Version: $Revision: 1.21 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -1016,6 +1016,9 @@ Index Views ~~~~~~~~~~~ +This is one of the class context views. It is also the default view for +classes. The template used is "*classname*.index". + Index View Specifiers ::::::::::::::::::::: @@ -1058,109 +1061,120 @@ Searching Views ~~~~~~~~~~~~~~~ +This is one of the class context views. The template used is typically +"*classname*.search". + TODO Item Views ~~~~~~~~~~ -An item view contains an editor section and a spool section. At the top of an -item view, links to superseding and superseded items are always displayed. +The basic view of a hyperdb item is provided by the "*classname*.item" +template. It generally has three sections; an "editor", a "spool" and a +"history" section. + + Editor Section :::::::::::::: -The editor section is generated from a template containing <display> tags to -insert the appropriate widgets for editing properties. +The editor section is used to manipulate the item - it may be a +static display if the user doesn't have permission to edit the item. -Here's an example of a basic editor template.:: +Here's an example of a basic editor template (this is the default "classic" +template issue item edit form - from the "issue.item" template):: - <table> - <tr> - <td colspan=2> - <display call="field('title', size=60)"> - </td> - </tr> - <tr> - <td> - <display call="field('fixer', size=30)"> - </td> - <td> - <display call="menu('status')> - </td> - </tr> - <tr> - <td> - <display call="field('nosy', size=30)"> - </td> - <td> - <display call="menu('priority')> - </td> - </tr> - <tr> - <td colspan=2> - <display call="note()"> - </td> - </tr> - </table> + <table class="form"> + <tr> + <th nowrap>Title</th> + <td colspan=3 tal:content="structure python:context.title.field(size=60)">title</td> + </tr> + + <tr> + <th nowrap>Priority</th> + <td tal:content="structure context/priority/menu">priority</td> + <th nowrap>Status</th> + <td tal:content="structure context/status/menu">status</td> + </tr> + + <tr> + <th nowrap>Superseder</th> + <td> + <span tal:replace="structure python:context.superseder.field(showid=1, size=20)" /> + <span tal:replace="structure python:db.issue.classhelp('id,title', label='list', width=500)" /> + <span tal:condition="context/superseder"> + <br>View: <span tal:replace="structure python:context.superseder.link(showid=1)" /> + </span> + </td> + <th nowrap>Nosy List</th> + <td> + <span tal:replace="structure context/nosy/field" /> + <span tal:replace="structure python:db.user.classhelp('username,realname,address,phone', label='list', width=500)" /> + </td> + </tr> + + <tr> + <th nowrap>Assigned To</th> + <td tal:content="structure context/assignedto/menu"> + assignedto menu + </td> + <td> </td> + <td> </td> + </tr> + + <tr> + <th nowrap>Change Note</th> + <td colspan=3> + <textarea name="__note" wrap="hard" rows="5" cols="60"></textarea> + </td> + </tr> + + <tr> + <th nowrap>File</th> + <td colspan=3><input type="file" name="__file" size="40"></td> + </tr> + + <tr> + <td> </td> + <td colspan=3 tal:content="structure context/submit"> + submit button will go here + </td> + </tr> + </table> -As shown in the example, the editor template can also request the display of a -"note" field, which is a text area for entering a note to go along with a -change. - -The <property> tag used in the index may also be used here - it checks to see -if the nominated Multilink property has any entries. This can be used to -eliminate sections of the editor section if the property has no entries:: - - <td class="form-text"> - <display call="field('superseder', size=40, showid=1)"> - <display call="classhelp('issue', 'id,title', label='list', width=500)"> - <property name="superseder"> - <br>View: <display call="link('superseder', showid=1)"> - </property> - </td> - -The "View: " part with the links will only display if the superseder property -has values. When a change is submitted, the system automatically generates a message -describing the changed properties. - -If a note is given in the "note" field, the note is appended to the -description. The message is then added to the item's message spool (thus -triggering the standard detector to react by sending out this message to the -nosy list). - -The message also displays all of the property values on the item and indicates -which ones have changed. An example of such a message might be this:: - - Polly's taken a turn for the worse - this is now really important! - ----- - title: Polly Parrot is dead - priority: critical - status: unread -> in-progress - fixer: terry - keywords: parrot,plumage,perch,nailed,dead +describing the changed properties. As shown in the example, the editor +template can use the "__note" and "__file" fields, which are added to the +standard change note message generated by Roundup. Spool Section ::::::::::::: -The spool section lists messages in the item's "messages" property. The index -of messages displays the "date", "author", and "summary" properties on the -message nodes, and selecting a message takes you to its content. +The spool section lists related information like the messages and files of +an issue. + +TODO + -The <property> tag used in the index may also be used here - it checks to see -if the nominated Multilink property has any entries. This can be used to -eliminate sections of the spool section if the property has no entries:: +History Section +::::::::::::::: + +The final section displayed is the history of the item - its database journal. +This is generally generated with the template:: - <property name="files"> - <tr class="strong-header"> - <td><b>Files</b></td> - </tr> + <tal:block tal:replace="structure context/history" /> + +*To be done:* - <tr> - <td><display call="list('files')"></td> - </tr> - </property> +*The actual history entries of the node may be accessed for manual templating +through the "journal" method of the item*:: + + <tal:block tal:repeat="entry context/journal"> + a journal entry + </tal:block> + +*where each journal entry is an HTMLJournalEntry.* Access Controls
