Reference Elements

Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows

Reference Elements

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

<Element type=" " context=" " name=" " key=" " format=" " separator=" " 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".
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 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 will be displayed on the rendered page. This is used by default if no format is specified.

When referencing a link element:

Use format="url" to only render the full URL of a link element.

Use format="path" to only render the site path of a link element. For example, site/sitearea/content .

Use format="tag" to render a complete link tag. This is used by default if no format is specified.

When referencing number or date elements:

In this case, the format is used to specify the display format of dates and numbers. See Setting parameters to format dates and Note on formatting numbers for further information.

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.
start=" "
end=" "

The start and end attributes are used to wrap the data returned by an IBM^® Workplace 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.

Parent topic:
Referencing elements

<Element type=" " context=" " name=" " key=" " format=" " separator=" " 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". 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 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 will be displayed on the rendered page. This is used by default if no format is specified. When referencing a link element: Use format="url" to only render the full URL of a link element. Use format="path" to only render the site path of a link element. For example, site/sitearea/content . Use format="tag" to render a complete link tag. This is used by default if no format is specified. When referencing number or date elements: In this case, the format is used to specify the display format of dates and numbers. See Setting parameters to format dates and Note on formatting numbers for further information.
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.
start=" " end=" "	The start and end attributes are used to wrap the data returned by an IBM^® Workplace 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.