All the WCM 6.1.5 tags

A wiki version of the information found here in the IBM Infocenter

WCM Element tags

Element's are fields (and there corresponding values) that you created when you defined an authoring template or added an element to a site or site area. The Element tag is reference an element within a presentation template or element design.

<Element type=" " context=" " name=" " key=" "
         format=" " link=" " separator=" "
         htmlencode=" " awareness=" " start=" " end=" " />

<Element

Opens the tag.

type=" "

This determines where the element is being referenced from. Either "content", "sitearea" or "site".

context=" "

This determines which content item or site area is being referenced.

  • Selected Refers to a particular item as specified in the name attribute below.
  • Current This will reference the element from the current site, site area or content item that is being browsed by the user.
  • AutoFill The element being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.

name=" "

Enter the name and library of the item the element is being referenced from. For example, name="library/item". To use the library specified in the URL of the current page, use name="./item".
Note:

  • If a content item with the same name is used in more than one site, you can also specify name="library/site/sitearea/item" to select the appropriate content item.
  • If you specify name="./item", the library name will not appear in your presentation template or element design. The actual path will not be resolved until the item is rendered.The "name" parameter is not used if context=current or context=autofill.

key=" "

This is the name of this element being referenced.

format=" "

This parameter is optional and can only be used with some component types:

When referencing an image component:

  • Use format="url" to only render the URL of an image component.
  • Use format="alt" to only render the contents of the alt tag of an image component.
  • Use format="tag" to render a complete image tag. The image will be displayed on the rendered page. This is used by default if no format is specified.
    When referencing a file resource component:
  • Use format="HTML" If your file resource is a file type that can be converted to HTML you can instead convert the file to HTML and render the converted HTML directly. Examples of supported file types include: word processing documents (.doc, *.odt) spreadsheets (.xls) HTML files (.htm, .html) Text files (.txt) Other file types may also work but you will need to test them first.
    Note: Maximum Cache SizeIf the converted HTML is larger than the default cache size defined by the resourceserver.maxCacheObjectSizeproperty in the WCM ConfigService.properties file, each request that contains this file will be converted dynamically instead of using the cached copy. This will impact performance. You may need to increase the size of the resourceserver.maxCacheObjectSizeproperty to support large file conversions. Before doing this your should ensure that your system has enough memory installed to cope with the increase in cache size. You could also break up the file into separate files that can be converted separately instead of increasing the cache size.

     When referencing file resource and image components:
  • Use format="mimetype" to render the mime type of a file or image. If no valid mime type can be determined then "www/unknown" will be rendered.
  • Use format="filename" to render the name of a file or image.
  • Use format="size" to render the size of a file or image using the most appropriate unit. If the resource is smaller then 1K then the size in bytes will be rendered. If the size of the resource is less then 1MB then the size in kilobytes will be rendered. If the size is greater than or equal to 1MB then the size will be rendered in megabytes.
  • Use format="size_bytes" to render the size of a file or image in bytes. Only the numeric value is displayed.
  • Use format="size_KB" to render the size of a file or image in kilobytes. Only the numeric value is displayed.
  • Use format="size_MB" to render the size of a file or image in megabytes. Only the numeric value is displayed.
    When referencing a link component:
  • Use format="url" to render the full URL of a link component. For example:/wps/wcm/myconnect/Library/Site/SiteArea/Content
  • Use format="path" to only render the site path of a link component. For example:/Library/Site/SiteArea/Content
  • Use format="tag" to render a complete link tag. This is used by default if no format is specified. For example:<a href="/wps/wcm/myconnect/Library/Site/SiteArea/Content"></a>
    Note: The URL generated by the link component will be fully qualified when viewed through a portal. If you want to generate a URL that isn't fully qualified use the "noprefix" option instead:
  • format="noprefixurl"
  • format="noprefixpath"
  • format="noprefixtag"
    When referencing number or date elements:In this case, the format is used to specify the display format of dates and numbers. The following formats can be defined when displaying dates:
  • format="DATE_SHORT"
  • format="DATE_MEDIUM"
  • format="DATE_LONG"
  • format="DATE_FULL"
  • format="DATE_TIME_SHORT"
  • format="DATE_TIME_MEDIUM"
  • format="DATE_TIME_LONG"
  • format="DATE_TIME_FULL"
  • format="TIME_SHORT"
  • format="TIME_MEDIUM"
  • format="TIME_LONG"
  • format="TIME_FULL"
  • format="relative" (The relative date will be displayed as either "today", "yesterday" or the number of days ago.)

    You can also set user-defined formats for both dates and numbers.
    When referencing user details:
    When formatting user details, the format parameter is used to define which LDAP parameter to use when displaying user details. For example:
  • format="cn" is used to display the common name.
  • format="dn" is used to display the distinguished name.
    Maximum character length:
    You can also specify a maximum number of characters to display by using this format:
  • format="length:number_of_characters" For example, to display a maximum of ten characters you would specify the following parameter: format="length:10"

