E.1 Substitution Tags for HTML Page Skins

You can introduce portal elements into your HTML page skin through HTML page skin substitution tags. Use these to introduce such Oracle Portal elements as page Edit or Personalize links, the name of the currently logged-in user, the current page's display name, and so on.

Use HTML page skins with your portal pages. Make your selection on the Template tab of page properties. For more information, see Section 12.3.1.1, "Creating an HTML Page Skin".

Table E-1 lists and describes the substitution tags available for use in HTML page skin templates. These tags take their values from values that were entered in the wizard that was used to build the host page (that is, the page using the template) and from other Oracle Portal settings.

Note:

Before you use any of the tags described in this section, there are a few things it may be useful to know:

  • Users have access to only those objects for which they have privileges. For example, if a user does not have the Personalize privilege on a page, he or she cannot use the Personalize hyperlink, even though it may be present in the HTML page skin. In such a case, the tag will be null.

  • If you use relative links in your HTML Page Skin template, you must include the #PAGE.BASE# tag in the <HEAD></HEAD> section the template or specifically set the base tag yourself.

  • The tag #PAGE.STYLE.URL#, used in previous versions of Oracle Portal, is no longer supported. Users with legacy Unstructured User Interface templates must manually update any uses of this tag to #PAGE.STYLE#, described in Table E-1.

Table E-1 HTML Page Skin Substitution Tags

Substitution Tag Value Set By …

#BODY#

The main body area of the page

This contains all the regions and region content that are wrapped in the page skin.

#OWNER#

The Portal schema

#IMAGE_PREFIX#

The Oracle Portal images directory as specified in the plsql.conf configuration file

#USER#

The user name of the user who is currently logged on

For pages cached at the system level, all user tags are rendered null.

#USER.FULLNAME#

The full name of the user who is currently logged on

Note that:

  • The full name includes the user's first, middle, and last names.

  • For pages cached at the system level, all user tags are rendered null.

#USER.FIRSTNAME#

The first name of the user who is currently logged on

Note that, for pages cached at the system level, all user tags are rendered null.

#USER.MIDDLENAME#

The middle name of the user who is currently logged on

Note that, for pages cached at the system level, all user tags are rendered null.

#USER.LASTNAME#

The last name (surname) of the user who is currently logged on

Note that, for pages cached at the system level, all user tags are rendered null.

#VERSION#

The version of this installation of Oracle Portal

#HELPSCRIPT#

Renders the JavaScript that pops up a window to display help

Use this tag between the HTML <HEAD></HEAD> tags. For example:

<HTML dir=#DIRECTION#>
<HEAD>
<TITLE>#TITLE#</TITLE>
#HELPSCRIPT#
#PAGE.STYLE#
#PAGE.BASE#
</HEAD>
<BODY leftMargin="0" rightMargin="0" topMargin="0" marginheight="0" marginwidth="0">

To call a specific help topic:

<a href="javascript:show_context_help('help_url')">Help</a>

#DIRECTION#

The direction of character layout (left-to-right or right-to-left)

This value is set based on the language selected for the portal. Use it in conjunction with portals using bi-directional languages. For example, using PL/SQL (between <oracle></oracle> tags), you can set up if statements that query the current text direction and, based on the result, set the alignment of template elements using the #ALIGN_LEFT# and #ALIGN_RIGHT# tags.

Place this tag within the <HTML> tag, for example:

<HTML dir=#DIRECTION#>
<HEAD>
<TITLE>#TITLE#</TITLE>
#HELPSCRIPT#
#PAGE.STYLE#
#PAGE.BASE#
</HEAD>
<BODY leftMargin="0" rightMargin="0" topMargin="0" marginheight="0" marginwidth="0">

#ALIGN_LEFT#

Align content to the left

#ALIGN_RIGHT#

Align content to the right

#PAGE.PAGEID#

The page ID of the page using the HTML page skin

This tag and the #page.pagegroupid# tag can be used in a query against the public view of a page. In the following example, assume that the privilege to view WWSBR_USER_FOLDERS is granted to the user or to PUBLIC:

<oracle>
begin
    htp.p('Page=#page.pageid#'); htp.br;
    htp.p('PageGroup=#page.pagegroupid#'); htp.br;
    for c1 in (
        select display_name, language
        from #owner#.WWSBR_USER_FOLDERS
        where id = #page.pageid#
        and caid = #page.pagegroupid#
        )
        loop
             htp.p(' Page title = '||c1.display_name||
             ' language = '||c1.language);
             htp.br;
        end loop;
