Component tag

The Component tag is used to reference a component stored in an item within a presentation template or component design.

<AptrixCmpnt type=" " context=" " name=" " key=" " start=" " end=" " />

<AptrixCmpnt	Opens a component tag.
type=" "	This determines where the component is being referenced from. Either "content", "sitearea" or "site".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the component is being referenced from. This is not used if context=current or context=autofill.
key=" "	This is the name of this component being referenced.
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using Start and End Attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Library component tag

The library component tag is used to reference a library component within a presentation template or component design.

<AptrixLibCmpnt name=" " start=" " end=" " />

<AptrixLibCmpnt	Opens a library component tag.
name=" "	This is the name of the item the component is being referenced from.
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag

Placeholder tag

The placeholder tag is used to reference a placeholder within a component design.

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

<placeholder	Opens a Placeholder Tag.
tag=" "	Determines which placeholder is being referenced: Name Href Namelink Sitepath Idnum Listnum Treenum Paddedtreenum Depth
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Placeholder types

Path component tag

The path component tag is used to represent certain parts of the URL. The PathCmpnt tag can represent the servlet path, the base path, or the context path of the current page.

<pathcmpnt type=" " start=" " end=" " />

<pathcmpnt	Opens a path component tag.
type=" "	This determines the type of path component:baseThis returns the base section of a URL. E.g., http://hostname:8080contextThis returns the context section of a URL. E.g., /ILWWCMservletThis returns the servlet path of a URL. E.g., /ILWWCM/connect
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

 Restriction: *Using the path component in a portlet.*The URLs generated by the path component will be fully qualified when viewed through a portal. To generate URLs with no prefix, use the following "Type" parameters instead of the standard parameters:

• Type="noprefixbase" instead of Type="base"
• Type="noprefixservlet" instead of Type="servlet".
• Type="Prefix". When viewed through portal the, prefix value will be printed. If no prefix exists then empty string is returned. Back to Top

Indent component tag

The indent component tag can be used when formatting navigator and taxonomy component designs.

<indentcmpnt offset=" " repeat=" " start=" " end=" " />

<indentcmpnt	Opens an indent component tag.
offset=" "	The number entered here determines the size of the indent.
repeat=" "	The text to repeat is entered.
Note: Double-byte character setsNot all double-byte character sets support extended ASCII. To use tags such as " " you will need to replace "&" with "&". E.g. - <indentcmpnt offset="0" repeat="  "/>
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Alternate design component tag

The alternate design component tag is used in a component design in a navigator or menu component. Its purpose is to display a library component based on the type of item that the navigator or menu is rendering.

For example: A navigator will work with both site areas and content items. The alternate design component can be configured to display one library component if the item that the navigator is rendering is a site area, and another if it is not. This configuration is done by setting the "type" attribute in the alternate design tag. If a type value is not entered, it defaults to "any", which means that the library component will be applied if the item is either a site area or a content.

The two attributes "normal" and "highlight" refer to library components. The value that is assigned to them is the name of the component in the component library. By default, the "normal" attribute value is used to apply a library component to the item. If the "highlight" attribute is specified, the component that the highlight attribute refers to will be applied to the item if the item is in the site path of the current content. For example: if the item that the alternate design is being applied to is the content page that was accessed in the URL, the "highlight" library component will be used.

The alternate design tag can refer to any component in the component library. If it refers to a rich text component in the component library, it is possible for this rich text component to contain placeholder tags that refer to the current item.

<alternatedesign type=" " normal=" " highlight=" " start=" " end=" " />

<alternatedesign	Opens a Component Tag.
type=" "	Type is either "sitearea", "content" or "Any". ("Any" means both "sitearea" and "content".)
normal=" "	Enter the name of a Library component.
highlight=" "	Enter the name of a Library component.
start=" "end=" "	The Start and End attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management Tag.

ID component tag

The ID component tag is used to display the ID details of sites, site areas or content items.

<idcmpnt type=" " context=" " name=" " field=" " separator=" " start=" " end=" " />

<idcmpnt	Opens an ID component tag.
type=" "	This determines where the ID is being referenced from. Either "site", "sitearea", "content" or "user".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the ID field is being referenced from. This is not used if context=current or context=autofill.
field=" "	Enter the IDField you wish to display. name description authors owners
separator=" "	Only used with field=authors or field=owners. Used to separate each listed author or owner. E.g. 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 "&". E.g. - separator="  "
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management Tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Profile component tag

The Profile component tag is used to display the profiling details (either categories or keywords) of an item.

<profilecmpnt type=" " context=" " name=" " field=" " separator=" " include=" " start=" " end=" " />

<profilecmpnt	Opens a Profile Component tag.
type=" "	This determines where the profile is being referenced from. Either "site", "sitearea", "content" or "user".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the component is being referenced from. This is not used if context=current or context=autofill.
field=" "	Enter the field you wish to display. categories. keywords.
separator=" "	Used to separate each listed category or keyword. E.g. separator=", "
Note: Double-byte character setsNot all double-byte character sets support extended ASCII. To use tags such as " " you will need to replace "&" with "&". E.g. - separator="  "
include=" "	Used only with field=categories. Determines which level of a taxonomy to display: exact ancestors descendants allE.g., If an item is profiled with a category of Sport, and include=descendants, then all the descendants of "sport" would also be displayed.
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Workflow component tag

