Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

Table of Contents

maxLevel	2

...

The CMS Library

The CMS library is used for retrieving information from the XperienCentral content management system.

...

Code Block

theme	Eclipse

<wm:documentLink var="docLink" contentId="${productInfo.document}" dataSource="jdbc/internaldb" />
${docLink}

Attribute	Description	Required	Expression*
`contentId`	Sets the content ID of the document to which a link should be returned.	Yes	Yes
`dataSource`	Sets the data source name which can be queried to retrieve more information about the document.	Yes	Yes
`className`	Specifies the class name to be used in the `class="..."` attribute of the resulting HTML link.	No	Yes
`linkText`	The text to be used in building the link. The default value is the title of the document that is referred to.	No	Yes
`mimeTypeOnly`	Specifies whether the MIME type of the document should be returned (set to `true`) or whether to return an HTML link to the document itself (set to `false`). The default value is `false`.	No	No
`mouseOverText`	Specifies the text to be used in the `title="..."` attribute of the resulting HTML link. This text is usually shown as a tooltip if the mouse cursor is hovered over the link. The default is the value of the `linkText` attribute (see above).	No	Yes
`showDocumentTypeIcon`	Specifies whether the `documenttype` icon should be shown to left of the link. The default value is `false` (no icon).	No	No
`showTitleOnly`	Specifies whether the `linkText` (see above) should be shown as an HTML link or as normal text. The default value is `true` (normal text).	No	No
`target`	Specifies the name of the HTML frame to be used in the `target="..."` attribute of the resulting link. If the link is clicked, the document is opened in this frame. If no frame with this name can be found, the link is opened in a new browser window. The default value for this attribute is empty which means the link will open in the same window.	No	Yes
`var`	Specifies the JSP variable to store the result in.	No	No
`webUserGroups`	Sets the web user groups who are granted access to the document.	No	Yes

*The attribute can support EL (Expression Language) values.

...

This displays the back button in a form.

Attribute	Description	Required	Expression*
`handle`	Sets the name of the handle that should be used. Valid values: see the description of the available handles above.	Yes	Yes
`extraPassOn`	Specifies a comma-separated list of extra parameters to be used in generating the URL in the form. This is the URL of the page to display when an action is performed in the form. By default the following values are already passed on: `contentid`,`dbid`,`typeofpage`,`step`,`orgurl`,`cfe`, and `forum`.	No	Yes
`target`	Specifies the name of the HTML frame to be used in the `target="..."` attribute of the resulting HTML form tag. The response to the form is displayed in the target frame. If the specified frame does not exist, the response is shown in a new window.	No	Yes
`frame`	If a value (OUTP) for this attribute is specified, an HTML input tag is created as follows in the body of the form tag: `<input type="hidden" name="frame" value="OUTP" />`. This attribute may be used in conjunction with the attribute `"target"` to specify the frame to load in the response to the form.	No	Yes
`onSubmit`	Specifies the name of the JavaScript function to be used in the `onSubmit="..."` attribute of the resulting HTML form tag. This function can be used to, for example, do some error checking on the form data. The default value is empty (no function).	No	Yes

*The attribute can support EL (Expression Language) values.

...

The fragment above will look up the form part with the alias "username".

Attribute	Description	Required	Expression*
`alias`	Specifies the alias of the form part to search for. This is the alias that is used in the XSL of the form handlers to identify the form part.	Yes	Yes
`var`	Specifies the JSP variable in which to store the result.	Yes	No

*The attribute can support EL (Expression Language) values.

...

The example above retrieves all media items that match a specified term.

Attribute	Description	Required	Expression*
`andnotterms`	Specifies the alias of the form part to search for. This is the alias that is used in the XSL of the form handlers to identify the form part.	No	Yes
`andterms`	Specifies the JSP variable in which to store the result.	No	Yes
`contenttypes`	Specifies the content type of the media item (article, image, etc.).	No	Yes
`createdsince`	Specifies the date after which the returned media items must have been created.	No	Yes
`excludemediaitemids`	Specifies the returned media item IDs that need to be excluded.	No	Yes
`orterms`	Specifies the term(s) that the returned media items must have.	No	Yes
`publicationdatefrom`	Specifies the beginning of the date range in which the returned media item was published.	No	Yes
`publicationdateto`	Specifies the end of the date range in which the returned media item was published.	No	Yes
`referenceddatabasentity`	Specifies the database entity the returned media item is linked to.	No	Yes
`referencedresourceinstance`	Specifies the resource instance the returned media item is linked to.	No	Yes
`resultrange`	Specifies the number of returned media items to display.	No	Yes
`sortascending`	Specifies whether to sort the returned media items in ascending order.	No	Yes
`sortoptions`	Specifies how to sort the returned media items. The options are: `creationdate` `mostviewed` `mostreactions` `publicationdate` `modificationdate` `voteaverage` `webtitle` `lastpost`	No	Yes
`statusid`	Specifies the media item’s workflow state.	No	Yes
`websiteid`	Specifies the ID of the website from which the media items are retrieved.	No	Yes

