Mercurial > p > roundup > code
comparison doc/customizing.txt @ 3038:6fbc8633a4c8 maint-0.7
merge from HEAD
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 03 Jan 2005 23:02:27 +0000 |
| parents | 4129ecd31eea |
| children | b248c058eb93 |
comparison
equal
deleted
inserted
replaced
| 3035:94053f8666c6 | 3038:6fbc8633a4c8 |
|---|---|
| 2096 ~~~~~~~~~~~~~~~~~~~~~ | 2096 ~~~~~~~~~~~~~~~~~~~~~ |
| 2097 | 2097 |
| 2098 An index view specifier (URL fragment) looks like this (whitespace has | 2098 An index view specifier (URL fragment) looks like this (whitespace has |
| 2099 been added for clarity):: | 2099 been added for clarity):: |
| 2100 | 2100 |
| 2101 /issue?status=unread,in-progress,resolved& | 2101 /issue?status=unread,in-progress,resolved& |
| 2102 topic=security,ui& | 2102 topic=security,ui& |
| 2103 :group=+priority& | 2103 @group=priority& |
| 2104 :sort==activity& | 2104 @sort=-activity& |
| 2105 :filters=status,topic& | 2105 @filters=status,topic& |
| 2106 :columns=title,status,fixer | 2106 @columns=title,status,fixer |
| 2107 | 2107 |
| 2108 The index view is determined by two parts of the specifier: the layout | 2108 The index view is determined by two parts of the specifier: the layout |
| 2109 part and the filter part. The layout part consists of the query | 2109 part and the filter part. The layout part consists of the query |
| 2110 parameters that begin with colons, and it determines the way that the | 2110 parameters that begin with colons, and it determines the way that the |
| 2111 properties of selected items are displayed. The filter part consists of | 2111 properties of selected items are displayed. The filter part consists of |
| 2126 ascending order; and within groups, sorted by activity, arranged in | 2126 ascending order; and within groups, sorted by activity, arranged in |
| 2127 descending order. The filter section shows filters for the "status" and | 2127 descending order. The filter section shows filters for the "status" and |
| 2128 "topic" properties, and the table includes columns for the "title", | 2128 "topic" properties, and the table includes columns for the "title", |
| 2129 "status", and "fixer" properties. | 2129 "status", and "fixer" properties. |
| 2130 | 2130 |
| 2131 ============ ============================================================= | |
| 2132 Argument Description | |
| 2133 ============ ============================================================= | |
| 2134 @sort sort by prop name, optionally preceeded with '-' to give | |
| 2135 descending or nothing for ascending sorting. | |
| 2136 @group group by prop name, optionally preceeded with '-' or to sort | |
| 2137 in descending or nothing for ascending order. | |
| 2138 @columns selects the columns that should be displayed. Default is | |
| 2139 all. | |
| 2140 @filter indicates which properties are being used in filtering. | |
| 2141 Default is none. | |
| 2142 propname selects the values the item properties given by propname must | |
| 2143 have (very basic search/filter). | |
| 2144 @search_text if supplied, performs a full-text search (message bodies, | |
| 2145 issue titles, etc) | |
| 2146 ============ ============================================================= | |
| 2147 | |
| 2148 | |
| 2131 Searching Views | 2149 Searching Views |
| 2132 --------------- | 2150 --------------- |
| 2133 | 2151 |
| 2134 .. note:: | 2152 .. note:: |
| 2135 If you add a new column to the ``:columns`` form variable | 2153 If you add a new column to the ``@columns`` form variable |
| 2136 potentials then you will need to add the column to the appropriate | 2154 potentials then you will need to add the column to the appropriate |
| 2137 `index views`_ template so that it is actually displayed. | 2155 `index views`_ template so that it is actually displayed. |
| 2138 | 2156 |
| 2139 This is one of the class context views. The template used is typically | 2157 This is one of the class context views. The template used is typically |
| 2140 "*classname*.search". The form on this page should have "search" as its | 2158 "*classname*.search". The form on this page should have "search" as its |
| 2141 ``@action`` variable. The "search" action: | 2159 ``@action`` variable. The "search" action: |
| 2142 | 2160 |
| 2143 - sets up additional filtering, as well as performing indexed text | 2161 - sets up additional filtering, as well as performing indexed text |
| 2144 searching | 2162 searching |
| 2145 - sets the ``:filter`` variable correctly | 2163 - sets the ``@filter`` variable correctly |
| 2146 - saves the query off if ``:query_name`` is set. | 2164 - saves the query off if ``@query_name`` is set. |
| 2147 | 2165 |
| 2148 The search page should lay out any fields that you wish to allow the | 2166 The search page should lay out any fields that you wish to allow the |
| 2149 user to search on. If your schema contains a large number of properties, | 2167 user to search on. If your schema contains a large number of properties, |
| 2150 you should be wary of making all of those properties available for | 2168 you should be wary of making all of those properties available for |
| 2151 searching, as this can cause confusion. If the additional properties are | 2169 searching, as this can cause confusion. If the additional properties are |
| 2152 Strings, consider having their value indexed, and then they will be | 2170 Strings, consider having their value indexed, and then they will be |
| 2153 searchable using the full text indexed search. This is both faster, and | 2171 searchable using the full text indexed search. This is both faster, and |
| 2154 more useful for the end user. | 2172 more useful for the end user. |
| 2155 | 2173 |
| 2156 The two special form values on search pages which are handled by the | 2174 If the search view does specify the "search" ``@action``, then it may also |
| 2157 "search" action are: | 2175 provide an additional argument: |
| 2158 | 2176 |
| 2159 :search_text | 2177 ============ ============================================================= |
| 2160 Text with which to perform a search of the text index. Results from | 2178 Argument Description |
| 2161 that search will be used to limit the results of other filters (using | 2179 ============ ============================================================= |
| 2162 an intersection operation) | 2180 @query_name if supplied, the index parameters (including @search_text) |
| 2163 :query_name | 2181 will be saved off as a the query item and registered against |
| 2164 If supplied, the search parameters (including :search_text) will be | 2182 the user's queries property. Note that the *classic* template |
| 2165 saved off as a the query item and registered against the user's | 2183 schema has this ability, but the *minimal* template schema |
| 2166 queries property. The *classic* template schema has this ability, but | 2184 does not. |
| 2167 the *minimal* template schema does not. | 2185 ============ ============================================================= |
| 2168 | 2186 |
| 2169 | 2187 |
| 2170 Item Views | 2188 Item Views |
| 2171 ---------- | 2189 ---------- |
| 2172 | 2190 |