1.1 --- a/framework/env/ui/enable_partial_loading.lua	Fri Feb 12 18:40:22 2010 +0100
     1.2 +++ b/framework/env/ui/enable_partial_loading.lua	Fri Feb 19 16:43:29 2010 +0100
     1.3 @@ -1,7 +1,15 @@
     1.4  --[[--
     1.5  ui.enable_partial_loading()
     1.6  
     1.7 -TODO: documentation
     1.8 +This function tells subsequent calls of ui.link{...} and ui.form{...} that
     1.9 +partial loading should be enabled when requested by passing "partial"
    1.10 +arguments to ui.link or ui.form.
    1.11 +
    1.12 +NOTE: To use partial loading, the slots being requested need to be
    1.13 +white-listed by calling request.set_allowed_json_request_slots({...})
    1.14 +in the application configuration file. TODO: By now, at least the slot
    1.15 +names "default", "trace" and "system_error" need to be white-listed, as
    1.16 +these slots are currently hardwired in ui._partial_load_js(...).
    1.17  
    1.18  --]]--
    1.19