Mercurial > p > roundup > code
comparison doc/customizing.txt @ 3364:9795ec63ff0f maint-0.8
merge from HEAD
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 24 Jun 2005 06:30:25 +0000 |
| parents | 90e711aa1be6 |
| children | 0607d084ebef |
comparison
equal
deleted
inserted
replaced
| 3362:5126627029d6 | 3364:9795ec63ff0f |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.161.2.16 $ | 5 :Version: $Revision: 1.161.2.17 $ |
| 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:: |
| 1760 eg. ``issue.filter(filterspec={"priority": "1"}, | 1760 eg. ``issue.filter(filterspec={"priority": "1"}, |
| 1761 sort=('activity', '+'))`` | 1761 sort=('activity', '+'))`` |
| 1762 | 1762 |
| 1763 classhelp display a link to a javascript popup containing this class' | 1763 classhelp display a link to a javascript popup containing this class' |
| 1764 "help" template. | 1764 "help" template. |
| 1765 | |
| 1766 This generates a link to a popup window which displays the | |
| 1767 properties indicated by "properties" of the class named by | |
| 1768 "classname". The "properties" should be a comma-separated list | |
| 1769 (eg. 'id,name,description'). Properties defaults to all the | |
| 1770 properties of a class (excluding id, creator, created and | |
| 1771 activity). | |
| 1772 | |
| 1773 You may optionally override the "label" displayed, the "width", | |
| 1774 the "height", the number of items per page ("pagesize") and | |
| 1775 the field on which the list is sorted ("sort"). | |
| 1776 | |
| 1777 With the "filter" arg it is possible to specify a filter for | |
| 1778 which items are supposed to be displayed. It has to be of | |
| 1779 the format "<field>=<values>;<field>=<values>;...". | |
| 1780 | |
| 1781 The popup window will be resizable and scrollable. | |
| 1782 | |
| 1783 If the "property" arg is given, it's passed through to the | |
| 1784 javascript help_window function. This allows updating of a | |
| 1785 property in the calling HTML page. | |
| 1786 | |
| 1787 If the "form" arg is given, it's passed through to the | |
| 1788 javascript help_window function - it's the name of the form | |
| 1789 the "property" belongs to. | |
| 1790 | |
| 1765 submit generate a submit button (and action hidden element) | 1791 submit generate a submit button (and action hidden element) |
| 1766 renderWith render this class with the given template. | 1792 renderWith render this class with the given template. |
| 1767 history returns 'New node - no history' :) | 1793 history returns 'New node - no history' :) |
| 1768 is_edit_ok is the user allowed to Edit the current class? | 1794 is_edit_ok is the user allowed to Edit the current class? |
| 1769 is_view_ok is the user allowed to View the current class? | 1795 is_view_ok is the user allowed to View the current class? |
| 1944 includes the item ids in the list labels | 1970 includes the item ids in the list labels |
| 1945 additional | 1971 additional |
| 1946 lists properties which should be included in the label | 1972 lists properties which should be included in the label |
| 1947 sort_on | 1973 sort_on |
| 1948 indicates the property to sort the list on as (direction, | 1974 indicates the property to sort the list on as (direction, |
| 1949 property) where direction is '+' or '-'. | 1975 (direction, property) where direction is '+' or '-'. A |
| 1976 single string with the direction prepended may be used. | |
| 1977 For example: ('-', 'order'), '+name'. | |
| 1950 | 1978 |
| 1951 The remaining keyword arguments are used as conditions for | 1979 The remaining keyword arguments are used as conditions for |
| 1952 filtering the items in the list - they're passed as the | 1980 filtering the items in the list - they're passed as the |
| 1953 "filterspec" argument to a Class.filter() call. | 1981 "filterspec" argument to a Class.filter() call. |
| 1954 sorted only on Multilink properties - produce a list of the linked | 1982 sorted only on Multilink properties - produce a list of the linked |