In This Section

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

The CMS Library

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

<%@taglib uri="http://www.gx.nl/taglib/wm" prefix="wm" %>

documentLink

<wm:documentLink> -  Returns an HTML link to a document and checks for web user authorization. Example usage:

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

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

<wm:editable contentHolder="${contentholder}" class="maincontentarea" area="0" tag="div"></wm:editable>

This is the most basic and common usage. The class attribute is passed through to the outputted HTML. The following example shows how to wrap the title of a page version:

<wm:editable tag="div" contentHolder="${pageVersion}" area="title" class="main_title">
   ${pageVersion.title}
</wm:editable>

The following are examples of incorrect usage of the <wm:editable> tag:

<wm:editable contentHolder="${contentholder}" class="maincontentarea" area="0" tag="div">
   <wm:render presentationName="freestylepresentation content" object="${contentholder}" startSeparator="0" endSeparator="1"/>
</wm:editable>

<wm:editable contentHolder="${contentholder}" class="maincontentarea" area="0" tag="div"><wm:render bject="${contentholder}"/></wm:editable>

Naming Convention Best Practice

It is best to give areas a meaningful name instead of assigning them a number. Doing so gives you the flexibility to change the order of areas at a later time if you decide to. For example:

<wm:editable contentHolder="${contentholder}" class="maincontentarea" area="maincontent" tag="div"></wm:editable>

Back to Top

form

<wm:form> - Returns an HTML form tag and a (number of) hidden input tags enclosed in it. Additional inputs can be defined in the body of the <wm:form> tag.

The <wm:form> tag is mostly used to render various types of forms. All these forms are processed by the FormHandler which runs on the frontend and processes forms submitted by users. This FormHandler expects several inputs in the form. The <wm:form> tag automatically generates these. What exactly is generated, depends on the handle. Currently the following builtin handles are supported in the <wm:form> tag:

• form - Indicates that the form should be processed using the FormHandler.
• formback - Navigates back one page in the form flow.
• search - Generates a search form.
• poll - Generates a form for the poll functionality.
• forum - Generates a form for the forum functionality.
• verseonstatus - Generates a form to get to call the VerseonFormStatusHandler.
• locationservicemappoint - Used by the Location services functionality in XperienCentral.

Except for the form handle, these are all related to specific XperienCentral features.

Example usage (1):

<wm:form handle="search" onSubmit="doSearch();">
   <input type="text" name="keyword" />
</wm:form>

The example above displays a search form (handle="search"). A search form should specify a keyword, therefore an input is included to set the keyword (using the HTML input tag). Also, some JavaScript should be executed if the form is to be submitted. The onSubmit parameter takes care of that. The rendering of the form parts is delegated using the <wm:render> tag ***. This tag renders the form object of the form element.

Example usage (2):

<wm:form handle="form" onSubmit="return checkForm${formElementId}();">
   <input name="dummybutton" type="image" value="" alt="" src="${presentationcontext.website.emptyImage}" style="position: absolute; border-style: none; padding: 0; spacing: 0; text-indent: 0;" height="0" width="0"/>
   <wm:render object="${formElement.form}" />
</wm:form>

Example usage (3):

<wm:form handle="formback" />

This displays the back button in a form.

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

Back to Top

filterHTMLBasic

<wmfn:filterHTMLBasic> -  Filters the HTML using a basic filtering configuration. It allows the following range of text nodes: <a>, <b>, <blockquote>, <br>, <cite>, <code>, <dd>, <dl>, <dt>, <em>, <i>, <li>, <ol>, <p>, <pre>, <q>, <small>, <span>, <strike>, <strong>, <sub>, <sup>, <u>, <ul> and <l>.

${wmfn:filterHTMLBasic(myHtmlToFilter)}

Back to Top

filterHTMLRelaxed

<wmfn:filterHTMLRelaxed> -  Filters the HTML using a relaxed filtering configuration. It allows the following range of text and structural body HTML:  <a>, <b>, <blockquote>, <br>, <caption>, <cite>, <code>, <col>, <colgroup>, <dd>, <div>, <dl>, <dt>, <em>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, <i>, <img>, <li>, <ol>, <p>, <pre>, <q>, <small>, <span>, <strike>, <strong>, <sub>, <sup>, <table>, <tbody>, <td>, <tfoot>, <th>, <thead>, <tr>, <u>, <ul> and <l>. Example usage:

${wmfn:filterHTMLRelaxed(myHtmlToFilter)}

Back to Top

filterHTMLTags

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

<c:set var="imagesFilter" value="figure,img,figcaption" />

<c:set var="allImages" value="${wmfn:filterHTMLTags(myContent, imagesFilter)}" />

Back to Top

filterHTMLTagsAndAttributes

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

Create an overview of only the a links on an html page:
${wmfn:filterHTMLTagsAndAttributes(myHtmlToFilter, 'a', 'href')}

Extract all images from an html page:
${wmfn:filterHTMLTagsAndAttributes(myHtmlWithImages, 'figure,img,figcaption,a', 'src,width,height,href')}

Remove any styling from the forms in content:
${wmfn:filterHTMLTagsAndAttributes(myStyledForms, 'form,input,fieldset,textarea,label,select,option', 'action,method,type,value,name,for')}

Back to Top

formPart

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

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

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

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

Back to Top

getMediaItems

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

<wm:getmediaitems var="mediaItems"/>

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

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

Back to Top

Back to Top

getMediaItemVersions

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

<wm:getmediaitemversions var="mediaItemVersions"/>

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

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

Back to Top

image

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

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

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

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

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

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

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

Back to Top

link

<wm:link> - Using this tag, link objects can be constructed that refer to pages, downloads, etc. This tag supports dynamic attributes (i.e. you can specify your own attributes) which are passed on to the link object that is created.

Example (1):

<wm:link var="aLinkObject" linkText="clickme" foo="bar" target="_top" />
${aLinkObject.htmlTag}

In the example above, a new link object is created referencing the current page. It is assigned to aLinkObject. Using dynamic attributes a custom attribute (foo) is defined.  The link is opened in the _top section of the window.

 Example (2):

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

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

<wm:object var="message" objectId="${param.message}" objectType="nl.gx.webmanager.cms.forum.ForumMessage"/>
<wm:render object="${message}" />

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.

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

Example 1:

<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). The <wm:pagePart> tag effectively tells XperienCentral to execute that JSPF and include the results.

Example 2:

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

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

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

Back to Top

pageMetaData

<wm:pageMetaData> -  Retrieves a pagemetadata object of the requested type for the current page version. Example usage:

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

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

Back to Top

presentationProperty

<wm:presentationProperty> - Looks up a presentation property defined in the presentation context and returns its value in a JSP variable. Several presentation property types in addition to String and Boolean are supported:

• string
• boolean
• image
• font
• button
• color
• layout

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:

<wm:presentationProperty var="bulletImage" label="bullet" />
${bulletImage.htmlTag}

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

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

Back to Top

render

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

Example (1):

<wm:render var="pollForm" presentationName="WM pollelement form"/>
<wm:render var="pollResult" presentationName="WM pollelement result" />

In the example above, a poll element object is rendered using two different presentations. In this case the default presentation of the poll element is not used because the optional presentationName attribute is provided in the <wm:render> tag. Additionally, no object is specified, which means that the object which is being rendered is the same as the object that is rendered by the JSP this code is in. The example renders both the form and the results into separate variables. Depending on whether the user has submitted the poll, either the form for doing so or the poll results can be displayed. You can also explicitly specify an object and no presentation.

Example (2):

<wm:render object="${element}" />

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

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

<wm:image var="bullet" url="http://www.gxsoftware.com/images/bullet.jpg "/>
<wm:sizedImage var="bulletSmall" image="${bullet}" width="20" height="20" />
${bulletSmall.htmlTag}

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

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

Back to Top

specialPages

<wm:specialPages> -   Returns the special pages for a specific label. In XperienCentral special pages can be defined for several types of labels. For example, a standard media repository page can be selected or RSS feed pages, etc. Example usage:

<wm:specialPages var="pages" label="footerPages" />
<c:forEach items="${pages}" var="page">
   <wm:link reference="${page}" />
</c:forEach>

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.

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

<wm:text var="submitText" label="wm_language.form_submit"/>
<input type="submit" name="${submitText}" />

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.

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

Back to Top

The Functions Library

The Functions library contains functions for manipulating data in XperienCentral. Example usage:

<%@taglib uri="http://www.gxsoftware.com/taglib/functions" prefix="wmfn"%>

Back to Top

function

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

Back to Top