end;
</oracle>

#PAGE.PAGEGROUPID#

The page group ID of the page using the HTML page skin

See the example provided in #page.pageid#.

#TITLE#

The display name assigned to the page through the portal

Use this tag in the page header. For example:

<HTML dir=#DIRECTION#>
<HEAD>
<TITLE>#TITLE#</TITLE>
#HELPSCRIPT#
#PAGE.STYLE#
#PAGE.BASE#
</HEAD>
<BODY leftMargin="0" rightMargin="0" topMargin="0" marginheight="0" marginwidth="0">

#PAGE.STYLE#

Fetches all relevant style classes and embeds them in the HTML

This tag is allowed only in the document HEAD. For example:

<HTML dir=#DIRECTION#>
<HEAD>
<TITLE>#TITLE#</TITLE>
#HELPSCRIPT#
#PAGE.STYLE#
#PAGE.BASE#
</HEAD>
<BODY leftMargin="0" rightMargin="0" topMargin="0" marginheight="0" marginwidth="0">

This tag pulls its information from the Oracle Portal style that is applied to the page that is using the HTML page skin template. You can use this tag, define your own cascading style sheet (CSS) for the page, or embed the Oracle Portal style element classes between <style></style> tags in the template header.

If you define your own style through a CSS or embed the Oracle Portal style element classes, consider omitting the #page.style# tag from the HTML page skin template. The style element classes included by the #page.style# tag may conflict with the styles you include in the template or in your CSS.

The style element classes used with Oracle Portal styles are listed and described in Table E-2.

#PAGE.BASE#

The base URL of the page to which the HTML Page Skin template is applied

This tag is allowed only in the document HEAD. For example:

<HTML dir=#DIRECTION#>
<HEAD>
<TITLE>#TITLE#</TITLE>
#HELPSCRIPT#
#PAGE.STYLE#
#PAGE.BASE#
</HEAD>
<BODY leftMargin="0" rightMargin="0" topMargin="0" marginheight="0" marginwidth="0">

This tag contains a full reference to the location of the portal page to which the HTML Page Skin template is applied. This includes the base page URL and the relevant associated HTML.

If you use relative links in your HTML Page Skin template, you must include the #PAGE.BASE# tag in the <HEAD></HEAD> section the template.

#PAGE.BASE.URL#

The base URL of the page to which the HTML Page Skin is applied

This is a subset of #PAGE.BASE#. It contains just the URL. Enclose this tag in a base href tag. For example:

<base href="#PAGE.BASE.URL#">

#PORTAL.HOME#

The HTML image hyperlink to the portal home page

This tag contains everything required to render a hyperlinked icon and label (the label displays as ALT text when users roll over the icon). Use this tag by itself to place a link to your portal's home page in your HTML Page Skin template. Alternatively, you can use the #PORTAL.HOME.URL#, #PORTAL.HOME.IMAGE#, and #PORTAL.HOME.LABEL#, plus the relevant HTML to create the same effect.

#PORTAL.HOME.URL#

The URL of the portal home page

Place this tag inside an href tag. For example:

<a href="#portal.home.url#">#portal.home.label#</a>

Or

<a href="#portal.home.url#">
<img src="#portal.home.image#" alt="#portal.home.label#">
</a>

#PORTAL.HOME.IMAGE#

The image used for the portal home page link

Always use this tag inside an img src tag. For example:

<img src="#portal.home.image#">

See the entry for #portal.home.url# for another usage example.

#PORTAL.HOME.LABEL#

The text used for the portal home page hyperlink, by default: Home

See the entry for #portal.home.url# for examples.

#PORTAL.NAVIGATOR#

The HTML image hyperlink to the Portal Navigator

This tag contains everything required to render a hyperlinked icon and label (the label displays as ALT text when users roll over the icon). Use this tag by itself to place a link to the Portal Navigator in your HTML Page Skin template. Alternatively, you can use the #PORTAL.NAVIGATOR.URL#, #PORTAL.NAVIGATOR.IMAGE#, and #PORTAL.NAVIGATOR.LABEL#, plus the relevant HTML to create the same effect.

#PORTAL.NAVIGATOR.URL#

The URL of the Portal Navigator

Place this tag inside an href tag. For example:

