Mercurial > p > roundup > code
comparison doc/customizing.txt @ 3037:714f2a60a97e maint-0.8
merge from HEAD
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 03 Jan 2005 22:56:26 +0000 |
| parents | b9a55628a78d |
| children | 70c9954f619f |
comparison
equal
deleted
inserted
replaced
| 3034:2739e3150e40 | 3037:714f2a60a97e |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.161 $ | 5 :Version: $Revision: 1.161.2.1 $ |
| 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:: |
| 2178 ~~~~~~~~~~~~~~~~~~~~~ | 2178 ~~~~~~~~~~~~~~~~~~~~~ |
| 2179 | 2179 |
| 2180 An index view specifier (URL fragment) looks like this (whitespace has | 2180 An index view specifier (URL fragment) looks like this (whitespace has |
| 2181 been added for clarity):: | 2181 been added for clarity):: |
| 2182 | 2182 |
| 2183 /issue?status=unread,in-progress,resolved& | 2183 /issue?status=unread,in-progress,resolved& |
| 2184 topic=security,ui& | 2184 topic=security,ui& |
| 2185 :group=+priority& | 2185 @group=priority& |
| 2186 :sort==activity& | 2186 @sort=-activity& |
| 2187 :filters=status,topic& | 2187 @filters=status,topic& |
| 2188 :columns=title,status,fixer | 2188 @columns=title,status,fixer |
| 2189 | 2189 |
| 2190 The index view is determined by two parts of the specifier: the layout | 2190 The index view is determined by two parts of the specifier: the layout |
| 2191 part and the filter part. The layout part consists of the query | 2191 part and the filter part. The layout part consists of the query |
| 2192 parameters that begin with colons, and it determines the way that the | 2192 parameters that begin with colons, and it determines the way that the |
| 2193 properties of selected items are displayed. The filter part consists of | 2193 properties of selected items are displayed. The filter part consists of |
| 2208 ascending order; and within groups, sorted by activity, arranged in | 2208 ascending order; and within groups, sorted by activity, arranged in |
| 2209 descending order. The filter section shows filters for the "status" and | 2209 descending order. The filter section shows filters for the "status" and |
| 2210 "topic" properties, and the table includes columns for the "title", | 2210 "topic" properties, and the table includes columns for the "title", |
| 2211 "status", and "fixer" properties. | 2211 "status", and "fixer" properties. |
| 2212 | 2212 |
| 2213 ============ ============================================================= | |
| 2214 Argument Description | |
| 2215 ============ ============================================================= | |
| 2216 @sort sort by prop name, optionally preceeded with '-' to give | |
| 2217 descending or nothing for ascending sorting. | |
| 2218 @group group by prop name, optionally preceeded with '-' or to sort | |
| 2219 in descending or nothing for ascending order. | |
| 2220 @columns selects the columns that should be displayed. Default is | |
| 2221 all. | |
| 2222 @filter indicates which properties are being used in filtering. | |
| 2223 Default is none. | |
| 2224 propname selects the values the item properties given by propname must | |
| 2225 have (very basic search/filter). | |
| 2226 @search_text if supplied, performs a full-text search (message bodies, | |
| 2227 issue titles, etc) | |
| 2228 ============ ============================================================= | |
| 2229 | |
| 2213 | 2230 |
| 2214 Searching Views | 2231 Searching Views |
| 2215 --------------- | 2232 --------------- |
| 2216 | 2233 |
| 2217 Note: if you add a new column to the ``:columns`` form variable | 2234 Note: if you add a new column to the ``@columns`` form variable |
| 2218 potentials then you will need to add the column to the appropriate | 2235 potentials then you will need to add the column to the appropriate |
| 2219 `index views`_ template so that it is actually displayed. | 2236 `index views`_ template so that it is actually displayed. |
| 2220 | 2237 |
| 2221 This is one of the class context views. The template used is typically | 2238 This is one of the class context views. The template used is typically |
| 2222 "*classname*.search". The form on this page should have "search" as its | 2239 "*classname*.search". The form on this page should have "search" as its |
| 2223 ``@action`` variable. The "search" action: | 2240 ``@action`` variable. The "search" action: |
| 2224 | 2241 |
| 2225 - sets up additional filtering, as well as performing indexed text | 2242 - sets up additional filtering, as well as performing indexed text |
| 2226 searching | 2243 searching |
| 2227 - sets the ``:filter`` variable correctly | 2244 - sets the ``@filter`` variable correctly |
| 2228 - saves the query off if ``:query_name`` is set. | 2245 - saves the query off if ``@query_name`` is set. |
| 2229 | 2246 |
| 2230 The search page should lay out any fields that you wish to allow the | 2247 The search page should lay out any fields that you wish to allow the |
| 2231 user to search on. If your schema contains a large number of properties, | 2248 user to search on. If your schema contains a large number of properties, |
| 2232 you should be wary of making all of those properties available for | 2249 you should be wary of making all of those properties available for |
| 2233 searching, as this can cause confusion. If the additional properties are | 2250 searching, as this can cause confusion. If the additional properties are |
| 2234 Strings, consider having their value indexed, and then they will be | 2251 Strings, consider having their value indexed, and then they will be |
| 2235 searchable using the full text indexed search. This is both faster, and | 2252 searchable using the full text indexed search. This is both faster, and |
| 2236 more useful for the end user. | 2253 more useful for the end user. |
| 2237 | 2254 |
| 2238 The two special form values on search pages which are handled by the | 2255 If the search view does specify the "search" ``@action``, then it may also |
| 2239 "search" action are: | 2256 provide an additional argument: |
| 2240 | 2257 |
| 2241 :search_text | 2258 ============ ============================================================= |
| 2242 Text with which to perform a search of the text index. Results from | 2259 Argument Description |
| 2243 that search will be used to limit the results of other filters (using | 2260 ============ ============================================================= |
| 2244 an intersection operation) | 2261 @query_name if supplied, the index parameters (including @search_text) |
| 2245 :query_name | 2262 will be saved off as a the query item and registered against |
| 2246 If supplied, the search parameters (including :search_text) will be | 2263 the user's queries property. Note that the *classic* template |
| 2247 saved off as a the query item and registered against the user's | 2264 schema has this ability, but the *minimal* template schema |
| 2248 queries property. Note that the *classic* template schema has this | 2265 does not. |
| 2249 ability, but the *minimal* template schema does not. | 2266 ============ ============================================================= |
| 2250 | 2267 |
| 2251 | 2268 |
| 2252 Item Views | 2269 Item Views |
| 2253 ---------- | 2270 ---------- |
| 2254 | 2271 |