Page History

...

In addition to the information in this topic, see also the description of the class nl.gx.webmanager.taglib of the XperienCentral Javadoc.

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

<wmfn:filterHTMLTags> - Filters the HTML. Passed tags are allowed , — other tags are removed from the HTML. Example usage:

...

<wmfn:filterHTMLTagsAndAttributes> - Filters the HTML. Passed tags and attributes are allowed , — other tags and attributes are removed from the HTML. Example usage:

...

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 supports EL (Expression Language) values.

Back to Top

...

getMediaItems

Panel

borderColor	#0081C0
titleColor	#0081C0

The getMediaItems tag was deprecated in XperienCentral version R31. Use getMediaItemVersions instead. See below.

<wm:getMediaItems> - This tag retrieves media items from the Content Repository and sorts the results. Example usage:

...

Code Block

theme	Eclipse

<wm:formPartgetmediaitems var="userNameFormPart" alias="username" mediaItems"/>
${userNameFormPart}

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

...

Attribute	Description	Required	Expression*
`andnotterms`	Specifies a ( comma separated ) list of terms the returned media item doesn't have. This includes terms present in other channels (XperienCentral R25 and higher).	No	Yes
`andterms`	Specifies a ( comma separated ) list of terms the returned media item must have.	No	Yes	This includes terms present in other channels (XperienCentral R25 and higher).	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 at least one of.	No	Yes	This includes terms present in other channels (XperienCentral R25 and higher).	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
`referenceddatabaseentity`	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 supports EL (Expression Language) values.

Back to Top

...

getMediaItemVersions

Panel

borderColor	#0081C0
titleColor	#0081C0

The getMediaItemVersions tag was introduced in XperienCentral version R31.

<wm:getMediaItemVersions> - This tag retrieves media items from the Content Repository and sorts the results. Example usage:

Code Block

theme	Eclipse

<wm:getmediaitemversions var="mediaItemVersions"/>

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

Attribute Description Required Expression*

andnotterms

Specifies a comma separated list of terms the returned media item doesn't have. This includes terms present in other channels (XperienCentral R25 and higher).

No

Yes

andterms

Specifies a comma separated list of terms the returned media item must have. This includes terms present in other channels (XperienCentral R25 and higher).

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

fallbackstrategy

Specifies the fallback strategy to use when the media item is not available in the specified language. This attribute has the following options:

default — The default fallback strategy is used.
ignore — Do not use a fallback language. If no version is found in the target language, nothing will be returned.
specific — Use the specified language as the fallback language. The specified language is configured with the fallbacklanguageid attribute (see below).

Info
If you do not specify a fallback strategy, `default` is used.

See Fallback Language for more information,

No

Yes

fallbacklanguageid Specifies the ID of the language to use as fallback. This attribute works together with the fallbackstrategy="specific" attribute (see above). No Yes

languageid Specifies the ID of the language that media items must match in order to be retrieved 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 at least one of. This includes terms present in other channels (XperienCentral R25 and higher).

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

referenceddatabasentityreferenceddatabaseentity

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

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 supports 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*

hideError

Panel

borderColor	#0081C0
titleColor	#0081C0

The hideError attribute was introduced in XperienCentral version R24.

When set to true, specifies that XperienCentral should not log an error if the specified objectId cannot be found.

No

objectId

Specifies the numerical ID of the object to retrieve.

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

var Specifies the JSP variable to store the result in. Yes No

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

...

<wm:pagePart> - The label defines which JSPF is used to generate the content (looked up in the presentation mappings that XperienCentral creates by reading the presentation descriptor files). An XperienCentral page can contain content consisting of multiple elements, each with its own presentation JSPs. To show these elements, the page presentation JSP should contain a wm tag that renders these elements.

Example ( 1):

Code Block

theme	Eclipse

<div id="column1">
   <wm:pagePart label="Content column 1" />
</div>

...

This tells XperienCentral that a pagePart with the label “Content column 1” should be displayed here. The “Content column 1” label is defined in the presentation descriptor file of the content . JSPF (i.e. content.xml) so the . The <wm:pagePart> tag effectively tells XperienCentral to execute that JSPF and include the results.

Example ( 2):

Code Block

theme	Eclipse

<wm:pagePart label="WM content" var="result"/>
${result}

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

The type for the presentation properties is defined in the presentation descriptor. The values for the properties can be defined in the descriptor files , by creating presentation variants in XperienCentral or by relying on the style information that is defined in XperienCentral. Example usage:

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

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 supports EL (Expression Language) values.

...

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 supports 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.

Back to Top

Page tree

Versions Compared

Old Version 25

New Version Current

Key

getMediaItems

getMediaItemVersions