Advanced Properties

An Advanced properties tab usually contains the following property fields:

Widget wrapper

The HTML elements that make up a widget are always wrapped in a single HTML element. This property lets you choose what element to use for this purpose.

Style Id

This property lets you set the widget wrapper element's id attribute, so it can easily be selected in CSS files. This attribute is mainly of interest to theme designers.

Style Class

This property lets you set the widget wrapper element's class attribute, so it can easily be selected in CSS files. This attribute is mainly of interest to theme designers.

Enable Edge Side Includes (ESI)

Check this property to enable Edge Side Includes (ESI) processing of this widget. ESI is a widely-used standard for caching of web pages (see http://www.edge-delivery.org/). If you check this option, then the HTML code representing the widget is wrapped in ESI mark-up specifying that it may be cached by ESI servers. You can specify that some widgets are cached, while others are not, and you can specify how long different widgets should be cached for. You may, for example, decide that a widget whose content changes infrequently can be cached for a long time. Other widgets with more volatile content can be set up to expire more frequently, or not cached at all.

Do not enable this option unless:

  • You know what ESI is and understand how to use it

  • You know that the generated output will be processed by an ESI server

Maximum age (in seconds)

If you have checked Enable Edge Side Includes (ESI), then you must use this property to specify how long the widget may be cached by the ESI server. The ESI server will only use the cached version of the widget until this limit is reached.

Set cache control directive

If you have checked Enable Edge Side Includes (ESI), then this property controls the value of a cache control directive included in the header of the response generated when a caching server requests a new version of this widget. It can be set to one of the following values:

public (the default)

The widget has public content that is valid for all users. The cached copy can therefore be used for all page requests.

private

The widget has user-specific content that is not valid for all users. It should therefore be saved in a private user-specific cache and only used for responding to requests from that user.

no-cache

The widget should not be cached at all.

The Advanced properties tab of some widget types may also contain other widget-specific properties.