link=" "

The link parameter is used to define the type of link created by the element tag:link="default"A standard link to an element is created. link="path"Contextual path linking will be used when rendering this element. link="contextual"Contextual content linking will be used when rendering this element. If not applicable, then contextual path linking is used.
Note: Contextual linking:*Contextual linking is used so that when content is linked from another site, the link will be rendered relative to the current site if possible. It can only be used if *context=current or context=autofill.

separator=" "

This only used when referencing an option selection or user selection element. It is used to define what text or code will be rendered between each selection displayed in an option selection or user selection element. For example, to add a line break between each selection, you would use separator="<br>" . If not defined, a comma will be placed between each selection when rendered.

htmlencode=" "

If htmlencode="true" the reserved HTML characters in text, short text and option selection elements will be converted into character entities. For example, '<' will be converted to '&lt;'. This is useful if you would like to prevent users adding malicious code, or if you want to prevent users changing the look and feel of their text using HTML.If not specified, the default setting specified in the WCMConfigService.properties file located in the was_profile_root/PortalServer/wcm/config/ directory is used. By default, this is set to "true":cmpnt.htmlEncodeDefault=true

awareness=" "

If awareness="true" then user names are displayed using the people awareness features. These features displays user names as hyperlinks that allow users to contact people with whom they might want to work. Wherever person links appear, users can click the link to display a menu of actions for collaborating (contacting and working) with the person named by the link. If you, as administrator, have also configured an IBM® Lotus® Sametime® server to work with WebSphere Portal, person links indicate whether a person is active, away, offline, or in a Do Not Disturb state.People awareness will only work in content rendered using either a local or remote rendering portlet.
If not specified, then awareness="false" and people awareness is not used.

start=" "end=" "

The start and end attributes are used to wrap the data returned by a tag within other tags, such as HTML. These attributes are not mandatory.

/>

This closes the tag.

WCM Component Tags

The Component tag is used to reference the content of a component within a presentation template or element design.

<Component name=" " context="autofill" format=" " separator=" "
           compute=" " htmlencode=" " awareness=" " start=" " end=" " />

<Component

Opens a library component tag.

name=" "

Enter the name and library of the component being referenced. For example, name="library/item". To use the library specified in the URL of the current page, use name="./item".Note: If you specify name="./item", the library name will not appear in your presentation template or element design. The actual path will not be resolved until the item is rendered.The "name" parameter is not used if context="autofill".

context="autofill"

This parameter is only used when referencing a Component tag within a Personalization element design to display the results of a Personalization rule that searches for components.

start=" "end=" "

The start and end attributes are used to wrap the data returned by a tag within other tags, such as HTML. These attributes are not mandatory.

format=" "

This parameter is optional and can only be used with some component types:

