Changes between Version 59 and Version 60 of S3

Timestamp:

05/12/14 10:56:00 (12 years ago)

Author:

Fran Boon

Comment:

--

S3

@@ -41 +41 @@
  - [wiki:S3/FieldSelectors Field Selectors]
 
+
+== Configuration ==
+=== Deployment Settings ===
+[wiki:DeveloperGuidelines/DeploymentSettings deployment_settings]
+
+=== Configure ===
+A lot of configuration options are stored as key/value pairs against the tablename using:
+{{{
+s3db.configure(tablename, key=value)
+}}}
+
+These values can be read using:
+{{{
+value = s3db.get_config(tablename, key)
+}}}
+
+These settings may have defaults defined within the core models ({{{modules/s3db/*.py}}}) or default controllers ({{{controllers/*.py}}}) - possibly conditional based on the values of [wiki:DeveloperGuidelines/DeploymentSettings deployment_settings] or which method is being invoked.
+
+Settings can also be customised within the {{{customise_*_resource()}}} or {{{customise_*_controller()}}} functions within a [wiki:DeveloperGuidelines/Templates Template].
+
+The value can be a simple string, a complex object or sometimes a generator function.
+
+Example settings include:
+* {{{list_fields}}}
+ - which fields get displayed as columns in datatables (& currently which are read from the database for use in datalist renderers, but this should change soon as we migrate to {{{S3DataListLayout()}}})
+* {{{filter_widgets}}}
+ - which [wiki:S3/FilterForms S3FilterWidgets] are displayed on datatable, datalist and [wiki:S3/S3Summary Summary] views.
+* {{{report_options}}}
+ - the axes & other options to configure [wiki:S3/S3Report S3Report] for both standalone {{{/report}}} pages & widgets e.g. in [wiki:S3/S3Summary Summary] views.
+* {{{orderby}}}
+ - The default sort order for datatables & datalists (datalists can specify {{{list_orderby}}} if they wish this to be different from that used by datables)
+
+NB If the value is a complex object, then customising this doesn't require re-storing the value as the object is edited in-place.
+
+=== Context ===
+* [wiki:S3/Context Context]
 
 == Database ==