webmcp

changeset 494:e7c9a80b6795

Improved documentation
author jbe
date Wed Jun 28 18:51:36 2017 +0200 (2017-06-28)
parents 9f9a67c8f6f5
children 7eec5b604b00
files framework/env/request/handler.lua framework/env/slot/set_layout.lua
line diff
     1.1 --- a/framework/env/request/handler.lua	Tue Jun 27 17:36:20 2017 +0200
     1.2 +++ b/framework/env/request/handler.lua	Wed Jun 28 18:51:36 2017 +0200
     1.3 @@ -4,7 +4,7 @@
     1.4    http_request    -- HTTP request object
     1.5  )
     1.6  
     1.7 -Called by mcp.lua to process an HTTP request. Calls request.router() and handles the request. Note: request initializers (see request.initialize()) are to be executed by mcp.lua before this function is invoked by mcp.lua.
     1.8 +Called by bin/mcp.lua to process an HTTP request. Calls request.router() and handles the request. Note: request initializers (see request.initialize()) are to be executed by mcp.lua before this function is invoked by mcp.lua.
     1.9  
    1.10  --]]--
    1.11  
     2.1 --- a/framework/env/slot/set_layout.lua	Tue Jun 27 17:36:20 2017 +0200
     2.2 +++ b/framework/env/slot/set_layout.lua	Wed Jun 28 18:51:36 2017 +0200
     2.3 @@ -4,7 +4,9 @@
     2.4    content_type    -- content-type to be sent to the browser, or nil for default
     2.5  )
     2.6  
     2.7 -This function selects which layout should be used when calling slot.render_layout(). If no layout is selected by passing nil as first argument, then no layout will be used, and the slot named "data" is used plainly. The second argument to slot.set_layout is the content-type which is sent to the browser.
     2.8 +This function selects which layout should be used when calling slot.render_layout() (as done by request.handler(...)). If nil is selected as layout, then no layout will be used, but the slot named "data" is used plainly. The second argument to slot.set_layout is the content-type which is sent to the browser.
     2.9 +
    2.10 +The default layout for views is "default". Actions have no default layout, but an explicit call of slot.set_layout(...) (even with nil as first argument) during request handling will cause subsequent calls of slot.layout_is_set() to return true which indicates that content (e.g. via slot.put_into("data", ...)) is available and should be rendered instead of using the action's return value to forward or redirect the user agent.
    2.11  
    2.12  --]]--
    2.13  

Impressum / About Us