extern/egroupware
1
0
Fork 1
mirror of https://github.com/EGroupware/egroupware.git synced 2024-10-05 09:42:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

update of the docs concerning the improved nextmatch-widget

Browse Source
This commit is contained in:
Ralf Becker 2003-12-18 06:08:55 +00:00
parent b5854dbaee
commit 3511e9d103
1 changed files with 32 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
etemplate/doc/referenz.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>eGroupWare: eTemplate-Referenz</title>
@ -691,6 +691,9 @@ $content[$id] = array( <span>// I = value set by the app, 0 = value on return /
'start' => <span>// IO position in list</span>
'cat_id' => <span>// IO category, if not 'no_cat' => True</span>
'search' => <span>// IO search pattern</span>
'order' => <span>// IO name of the column to sort after (optional for the sortheaders)</span>
'sort' => <span>// IO direction of the sort: 'ASC' or 'DESC'</span>
'col_filter' => <span>// IO array of column-name value pairs (optional for the filterheaders)</span>
'filter' => <span>// IO filter, if not 'no_filter' => True</span>
'filter2' => <span>// IO filter2, if not 'no_filter2' => True</span>
'rows' => <span>// O content set by callback</span>
@ -766,6 +769,30 @@ function index($content = 0)
</pre>
</td>
</tr>
<tr>
<td><b>Nextmatch-SortHeader</b><p><b>Nextmatch-FilterHeader</b></td>
<td>
&lt;nextmatch type="nextmatch-sortheader" id="col-name" label="ColLabel"/><p>
&lt;nextmatch type="nextmatch-filterheader" id="col-name"/>
</td>
<td>no</td>
<td>nextmatch-sortheader<p>nextmatch-filterheader</td>
<td>
These widget are an optional part of the nextmatch widget.<p>
<b>nextmatch-sortheader</b><br>
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 <b>name</b> (xml:id) the
<b>label</b> 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.<p>
<b>nextmatch-filterheader</b><br>
Widget to allow to show only certain row, which match a selected filter-value. The column-name is given as <b>name</b>
(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) <b>label</b> can be given.<p>
<i><u>Note</u>:</i> 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 <u>not</u> returned in the rows sub-array.
</td>
</tr>
<tr>
<td><b>LinkWidgets</b></td>
<td>
@ -783,15 +810,15 @@ function index($content = 0)
Widget to shows the links to an entry and a Unlink Button for each link. <p>
<i><u>Note</u>:</i> Both Widgets can be used on the same template with the <u>same</u> name. They share
the content of that variable, which contains just the id of the entry in the current app.<p>
<b>link-string</b><br>
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().
</td>
</tr>
</table>
<h3>One remark about cross-site-scripting</h3>
The following eTemplate Widgets are parsing its content before displaying through <b>htmlentities()</b> to
The following eTemplate Widgets are parsing its content before displaying through <b>htmlspecialchars()</b> to
correctly display the content and to gard against malecious data (like scripts etc.):
<ul>
<li>Label
@ -809,7 +836,7 @@ This is done in most cases by the underlaying html-class and not direct in eTemp
eTemplates to define the UI of the new widget and are stored in the eTemplate's inc-dir or the inc-dir of a
eGroupWare application. The editor and the etemplate-class autoload the existing extensions.</p>
<i>I will made more documentation about the interface availible soon. For now have a look for the source
<i>I will made more documentation about the interface availible soon. For now have a look for the source
of the existing extensions.</i>
<h2>please <a href="#" onClick="document.location='mai'+'lto:RalfBecker'+unescape('%40')+'outdoor-training'+unescape('%2E')+'de'; return false;">contact me</a> if you have further questions or comments about the eTemplates</h2>