*The attribute can support EL (Expression Language) values.

...

Code Block

theme	Eclipse

<wm:image var="photo" url="http://www.gx.nl/images/picture.jpg" alternativeText="a picture" />
${image.htmlTag}

Attribute	Description	Required	Expression*
`alias`	Specifies the alias of the form part to search for. This is the alias that is used in the XSL of the form handlers to identify the form part.	Yes	Yes
`var`	Specifies the JSP variable in which to store the result.	Yes	No

*The attribute can support EL (Expression Language) values.

...

Code Block

theme	Eclipse

<wm:includeUrl url="/WEB-INF/presentation/jsp/shared/include/top.jspf" />

Attribute	Description	Required	Expression*
`url`	Specifies the URL indicating the resource to retrieve the HTML from. To include references to other JSP files, use the relative path found on the “Presentation” tab in XperienCentral.	Yes	Yes
`connectionTimeout`	Sets the connection timeout in milliseconds for external URLs. The default value is `5000` (= 5 sec.).	No	Yes
`followRedirects`	Specifies whether a redirect should be followed if the URL returns a redirect to another location. The default value is `true` (= follow the redirect).	No	Yes
`readTimeout`	Sets the read timeout in milliseconds for external URLs. Input. The default value is `10000` (= 10 sec.).	No	Yes

*The attribute can support EL (Expression Language) values.

...

Code Block

theme	Eclipse

<wm:isActive var="componentLoaded" object="${componentObject}"/>
<c:if test="componentLoaded">
...
</c:if>

Attribute	Description	Required	Expression*
`object`	Specifies the Java object to check.	Yes	Yes
`var`	Specifies the JSP variable to store the result in.	No	No

*The attribute can support EL (Expression Language) values.

...

Code Block

theme	Eclipse

<wm:link var="homepage" reference="${presentationcontext.website.homePage}" linkText="to the homepage" />
Click here to go ${homepage.htmlTag}.

