Mercurial > p > roundup > code
comparison doc/customizing.txt @ 1638:4a47eb555e51
more doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 09 May 2003 04:04:27 +0000 |
| parents | 137b26174a0c |
| children | 496f8f741e26 |
comparison
equal
deleted
inserted
replaced
| 1637:e72158c2f831 | 1638:4a47eb555e51 |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.84 $ | 5 :Version: $Revision: 1.85 $ |
| 6 | 6 |
| 7 .. This document borrows from the ZopeBook section on ZPT. The original is at: | 7 .. This document borrows from the ZopeBook section on ZPT. The original is at: |
| 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx | 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx |
| 9 | 9 |
| 10 .. contents:: | 10 .. contents:: |
| 1626 ---------- | 1626 ---------- |
| 1627 | 1627 |
| 1628 The basic view of a hyperdb item is provided by the "*classname*.item" | 1628 The basic view of a hyperdb item is provided by the "*classname*.item" |
| 1629 template. It generally has three sections; an "editor", a "spool" and a | 1629 template. It generally has three sections; an "editor", a "spool" and a |
| 1630 "history" section. | 1630 "history" section. |
| 1631 | |
| 1632 | 1631 |
| 1633 | 1632 |
| 1634 Editor Section | 1633 Editor Section |
| 1635 ~~~~~~~~~~~~~~ | 1634 ~~~~~~~~~~~~~~ |
| 1636 | 1635 |
| 1702 When a change is submitted, the system automatically generates a message | 1701 When a change is submitted, the system automatically generates a message |
| 1703 describing the changed properties. As shown in the example, the editor | 1702 describing the changed properties. As shown in the example, the editor |
| 1704 template can use the ":note" and ":file" fields, which are added to the | 1703 template can use the ":note" and ":file" fields, which are added to the |
| 1705 standard change note message generated by Roundup. | 1704 standard change note message generated by Roundup. |
| 1706 | 1705 |
| 1706 Form values | |
| 1707 ::::::::::: | |
| 1708 | |
| 1709 We have a number of ways to pull properties out of the form in order to | |
| 1710 meet the various needs of: | |
| 1711 | |
| 1712 1. editing the current item (perhaps an issue item) | |
| 1713 2. editing information related to the current item (eg. messages or | |
| 1714 attached files) | |
| 1715 3. creating new information to be linked to the current item (eg. time | |
| 1716 spent on an issue) | |
| 1717 | |
| 1718 In the following, ``<bracketed>`` values are variable, ":" may be | |
| 1719 one of ":" or "@", and other text "required" is fixed. | |
| 1720 | |
| 1721 Properties are specified as form variables: | |
| 1722 | |
| 1723 ``<propname>`` | |
| 1724 property on the current context item | |
| 1725 | |
| 1726 ``<designator>:<propname>`` | |
| 1727 property on the indicated item (for editing related information) | |
| 1728 | |
| 1729 ``<classname>-<N>:<propname>`` | |
| 1730 property on the Nth new item of classname (generally for creating new | |
| 1731 items to attach to the current item) | |
| 1732 | |
| 1733 Once we have determined the "propname", we check to see if it | |
| 1734 is one of the special form values: | |
| 1735 | |
| 1736 ``:required`` | |
| 1737 The named property values must be supplied or a ValueError | |
| 1738 will be raised. | |
| 1739 | |
| 1740 ``:remove:<propname>=id(s)`` | |
| 1741 The ids will be removed from the multilink property. | |
| 1742 | |
| 1743 ``:add:<propname>=id(s)`` | |
| 1744 The ids will be added to the multilink property. | |
| 1745 | |
| 1746 ``:link:<propname>=<designator>`` | |
| 1747 Used to add a link to new items created during edit. | |
| 1748 These are collected up and returned in all_links. This will | |
| 1749 result in an additional linking operation (either Link set or | |
| 1750 Multilink append) after the edit/create is done using | |
| 1751 all_props in _editnodes. The <propname> on the current item | |
| 1752 will be set/appended the id of the newly created item of | |
| 1753 class <designator> (where <designator> must be | |
| 1754 <classname>-<N>). | |
| 1755 | |
| 1756 Any of the form variables may be prefixed with a classname or | |
| 1757 designator. | |
| 1758 | |
| 1759 Two special form values are supported for backwards | |
| 1760 compatibility: | |
| 1761 | |
| 1762 ``:note`` | |
| 1763 create a message (with content, author and date), link | |
| 1764 to the context item. This is ALWAYS desginated "msg-1". | |
| 1765 ``:file`` | |
| 1766 create a file, attach to the current item and any | |
| 1767 message created by :note. This is ALWAYS designated "file-1". | |
| 1768 | |
| 1769 | |
| 1707 Spool Section | 1770 Spool Section |
| 1708 ~~~~~~~~~~~~~ | 1771 ~~~~~~~~~~~~~ |
| 1709 | 1772 |
| 1710 The spool section lists related information like the messages and files of | 1773 The spool section lists related information like the messages and files of |
| 1711 an issue. | 1774 an issue. |