<a href="#portal.navigator.url#">#portal.navigator.label#</a>

Or

<a href="#portal.navigator.url#">
<img src="#portal.navigator.image#" alt="#portal.navigator.label#">
</a>

#PORTAL.NAVIGATOR.IMAGE#

The image used for the Portal Navigator link

Always use this tag inside an img src tag. For example:

<img src="#portal.navigator.image#">

See the entry for #portal.navigator.url# for another usage example.

#PORTAL.NAVIGATOR.LABEL#

The text used for the Portal Navigator hyperlink, by default: Navigator

See the entry for #portal.navigator.url# for examples.

#PORTAL.HELP#

The HTML image hyperlink to the Oracle Portal online help

This tag contains everything required to render a hyperlinked icon and label (the label displays as ALT text when users roll over the icon). Use this tag by itself to place a link to Oracle Portal online help in your HTML Page Skin template. Alternatively, you can use the #PORTAL.HELP.URL#, #PORTAL.HELP.IMAGE#, and #PORTAL.HELP.LABEL#, plus the relevant HTML to create the same effect.

#PORTAL.HELP.URL#

The URL of the Oracle Portal online help

Place this tag inside an href tag. For example:

<a href="#portal.help.url#">#portal.help.label#</a>

Or

<a href="#portal.help.url#">
<img src="#portal.help.image#" alt="#portal.help.label#">
</a>

#PORTAL.HELP.IMAGE#

The image used for the Oracle Portal online help link

Always use this tag inside an img src tag. For example:

<img src="#portal.help.image#">

See the entry for #portal.help.url# for another usage example.

#PORTAL.HELP.LABEL#

The text used for the Oracle Portal online help hyperlink, by default: Help

See the entry for #portal.help.url# for examples.

#PORTAL.COMMUNITY#

The HTML image hyperlink to the Portal Community Web site

This tag contains everything required to render a hyperlinked icon and label (the label displays as ALT text when users roll over the icon). Use this tag by itself to place a link to the Portal Community Web site in your HTML Page Skin template. Alternatively, you can use the #PORTAL.COMMUNITY.URL#, #PORTAL.COMMUNITY.IMAGE#, and #PORTAL.COMMUNITY.LABEL#, plus the relevant HTML to create the same effect.

#PORTAL.COMMUNITY.URL#

The URL of the Portal Community Web site

Place this tag inside an href tag. For example:

<a href="#portal.community.url#">#portal.community.label#</a>

Or

<a href="#portal.community.url#">
<img src="#portal.community.image#" alt="#portal.community.label#">
</a>

#PORTAL.COMMUNITY.IMAGE#

The image used for the Portal Community Web site link

Always use this tag inside an img src tag. For example:

<img src="#portal.community.image#">

See the entry for #portal.community.url# for another usage example.

#PORTAL.COMMUNITY.LABEL#

The text of the Portal Community hyperlink, by default: Community

See the entry for #portal.community.url# for examples.

#PAGE.EDITPAGE#

The Edit hyperlink to portal page editing functionality

This tag contains everything required to render a hyperlink. Use this tag by itself to place an Edit page link in your HTML Page Skin template. Alternatively, you can use the #PORTAL.EDITPAGE.URL# and #PORTAL.EDITPAGE.LABEL#, plus the relevant HTML to create the same effect.

When the Edit link is placed on a navigation page, and the navigation page is rendered on a page, the Edit link executes on the page and not on the navigation page.

The value of this tag is returned only if the user has the page privilege Manage on the page.

#PAGE.EDITPAGE.URL#

The HTML text to allow page URL editing

Place this tag inside an href tag. For example:

<a href="#page.editpage.url#">#page.editpage.label#</a>

When the Edit link is placed on a navigation page, and the navigation page is rendered on a page, the Edit link executes on the page and not on the navigation page.

The value of this tag is returned only if the user has the page privilege Manage on the page.

#PAGE.EDITPAGE.LABEL#

The text for the Edit page hyperlink, by default: Edit

When the Edit link is placed on a navigation page, and the navigation page is rendered on a page, the Edit link executes on the page and not on the navigation page.

The value of this tag is returned only if the user has the page privilege Manage on the relevant page.

See the entry for #page.editpage.url# for examples.

#PAGE.CUSTOMIZEPAGE#

The hyperlink to the personalize page dialog