The workflow component tag is used to display workflow details of an item.

<workflowcmpnt type="" context="" name="" field="" separator="" format="" start=" " end=" " />

<workflowcmpnt	Opens a workflow component tag.
type=" "	This determines where the workflow field is being referenced from. Either "site", "sitearea", or "content".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the ID field is being referenced from. This is not used if context=current or context=autofill.
field=" "	Enter the IDField you wish to display. status workflow currentstage publishdate expirydate generaldateone generaldatetwo additionalviewers
separator=" "	Only used when field="additionalviewers". Used to separate each additional viewer. E.g. separator=", "
Note: Double-byte character setsNot all double-byte character sets support extended ASCII. To use tags such as " " you will need to replace "&" with "&". E.g. - separator="  "
format=" "	Used to define the format of the date/time to be displayed. Only applies to date fields used with the field="" attribute. See Note on formatting dates.
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

History component tag

The history component tag is used to display an item's history details.

<historycmpnt type=" " context=" " name=" " field="lastmodified" format="" start=" " end=" " />

<historycmpnt	Opens a history component tag.
type=" "	This determines where the workflow field is being referenced from. Either "site", "sitearea", or "content".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the ID field is being referenced from. This is not used if context=current or context=autofill.
field=" "	This is always equal to "lastmodified".
format=""	Used to define the format of the date/time to be displayed. Only applies to date fields used with the field="" attribute. See Note on formatting dates.
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Security component tag

The security component tag is used to display the users or groups granted effective security for an item.

<securitycmpnt type=" " context=" " name=" " field=" " separator=" " start=" " end=" " />

<securitycmpnt	Opens a security component component tag.
type=" "	This determines where the workflow field is being referenced from. Either "site", "sitearea", or "content".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the security field is being referenced from. This is not used if context=current or context=autofill.
field=" "	Enter the security field you wish to display. live read edit delete
separator=" "	Used to separate each listed user or group. E.g. separator=", "
Note: Double-byte character setsNot all double-byte character sets support extended ASCII. To use tags such as " " you will need to replace "&" with "&". E.g. - separator="  "
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Document Manager component tag

The Document Manager component tag is used to reference a Document Manager component stored in a site, site area or content item within a presentation template or component design. It is also used to reference the content of Document Manager documents in a Personalization component design.

<DocumentManagerCmpnt type=" " context=" " name=" " key=" " scope=" " attributename=" " format=" " convertTo=" " start=" " end=" " />

<DocumentManagerCmpnt	Opens a component tag.
type=" "	This determines where the component is being referenced from. Either "content", "sitearea", "site" or "personalization".Note: Referencing Document Manager content using a Personalization rule or content spot.*If you use a Personalization Component tag to reference Document Manager content displayed in a Personalization rule or content spot, you will only be able to retrieve attributes about the document. To display the document itself you will need to use a Document Manager component tag with *type="personalization".
context=" "	This determines which item is being referenced.SelectedRefers to a particular item as specified in the name attribute below.CurrentThis will reference the component from the current site, site area or content file that is being browsed by the user.AutoFillThe component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	This is the name of the item the component is being referenced from. This is not used if context=current or context=autofill.
key=" "	This is the name of the component being referenced from the site, site area or content item. This is not required if type="personalization".
scope=" "	The scope specifies what will be returned from the selected Document Manager document:documentThis will display the content of theDocument Managerdocument.documenturlThis will display the URL to theDocument Managerdocument.attributeThis will display a particular attribute of theDocument Managerdocument.
attributeName=" "	If scope="attribute" you must use this parameter to specify the attribute to display. A list of possible attributes can be determined by using the Details option from a document specified in the Document Manager component form of Web Content Management.
format=" "	This parameter accepts any format string which is valid under the rules defined in the Java class "java.text.SimpleDateFormat".Example: If an attribute is a "date", the format of the date can be specified here. E.g. - "dd/MM/yyyy" would format a date as 16/08/2004.
convertTo=" "	Used to specify a mime type that the document should be converted to. E.g. - "text/html" or "application/pdf".
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.

Examples:

• Displaying the attributes of a Document Manager document:
  To display the "title" of a Document Manager document, the following tag could be used:<DocumentManagerCmpnt type="content" context="current" key="component_name" scope="Attribute" attributeName="title" />
  To display the "last modified" date of a Document Manager document, the following tag could be used:<DocumentManagerCmpnt type="content" context="current" key="component_name" scope="Attribute" attributeName="lastModified" format="dd/MM/yyyy" />

• Displaying the content of a Document Manager document:
  To display the content of a Document Manager document, the following tag could be used:<DocumentManagerCmpnt type="content" context="current" key="component_name" scope="Document" />
  Depending on the content type being returned, you may also need to convert the content to HTML. In this case you would use the following tag:<DocumentManagerCmpnt type="content" context="current" key="component_name" scope="Document" convertTo="text/html" />

