site xml

From bemoko developer wiki

Jump to: navigation, search

site-config.xml

Header xml doc

element attribute values description
header name [a-zA-Z]+ Name of the HTTP header to be sent in the response
  value [a-zA-Z]+ Value of the HTTP header to be sent in the response
  expr expression The header will be sent when the expression is true (or if the expression is not set)

Intent xml doc

element attribute values description
intent name [a-z]+ Name of the intent as referenced to in the URI context, e.g. http://myhost/site/intent
  type template (default), application or renderer. The type of the template. Template indicates that the view is text file with template instructions in, e.g. Freemarker. Application indicates that the view is an application, e.g. a PHP page. Renderer indicates that the intent is delivered by a render plugin which gives you full control from within a plugin to deliver response content.
  view file name The name of file to use to render the intent whether it be a template or an application, e.g. index.html

Param xml doc

element attribute values description
param name [a-zA-Z]+ Name of the parameter. The value of the parameter is taken from the content of the param element

Source xml doc

element attribute values description
source name [a-zA-Z]+ Name for the plugin. This as the plugin is referred to in a template
  plugin [a-zA-Z\.]+ Plugin class name. This as the name of the plugin class without the extension, for example if you have a plugin called MyPlugin.groovy defined in the plugins folder, then you would refer to it as MyPlugin. If you have a plugin called MyPlugin.groovy defined in the plugins/mypackage folder then you would refer to it here as mypackage.MyPlugin. If you do not specify a name then the plugin attribute value is the name by which the plugin is made available in the templates.
  scope request (default), session or site Scope that the plugin is stored at. Request scoped plugins are created new for each request, session scoped plugins are created once and reused for a given users sessions, site scoped plugins are created once for the site and reused for all users
  expr expression When the expression is true the plugin will be available for the given request

UI xml doc

element attribute values description
source name [a-z]+ Name of the UI
  expr expression When the expression is true the UI (or a child of this UI) will be enabled
  fallback [a-z]+ Name of a UI that this UI inherits from