When referencing an image component:

  • Use format="url" to only render the URL of an image component.
  • Use format="tag" to render a complete image tag. The image will be displayed on the rendered page. This is used by default if no format is specified.
    When referencing a file resource component:
  • Use format="HTML" If your file resource is a file type that can be converted to HTML you can instead convert the file to HTML and render the converted HTML directly. Examples of supported file types include: word processing documents (.doc, *.odt) spreadsheets (.xls) HTML files (.htm, .html) Text files (.txt) Other file types may also work but you will need to test them first.
    Note: Maximum Cache SizeIf the converted HTML is larger than the default cache size defined by the resourceserver.maxCacheObjectSizeproperty in the WCM ConfigService.properties file, each request that contains this file will be converted dynamically instead of using the cached copy. This will impact performance. You may need to increase the size of the resourceserver.maxCacheObjectSizeproperty to support large file conversions. Before doing this your should ensure that your system has enough memory installed to cope with the increase in cache size. You could also break up the file into separate files that can be converted separately instead of increasing the cache size.

     When referencing file resource and image components:
  • Use format="mimetype" to render the mime type of a file or image. If no valid mime type can be determined then "www/unknown" will be rendered.
  • Use format="filename" to render the name of a file or image.
  • Use format="size" to render the size of a file or image using the most appropriate unit. If the resource is smaller then 1K then the size in bytes will be rendered. If the size of the resource is less then 1MB then the size in kilobytes will be rendered. If the size is greater than or equal to 1MB then the size will be rendered in megabytes.
  • Use format="size_bytes" to render the size of a file or image in bytes. Only the numeric value is displayed.
  • Use format="size_KB" to render the size of a file or image in kilobytes. Only the numeric value is displayed.
  • Use format="size_MB" to render the size of a file or image in megabytes. Only the numeric value is displayed.
    When referencing a link component:
  • Use format="url" to render the full URL of a link component. For example:/wps/wcm/myconnect/Library/Site/SiteArea/Content
  • Use format="path" to only render the site path of a link component. For example:/Library/Site/SiteArea/Content
  • Use format="tag" to render a complete link tag. This is used by default if no format is specified. For example:<a href="/wps/wcm/myconnect/Library/Site/SiteArea/Content"></a>
    Note: The URL generated by the link component will be fully qualified when viewed through a portal. If you want to generate a URL that isn't fully qualified use the "noprefix" option instead:
  • format="noprefixurl"
  • format="noprefixpath"
  • format="noprefixtag"
    When referencing number or date elements:In this case, the format is used to specify the display format of dates and numbers. The following formats can be defined when displaying dates:
  • format="DATE_SHORT"
  • format="DATE_MEDIUM"
  • format="DATE_LONG"
  • format="DATE_FULL"
  • format="DATE_TIME_SHORT"
  • format="DATE_TIME_MEDIUM"
  • format="DATE_TIME_LONG"
  • format="DATE_TIME_FULL"
  • format="TIME_SHORT"
  • format="TIME_MEDIUM"
  • format="TIME_LONG"
  • format="TIME_FULL"
  • format="relative" (The relative date will be displayed as either "today", "yesterday" or the number of days ago.)

    You can also set user-defined formats for both dates and numbers.
    When referencing user details:
    When formatting user details, the format parameter is used to define which LDAP parameter to use when displaying user details. For example:
  • format="cn" is used to display the common name.
  • format="dn" is used to display the distinguished name.
    Maximum character length:
    You can also specify a maximum number of characters to display by using this format:
  • format="length:number_of_characters" For example, to display a maximum of ten characters you would specify the following parameter: format="length:10"

compute=" "

This is only applicable to menu, navigator and taxonomy components. You specify compute="always" when you reference some JSP code within a component design, and you want that code to be run separately on each result returned by a menu, navigator and taxonomy component.For example, if a menu referenced JSP code that used the public DocumentId getCurrentResultId(); method, you would use compute="always" to make the JSP code run separately in every result returned by the menu.
If not specified, then compute="once" is used which is the default method for delivering the results of menu, navigator and taxonomy components.

htmlencode=" "