Attribute	Description	Required	Expression*
`var`	Specifies the JSP variable in which to store the result in.	Yes	No
`className`	Specifies the class name to be used in the `class="..."` attribute of the resulting HTML link.	No	Yes
`linkText`	Sets the text to use when displaying the HTML link. The default value is the title of the page that is linked to.	No	Yes
`mouseOverText`	Specifies the text to be used in the `title="..."` attribute of the resulting HTML link. This text is usually shown as a tooltip if the mouse cursor is hovered over the link.	No	Yes
`passOn`	Specifies a comma separated list of all URL parameters of the current request that need to be included in the link that is built.	No	Yes
`passOnAllParameters`	Specifies whether all URL parameters of the current request are included in the link that is built. The default value is `false` (don't include).	No	Yes
`presentationName`	Specifies an XperienCentral presentation object. The link is rendered by this presentation.	No	Yes
`reference`	The page to link to. If not set, the current page will be used.	No	Yes
`target`	Specify the target to be used in the `target="..."` attribute of the resulting HTML link. Using this attribute, links can be opened in a new browser window. The default value is empty which means the link will open in the current window.	No	Yes

*The attribute can support EL (Expression Language) values.

...

The example above assigns a ForumMessage object to the variable message. Some tags like <wm:render> have an attribute object. The variable may be used in such tags.

Attribute	Description	Required	Expression*
`objectid`	Sets the numerical ID of the object to retrieve.	Yes	Yes
`objectType`	Specifies the Java class of the object to retrieve. The `objectType` should be a fully qualified classname. Note there are some deprecated abbreviations for some classes which are still supported. You should always use the fully qualified classname. In future releases, support for the abbreviations may be dropped.	Yes	Yes
`var`	Specifies the JSP variable to store the result in.	Yes	No

*The attribute can support EL (Expression Language) values.

...

Create custom pageParts by defining a .JSPF and an XML descriptor file.

Attribute	Description	Required	Expression*
`label`	Specifies the label of the page part to render. This must be an exact match of the value of the `<name>` defined in the descriptor XML file and the `<scope>` in that file must be “pagepart”.	Yes	Yes
`object`	Specifies the object to render. The default value is `${presentationcontext.baseObject}` (the object that is rendered by the jsp this tag is in).	No	Yes
`var`	Specifies the JSP variable to store the result in.	No	No

*The attribute can support EL (Expression Language) values.

...

Code Block

theme	Eclipse

<wm:pageMetaData var="keywords" type="keywords" />
<meta name="keywords" value="${keywords}" />

Attribute	Description	Required	Expression*
`type`	Specifies the type of metadata. The valid values are `keywords` and `description`.	Yes	Yes
`var`	Specifies the JSP variable to store the result in.	Yes	No

*The attribute can support EL (Expression Language) values.

...

In the example above, the presentation property named “bullet” is retrieved and its value is returned in the variable bulletImage.

Attribute	Description	Required	Expression*
`label`	Specifies the property label to retrieve.	Yes	Yes
`var`	Specifies the JSP variable to store the result in.	Yes	No
`page`	Specifies the page to used to retrieve a style property from. For example, this is used for page images in a navigation menu. This attribute is only used for properties of type `image`, `button`, `color` and `font`. For other property types this attribute is ignored.
`useTargetPageStyle`	Specifies whether the style of the target page is used to retrieve a style property instead of the style of the current page. This attribute is only used for properties of type `image`, `button`, `color` and `font`. For other property types this attribute is ignored.

*The attribute can support EL (Expression Language) values.

...

The <wm:render> tag renders the object ${element} using whatever presentation is associated with the object in XperienCentral.

Attribute	Description	Required	Expression*
`object`	Specifies the object to render. The default value is `${presentationcontext.baseObject}` (the object that is rendered by the JSP this tag is in).	Yes	Yes
`presentationName`	Sets the presentation that the object should be rendered with. The default value is empty, which means the object is rendered using the presentation assigned in XperienCentral.	Yes	No
`var`	Specifies the JSP variable to store the result in.	No	No

*The attribute can support EL (Expression Language) values.

...

In the example above the image stored in the variable bullet is resized to 20x20 pixels and returned in the variable bulletSmall.

Attribute	Description	Required	Expression*
`height`	Sets the height of the resized image in pixels.	Yes	Yes
`image`	Specifies the image object to resize.	Yes	No
`var`	Specifies the JSP variable to store the result in.	Yes	No
`width`	Sets the width of the resized image in pixels.	Yes	Yes

*The attribute can support EL (Expression Language) values.

...

In the example above all footer Pages (defined in the XperienCentral Configuration menu) are returned in the variable pages. A link to each of these pages is created.

Attribute	Description	Required	Expression*
`label`	Specifies the special page label as defined in XperienCentral	Yes	Yes
`var`	Specifies the JSP variable to store the result in.	Yes	No

*The attribute can support EL (Expression Language) values.

...

In the example above the text defined for the label "wm_language.form_submit" is retrieved for the current language. A button using this text is displayed.

Attribute	Description	Required	Expression*
`label`	Specifies the text label as defined in XperienCentral	Yes	Yes
`var`	Specifies the JSP variable to store the result in.	No	No

*The attribute can support EL (Expression Language) values.

...

Code Block

theme	Eclipse

<script type="text/javascript">
alert('page title is ${wmfn:escapeToJavascript(pageVersion.title)}');
</script>

Function	Description
`addLineFeed` `: string`	Retrieves a line feed (usually line feeds in JSP pages are ignored).
`contains` `(object, object[]) : boolean`	Returns `true` if the array contains the instance.
`convertToJavaScript` `(string) : string`	Converts HTML code to JavaScript document.write statements.
`escapeToJavaScript` `(string) : string`	Replaces `\\` with `\\\\` and `'` with `\\'` in a string so that it can be used in a JavaScript statement.
`escapeToText` `(string) : string`	Surrounds the text part with a `<pre>` tag so that while processing this part should be taken literally and so that line feeds should be preserved.
`formatExternalUrl` `(string) : string`	Prepends `http://` before an external URL if it doesn't start with `http://`, `https://`, `ftp://`, `file://`, `javascript`:, `mailto:`, / or `#`.
`formSignatureParameterName` `(servletcontext) : string`	If secure forms are enabled, this function retrieves the name of the secure form request parameter. This function returns the name of the form parameter which should be used for sending the form signature.
`indexOf` `(object, object[]): int`	Returns the index of the object in the array or `-1` if the array doesn't contain the object.
`instanceOf` `(object, string): boolean`	This is more flexible `instanceOf` implementation than the built-in Java `instanceOf` operator.
`replaceNewLines` `(string) : string`	Replaces new lines with `<br />`.
`signFormParameters` `(servletcontext, servletrequest, string) : string`	Computes a signature for a set of names for the use of secure forms in SiteWorks.
`signFragment` `(servletcontext, servletrequest, string) : string`	Generates a secure forms signature for the given HTML fragment.
`sortRows` `(object[][], int, boolean) : object[]`	Sorts a two dimensional array (an array of arrays) by the objects in a column.
`sortMaps` `(sortedmap[], string, boolean) : sortedmap`	Sorts an array of `SortedMaps` by the elements at a specified key.
`subArray` `(object[], int, int) : object[]`	Returns a sub array of the original array.
`urlEncode` `(string) : string`	The URL encodes a UTF-8 string.

...