Versions Compared

Key

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

...

Table 1. Additional tag parameters

Tag parameters

Details

normal=" "

To use the library specified in the URL of the current page, use normal="./name"

Note: If you specify normal="./name", the library name does not appear in your presentation template or element design. The actual path is not resolved until the item is rendered.

highlight=" "

To use the library specified in the URL of the current page, use highlight="./name"

Note: If you specify highlight="./name", the library name does not appear in your presentation template or element design. The actual path is not resolved until the item is rendered.

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.

Topofpage

...

Attribute resource tags (Search Component)

...

Table 1. Additional tag parameters

Tag parameters

Details

attributeName=authoringtemplate

The name of the authoring template, if available, that was used to create the content item.

attributeName=author

The name or names of the authors of the content item, if any are defined. If there is more than one author, then they are rendered with the string specified in the optional separator attribute between each value.

attributeName=category

The categories of the content item if any are defined. If there is more than one category, then they are rendered with the string specified in the optional separator attribute between each value.

attributeName=contentid

The id of the content item.

attributeName=contentpath

The path excluding the server address, port, or servlet context (/wps/wcm) for this search result.

attributeName=date

The value of the date field from the SIAPI result. The format of the date can be specified by using the optional format attribute. See the Javadoc HTML documentation for SimpleDateFormat in the Java SDK for details.

attributeName=description

The description of the content item.

attributeName=effectivedate

The effective date of the content item. The format of the date can be specified by using the optional format attribute. See the Javadoc HTML documentation for SimpleDateFormat in the Java SDK for details.

attributeName=expirationdate

The expiration date of the content item. The format of the date can be specified by using the optional format attribute. See the Javadoc HTML documentation for SimpleDateFormat in the Java SDK for details.

attributeName=keywords

The keywords of the content item if any are defined. If there is more than one keyword, then they are rendered with the string specified in the optional separator attribute between each value.

attributeName=lastmodifieddate

The last modified date of the content item. The format of the date can be specified by using the optional format attribute. See the Javadoc HTML documentation for SimpleDateFormat in the Java SDK for details.

attributeName=modifier

The name of the last person to modify the content item.

attributeName=name

The name of the content item.

attributeName=namelink

This assembles a complete link based on the name of the item being returned.

attributeName=owner

The name or names of the owners of the content item, if any are defined. If there is more than one author, then they are rendered with the string specified in the optional separator attribute between each value.

attributeName=parentcontentpath

This is used to return the content path excluding the server address, port, or Servlet context for the parent content item of this search result. For example: /wps/wcm

This parameter is valid when the search results include a link to a file resource element in the parent content item and is used to give context to the attached file. When the search result is not for an attached file in a file resource element, this value is an empty string.

attributeName=relevance

The relevance “score” for this search result from the search engine.

attributeName=summary

The summary of the content item as generated by Portal Search.

attributeName=title

This is the title of a content item.

attributeName=titlelink

This assembles a complete link based on the title of the item being returned.

attributeName=url

Displays the URL of a content item.

format=" "

This parameter is optional and can only be used with some parameter types:
When referencing number or date elements:

  •  Options:
    • 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 is displayed as either "today", "yesterday" or the number of days ago.)** Setting parameters to format dates
    • Note on formatting numbers

separator=" "

Enter text or code to be used to separate multiple search results. For example: separator=" - "

Topofpage

...

Component tags

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

...

Table 1. Additional tag parameters

Tag parameters

Details

name=" "

To use the library specified in the URL of the current page, use name="./item".

Note: If you specify name="./item", the library name does not appear in your presentation template or element design. The actual path is not resolved until the item is rendered.

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:

  • format="url" - prints the url of the image
  • format="tag" - prints the complete tag i.e. <img src="url/of/image.jpg" width="123" height="123" />
    When referencing a file resource component
  • Use _format="HTML" - this only works for _word-processing documents (.doc, *.odt) spreadsheets (.xls), HTML files (.htm, *.html) and text files (.txt*)*
  • Use format="mimetype" - to render the mime type of a file or image. If no valid mime type can be determined then "www/unknown" is 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 than 1K then the size in bytes is rendered. If the size of the resource is less than 1MB then the size in kilobytes are rendered. If the size is greater than or equal to 1MB then the size is 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:
    Outputs something like: 
  • format="noprefixurl" - i.e.  /wps/wcm/myconnect/Library/SiteArea/Content
  • format="noprefixpath" - i.e  /Library/SiteArea/Content 
  • format="noprefixtag" - i.e. <a href="/wps/wcm/myconnect/Library/SiteArea/Content"></a> 
  • format="url" - i.e. http://domain/wps/wcm/myconnect/Library/SiteArea/Content
  • format="path" 
  • format="tag" 
    When referencing number or date elements:  
  • 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 is displayed as either "today", "yesterday" or the number of days ago.)See Setting parameters to format dates and Note on formatting numbers
    http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Note_on_formatting_numbers_wcm7
    http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Note_on_formatting_numbers_wcm7
    http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Note_on_formatting_numbers_wcm7
    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: 
  • format="length:number_of_characters"
  • 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 are converted into character entities. For example, '<' is 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 by the cmpnt.htmlEncodeDefault property in the WCM WCMConfigService service is used. By default, this property is set to true.

awareness=" "

If awareness="true" then user names are displayed using the people 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, 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 only works 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 is rendered between each selection. For example, to add a line break between each selection, you would use separator="<br>" . If not defined, a comma is placed between each selection when rendered.