If htmlencode="true" the reserved HTML characters in text and short text components will be converted into character entities. For example, '<' will be converted to '<'. This is useful if you would like to prevent users adding malicious code, or if you want to prevent users changing the look and feel of their text using HTML.If not specified, the default setting specified in the WCMConfigService.properties file. By default, this is set to "true":cmpnt.htmlEncodeDefault=true

awareness=" "

If awareness="true" then user names are displayed using the people awareness features. These features displays user names as hyperlinks that allow users to contact people with whom they might want to work. Wherever person links appear, users can click the link to display a menu of actions for collaborating (contacting and working) with the person named by the link. If you, as administrator, have also configured an IBM® Lotus® Sametime® server to work with WebSphere Portal, person links indicate whether a person is active, away, offline, or in a Do Not Disturb state.People awareness will only work in content rendered using either a local or remote rendering portlet.
If not specified, then awareness="false" and people awareness is not used.

separator=" "

This only used when referencing a user selection component. It is used to define what text or code will be rendered between each selection. For example, to add a line break between each selection, you would use separator="<br>" . If not defined, a comma will be placed between each selection when rendered.

/>

This closes the tag.

WCM Placeholder tags

You use a placeholder tag to display metadata of an item. This is different from the

<placeholder tag=" " htmlencode=" " start=" " end=" " />

<placeholder

Opens a Placeholder Tag.

tag=" "

Determines which placeholder is being referenced:

  • Name
  • Title
  • dn
  • Href
  • noprefixhref
  • Namelink
  • noprefixnamelink
  • Titlelink
  • noprefixtitlelink
  • Sitepath
  • Idnum
  • Listnum
  • Treenum
  • Paddedtreenum
  • Depth

htmlencode=" "

If htmlencode="true" the reserved HTML characters in the source will be converted into character entities. For example, '<' will be converted to '<'. This is useful if you would like to prevent users adding malicious code, or if you want to prevent users changing the look and feel of their text using HTML.If not specified, the default setting specified in the WCMConfigService.properties file located in the was_profile_root/PortalServer/wcm/config/ directory is used. By default, this is set to "true":cmpnt.htmlEncodeDefault=true

start=" "end=" "

The start and end attributes are used to wrap the data returned by a tag within other tags, such as HTML. These attributes are not mandatory.

/>

This closes the tag.

Placeholder types

Name

This is used to display the name of the site area or content being retrieved in a menu or navigator. This can also be used when you create a user name component, where you can add a placeholder tag in the design and specify tag="name" to render the name of the user.

Title

This is used to display the title of the site area or content being retrieved in a menu or navigator.

dn

This is for when you create a user name component. You can add a placeholder tag in the design and specify tag="dn" to render the distinguished name of the user.

HREF

This inserts a link to the page of the site area or content being retrieved in a menu or navigator.

noprefixhref

The URLs generated by "HREF" parameter will be fully qualified when viewed through a portal. To generate URLs with no prefix, use the "noprefixhref" parameter instead of the "HREF" parameter.

NameLink

This is a combination of the name and HREF tags. It assembles a complete link based on the name of the item being returned.

noprefixnameLink

The URLs generated by "nameLink" parameter will be fully qualified when viewed through a portal. To generate URLs with no prefix, use the "noprefixnameLink" parameter instead of the "nameLink" parameter.

TitleLink

This is a combination of the title and HREF tags. It assembles a complete link based on the title of the item being returned.

noprefixtitleLink

The URLs generated by "titleLink" parameter will be fully qualified when viewed through a portal. To generate URLs with no prefix, use the "noprefixtitleLink" parameter instead of the "titleLink" parameter.

sitepath

This is similar to the HREF placeholder except that it only display the site path of an items URL.For example, an HREF placeholder tag displaying a content item may give you:

  • /ILWWCM/connect/metaorg/intranet/press+releasesWhereas the site path will give you:
  • /metaorg/intranet/press+releasesFor example, an HREF placeholder tag displaying a site area may give you:
  • /ILWWCM/connect/metaorg/intranet/Whereas the site path will give you:
  • /metaorg/intranet
    Note that the final / slash is not included when the site path is displayed for sites and site areas.

