Versions Compared

Key

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

...

AttributeDescriptionRequired

Expression*

contentIdSets the content ID of the document to which a link should be returned.YesYes
dataSourceSets the data source name which can be queried to retrieve more information about the document.YesYes
classNameSpecifies the class name to be used in the class="..." attribute of the resulting HTML link.NoYes
linkTextThe text to be used in building the link. The default value is the title of the document that is referred to.NoYes
mimeTypeOnlySpecifies 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.NoNo
mouseOverTextSpecifies 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).NoYes
showDocumentTypeIconSpecifies whether the documenttype icon should be shown to left of the link. The default value is false (no icon).NoNo
showTitleOnlySpecifies whether the linkText (see above) should be shown as an HTML link or as normal text. The default value is true (normal text).NoNo
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.

NoYes
varSpecifies the JSP variable to store the result in.NoNo
webUserGroupsSets the web user groups who are granted access to the document.NoYes

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

 

Back to Top

 

...

editable

<wm:editable> -  Marks editable content areas on the page inside the editor. The inline edit mode in XperienCentral needs to know where editable content exists on the page. This is accomplished by wrapping the editable areas using the <wm:editable> tag, thereby indicating where the editable content is located. Example usage:

...

AttributeDescriptionRequiredExpression*
handle

Sets the name of the handle that should be used. Valid values: see the description of the available handles above.

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

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

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

NoYes
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).

NoYes

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

 

Back to Top

 

...

formPart

<wm:formPart> -  This tag retrieves a form part using its alias as the search criteria. Example usage:

...

AttributeDescriptionRequiredExpression*
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.

YesYes
var

Specifies the JSP variable in which to store the result.

YesNo

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

 

Back to Top

 

...

getMediaItems

...

AttributeDescriptionRequiredExpression*
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.

NoYes
andterms

Specifies the JSP variable in which to store the result.

NoYes
contenttypes

Specifies the content type of the media item (article, image, etc.).

NoYes
createdsince

Specifies the date after which the returned media items must have been created.

NoYes
excludemediaitemids

Specifies the returned media item IDs that need to be excluded.

NoYes
orterms

Specifies the term(s) that the returned media items must have.

NoYes
publicationdatefrom

Specifies the beginning of the date range in which the returned media item was published.

NoYes
publicationdateto

Specifies the end of the date range in which the returned media item was published.

NoYes
referenceddatabasentity

Specifies the database entity the returned media item is linked to.

NoYes
referencedresourceinstance

Specifies the resource instance the returned media item is linked to.

NoYes
resultrange

Specifies the number of returned media items to display.

NoYes
sortascending

Specifies whether to sort the returned media items in ascending order.

NoYes
sortoptions

Specifies how to sort the returned media items. The options are:

  • creationdate
  • mostviewed
  • mostreactions
  • publicationdate
  • modificationdate
  • voteaverage
  • webtitle
  • lastpost
NoYes
statusid

Specifies the media item’s workflow state.

NoYes
websiteid

Specifies the ID of the website from which the media items are retrieved.

NoYes

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

 

Back to Top

 

...

image

<wm:image> -  Creates an Image object from its URL. Example usage:

...

AttributeDescriptionRequiredExpression*
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.

YesYes
var

Specifies the JSP variable in which to store the result.

YesNo

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

 

Back to Top

 

...

includeUrl

<wm:includeUrl> - This tag evaluates the URL to which the given parameter points to and writes the result to the JSP page. External URLs should start with http. Internal URLs should be relative to the context path (i.e. start with /). Use this instead of jsp:include to pass on the presentation context. Example usage:

...

AttributeDescriptionRequiredExpression*
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.

YesYes
connectionTimeout

Sets the connection timeout in milliseconds for external URLs. The default value is 5000 (= 5 sec.).

NoYes
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).

NoYes
readTimeout

Sets the read timeout in milliseconds for external URLs. Input. The default value is 10000 (= 10 sec.).

NoYes

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

 

Back to Top

 

...

isActive