• Displaying the URL of a Document Manager document:
  To display the URL of a Document Manager document, the following tag could be used:
  <DocumentManagerCmpnt type="content" context="current" key="component_name" scope="DocumentURL" convertTo="text/html" />

• Displaying the URL of a Document Manager document as a link:
  To display the URL of a Document Manager document as a link in a web page, the following tags could be used:
  <a href="<DocumentManagerCmpnt type="content" context="current" key="component_name" scope="DocumentURL" convertTo="text/html" />">
  <DocumentManagerCmpnt type="content" context="current" key="component_name" scope="Attribute" attributeName="title" />
  </a>

• Using a Document Manager component tag in a Personalization component design:
  If you use a Personalization component tag to reference Document Manager content displayed in a Personalization rule or content spot, you will only be able to retrieve attributes about the document. To display the document itself you will need to use a Document Manager component tag with type="personalization".
  <DocumentManagerCmpnt type="personalization" context="autofill"  scope="document" convertTo="text/html" />

Document Manager Library component tag

The Document Manager Library component tag is used to reference a Document Manager component stored in the component library.

<DocumentManagerLibCmpnt name=" " scope=" " attributeName=" " format=" " convertTo=" " start=" " end=" " />

<DocumentManagerLibCmpnt	Opens a Component Tag.
name=" "	This is the name of the Document Manager Library Component.
scope=" "	The scope specifies what will be returned from the selected Document Manager document:documentThis will display the content of theDocument Managerdocument.documenturlThis will display the URL to theDocument Managerdocument.attributeThis will display a particular attribute of theDocument Managerdocument.
attributeName=" "	If scope="attribute" you must use this parameter to specify the attribute to display.
format=" "	This parameter accepts any format string which is valid under the rules defined in the Java class "java.text.SimpleDateFormat".Example: If an attribute is a "date", the format of the date can be specified here. E.g. - "dd/MM/yyyy" would format a date as 16/08/2004.
convertTo=" "	Used to specify a mime type that the document should be converted to. E.g. - "text/html" or "application/pdf".
start=" "end=" "	The Start and End attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using Start and End Attributes topic for more information on using these attributes.
/>	Closes a Web Content Management Tag.

Examples:

• Displaying the attributes of a Document Manager document:
  To display the "title" of a Document Manager document, the following tag could be used:<DocumentManagerLibCmpnt name="component_name" scope="Attribute" attributeName="title" />
  To display the "last modified" date of a Document Manager document, the following tag could be used:<DocumentManagerLibCmpnt name="component_name" scope="Attribute" attributeName="lastModified" format="dd/MM/yyyy" />

• Displaying the content of a Document Manager document:
  To display the content of a Document Manager document, the following tag could be used:<DocumentManagerLibCmpnt name="component_name" scope="Document" />
  Depending on the content type being returned, you may also need to convert the content to HTML. In this case you would use the following tag:<DocumentManagerLibCmpnt name="component_name" scope="Document" convertTo="text/html" />

• Displaying the URL of a Document Manager document:
  To display the URL of a Document Manager document, the following tag could be used:<DocumentManagerLibCmpnt name="component_name" scope="DocumentURL" convertTo="text/html" />

• Displaying the URL of a Document Manager document as a link:
  To display the URL of a Document Manager document as a link in a web page, the following tags could be used:<a href="<DocumentManagerLibCmpnt name="component_name" scope="DocumentURL" convertTo="text/html" />">
  <DocumentManagerLibCmpnt name="component_name" scope="Attribute"attributeName="title" /></a>

Personalization component tag

The Personalization component tag is used as a placeholder to display attributes from a content spot or Personalization rule within a Personalization component design. It cannot be used in a presentation template or other component types.

<personalizationCmpnt attributeName="ibmcm: " format=" " start=" " end=" " />
<personalizationCmpnt	Opens a component tag.
attributeName="ibmcm: "	This is the name of the attribute you would like to display from a content spot or Personalization rule. When selecting a content spot or Personalization rule in a Personalization component form, the list of attributes for each content spot or Personalization rule is listed in the right-hand view.The attribute must always be prefixed by "ibmcm:attributeName="ibmcm:attribute"The following attribute names can be used: ibmcm:title ibmcm:description ibmcm:modifiedDate ibmcm:expirationDate ibmcm:effectiveDate ibmcm:wcmType
format=" "	This parameter accepts any format string which is valid under the rules defined in the java class "java.text.SimpleDataFormat".Example: If an attribute is a "date", the format of the date can be specified here. E.g. - "dd/MM/yyyy" would format a date as 16/08/2004.
start=" "end=" "	The start and end attributes are used to wrap the data returned by an Web Content Management tag within other tags, such as HTML. These attributes are not mandatory. See the Using start and end attributes topic for more information on using these attributes.
/>	Closes a Web Content Management tag.
Note: Referencing Document Manager content using a Personalization rule or content spot.*If you use a Personalization component tag to reference Document Manager content displayed in a Personalization rule or content spot, you will only be able to retrieve attributes about the document. To display the document itself you will need to use a Document Manager component tag with *type="personalization".

Note on formatting dates

These parameters are used to set the format of displayed dates in components.

Examples Using the US locale: