...
include
Extended version of the cq:include tag. In addition to the original behaviour it allows controlling the WCM mode inside the include, and disabling the decoration markup that's added by WCM by default. The control is done either at component level - using custom properties stored in a component's node, or at the include level - using tag's attributes. Tag's attributes have higher priority than component's meta-data. To force WCM disable / enable set the cog:disableWcm property to true / false respectively (String and Boolean property supported). To set in which modes the decoration is enabled, set the cog:enableDecorationInModes property either as String or multi-value String with one or more of following: disabled, edit, read-only, preview, design, author, publish, all, none.
Attribute | Description | Required? |
|---|---|---|
| additionalCssClassNames | Comma separated list of additional CSS class names that will be added to wrapping markup |  |
| disableWcm | If true, the component is always included with WCM disabled (WCMMode.fromRequest(request) == WCMMode.Disabled). If false - the current WCM mode is passed. False by default. Note, that thanks to the include hierarchy, this setting is populated to all child components. This attribute overrides component's cog:disableWcm property. | |
| enableDecoration | A decoration is an additional markup required by WCM to draw dialog box and added around the include. If true, the decoration of current component is applied as in default cq:include. If false, no decoration is added. True by default. This configuration setting is not populated to children components. This attribute overrides component's cog:disableDecorationInModes property. | |
| flush | if true, tag flushes the output before including the target; false by default | |
| ignoreComponentHierarchy | A boolean controlling whether the component hierarchy should be ignored for script resolution. If true, only the search paths are respected. False by default. | |
| path | The path to the resource object to include in the current request processing. If this path is relative it is appended to the path of the current resource whose script is including the given resource. Either resource or path must be specified. If both are specified, the resource takes precedences. | |
| render | if false, tag does not render; true by default | |
| resourceType | The resource type of a resource to include. If the resource to be included is specified with the path attribute, which cannot be resolved to a resource, the tag may create a synthetic resource object out of the path and this resource type. If the resource type is set the path must be the exact path to a resource object. That is, adding parameters, selectors and extensions to the path is not supported if the resource type is set. | |
| script | The JSP script to include. Either path and resourceType, or script must be specified. | |
...