Show TOC

Framework Tag LibraryLocate this document in the navigation structure

Use

The framework tag library helps you create masthead and page title bar navigation iViews. The tags enable you to create standard links (such as for logging off) and display commonly used text strings (such as the current user's name).

For all tags that create a link, the tag's body is the text or image for the link.

Tags for Masthead iViews

The masthead iView is used to display the current user's name, links for logging off the portal and performing other tasks, and branding images and text.

The following tags are available:

Tag

Description

personalizePortalAnchor

Creates a link to open the personalize dialog for the portal.

newSessionAnchor

Creates a link to open a new session in the portal.

logInAnchor

Creates a link to log on to the portal.

logOffAnchor

Creates a link to log off the portal.

portalHelpAnchor

Creates a link to display help for the portal.

userFirstName

Displays the current user's first name.

userLastName

Displays the current user's last name.

userSalutation

Displays the current user's salutation, such as Prof. or Dr. .

The userFirstName, userLastName, and userSalutation tags do not have any attributes.

Note

The masthead tags require special JavaScript contained in the default masthead. To create your own masthead iView, either modify a copy of the default masthead or copy the JavaScript from the default masthead to your masthead.

Tags for Page Title Bar iViews

The page title bar iView is used to display the title of the current page and to display links for invoking page functions, such as refreshing or personalizing the page.

The following tags are available:

Tag

Description

pageDetailsAnchor

Creates a link to display information about the current page.

pageExpandAnchor

Creates a link to open the current page in a new window.

pageHelpAnchor

Creates a link to display help for the current page.

pagePersonalizeAnchor

Creates a link to open the personalize dialog for the current page.

pageRefreshAnchor

Creates a link to refresh the page.

addToBrowserFavoritesAnchor

Creates a link to add the current page to the browser's favorites.

addToPortalFavoritesAnchor

Creates a link to add the current page to the portal favorites displayed in the navigation panel.

The pageDetailsAnchor, pageExpandAnchor, pageHelpAnchor, pagePersonalizeAnchor, and pageRefreshAnchor tags require that the Content Area iView runs in the same frame/window where the tags are used.

The page title bar tags require special JavaScript contained in certain other iViews or configurations of a framework page when these tags are used.

Optional Attributes

All these tags have an optional anchorAttributes attribute that you can use to specify additional HTML tag attributes that are added to the rendered anchor tag, such as style, class, or id.

If you need to override the original implementation of a tag for masthead iViews, you can use the anchorAttributes attribute. This attribute causes the tag to be rendered as a plain <a> tag, for example:

<frm:portalHelpAnchor>Help</frm:portalHelpAnchor>

renders into

<a class="urLnkFunction" id="HelpLink" href="#" onclick="openHelp();return false;">
<span class="urFontStd">
<span ct="TextView" class="urTxtStd" style="white-space:nowrap;">Help</span>
</span> </a>
            

whereas

<frm:portalHelpAnchor anchorAttributes="id=\"help\"">Help</frm:portalHelpAnchor>

renders into

<a href="#" onclick="openHelp();return false;" id="help">Help</a>