Idnum

This returns the hexadecimal id value of an item. This can be used when creating static URLs in menus and navigators. You could hard-code the site/site area path in a menu or navigator element design and use the Idnum for each content item being displayed. This would allow you to display content with a different presentation template (for example, a printer friendly presentation template) or use different security settings.

Listnum

Displays a single column list of numbered links:

  1. First
  2. Second
  3. Third

Treenum

Displays a hierarchical numbered list:1.0
1.1
1.2
2.0
2.1
2.2

Paddedtreenum

Similar to Treenum, but the numbers are padded:0001
00010001
00010002
000100020001
000100020002

Depth

Displays the depth of the currently processed node (in a navigator or menu) as a number. A top-level node has a depth of 1.

Note: Using a URLCmpnt tag.*The *URLCmpnt tag is used to generate a URL to a site, site area or content item and can be used as an alternative to a placeholder when generating a URL. This is particularly useful when creating links to Web content displayed within rendering portlets.

Profile Component Tags

Displaying the profile details of an item
The Profile component tag is used to display the profiling details (either categories or keywords) of an item. This tag can be added to presentation templates, element designs and component designs.

<profilecmpnt type=" " context=" " name=" " field=" " format=" " separator=" " include=" " restrict=" " ifEmpty=" " htmlencode=" " start=" " end=" " />

<profilecmpnt

Opens a Profile Component tag.

type=" "

This determines where the profile is being referenced from. Either "site", "sitearea", "content" or "user".
The user type displays a users profile. You can either select context="current" to display the current users profile, or context="selected" and enter a user name in the name parameter to display a specific user profile.

context=" "

This determines which item is being referenced.
Selected - Refers to a particular item as specified in the name attribute below.
Current - This will reference the component from the current site, site area or content file that is being browsed by the user.
AutoFill - The component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.

name=" "

Enter the name and library of the item being referenced. For example, name="library/item" . If no library is specified, the library specified in the URL of the current page is used. This is not used if context=current or context=autofill.

field=" "

Enter the field you wish to display
categories
keywords.

format=" "

When field="categories" the format parameter is used to determine the output format.
format="title" - displays a list of category titles.
format="uri" displays a the wcm:oid:<id> style URI for each listed category.
separator=" " - Used to separate each listed category or keyword. For example, separator=", "

Note: Double-byte character sets
Not all double-byte character sets support extended ASCII. To use tags such as " " you will need to replace "&" with "&".
For example: separator="  "

ifEmpty=" "

Enter some text to display if no result is returned by the tag. If not specified, nothing is displayed if no result is returned by the tag.

include=" "

Used only with field="categories". Determines which level of a taxonomy to display:
- exact
- ancestors
- descendants
- all
For example, if an item is profiled with a category of Sport, and include="descendants", then all the descendants of "sport" would also be displayed.

restrict=" "

Used only with field="library/categories". Enter a list of categories separated by commas to only return results for the categories specified in the list. For example, restrict="library/red, library/green" will only display profile details of items profiled with the categories or red or green. If no library is specified, the default library is used.

htmlencode=" "

If htmlencode="true" any reserved HTML characters in categories or keywords will be converted into character entities. For example, '<' will be converted to '<'. This is useful if you would like to prevent users adding malicious code, or if you want to prevent users changing the look and feel of their text using HTML.
If not specified, the default setting specified in the WCMConfigService.properties file located in the was_profile_root/PortalServer/wcm/config/ directory is used. By default, this is set to "true": cmpnt.htmlEncodeDefault=true

start=" "
end=" "

The start and end attributes are used to wrap the data returned by a Web content tag within other tags, such as HTML. These attributes are not mandatory.

/>

Closes the tag.

Even more tags!

There are more elements you can pull from the authoring templates see All the IBM WCM 6.1.5 Authoring Template Elements. For examples and details on:

  • Idcomponents
  • Placeholders
  • Workflow components
  • History information
  • Root Path information
  • Security information