isinclude Element

Syntax

<isinclude 
  (template = template_name) | (url = url_path) //required. template or URL, but not both
  sf-toolkit = on | off //on is default
/>
(template = template_path) | (url = url_path)

You must include either template or URL, but not both:

  • template = template_path

    Allowed data type: string or expression.

    template_path specifies the name and location of the included template. Use a fixed value or an expression. This is a local include.

  • url = url_path

    Allowed data type: string or expression.

    url_path specifies a URL via a literal string or an expression. This includes the content of this URL, typically a URL from the same server. This is a remote include.
    Note: SEO URLs can't be included remotely.
sf-toolkit

Allowed data type: string

on renders the dwMarker tag around includes. This can cause Internet Explorer to enter Quirks mode.

off suppresses the dwMarker tag around includes. See the section on suppressing the dwMarker tag.

Purpose

Includes the contents of one template inside another or the contents of another URL. The template being included can be as complex as an entire page template, or as simple as a single line of HTML code.

Iterators used in the including template can be referenced from the included template. This is particularly useful if you want to use an included template in a loop statement. To avoid infinite template processing caused by self-includes, the maximum include depth is fixed to 10.

Note: Includes from another server are not supported.

There are two possibilities when referencing an included template: The ISML code is processes or the ISML code isn't processed

ISML Code Is Processed

If the template is stored in a Salesforce B2C Commerce cartridge, you can use the template attribute to specify the path and the file name of the template to be included (the specified path has to be relative to your cartridge's root/templates/default language directory).

For example:

<isinclude template="reporting/ReportBasket.isml">

Example:

The following example shows a standard include of a template. The template blueBar.isml file could be used in a template to show a menu bar on the storefront pages.

This menu bar gives the customer access to different storefront functionality, such as a basket or the search mask. Using <isinclude> this way implements server-side frames that give you the full functionality of frames without the caveats of client-side frames due to incompatibilities between different browsers.

<isinclude template="inc/blueBar">

This example shows a standard include where the included template references an iterator of the including template:

<isloop iterator = "${pdict.Basket.product}" var="product">
<isinclude template = "inc/banner">
</isloop>
...
<!-- code of the included template -->

ISML Code Isn't Processed

The second possibility is to reference a remote URL that is located on another server accessible via an HTTP or HTTPS connection. In this case, use the URL attribute to specify a valid URL. Using the URL attribute directs B2C Commerce eCommerce to open an HTTP(S) connection to the specified remote system during run time, and to add the result of this HTTP(S) request to the template. Remote templates are particularly useful if you want to avoid client-side frames in HTML or when combining data in one template that comes from multiple servers.

The included URL can have a different caching policy. This lets you, for example, embed a dynamic snippet of HTML, which isn't cached, into a completely cached surrounding page. Conversely, a fully cached snippet can be embedded into a fully dynamic and uncached page.

for example:

<isinclude url="${URLUtils.url('Page-Include','cid', 'COOKIE_TEST')}">

Example:

This example shows an include that combines data into one template. In this case, <isinclude> triggers another pipeline to show hot deals on the storefront entry page. The call is executed after the Webserver processes the initial request. Therefore, data in the Pipeline Dictionary is no longer available.

<isinclude url="${URLUtils.url('BrowseCatalog-Hotdeals',
'catalogCategoryID','Storefront')}">

This example illustrates dynamic template selection. The name of the referenced template is built during run time.

<isinclude template = "${'ProductTemplates/Template' + pdict.product.templateNumber}">

Suppressing the DwMarker Tag for Internet Explorer

If you have enabled the Storefront Toolkit, the content of every <isinclude> tag is surrounded by a dwMarker tag. Under some circumstances, the dwMarker tag causes Internet Explorer to change into Quirks mode.

For example:

<!-- dwMarker="linclude" dwTemplateTitle="/default/test/customassets.isml (SiteGenesis Storefront cartridge)" dwTemplateURL="http://localhost:60606/target=/c/sitegenesis_storefront_richUI/t/default/test/customassets.isml" -->
<!DOCTYPE html>
You can now add the sf-toolkit="off" attribute in your isinclude tag to suppress the dwMarker tag from being written into your HTML page.
<isinclude template="test/customassets" sf-toolkit="off"/>

This suppresses the dwMarker tag around the content produced by test/customassets.isml. The new attribute is only supported by local includes. However, remote includes don't support this attribute.

Note: The sf-toolkit="off" attribute is not applied recursively. The dwmarker tag is only suppressed for the include tag itself, and not for any child-"isinclude" inside of that "include" template.