Changes between Version 7 and Version 8 of S3/S3Summary

Timestamp:

07/31/14 13:40:42 (11 years ago)

Author:

Dominic König

Comment:

--

S3/S3Summary

@@ -33 +33 @@
 == Configuration ==
 
+The summary page configuration is a deployment setting:
+
+{{{#!python
+settings.ui.summary = [...]
+}}}
+
+It takes a list of section configurations as value, or None.
+
+The deployment setting can be overridden per resource:
+{{{#!python
+s3db.configure(tablename, summary = [...])
+}}}
+
+A useful technique is to extend the deployment settings for a particular resource as needed:
+{{{#!python
+# Get the default configuration
+summary = list(current.deployment_settings.get_ui_summary() or [])
+# Extend with resource-specific sections
+summary.extend([...])
+s3db.configure(tablename, summary = summary)
+}}}
+
+=== Sections Configuration ===
+
+Each section configuration is a dict:
+{{{#!python
+settings.ui.summary = [{"name": "table",    # the section name, must be unique
+                        "label": "Table",   # the section label, will automatically be translated
+                        "common": False,    # show this section on all tabs
+                        "translate": True,  # turn automatic label translation on/off (default=True)
+                        "widgets": [...],   # list of widgets for this section
+                        },
+                        {...}, # next section
+                        ...
+                       ]
+}}}
+
+Sections are rendered in the order in which they are configured.
+
+=== Widget Configuration ===
+
+Each widget configuration is a dict in the "widgets" list of a section:
+{{{#!python
+settings.ui.summary = [{"name": "table",
+                        "label": "Table",
+                        "common": False,
+                        "translate": True,
+                        "widgets": [
+                           {"method": "datatable",  # widget method, either a name that resolves into
+                                                    # a S3Method, or a callable to render the widget
+
+                            "filterable": True,     # Whether the widget can be filtered by the summary
+                                                    # filter form
+
+                            "ajax_init": False,     # Whether the widget requires an Ajax-request to initialize
+                                                    # True for "report" and "map" widgets
+                            },
+                           {...},                   # Next widget
+                         ],
+                        },
+                       ]
+}}}
+
+If a method name is passed for "method", it is important that the corresponding method handler implements the widget() interface.
+
+Instead of a name, you can also specify a callable that returns either HTML content, or a dict of variables for the view template.
 == Code ==