Changes between Version 3 and Version 4 of S3/S3Summary

Timestamp:

07/31/14 12:57:44 (11 years ago)

Author:

Dominic König

Comment:

--

S3/S3Summary

@@ -2 +2 @@
 [[TOC]]
 
+A summary page is a single-resource, multi-record view with multiple embedded data presentations ("widgets", e.g. tables, maps, charts) and a common filter form.
+
+The general structure of a summary page is:
+
 [[Image(summary_structure.png)]]
+
+== Sections ==
+
+The summary page can be broken up into '''sections''' (optional), each of which containing one or more widgets. 
+
+Sections are rendered with a tab-style navigation, only one section visible at a time. An additional "common" section is always visible.
+
+Number, type and contents of the sections are freely configurable.
+
+== Widgets ==
+
+'''Widgets''' are presentations of the filtered data, e.g. as tables, maps or charts. 
+
+The summary framework does not render the widgets itself, but invokes the {{{widget()}}} interface of regular REST method handlers (e.g. S3CRUD, S3Map, S3Report) to generate them.
+
+The type and order of widgets is freely configurable.
+
+== Filtering ==
+
+All widgets can be filtered simultaneously with a common '''filter form'''. 
+
+The summary framework features lazy-refresh, so that only visible widgets are refreshed immediately after a filter change, while the hidden widgets are scheduled for refresh when they become visible. This reduces the load for server and network to what is really necessary.
+
+The summary framework does not render or control the filter form itself, but uses the S3Filter framework to generate the form and apply the filters.
 == Configuration ==