WCM TAGs reference¶
Overview and syntax¶
These examples describe how to write web content tags, their syntax, and valid abbreviations and shortcuts.
Tag delimiter¶
Web content tags can be written by using square or angle brackets. For example:
[Property field="title"]
<Property field="title">
Parameter delimiter¶
A choice of attribute delimiters can be used when you write web content tags. For example, the field parameter in a property tag can be written with double quotation marks, single quotation marks, or no quotation marks:
[Property field="title"]
[Property field='title']
[Property field=title ]
Warning
The anchor and image HTML tags are the only HTML tags that are processed within web content tags. An attribute delimiter tag must always be used with these HTML tags, and are added automatically if omitted.
Primary parameters¶
Tags can be shortened by using their primary parameter.
For example, the tag [Property field="title"] can be shortened to [Property:title].
These primary parameters can be used to shorten a tag:
Field
This parameter is the primary parameter of the Property and EditableProperty tags.
Key
This parameter is the primary parameter of the Element, EditableElement, IfDefined, and IfNotDefined tags.
Warning
A shortened tag cannot be used with elements that have a space in their name. For example, if you add a text element to an item named "First Text Element" you cannot shorten its tag to [Element:First Text Element]. You must instead use the full tag syntax: [Element key="First Text Element"]
Tag
This parameter is the primary parameter of the Placeholder tag.
Type
This parameter is the primary parameter of the Path Component tag.
Dynamic Parameter Tag¶
The dynamic parameter tag is used as a simple representation of a more complex web content tag. It is represented by using a $ symbol.
For example, the property tag [Property field="title"] can be written as [$title].
When a dynamic parameter tag is used, the context of the tag is determined in this order:
- Property
- then element
- then parameter resource
So, if you used this tag, [$yellow], a property named "yellow" would be used first. If this property does not exist, an element named "yellow" would be used. If neither of these tags exist, a tag that contains a resource parameter named "yellow" would set the context.
The parameters of a dynamic parameter tag always default to context="autofill", and type="auto".
Note
To disable this behavior add the parameter dynamic.parameter.tag.enabled with a value of "false" to the WCM WCMConfigService service by using the WebSphere® Integrated Solutions Console. You will need to restart your server after making this change. Any dynamics tags created before disabling this feature will remain valid until an item is updated and saved.
Simplified plug-in tags¶
This tag is an example of a plug-in tag: [Plugin:Page paramKey1='id']
You can simplify the plug-in tag to this: [Page paramKey1='id']
The simplified plug-in tag cannot replace an existing web content tag. For example, if you created a plug-in named "Property", you must use the full tag: [Plugin:Property]. The tag [Property] is treated as a property tag, not a plug-in tag.
Note
To disable this behavior add the parameter renderingplugin.shortform.enabled with a value of "false" to the WCM WCMConfigService service by using the WebSphere® Integrated Solutions Console. This parameter is applied only when items are saved. This causes the simplified plug-in tags to be ignored. For instance, [Page] is rendered, rather than being interpreted as a tag. To use a tag, the long-form tag such as [Plugin:Page] must be used.
Default undefined tag attributes¶
If not specified in a tag, the context and type tag parameters default to context="autofill" and type="auto".
HTML image tag¶
The border tag that is used in HTML image tags that are generated by Web Content Manager are not rendered in the tag if the border specified in an image element is not specified, or is zero.
Tag attribute order¶
Tag attributes are rendered in the order they are entered. Extra attributes, if any, are rendered next.
Common tag attributes¶
Name¶
If you specify name="./itemName", the actual path is not resolved until the item is rendered. This method takes slightly longer to resolve than specifying the path to the item.
Context and Type¶
| Context="Selected" | type="auto" | type="content" | type="sitearea" | type="parent" | type="top" |
|---|---|---|---|---|---|
| The context is set by the selected item. You select an item by clicking Select. This parameter is added to the tag as the name=" " parameter. | This parameter displays an element from the selected item. | This parameter displays an element from the selected content item. If a site area is selected, then nothing is displayed. | If the selected item is a site area, then this parameter displays the element from the site area. If the selected item is a content item, then this parameter displays the element from the parent site area of the content item. | This parameter displays an element from the parent of the selected item. | This parameter displays an element from the first item in the path of the selected item. |
| Context="Current" | type="auto" | type="content" | type="sitearea" | type="parent" | type="top" |
|---|---|---|---|---|---|
| The context is set by the current item. | This parameter displays an element from the item currently being rendered. | This parameter displays an element from the selected content item. If a site area is selected, then nothing is displayed. | If the item currently being rendered is a site area, this parameter displays the element from the current site area. If the item currently being rendered is a content item, this parameter displays the element from the parent site area of the content item. | This parameter displays an element from the parent site area of the item currently being rendered. | This parameter displays an element from the first item in the path of the selected item.This parameter displays an element from the first item in the path of the item currently being rendered. |
| Context="Autofill" | type="auto" | type="content" | type="sitearea" | type="parent" | type="top" |
|---|---|---|---|---|---|
| Use this option when the element that is referenced is determined by the search parameters of a menu, navigator, or taxonomy component. If the tag is not used within a menu, navigator, or taxonomy component, the context reverts to the current item. | This parameter displays an element from the item that is returned by a menu, navigator, or taxonomy component. | This parameter displays an element from a content item that is returned by a menu, navigator, or taxonomy component. If a site area is selected, then nothing is displayed. | If the current item returned by a menu, navigator, or taxonomy component is a site area, then the element from the site area is displayed. If the current item returned by a menu, navigator, or taxonomy component is a content item, then the element from the parent of the content item is displayed. | This parameter displays an element from the parent item of the item that is returned by a menu, navigator, or taxonomy component. | This parameter displays an element from the first item in the path of the item that is returned by a menu, navigator, or taxonomy component. |
| Context="portalMapping" | type="auto" | type="content" | type="sitearea" | type="parent" | type="top" |
|---|---|---|---|---|---|
| The context is set by the web content association of the current page. This option is only valid for content that is delivered by using a web content viewer portlet. See the knowledge center topic that is called Web content associations for further information. | This parameter displays an element from the item that is selected as the default web content association of the page. | This parameter displays an element from the default content item of the site area that is selected as the default web content association of the page. | This parameter displays an element from the site area that is selected as the default web content association of the page. | This parameter displays an element from the site area that is selected as the default web content association of the page. | This parameter displays an element from the first item in the path of the item that is selected as the default web content association of the page. |
| Context="portletContext" | type="auto" | type="content" | type="sitearea" | type="parent" | type="top" |
|---|---|---|---|---|---|
| The context is set by context of the current web content viewer portlet. This option is only valid for content that is delivered by using a web content viewer portlet. | This parameter displays an element from the current portlet context item. | If the context of the current portlet is a content item, the element from the current content item is displayed. If the context of the current portlet is a site area, the element from the default content item of the site area is displayed. | If the context of the current portlet is a site area, the element from the site area is displayed. If the context of the current portlet is a content item, the element from the parent of the content item is displayed. | If the context of the current portlet is a site area, the element from the site area is displayed. If the context of the current portlet is a content item, the element from the parent of the content item is displayed. | This parameter displays an element from the first item in the path of the current portlet context item. |
Note
The portal mapping context is determined by the web content associations that are assigned to each page. This context is used for rendering when users first access a page. The context of the page can change when users interact with the content on the page. Each web content viewer on a page can be configured with an explicit context that overrides the rendering page context. The context of the portlet can also change if it is configured to receive links. When users click a link within the viewer that is configured to broadcast its links, the page context is updated. This new context is maintained until users click another link, or until users start a new session. When users start a new session, the original page context is used.
format¶
This parameter is optional and can be used only with some element types
field="ID"¶
| format | Details |
|---|---|
| id | Display the plain ID. If not specified, this format is used by default. |
| uri | outputs a wcm:oid: style URI. |
User details¶
When formatting user details, the format parameter is used to define which LDAP parameter to use when you display user details
| format | Details |
|---|---|
| cn | is used to display the common name |
| dn | is used to display the distinguished name |
| uid | is used to display the user id |
| other | other LDAP parameter |
field="categories"¶
| format | Details |
|---|---|
| title | The format parameter is used to determine the output format. |
| uri | displays a wcm:oid: |
When you reference text fields you can specify the maximum number of characters to display by using this format:
format="length:number_of_characters"
| format | output |
|---|---|
| DATE_SHORT | 31/08/22 |
| DATE_MEDIUM | 31 aug 2022 |
| DATE_LONG | 31 august 2022 |
| DATE_FULL | Wednesday 31 August 2022 |
| DATE_TIME_SHORT | 31/08/22, 10:22 |
| DATE_TIME_MEDIUM | 31 aug 2022, 10:22:44 |
| DATE_TIME_LONG | 31 August 2022 10:22:44 CEST |
| DATE_TIME_FULL | Wednesday 31 August 2022 10:22:44 Central European Summer Time |
| TIME_SHORT | 10:22 |
| TIME_MEDIUM | 10:22:44 |
| TIME_LONG | 10:22:44 CEST |
| TIME_FULL | 10:22:44 Central European Summer Time |
| DATE_SHORT_TIME_MEDIUM | 31/08/22, 10:22:44 |
| DATE_SHORT_TIME_LONG | 31/08/22, 10:22:44 CEST |
| DATE_SHORT_TIME_FULL | 31/08/22, 10:22:44 Central European Summer Time |
| DATE_MEDIUM_TIME_SHORT | 31 aug 2022, 10:22 |
| DATE_MEDIUM_TIME_LONG | 31 aug 2022, 10:22:44 CEST |
| DATE_MEDIUM_TIME_FULL | 31 Aug 2022, 10:22:44 Central European Summer Time |
| DATE_LONG_TIME_SHORT | 31 August 2022 10:22 |
| DATE_LONG_TIME_MEDIUM | 31 August 2022 10:22:44 |
| DATE_LONG_TIME_FULL | 31 August 2022 10:22:44 Central European Summer Time |
| DATE_FULL_TIME_SHORT | Wednesday, 31 August 2022 10:22 |
| DATE_FULL_TIME_MEDIUM | Wednesday, 31 August 2022 10:22:44 |
| DATE_FULL_TIME_LONG | Wednesday, 31 August 2022 10:22:44 CEST |
| RELATIVE | The relative date is displayed as either "today" or "yesterday" |
| MILLIS | Number of milliseconds since Midnight, January 1, 1970 GMT |
| User-defined | Setting parameters to format dates |
Note
All date formats are based on the timezone of the user, except for format="MILLIS", which is not dependent on the current timezone.
field="name" or field="title"¶
| format | Details |
|---|---|
| path | you can retrieve the path of the item |
field="categories"¶
| format | Details |
|---|---|
| namepath | you can retrieve the name path of the categories |
| titlepath | you can retrieve the name path of the categories |
link¶
htmlencode¶
| Value | Details |
|---|---|
| true | Any reserved HTML characters is converted into character entities. For example, '<' is converted to '<'. This parameter is useful if you would like to prevent users from adding malicious code, or if you want to prevent users from changing the design of their text by using HTML. |
| false | HTML markup is maintained. |
Note
If not specified, the default setting specified by the cmpnt.htmlEncodeDefault property in the WCM WCMConfigService service is used. By default, this property is set to true.
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
- adescendants
- 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=categories or field=library. Enter a list of categories that are separated by commas to return results only for the categories that are specified in the list. For example, restrict="library/red, library/green" displays profile details only of items that are profiled with the categories of red or green. If no library is specified, the default library is used.
resolve¶
This parameter determines which type of access to resolve to when you render access level properties:
| Value | Details |
|---|---|
| none | Only users and groups that are selected in the access section of an item is resolved. This access is a combination of User, Workflow, and Administrator defined access settings. Virtual users are not resolved. If the field parameter is used, only users and groups that are directly selected for a role type is resolved. For example, a user assigned "contributor" access would not be resolved if field="user". |
| virtual | Only users and groups that are selected in the access section of an item, including virtual users, is resolved. This access is a combination of User, Workflow, and Administrator defined access settings. If the field parameter is used, only users and groups that are directly selected for a role type is resolved. For example, a user assigned "contributor" access would not be resolved if field="user". |
| inherited | All inherited users and groups plus users and groups that are selected in the access section of an item, including virtual users, is resolved. This access is a combination of Inherited, User, Workflow, and Administrator defined access settings. If the field parameter is used, only users and groups that are either directly selected for a role type or that inherit a role type is resolved. For example, a user assigned "contributor" access would not be resolved if field="user". |
| inheritedonly | Only inherited users and groups, including virtual users, are resolved. If the field parameter is used, only users and groups that directly inherit a role type is resolved. For example, a user that inherits "contributor" access would not be resolved if field="user". |
| effective | Only users and groups that are selected in the access section of an item, including virtual users, is resolved. This access is a combination of User, Workflow, and Administrator defined access settings. If the field parameter is used, access roles are cascaded down so that users and groups assigned roles higher than the role selected by using the field parameter is resolved. For example, if field="user", contributors, editors, and managers are also resolved. |
| all | All inherited users and groups plus users and groups that are selected in the access section of an item, including virtual users, is resolved. This access is a combination of Inherited, User, Workflow, and Administrator defined access settings. If the field parameter is used, access roles are cascaded down so that users and groups assigned roles higher than the role selected by using the field parameter is resolved. For example, if field="user", contributors, editors, and managers are also resolved. |
pre¶
Set pre="true" to enable multi-line support. This setting is only applicable to the description field. If enabled, line breaks entered by the user when they enter text in the description field are recognized when rendered. If not specified, this setting defaults to false.
start, end, separator¶
The start and end attributes are used to wrap the data that is returned by a tag within other tags, such as HTML. These attributes are not mandatory.
separator parameter is used when you reference a property that returns multiple results. The html tags can be used as separators. If not defined, a comma is placed between each result when rendered.
Note
Not all double-byte character sets support extended ASCII.
Example separator=" " --> & &
Setting parameters to format dates¶
Any characters in the pattern that are not in the ranges of ['a'..'z'] and ['A'..'Z'] is treated as quoted text. For example, characters like ':', '.', ' ', '#' and '@' appear in the resulting time text even if they are not embraced within single quotation marks.
If a date or time code is entered incorrectly, nothing is returned.
These parameters are used to set the format of dates.
| Symbol | Meaning | Presentation | Example |
|---|---|---|---|
| G | era designator | text | AD |
| y | year | number | 1996 |
| M | month in year | text and number | M=3, MM=03, MMM=Mar, MMMM=March |
| d | day in moth | number | 10 |
| h | hour in am/pm (1-12) | number | 12 |
| H | hour in day (0-23) | number | 21 |
| m | minute in hour | number | 30 |
| s | second in minute | number | 55 |
| S | millisecond | number | 978 |
| E | day in week | text | tuesday |
| D | day in year | number | 189 |
| F | day of week in month | number | 2 (2nd Wed in July) |
| w | week of year | number | 27 |
| W | week in month | number | 2 |
| a | am/pm marker | text | PM |
| k | hour in day (1-24) | number | 24 |
| K | hour in am/pm (0-11) | number | 3 |
| z | time zone | text | Pacific Standard Time |
| ' | escape for text | delimiter | |
| '' | single quotation mark | literal |
Text
-
Four or more pattern letters, use full form.
dd,MMMM,yyyy = 03,March,2003 -
Less than four, use short or abbreviated form if one exists.
d,M,y = 3,3,3 dd,MM,yy = 03,03,03 dd,MMM,yy = 03,Mar,03
Lowercase and uppercase
- The case of letters that are used in date and time code is not consistent. For example, "M" for month but "d" for day and "y" for year.
- Uppercase and lowercase letters can mean different things. For example, "s" for second and "S" for millisecond.
[Property] tags¶
A property tag is used to display various fields and metadata from content items and site areas. The format of a property tag:
[Property field="" context="" type="" name="" format="" link="" separator=""
htmlencode="" awareness="" ifEmpty="" include="" restrict="" resolve="" pre=""
start="" end="" ]
Fields reference¶
Identification¶
| Field | Details |
|---|---|
| name | Displays the text that is entered in the name field of an item. |
| title | Displays the text that is entered in the title field of an item. |
| id | Displays the GUID of an item. |
| description | Displays the text that is entered in the description field of an item. |
| authors | Displays the users and groups that are selected in the authors field of an item. |
| owners | Displays the users and groups that are selected in the owners field of an item. |
Access level¶
| Field | Details |
|---|---|
| user | Displays a list of users and groups assigned user access to an item. |
| contributor | Displays a list of users and groups assigned contributor access to an item. |
| editor | Displays a list of users and groups assigned editor access to an item. |
| manager | Displays a list of users and groups assigned manager access to an item. |
Authoring template¶
| Field | Details |
|---|---|
| authtemplateid | Displays the GUID of the authoring template that is used by the current item. |
| authtemplatename | Displays the name of the authoring template that is used by the current item. |
| authtemplatetitle | Displays the display title of the authoring template that is used by the current item. |
Current project¶
| Field | Details |
|---|---|
| projectid | Displays the GUID of the project the current item is included in. |
| projectname | Displays the item name of the project the current item is included in. |
| projecttitle | Displays the title of the project the current item is included in. |
History¶
| Field | Details |
|---|---|
| lastmodified | Displays the last modified date and the last change message. |
| lastmodifieddate | Displays the last modified date. |
| creation | Displays the creation date. |
| lastmodifier | Displays the name of the user who last modified the item. |
| creator | Displays the name of the user who created the item. |
Library¶
| Field | Details |
|---|---|
| libraryid | Displays the GUID of the library that is used by the current item. |
| libraryname | Displays the name of the library that is used by the current item. |
| librarytitle | Displays the display title of the library that is used by the current item. |
Parent¶
| Field | Details |
|---|---|
| parentid | Displays the GUID of the parent of the current item. |
| parentname | Displays the name of the parent of the current item. |
| parenttitle | Displays the display title of the parent of the current item. |
Profile¶
| Field | Details |
|---|---|
| categories | Displays the categories that this item is profiled with. |
| keywords | Displays the keywords that this item is profiled with. |
Workflow¶
| Field | Details |
|---|---|
| status | Displays the workflow status of an item. |
| statusid | Displays the workflow status of an item as an integer: 1 for draft, 2 for published, 4 for expired |
| pendingstatus | Displays a translated string for the pending status. The pending status is the status that the document will move into in the future. For example, when a scheduled date is reached, or when a project is published. |
| pendingstatusid | Retrieves the pending status as an integer: 1 for an item not pending a change in status. 2 for publish pending. 4 for expire pending. 8 for delete pending. |
| workflow | Displays the selected workflow of an item. |
| currentstage | Displays the workflow stage that the item is in. |
| publishdate | Displays the date and time that is selected in the publish date field of an item. View format |
| expirydate | Displays the date and time that is selected in the expiry date field of an item. View format |
| generaldateone | Displays the date and time that is selected in the general date one field of an item. View format |
| generaldatetwo | Displays the date and time that is selected in the general date two field of an item. View format |
| additionalviewers | Displays the names of any additional viewers that are selected for an item. |
[Element] tags¶
The Element tag is used to reference an element within a presentation template or element design.
[Element type=" " context=" " name=" " key=" " format=" " pre=" " link=" "
separator=" " htmlencode=" " awareness=" " ifEmpty=" " start=" " end=" " ]
key¶
key parameter is the name of the element in authoring template thet you want to display.
format¶
image element¶
| format | Details |
|---|---|
| url | render the URL of an image element. |
| tag | render a complete image tag. The image is displayed on the rendered page. This parameter is used by default if no format is specified. |
| height | render the height of an image element. |
| width | render the width of an image element. |
| alt | render the alt text of an image element. |
file resource element¶
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 in your web content by using the parameter.
Examples of supported file types include:
- word-processing documents (.doc, .odt)
- spreadsheets (*.xls) *
- HTML files (.htm, .html)
- Text files (*.txt)
Other file types might also work but you need to test them first.
Note
Maximum Cache Size:
If the converted HTML is larger than the default cache size defined by the resourceserver.maxCacheObjectSize property in the WCM WCMConfigService service, each request that contains this file is converted dynamically instead of using the cached copy. This method impacts performance. You might need to increase the size of the resourceserver.maxCacheObjectSize property to support large file conversions. Ensure that your system has enough memory installed to cope with the increase in cache size. You might also break up the file into separate files that can be converted separately instead of increasing the cache size.
file resource and image elements¶
| format | Details |
|---|---|
| mimetype | render the mime type of a file or image. If no valid mime type can be determined, then "www/unknown" is rendered. |
| filename | render the name of a file or image. |
| size | render the size of a file or image with the most appropriate unit. If the resource is smaller than 1 K, then the size in bytes is rendered. If the size of the resource is less than one MB, then the size in Kb is rendered. If the size is greater than or equal to 1 MB, then the size is rendered in megabytes. |
| size_bytes | render the size of a file or image in bytes. Only the numerical value is displayed. |
| size_KB | render the size of a file or image in Kb. Only the numerical value is displayed. |
| size_MB | render the size of a file or image in megabytes. Only the numerical value is displayed. |
link element¶
| format | Details | Example |
|---|---|---|
| url | render the full URL of the target of the link element. | /wps/wcm/myconnect/Library/Site+Area/Content |
| namepath | render the site path of the target of the link element. If the target is a component reference component, the title path of the final target is rendered. | /Library/SiteArea/Content |
| titlepath | render the site path of the target of the link element. If the target is a component reference component, the title path of the final target is rendered. | /Library/Site Area/Content |
| id | render the ID of the target of the link element. If the target is a link component, the ID of the final target is rendered. | |
| tag | render a complete link tag. This option is used by default if no format is specified. | |
| linktext | render text of the link. |
component reference element¶
| format | Details |
|---|---|
| id | render the ID of the target of the component reference element. If the target is a component reference component, the ID of the final target is rendered. |
| namepath | render the site name path of the target of the component reference element. If the target is a component reference component, the name path of the final target is rendered. |
| titlepath | render the site title path of the target of the component reference element. If the target is a component reference component, the title path of the final target is rendered. |
Note
The URL generated by the link element is fully qualified when viewed through a portal. If you want to generate a URL that is not fully qualified, use the "noprefix" option instead:
- format="noprefixurl"
- format="noprefixpath"
- format="noprefixtag"
date element¶
When you reference date elements, the following formats can be defined when you display dates:
| format | output |
|---|---|
| DATE_SHORT | 31/08/22 |
| DATE_MEDIUM | 31 aug 2022 |
| DATE_LONG | 31 august 2022 |
| DATE_FULL | Wednesday 31 August 2022 |
| DATE_TIME_SHORT | 31/08/22, 10:22 |
| DATE_TIME_MEDIUM | 31 aug 2022, 10:22:44 |
| DATE_TIME_LONG | 31 August 2022 10:22:44 CEST |
| DATE_TIME_FULL | Wednesday 31 August 2022 10:22:44 Central European Summer Time |
| TIME_SHORT | 10:22 |
| TIME_MEDIUM | 10:22:44 |
| TIME_LONG | 10:22:44 CEST |
| TIME_FULL | 10:22:44 Central European Summer Time |
| DATE_SHORT_TIME_MEDIUM | 31/08/22, 10:22:44 |
| DATE_SHORT_TIME_LONG | 31/08/22, 10:22:44 CEST |
| DATE_SHORT_TIME_FULL | 31/08/22, 10:22:44 Central European Summer Time |
| DATE_MEDIUM_TIME_SHORT | 31 aug 2022, 10:22 |
| DATE_MEDIUM_TIME_LONG | 31 aug 2022, 10:22:44 CEST |
| DATE_MEDIUM_TIME_FULL | 31 Aug 2022, 10:22:44 Central European Summer Time |
| DATE_LONG_TIME_SHORT | 31 August 2022 10:22 |
| DATE_LONG_TIME_MEDIUM | 31 August 2022 10:22:44 |
| DATE_LONG_TIME_FULL | 31 August 2022 10:22:44 Central European Summer Time |
| DATE_FULL_TIME_SHORT | Wednesday, 31 August 2022 10:22 |
| DATE_FULL_TIME_MEDIUM | Wednesday, 31 August 2022 10:22:44 |
| DATE_FULL_TIME_LONG | Wednesday, 31 August 2022 10:22:44 CEST |
| RELATIVE | The relative date is displayed as either "today" or "yesterday" |
| MILLIS | Number of milliseconds since Midnight, January 1, 1970 GMT |
| User-defined | Setting parameters to format dates |
Note
All date formats are based on the timezone of the user, except for format="MILLIS", which is not dependent on the current timezone.
option select element¶
| format | type | Details |
|---|---|---|
| textprovider | User Defined | To render the translated selection. |
| namepath | Use Taxonomy | render the namepath of the selected category. |
| name | Use Taxonomy | render the name of the selected category. |
| titlepath | Use Taxonomy | render the titlepath of the selected category. |
| title | Use Taxonomy | render the title of the selected category. |
| id | Use Taxonomy | render the id of the selected category. |
user details¶
When formatting user details, the format parameter is used to define which LDAP parameter to use when user details are displayed. For example:
| format | Details |
|---|---|
| cn | display the common name. |
| dn | display the distinguished name. |
| uid | display the user id. |
| ... | other LDAP parameter |
Maximum character length¶
You can also specify a maximum number of characters to display
| format | Example |
|---|---|
| length:number_of_character | format="length:10" |
Format length remove html from the output for example in rich text element HTML tags are removed
[element key="rich text"] --> <p>Lorem ipsum....</p>
[element key="rich text" format="length:10"] --> Lorem ipsu
Number elements¶
The Java Number Format Pattern Syntax is used to set the format of numbers.
| Symbol | Meaning |
|---|---|
| 0 | Represents a digit. Leading and trailing zeros are shown. |
| # | Represents a digit. Leading and trailing zeros are not shown. |
| . | A placeholder for decimal separator. |
| , | A placeholder for grouping separator. |
| E | A placeholder for grouping separator. |
| ; | Used to separate formats. |
| - | Used to separate formats. |
| % | Used to separate formats. |
| ? | Multiplies the number by 1000 and displays it per mille. |
| ¤ | Displays the number as a currency. |
| ' | Used to quote special characters in a prefix or suffix. |
Example
| Format Pattern | Result |
|---|---|
| ###,###.### | 123,456.789 |
| ###.## | 123456.79 |
| 00000000.0000 | 000123456.7890 |
[Component] tags¶
The Component tag is used to reference the content of a component within a presentation template or element design.
[Component name=" " context=" " format=" " separator=" " compute=" "
htmlencode=" " awareness=" " presentation=" " startPage=" " resultsPerPage=" " start=" " end=" " ]
compute
This parameter is only applicable to menu, navigator, and taxonomy components.
| Value | Details |
|---|---|
| always | when you reference some JSP code within a component design, and you want that code to be run separately on each result that is 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 that is run separately in every result that is returned by the menu. |
| once | If not specified, then compute="once" is used which is the default method for delivering the results of menu, navigator, and taxonomy components. |
awareness
This parameter enables the awareness features. This feature 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, also configure an HCL Sametime server to work with HCL Portal, person links indicate whether a person is active, away, offline, or in a Do Not Disturb state.
| Value | Details |
|---|---|
| true | then user names are displayed by using the people awareness features. |
| false | people awareness is not used. |
presentation
This parameter is used to specify the name of a list presentation to use when you display a navigator, menu, personalization, or search component. This parameter overrides the list presentation that is selected on the component itself. To use the library that is specified in the URL of the current page, use presentation="./item".
startPage
This parameter is optional and is used to set which page of results to display when a navigator, menu, personalization, or search component is first displayed. This parameter overrides the Start page value that is specified in the component itself.
resultsPerPage
This parameter is optional and is used to set the number of items to display in each page of results that are displayed by a navigator, menu, personalization, or search component. This parameter overrides the Results per page value that is specified in the component itself.
separator
This parameter only used when a user selection component is referenced. It is used to define what text or code is rendered between each selection. If not defined, a comma is placed between each selection when rendered.
[Placeholder] tags¶
You use a placeholder tag to display metadata within an element or component design.
[placeholder tag=" " htmlencode=" " start=" " end=" " ]
| tag | Details |
|---|---|
| Name | This is used to display the name of the site area or content item that is retrieved in a menu or navigator. This parameter 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 item that is 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 item that is retrieved in a menu or navigator. |
| noprefixhref | The URLs generated by "HREF" parameter is fully qualified when viewed through a portal. To generate URLs with no prefix, use the "noprefixhref" parameter instead of the "HREF" parameter. |
| TitleLink | This is a combination of the title and HREF tags. It assembles a complete link based on the title of the item that is returned. |
| noprefixtitleLink | The URLs generated by "titleLink" parameter is 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 thet it only displays only the site path of an item's URL (generate a URL without wps/connect) |
| idnum | This returns the hexadecimal ID value of an item. This parameter can be used to create static URLs in menus and navigators. You can hardcode the site area path in a menu or navigator element design and use the Idnum for each content item displayed. This method is used to display content with a different presentation template (for example, a printer-ready presentation template) or use different security settings. |
| Listnum | The index of the item in the list. |
| Treenum | Displays a hierarchical numbered list: 1.0, 1.1, 1.2, 2.0, 2.1 |
| Paddedtreenum | Similar to Treenum, but the numbers are padded:0001, 00010001, 00010002 |
| 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. |
If you are using the placeholder tag with an authoring tools element that is rendered by the JSR 286 web content viewer, specify the format attribute to control where the authoring task is performed.
| format | details |
|---|---|
| tag | The placeholder is rendered as a URL that opens the authoring portlet in a new window. This behavior is used by default if no value is specified. |
| url | The placeholder is rendered as a URL that redirects the user to a hidden portal page that is used by the JSR 286 web content viewer for inline editing. |
htmlencode
If selected the default setting specified by the cmpnt.htmlEncodeDefault property in the WCM WCMConfigService service is used. By default, this property is set to true.