From 3511e9d103fc3c38b2dc6f9425ba6045651503bc Mon Sep 17 00:00:00 2001 From: Ralf Becker Date: Thu, 18 Dec 2003 06:08:55 +0000 Subject: [PATCH] update of the docs concerning the improved nextmatch-widget --- etemplate/doc/referenz.html | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/etemplate/doc/referenz.html b/etemplate/doc/referenz.html index c1c6182b63..c4b9f13b79 100644 --- a/etemplate/doc/referenz.html +++ b/etemplate/doc/referenz.html @@ -1,4 +1,4 @@ - + eGroupWare: eTemplate-Referenz @@ -691,6 +691,9 @@ $content[$id] = array( // I = value set by the app, 0 = value on return / 'start' => // IO position in list 'cat_id' => // IO category, if not 'no_cat' => True 'search' => // IO search pattern + 'order' => // IO name of the column to sort after (optional for the sortheaders) + 'sort' => // IO direction of the sort: 'ASC' or 'DESC' + 'col_filter' => // IO array of column-name value pairs (optional for the filterheaders) 'filter' => // IO filter, if not 'no_filter' => True 'filter2' => // IO filter2, if not 'no_filter2' => True 'rows' => // O content set by callback @@ -766,6 +769,30 @@ function index($content = 0) + + Nextmatch-SortHeader

Nextmatch-FilterHeader + + <nextmatch type="nextmatch-sortheader" id="col-name" label="ColLabel"/>

+ <nextmatch type="nextmatch-filterheader" id="col-name"/> + + no + nextmatch-sortheader

nextmatch-filterheader + + These widget are an optional part of the nextmatch widget.

+ nextmatch-sortheader
+ Widget to be placed as a colum-header in the headerline of a nextmatch-template. It allows, by clicking on it, + to order the lines of the nextmatch after a certain column. The column-name is given as name (xml:id) the + label is show as a link of button (no javascript). Consecutive click on the header change the sorting + direction, indicated by a little up- or down-arrow.

+ nextmatch-filterheader
+ Widget to allow to show only certain row, which match a selected filter-value. The column-name is given as name + (xml:id), the options of the displayed selectbox need to be set as for an ordinary selectbox (eg. in the options + parameter to the uietemplate::exec function). If no extra-label is given in options, lang('all') will be used for + the empty value, which means no filter activ. An (optional) label can be given.

+ Note: Both widgets interoperate with the nextmatch-widget which passes the set values as part if + the query-parameter to its get_rows function, they are not returned in the rows sub-array. + + LinkWidgets @@ -783,15 +810,15 @@ function index($content = 0) Widget to shows the links to an entry and a Unlink Button for each link.

Note: Both Widgets can be used on the same template with the same name. They share the content of that variable, which contains just the id of the entry in the current app.

- + link-string
- Comma-separated list of link-titles with a link to its view-method, value is like the return + Comma-separated list of link-titles with a link to its view-method, value is like the return of bolink::get_links().

One remark about cross-site-scripting

-The following eTemplate Widgets are parsing its content before displaying through htmlentities() to +The following eTemplate Widgets are parsing its content before displaying through htmlspecialchars() to correctly display the content and to gard against malecious data (like scripts etc.):