Mercurial > p > roundup > code
comparison doc/customizing.txt @ 3363:7bc1e9c42a26
allow specification of pagesize, sorting and filtering in "classhelp" popups
[SF#1211800]
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 24 Jun 2005 06:27:45 +0000 |
| parents | 8897483a9f8b |
| children | 7d48c5b1e8f2 |
comparison
equal
deleted
inserted
replaced
| 3361:64cc03598c8a | 3363:7bc1e9c42a26 |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.181 $ | 5 :Version: $Revision: 1.182 $ |
| 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:: |
| 1762 eg. ``issue.filter(filterspec={"priority": "1"}, | 1762 eg. ``issue.filter(filterspec={"priority": "1"}, |
| 1763 sort=('activity', '+'))`` | 1763 sort=('activity', '+'))`` |
| 1764 | 1764 |
| 1765 classhelp display a link to a javascript popup containing this class' | 1765 classhelp display a link to a javascript popup containing this class' |
| 1766 "help" template. | 1766 "help" template. |
| 1767 | |
| 1768 This generates a link to a popup window which displays the | |
| 1769 properties indicated by "properties" of the class named by | |
| 1770 "classname". The "properties" should be a comma-separated list | |
| 1771 (eg. 'id,name,description'). Properties defaults to all the | |
| 1772 properties of a class (excluding id, creator, created and | |
| 1773 activity). | |
| 1774 | |
| 1775 You may optionally override the "label" displayed, the "width", | |
| 1776 the "height", the number of items per page ("pagesize") and | |
| 1777 the field on which the list is sorted ("sort"). | |
| 1778 | |
| 1779 With the "filter" arg it is possible to specify a filter for | |
| 1780 which items are supposed to be displayed. It has to be of | |
| 1781 the format "<field>=<values>;<field>=<values>;...". | |
| 1782 | |
| 1783 The popup window will be resizable and scrollable. | |
| 1784 | |
| 1785 If the "property" arg is given, it's passed through to the | |
| 1786 javascript help_window function. This allows updating of a | |
| 1787 property in the calling HTML page. | |
| 1788 | |
| 1789 If the "form" arg is given, it's passed through to the | |
| 1790 javascript help_window function - it's the name of the form | |
| 1791 the "property" belongs to. | |
| 1792 | |
| 1767 submit generate a submit button (and action hidden element) | 1793 submit generate a submit button (and action hidden element) |
| 1768 renderWith render this class with the given template. | 1794 renderWith render this class with the given template. |
| 1769 history returns 'New node - no history' :) | 1795 history returns 'New node - no history' :) |
| 1770 is_edit_ok is the user allowed to Edit the current class? | 1796 is_edit_ok is the user allowed to Edit the current class? |
| 1771 is_view_ok is the user allowed to View the current class? | 1797 is_view_ok is the user allowed to View the current class? |
| 1951 includes the item ids in the list labels | 1977 includes the item ids in the list labels |
| 1952 additional | 1978 additional |
| 1953 lists properties which should be included in the label | 1979 lists properties which should be included in the label |
| 1954 sort_on | 1980 sort_on |
| 1955 indicates the property to sort the list on as (direction, | 1981 indicates the property to sort the list on as (direction, |
| 1956 property) where direction is '+' or '-'. | 1982 (direction, property) where direction is '+' or '-'. A |
| 1983 single string with the direction prepended may be used. | |
| 1984 For example: ('-', 'order'), '+name'. | |
| 1957 | 1985 |
| 1958 The remaining keyword arguments are used as conditions for | 1986 The remaining keyword arguments are used as conditions for |
| 1959 filtering the items in the list - they're passed as the | 1987 filtering the items in the list - they're passed as the |
| 1960 "filterspec" argument to a Class.filter() call. | 1988 "filterspec" argument to a Class.filter() call. |
| 1961 | 1989 |