<wm:isActive> -  This tag specifies whether the object that is specified comes from a component that is currently active. For example, it returns false when invoked on an element that is contained by a plugin that is in the RESOLVED state (currently not running). Example usage:

...

AttributeDescriptionRequiredExpression*
var

Specifies the JSP variable in which to store the result in.

YesNo
className

Specifies the class name to be used in the class="..." attribute of the resulting HTML link.

NoYes
linkTextSets the text to use when displaying the HTML link. The default value is the title of the page that is linked to.NoYes
mouseOverTextSpecifies 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.NoYes

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.NoYes
passOnAllParametersSpecifies whether all URL parameters of the current request are included in the link that is built. The default value is false (don't include).NoYes
presentationNameSpecifies an XperienCentral presentation object. The link is rendered by this presentation.NoYes
referenceThe page to link to. If not set, the current page will be used.NoYes
targetSpecify 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.NoYes

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

 

Back to Top

 

...

object

<wm:object> -  Retrieves an object from the content database which is filled with objects that have an ID and a type. For XperienCentral objects that are exposed through the Java API, wrapper classes are available that encapsulate the data that is stored in the content database. The public API of these wrapper classes is defined in interfaces. The <wm:object> tag can be used as a factory for creating wrapper objects based on the type and object ID. The type is the fully qualified class name of the wrapper interface. If no wrapper object can be created (either the ID or the type is wrong), the value null is used. Example usage:

...

AttributeDescriptionRequiredExpression*
objectid

Sets the numerical ID of the object to retrieve.

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

YesYes
varSpecifies the JSP variable to store the result in.YesNo

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

 

Back to Top

 

...

pagePart

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

...

AttributeDescriptionRequiredExpression*
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”.

YesYes
object

Specifies the object to render. The default value is ${presentationcontext.baseObject} (the object that is rendered by the jsp this tag is in).

NoYes
varSpecifies the JSP variable to store the result in.NoNo

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

 

Back to Top

 

...

pageMetaData

...

AttributeDescriptionRequiredExpression*
type

Specifies the type of metadata. The valid values are keywords and description.

YesYes
varSpecifies the JSP variable to store the result in.YesNo

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

 

Back to Top

 

...

presentationProperty

...

AttributeDescriptionRequiredExpression*
label

Specifies the property label to retrieve.

YesYes
varSpecifies the JSP variable to store the result in.YesNo
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.
  
useTargetPageStyleSpecifies 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.

 

Back to Top

 

...

render

<wm:render> -  renders an object using a presentation.

...

AttributeDescriptionRequiredExpression*
object

Specifies the object to render. The default value is ${presentationcontext.baseObject} (the object that is rendered by the JSP this tag is in).

YesYes
presentationNameSets 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.YesNo
varSpecifies the JSP variable to store the result in.NoNo

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

 

Back to Top

 

...

sizedImage

<wm:sizedImage> -  Resizes image objects. If the aspect ratio (height/width) of the resized image is different than the source image, the image will be cropped from the top and bottom or left and right to avoid the displaying of black bars. It returns the resized image object. Example usage:

...

AttributeDescriptionRequiredExpression*
height

Sets the height of the resized image in pixels.

YesYes
imageSpecifies the image object to resize.YesNo
varSpecifies the JSP variable to store the result in. YesNo
widthSets the width of the resized image in pixels.YesYes

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

 

Back to Top

 

...

specialPages

...

AttributeDescriptionRequiredExpression*
label

Specifies the special page label as defined in XperienCentral

YesYes
varSpecifies the JSP variable to store the result in. YesNo

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

 

Back to Top

 

...

text

<wm:text> - This tag looks up the text value defined for a language label as configured in XperienCentral. The configuration can be found in the Configure > Language Labels menu in XperienCentral. If the var attribute is set, the result is bound to this variable, otherwise the result of the lookup is printed. Example usage:

...

AttributeDescriptionRequiredExpression*
label

Specifies the text label as defined in XperienCentral

YesYes
varSpecifies the JSP variable to store the result in. NoNo

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

 

Back to Top

 

...

The Functions Library

...