1.1 --- a/framework/env/ui/partial.lua	Fri Feb 12 18:40:22 2010 +0100
     1.2 +++ b/framework/env/ui/partial.lua	Fri Feb 19 16:43:29 2010 +0100
     1.3 @@ -1,16 +1,22 @@
     1.4  --[[--
     1.5  ui.partial{
     1.6 -  module =
     1.7 -  view =
     1.8 -  id =
     1.9 -  params =
    1.10 -  target =
    1.11 +  module  = module,     -- module to be used to reload inner contents
    1.12 +  view    = view,       -- view   to be used to reload inner contents
    1.13 +  id      = id,         -- id     to be used to reload inner contents
    1.14 +  params  = params,     -- params to be used to reload inner contents
    1.15 +  target  = target,     -- id of HTML element containing contents to be replaced
    1.16    content = function()
    1.17 -    ...                   -- 
    1.18 +    ...
    1.19    end
    1.20  }
    1.21  
    1.22 -TODO: documentation
    1.23 +Calling this function declares that the inner contents can be requested
    1.24 +directly via the given module, view, id and params. The parameter "target"
    1.25 +specifies the id of the HTML element, which should be replaced when
    1.26 +reloading partially.
    1.27 +
    1.28 +The function has an effect on inner calls of ui.link{..., partial = {...}}
    1.29 +and ui.form{..., partial = {...}}.
    1.30  
    1.31  --]]--
    1.32