This tag contains everything required to render a hyperlink. Use this tag by itself to place a Personalize page link in your HTML Page Skin template. Alternatively, you can use the #PAGE.CUSTOMIZEPAGE.URL# and #PAGE.CUSTOMIZEPAGE.LABEL#, plus the relevant HTML to create the same effect.

The value of this tag is returned only if the user has sufficient privileges to personalize the page.

#PAGE.CUSTOMIZEPAGE.URL#

The URL that renders the personalize page view

Use this in conjunction with the #PAGE.CUSTOMIZEPAGE.LABEL# tag to construct your Personalize link. For example:

<a href="#PAGE.CUSTOMIZEPAGE.URL#">
#PAGE.CUSTOMIZEPAGE.LABEL#</a>

The value of this tag is returned only if the user has sufficient privileges to personalize the page.

#PAGE.CUSTOMIZEPAGE.LABEL#

The text for the personalize page link, by default: Personalize

The value of this tag is returned only if the user has sufficient privileges to personalize the page.

#PAGE.REFRESH#

The page refresh hyperlink

This tag contains everything required to render a hyperlink. Use this tag by itself to place a Refresh page hyperlink in your HTML Page Skin template. Alternatively, you can use the #PAGE.REFRESH.URL# and #PAGE.REFRESH.LABEL#, plus the relevant HTML to create the same effect.

When this tag is placed on a navigation page, and the navigation page is rendered on a page, the Refresh link executes on the page and not on the navigation page.

The Refresh hyperlink displays only when the page's cache mode is set to Cache Page Definition and Content.

#PAGE.REFRESH.URL#

The URL that invokes the page refresh functionality

Use this in conjunction with the #PAGE.REFRESH.LABEL# tag to construct your Refresh hyperlink. For example:

<a href="#page.refresh.url#">
#page.refresh.label#</a>

When the Refresh link is placed on a navigation page, and the navigation page is rendered on a page, the Refresh link executes on the page and not on the navigation page.

The Refresh hyperlink displays only when the page's cache mode is set to Cache Page Definition and Content.

#PAGE.REFRESH.LABEL#

The text used for the refresh hyperlink, by default: Refresh

When the Refresh link is placed on a navigation page, and the navigation page is rendered on a page, the Refresh link executes on the page and not on the navigation page.

The Refresh hyperlink displays only when the page's cache mode is set to Cache Page Definition and Content.

See the entry for #page.refresh.url# for a usage example.

#PORTAL.LOGOUT#

The Oracle Portal Logout hyperlink

This tag contains everything required to render a hyperlink. Use this tag by itself to place a Logout hyperlink in your HTML Page Skin template. Alternatively, you can use the #PORTAL.LOGOUT.URL# and #PORTAL.LOGOUT.LABEL#, plus the relevant HTML to create the same effect.

The Logout hyperlink toggles between Logout and Login, depending on its current state.

#PORTAL.LOGOUT.URL#

The Oracle Portal logout URL

Use this in conjunction with the #PORTAL.LOGOUT.LABEL# tag to construct your Logout hyperlink. For example:

<a href="#portal.logout.url#">
#portal.logout.label#</a>

The Logout hyperlink toggles between Logout and Login, depending on its current state.

#PORTAL.LOGOUT.LABEL#

The text used for the logout hyperlink, by default: Logout

The Logout hyperlink toggles between Logout and Login, depending on its current state.

See the entry for #portal.logout.url# for a usage example.

#PORTAL.ACCOUNTINFO#

The hyperlink to the account information dialog

This tag contains everything required to render a hyperlink. Use this tag by itself to place an Account Info hyperlink in your HTML Page Skin template. Alternatively, you can use the #PORTAL.ACCOUNTINFO.URL# and #PORTAL.ACCOUNTINFO.LABEL#, plus the relevant HTML to create the same effect.

Users must be logged in to see the Account Info hyperlink.

#PORTAL.ACCOUNTINFO.URL#

The URL to the account information dialog

Use this in conjunction with the #PORTAL.ACCOUNTINFO.LABEL# tag to construct your Account Info hyperlink. For example:

<a href="#portal.accountinfo.url#">
#portal.accountinfo.label#</a>

Users must be logged in to see the Account Info hyperlink.

#PORTAL.ACCOUNTINFO.LABEL#

The text used for the account information hyperlink, by default: Account Info

Users must be logged in to see the Account Info hyperlink.

See the entry for #portal.accountinfo.url# for a usage example.