Topofpage

...

Element tags

The Element tag is used to reference an element within a presentation template or element design.

...

Table 1. Additional tag parameters

Parameters

Details

name=" "

If you specify name="./itemName", the actual path is not resolved until the item is rendered. This takes slightly longer to resolve than specifying the path to the item.

format=" "

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

When referencing an image element:

  • Use format="url" to only render the URL of an image element.
  • Use format="tag" to render a complete image tag. The image is displayed on the rendered page. This is used by default if no format is specified.


When referencing a link element:

  • Use format="url" to render the full URL of a link element. For example: /wps/wcm/myconnect/Library/SiteArea/Content
  • Use format="path" to only render the site path of a link element. For example: /Library/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/SiteArea/Content"></a>

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" or format="noprefixtag".


When referencing a 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 using the format="HTML" parameter. 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 need to test them first.

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 will impact performance. You may need to increase the size of the resourceserver.maxCacheObjectSize property to support large file conversions. Before doing this, you 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 elements:

  • Use format="mimetype" to render the mime type of a file or image. If no valid mime type can be determined then "www/unknown" is 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 than 1K, then the size in bytes is rendered. If the size of the resource is less than 1MB, then the size in kilobytes is rendered. If the size is greater than or equal to 1MB, then the size is 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 number or date elements:

  • 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 is displayed as either "today", "yesterday" or the number of days ago.) Note on formatting numbers Setting parameters to format dates


When referencing user detWhen 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:

  • format="length:number_of_characters"
  • format="length:10" 

link=" "

The link parameter is used to define the type of link created by the element tag:

  • link="default" 
  • link="path"
  • link="contextual"
    Contextual linking:  
    Contextual linking is used so that when content is linked from another site, the link is rendered relative to the current site if possible. It can only be used if context=current or context=autofill.

separator=" "

This is used when referencing an option selection or user selection element. It is used to define what text or code is 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 is placed between each selection when rendered.

htmlencode=" "

If htmlencode="true" the reserved HTML characters in text, short text and option selection elements are converted into character entities. For example, '<' is 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 by the cmpnt.htmlEncodeDefault property in the WCM WCMConfigService service is used. By default, this property is set to true.

awareness=" "

If awareness="true" then user names are displayed using the people awareness features. These features display 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 only works 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.

Topofpage

...

Information tags 

...

Table 1. Additional tag parameters

Tag parameters

Details

knowntext=" "

unknowntext=" "

These parameters are used when value="unknownPages". For example:

[PageInfo value="unknownPages"
knowntext="of" unknowntext="of at least" ]

This could be used with other PageInfo tags to render the following:

  • When the total number of pages are known: "Page 2 of 5."
  • When the total number of pages are unknown: "Page 2 of at least 5."

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.

Topofpage

...

Path component tags

...

Table 1. Additional tag parameters

Tag parameters

Details

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.

Topofpage

...

placeholder tags  

...

  • Name - Displays the text entered in the name field of an item.
  • Title - Displays the text entered in the title field of an item.
  • Description - Displays the text entered in the description field of an item.
  • Authors - Displays the users and groups selected in the authors field of an item.
  • Owners - Displays the users and groups selected in the owners field of an item.
  • ID - Displays the GUID of an item. Note: For Link items, it will display the ID of the Link, not the ID of the content item. [Placeholder tag=“idnum”] does return the ID of the content item.

Authoring template properties:

...

Table 1. Additional tag parameters

Tag parameters

Details

name=" "

You must specify the name of the item being referenced if the context="selected". If you specify name="./itemName", the actual path is not resolved until the item is rendered. This takes slightly longer to resolve than specifying the path to the item.

format=" "

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

When field="ID":

  • format="id" displays the plain ID. If not specified, this format is used by default.
  • format="uri" outputs a wcm:oid:<id> style URI.

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.
  • When field="categories":
  • format="title" displays a list of category titles.
  • format="uri" displays a wcm:oid:<id> style URI for each listed category.
    Maximum character length:
  •  format="length:number_of_characters"** format="length:10"
    When referencing number or date elements:
  • 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 is displayed as either "today", "yesterday" or the number of days ago.)** Setting parameters to format dates , Note on formatting numbers

separator=" "

This is used when referencing a property that returns multiple results. For example, to add a line break between each result, you would use separator="<br>" . If not defined, a comma is placed between each result when rendered.

htmlencode=""

If htmlencode="true" any reserved HTML characters is converted into character entities. For example, '<' is 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 by the cmpnt.htmlEncodeDefault property in the WCM WCMConfigService service is used. By default, this property is set to true.

awareness=""

If awareness="true" then user names are displayed using the people 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, 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 only works in content rendered using either a local or remote rendering portlet.

If not specified, then awareness="false" and people awareness is not used.

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" only displays profile details of items profiled with the categories of red or green. If no library is specified, the default library is used.

resolve=" "

This determines which type of access to resolve to when rendering access level properties:
none,  virtual,  inherited, inheritedonly, effective, all 

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.

Topofpage

...

style element tag

...

Table 1. Additional tag parameters

Tag parameters

Details

 

name="./itemName"

 

 

 

 

 

 

Topofpage

...

Indenting element designs

...

Table 1. indent tag parameters

Tag parameter

Description

repeat=" "

Enter the text to repeat at the beginning of the indent.

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.

Example:

Code Block
[indentcmpnt offset="0" repeat="&amp;nbsp;&amp;nbsp;"]

...