The
<ui:includeClientLib>
tag Includes a AEM html client library, which can be a js, a css, or a theme library. For multiple inclusions of different types, for example js and css, this tag needs to be used multiple times in the jsp. This tag is a convenience wrapper around the
[com.adobe.granite.ui.clientlibs.HtmlLibraryManager](https://helpx.adobe.com/experience-manager/6-4/sites/developing/using/reference-materials/javadoc/com/adobe/granite/ui/clientlibs/HtmlLibraryManager.html)
service interface.

It has the following attributes:

categories
- A list of comma-separated client lib categories. This will include all Javascript and CSS libraries for the given categories. The theme name is extracted from the request.

themed
- A flag that indicates of only themed or non themed libraries should be included. If omitted, both sets are included. Only applies to pure JS or CSS includes (not for categories or theme includes).

CQ Tag Library

To use the CQ Tag Library in your script, the script must start with the following code:

<%@taglib prefix="cq" uri="https://www.day.com/taglibs/cq/1.0" %>

When the
/libs/foundation/global.jsp
file is included in the script, the taglib is automatically declared.

When you develop the jsp script of a AEM component, it is recommended to include following code at the top of the script:

<%@include file="/libs/foundation/global.jsp"%>

It declares the sling, CQ, and jstl taglibs and exposes the regularly used scripting objects defined by the
<cq:defineObjects />
tag. This shortens and simplifies the jsp code of your component.

The
<cq:text>
tag is a convenience tag that outputs component text in a JSP.

It has the following optional attributes:

property
- Name of the property to use. The name is relative to the current resource.

value
- Value to use for output. If this attribute is present, it overwrites the use of the property attribute.

oldValue
- Value to use for diff output. If this attribute is present, it overwrites the use of the property attribute.

escapeXml
- Defines whether the characters <, >, &, ' and " in the resulting string should be converted to their corresponding character entity codes. Default value is false. Note that the escaping is applied after the optional formatting.

format
- Optional java.text.Format to use for formatting the text.

noDiff
- Suppresses the calculation of a diff output, even if a diff info is present.

tagClass
- CSS class name of an element that will surround a non-empty output. If empty, no element is added.

tagName
- Name of the element that will surround a non-empty output. It defaults to DIV.

placeholder
- Default value to use for null or empty text in edit mode, i.e. the placeholder. Please note that the default check is performed after the optional formatting and escaping, i.e. it is written as-is to the output. It defaults to:

<div><span class="cq-text-placeholder">&para;</span></div>

default
- Default value to use for null or empty text. Note that the default check is performed after the optional formatting and escaping i.e. it is written as-is to the output.

The
<cq:setContentBundle>
tag creates an i18n localization context and stores it in the
javax.servlet.jsp.jstl.fmt.localizationContext
configuration variable.

It has the following attributes:

language
- The language of the locale for which to retrieve the resource bundle.

source
- The source where the locale should be taken from. It can be set to one of the following values:

static
- the locale is taken from the
language
attribute if available, otherwise from the server default locale.

page
- the locale is taken from the language of the current page or resource if available, otherwise from the
language
attribute if available, otherwise from the server default locale.

request
- the locale is taken from the request locale (
request.getLocale()
).

auto
- the locale is taken from the
language
attribute if available, otherwise from the language of the current page or resource if available, otherwise from the request.

If the
source
attribute is not set:

If the
language
attribute is set, the
source
attribute defaults to ``
static
.

If the
language
attribute is not set, the
source
attribute defaults to
auto
.

The "content bundle" can be simply used by standard JSTL
<fmt:message>
tags. The lookup of messages by keys is two-fold:

First, the JCR properties of the underlying resource that is currently rendered are searched for translations. This allows you to define a simple component dialog to edit those values.

If the node does not contain a property named exactly like the key, the fallback is to load a resource bundle from the sling request (
SlingHttpServletRequest.getResourceBundle(Locale)
). The language or locale for this bundle is defined by the language and source attributes of the
<cq:setContentBundle>
tag.

A boolean defining whether to flush the output before including the target.

path

The path to the resource object to be included 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 path and resourceType, or script must be specified.

resourceType

The resource type of the resource to be included. If the resource type is set, the path must be the exact path to a resource object: in this case, adding parameters, selectors and extensions to the path is not supported.

If the resource to be included is specified with the path attribute that cannot be resolved to a resource, the tag may create a synthetic resource object out of the path and this resource type.

Either path and resourceType, or script must be specified.

script

The jsp script to include. Either path and resourceType, or script must be specified.

ignoreComponentHierarchy

A boolean controlling whether the component hierarchy should be ignored for script resolution. If true, only the search paths are respected.

Should you use
<%@ include file="myScript.jsp" %>
or
<cq:include script="myScript.jsp" %>
to include a script?

The
<%@ include file="myScript.jsp" %>
directive informs the JSP compiler to include a complete file into the current file. It is as if the contents of the included file were pasted directly into the original file.

With the
<cq:include script="myScript.jsp">
tag, the file is included at runtime.

Should you use
<cq:include>
or
<sling:include>
?

When developing AEM components, Adobe recommends that you use
<cq:include>
.

<cq:include>
allows you to directly include script files by their name when using the script attribute. This takes component and resource type inheritance into account, and is often simpler than strict adherence to Sling's script resolution using selectors and extensions.

The
<cq:includeClientLib>
tag Includes a AEM html client library, which can be a js, a css or a theme library. For multiple inclusions of different types, for example js and css, this tag needs to be used multiple times in the jsp. This tag is a convenience wrapper around the
com.day.cq.widget.HtmlLibraryManager
service interface.

It has the following attributes:

categories
- A list of comma-separated client lib categories. This will include all Javascript and CSS libraries for the given categories. The theme name is extracted from the request.

Equivalent to:
com.day.cq.widget.HtmlLibraryManager#writeIncludes

theme
- A list of comma-separated client lib categories. This will include all theme related libraries (both CSS and JS) for the given categories. The theme name is extracted from the request.

js
- A list of comma-separated client lib categories. This will include all Javascript libraries for the given categories.

Equivalent to:
com.day.cq.widget.HtmlLibraryManager#writeJsInclude

css
- A list of comma-separated client lib categories. This will include all CSS libraries for the given categories.

Equivalent to:
com.day.cq.widget.HtmlLibraryManager#writeCssInclude

themed
- A flag that indicates of only themed or non themed libraries should be included. If omitted, both sets are included. Only applies to pure JS or CSS includes (not for categories or theme includes).

When the
/libs/foundation/global.jsp
file is included in the script, the
<cq:defineObjects />
tag is automatically included.

The
<cq:requestURL>
tag writes the current request URL to the JspWriter. The two tags
<cq:addParam>
and
<cq:removeParam>
and may be used inside the body of this tag to modify the current request URL before it is written.

It allows you to create links to the current page with varying parameters. For example, it enables you to transform the request:

When the
/libs/foundation/global.jsp
file is included in the script, the sling taglib is automatically declared.

The
<sling:include>
tag includes a resource into the current page.

It has the following attributes:

flush

A boolean defining whether to flush the output before including the target.

resource

The resource object to be included in the current request processing. Either resource or path must be specified. If both are specified, the resource takes precedence.

path

The path to the resource object to be included 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 precedence.

resourceType

The resource type of the resource to be included. If the resource type is set, the path must be the exact path to a resource object: in this case, adding parameters, selectors and extensions to the path is not supported.

If the resource to be included is specified with the path attribute that cannot be resolved to a resource, the tag may create a synthetic resource object out of the path and this resource type.

replaceSelectors

When dispatching, the selectors are replaced with the value of this attribute.

addSelectors

When dispatching, the value of this attribute is added to the selectors.

replaceSuffix

When dispatching, the suffix is replaced by the value of this attribute.

The resolution of the resource and the script that are included with the
<sling:include>
tag is the same as for a normal sling URL resolution. By default, the selectors, extension, etc. from the current request are used for the included script as well. They can be modified through the tag attributes: for example
replaceSelectors="foo.bar"
allows you to overwrite the selectors.

Examples:

<div class="item"><sling:include path="<%= pathtoinclude %>"/></div>

<sling:include resource="<%= par %>"/>

<sling:include addSelectors="spool"/>

<sling:include resource="<%= par %>" resourceType="<%= newType %>"/>

<sling:include resource="<%= par %>" resourceType="<%= newType %>"/>

<sling:include replaceSelectors="content" />

The
<sling:defineObjects>
tag exposes the following, regularly used, scripting objects which can be referenced by the developer:

SlingHttpServletResponse object, providing access for the HTTP response that is created by the server. This is currently the same as the HttpServletResponse from which it extends.
request

The standard JSP request object which is a pure HttpServletRequest.
response

The standard JSP response object which is a pure HttpServletResponse.

resourceResolver

The current ResourceResolver object. It is the same as slingRequest.getResourceResolver()

.
sling

A SlingScriptHelper object, containing convenience methods for scripts, mainly sling.include('/some/other/resource') for including the responses of other resources inside this response (eg. embedding header html snippets) and sling.getService(foo.bar.Service.class) to retrieve OSGi services available in Sling (Class notation depending on scripting language).

resource

the current Resource object to handle, depending on the URL of the request. It is the same as slingRequest.getResource().

currentNode

If the current resource points to a JCR node (which is typically the case in Sling), this gives direct access to the Node object. Otherwise this object is not defined.

log

Provides an SLF4J Logger for logging to the Sling log system from within scripts, eg. log.info("Executing my script").

JSTL Tag library

The
JavaServer Pages Standard Tag Library
contains a lot of useful and standard tags. The core, formatting and functions taglibs are defined by the
/libs/foundation/global.jsp
as shown in the following snippet.