Meta-HTML Reference

In this section, each meta-HTML element is discussed in alphabetical order.

Description

At runtime %Appserver is replaced with the name of the application server.

This meta-HTML variable is valid for use in attached auxiliary files.

Description

At runtime %AppsRel is replaced with the application release string.

This meta-HTML variable is valid for use in attached auxiliary files.

Description

At runtime %Browser is replaced with the browser name as specified by the browser loading the current page.

Description

At runtime %BrowserPlatform is replaced with the operating system name as specified by the browser loading the current page.

Description

At runtime %BrowserVersion is replaced by the version string as specified by the browser loading the current page.

Syntax

%Cols(n)

Description

At runtime %Cols(n) is replaced with COLS=n.

Parameters

Field or Control	Definition
`n`	Specify the number of columns.

This meta-HTML function is valid for use in attached auxiliary files, but always generates COLS=n, that is, it isn't Browser-aware when used in attached files.

Description

At runtime %Component is replaced with the component name of the current component.

Syntax

%BB(css_property)

Description

Use the %BB function to expand the generic style into the browser-specific style and add the browser prefix to the both the CSS property name and the property value. Use this function in free form style sheet definitions only.

Note: Use this function in style sheet definitions only.

Parameters

Field or Control	Definition
`css_property`	Specifies the CSS property as a String value.

Example

%BB(transition:transform 1s ease-in-out 0.3s);

In the case of Firefox, the expanded browser-specific style would be as follows:

-moz-transition:-moz-transform 1s ease-in-out 0.3s

Syntax

%BP(css_property)

Description

Use the %BP function to expand the generic style into the browser-specific style and add the browser prefix to the CSS property name. Use this function in free form style sheet definitions only.

Note: Use this function in style sheet definitions only.

Parameters

Field or Control	Definition
`css_property`	Specifies the CSS property as a String value.

Example

The following %BP function expands the generic style:

%BP(box-orient: vertical);

In the case of a WebKit browser (Safari or Chrome), the expanded browser-specific style would be as follows:

-webkit-box-orient: vertical

Syntax

%BV(css_property)

Description

Use the %BV function to expand the generic style into the browser-specific style and add the browser prefix to the CSS property value. Use this function in free form style sheet definitions only.

Note: Use this function in style sheet definitions only.

Parameters

Field or Control	Definition
`css_property`	Specifies the CSS property as a String value.

Example

The following %BV function expands the generic style:

%BV(display:box);

In the case of Internet Explorer, the expanded browser-specific style would be as follows:

display:-ms-box

Syntax

%ContentReference(PORTAL_NAME, CREF_object, [URL_type])

Description

At runtime, %ContentReference is replaced with the absolute URL to the specified content reference.

Note: If the specified content reference object does not exist or the current user does not have access to it, an error message is returned instead of the URL.

Parameters

Field or Control	Definition
`PORTAL_NAME`	Specifies the portal.
`CREF_object`	Specifies the name of the content reference definition.
`URL_type`	Specifies the URL type: `psp` — Specifies the absolute portal URL. `psc` — Specifies the absolute content URL. Note: `psp` is the default value.

Field or Control

Definition

PORTAL_NAME

Specifies the portal.

CREF_object

Specifies the name of the content reference definition.

URL_type

Specifies the URL type:

psp — Specifies the absolute portal URL.
psc — Specifies the absolute content URL.

Note: psp is the default value.

Example

The following example demonstrates a usage of %ContentReference:

%ContentReference(EMPLOYEE, PT_PTFP_VIEW_GBL, psp)

The resulting absolute URL would be similar to the following:

http://myserver.example.com:8080/psp/QEDMO/EMPLOYEE/PT_LOCAL/c/PTFP_FEED_PUBLISHING.PTFP_VIEW.GBL

Description

At runtime %Copyright is replaced with a string suitable for use as a standard PeopleSoft copyright notice.

This meta-HTML variable is valid for use in attached auxiliary files.

Description

At runtime %DBName is replaced with the name of the application database.

This meta-HTML variable is valid for use in attached auxiliary files.

Description

At runtime %DBType is replaced with the type of the application database.

This meta-HTML variable is valid for use in attached auxiliary files.

Syntax

%Encode(anything)

Description

At runtime %Encode plus anything is replaced with the encoded string. Encoding is done according to normal URL encoding rules.

Parameters

Field or Control	Definition
`anything`	Specify the string to be encoded.

This meta-HTML function is valid for use in attached auxiliary files.

Syntax

%ExplainMessage(message_set, message_num [, alt_msg_text])

Description

Use the %ExplainMessage function to retrieve the Description field (that is, the explain, or detailed text) for a message from the message catalog.

Note: Use this function in HTML definitions only.

Parameters

Field or Control	Definition
`message_set`	Specifies the message set as an Integer value.
`message_num`	Specifies the message number as an Integer value.
`alt_msg_text`	Specifies a String value representing an alternate message to be used if the message set and number are not found in the message catalog. Note: The alternate message is used as is. Any quotation marks used to enclose the alternate message will be output as part of the message instead. In addition, because a comma is used as a separator between parameters, a comma will truncate the alternate message.

Example 1

The following example demonstrates usage of the %ExplainMessage function:

%ExplainMessage(124, 528, Message Not Found: Click Yes to go back and save; No to discard your changes)

The resulting description is returned from the message catalog:

Click Yes to go back and save, No to discard your changes

Example 2

The following example specifies a message set and number that is undefined in the message catalog:

%ExplainMessage(124, 999, "Message Not Found: Click Yes to go back and save, No to discard your changes")

Because the alternate message includes a comma, it would be truncated as follows:

"Message Not Found: Click Yes to go back and save

Description

Use the %FORMFACTOREXTRALARGE variable to return the ceiling (the maximum device width in physical pixels) defined in the web server's configuration files for the extra large form factor as an Integer.

Note: Use this variable in media queries in free form style sheet definitions only.

Example

@media only screen
and (max-width:%FORMFACTORMEDIUM) 
{
	.psc_columnitem-1of2,
	.psc_columnitem-2of2,
	.psc_columnitem-1of3,
	.psc_columnitem-2of3,
	.psc_columnitem-3of3
	{
	float:none;
	width:auto;
	display:block; 
	}
}

Description

Use the %FORMFACTORLARGE variable to return the ceiling (the maximum device width in physical pixels) defined in the web server's configuration files for the large form factor as an Integer.

Note: Use this variable in media queries in free form style sheet definitions only.

Description

Use the %FORMFACTORMEDIUM variable to return the ceiling (the maximum device width in physical pixels) defined in the web server's browscap file for the medium form factor as an Integer.

Note: Use this variable in media queries in free form style sheet definitions only.

Description

Use the %FORMFACTORSMALL variable to return the ceiling (the maximum device width in physical pixels) defined in the web server's configurations files for the small form factor as an Integer.

Note: Use this variable in media queries in free form style sheet definitions only.

Description

At runtime %Formname is replaced with the name of the HTML FORM generated for the current page.

This meta-HTML variable is valid for use in attached auxiliary files.

Syntax

%HtmlContent(ContentName)

Description

At runtime %HtmlContent and ContentName are replaced by the URL suitable for referencing the content on the web server. In addition, the content is loaded into the web server's cache directory.

Parameters

Field or Control	Definition
`ContentName`	Specify the content you want to access, as a string.

Syntax

%Image(imagename)

Description

At runtime %Image and imagename are replaced by the URL suitable for referencing the image on the web server. In addition, the image is loaded into the web server's cache directory.

Parameters

Field or Control	Definition
`imagename`	Specify the name of an image saved as an image definition in Application Designer.

Example

<img src='%Image(PSLOGO)'>

Syntax

%JavaScript(HTMLDefinition)

Description

At runtime %JavaScript and the HTMLDefinition are replaced by the URL suitable for referencing the .js file on the web server. In addition, the JavaScript is loaded into the web server's cache directory.

Parameters

Field or Control	Definition
`HTMLDefinition`	Specify the name of an HTML definition that contains a JavaScript program.

Example

<script src='%JavaScript(PT_EDITSCRIPTS)'></script>

Description

At runtime %LableTag is replaced with the text LABEL.

This meta-HTML variable is valid for use in attached auxiliary files, but always generates LABEL, that is, it isn't Browser-aware when used in attached files.

Description

At runtime %LanguageISO is replaced with a string value representing the current session’s language code or language code and country code if a country code exists.

Use %LanguageISO to declare the language of a Web page using the HTML lang attribute.

For instance, if the language for the current language is English, then <html lang="%LanguageISO"> resolves to <html lang="en"> at runtime. If the current language is Canadian French then it would resolve to <html lang="fr-ca"> .

Example

&html = "<html dir='" | %Direction | "' lang='" | %LanguageISO | "'>";

Description

At runtime %Menu is replaced by the menu name for the currently loaded component.

Syntax

%Message(message_set, message_num, default_msg_txt [, paramlist])

where paramlist is an arbitrary-length list of parameters to be substituted in the resulting text string, in the form:

param1 [, param2]. . .

Description

%Message retrieves a message from the PeopleCode Message Catalog and substitutes in the values of the parameters into the message.

The message_set and message_num parameters specify the message to retrieve from the catalog. If the message is not found in the Message Catalog, the default message provided in default_msg_txt is used. Message sets 1 through 19,999 are reserved for use by PeopleSoft applications. Message sets 20,000 through 32,767 can be used by PeopleSoft users.

The parameters listed in the optional paramlist are referenced in the message using the % character followed by an integer referencing the position of the parameter in the function call. For example, if the first and second parameters in paramlist were MONDAY and 12/5/2001, they would be inserted into the message string as %1 and %2. To include a literal percent sign in the string, use %%; %\ is used to indicate an end-of-string and terminates the string at that point, this is generally used to specify fixed-length strings with trailing blanks.

The message is obtained using the current user language code.

Parameters

Field or Control	Definition
`message_set`	Specify the message set to be retrieved from the catalog. This parameter takes a number value.
`message_num`	Specify the message number to be retrieved from the catalog. This parameter takes a number value.
`default_msg_txt`	Specify the text to be displayed if the message isn't found. This parameter takes a string value.
`paramlist`	Specify values to be substituted into the message.

This is valid for use in attached auxiliary files.

Note: If the message is changed (or a new language version is added) after the auxiliary file has been loaded to the web server, the auxiliary file still contains the old version of the message. It is necessary to manually delete the file from the web server cache directory to get it to re-retrieve the (unmodified) auxiliary component with the (modified) message bindings.

Description

At runtime %Page is replaced by the name of the current page.

Description

At runtime %ServicePack is replaced with the application service pack string.

This meta-HTML variable is valid for use in attached auxiliary files.

Syntax

%StyleSheet(STYLE_SHEET_NAME)

Description

At runtime, %StyleSheet and the STYLE_SHEET_NAME parameter are replaced by the absolute URL suitable for referencing the .css file on the web server. In addition, the style sheet is loaded into the web server's cache directory.

Parameters

Field or Control	Definition
`STYLE_SHEET_NAME`	Specify the name of a style sheet definition stored in the database.

Example

The following example demonstrates a usage of %StyleSheet:

%StyleSheet(PSSTYLEDEF_FMODE)

The resulting absolute URL would be similar to the following:

http://myserver.example.com:8080/cs/QEDMO/cache/PSSTYLEDEF_FMODE_133.css

Description

At runtime %SubmitScriptName is replaced with the name of the JavaScript function that the current page uses to submit the form when a server action is required.

This meta-HTML variable is valid for use in attached auxiliary files.

Description

At runtime, for each field inside an HTML area that is defined with the %tabindex meta-variable, %tabindex will be replaced with the tab index of the HTML area itself.

This meta-variable is valid for fields inside an HTML area only; if the field is not inside HTML area, then this meta-variable will remain unresolved at runtime.

Example

In the following example, two fields have been defined with the %tabindex meta-HTML variable, while one has not:

<a href="http://www.w3schools.com" tabindex="%tabindex">Visit W3Schools.com!</a>
<a id="HELP" name="HELP" href="javascript:some_function1();" tabindex="%tabindex">Help</a>
<a id="NEWWIN" name="NEWWIN" href="javascript:some_function2();">New Window</a>

At runtime, if the tab index for the HTML area is 20, then this HTML fragment resolves to:

<a href="http://www.w3schools.com" tabindex="20">Visit W3Schools.com!</a>
<a id="HELP" name="HELP" href="javascript:some_function1();" tabindex="20">Help</a>
<a id="NEWWIN" name="NEWWIN" href="javascript:some_function2();">New Window</a>

Description

At runtime %ToolsRel is replaced with the tools release string.

This meta-HTML variable is valid for use in attached auxiliary files.

Syntax

%URL(URLIdentifier [, NOENCODE | ENCODE | DESCR])

Description

The %URL meta-HTML function finds the URL specified by URLIdentifier and substitutes its value. The URLIdentifier must already exist and have been created using URL Maintenance.

Parameters

Field or Control	Definition
`URLIdentifier`	Specify a URL Identifier for a URL that already exists and was created using the URL Maintenance page.
NOENCODE \| ENCODE \| DESCR	Specify any encoding or other processing to be done with the URL. ENCODE is the default value. If you specify ENCODE, special characters in the URL are encoded using standard URL encoding rules, that is, blanks are replaced with %20, and so on. If you specify NOENCODE, no encoding is done with the URL. If you specify DESCR, the description from the URL definition is used instead of the URL itself.

Field or Control

Definition

URLIdentifier

Specify a URL Identifier for a URL that already exists and was created using the URL Maintenance page.

NOENCODE | ENCODE | DESCR

Specify any encoding or other processing to be done with the URL. ENCODE is the default value. If you specify ENCODE, special characters in the URL are encoded using standard URL encoding rules, that is, blanks are replaced with %20, and so on.

If you specify NOENCODE, no encoding is done with the URL.

If you specify DESCR, the description from the URL definition is used instead of the URL itself.

This meta-HTML function is valid for use in attached auxiliary files.

Example

<a href='%URL(homepage)'>%URL(homepage, DESCR)</a>

Description

At runtime %UserID is replaced with the current user ID.

Meta-HTML Reference

%Appserver

Description

%AppsRel

Description

%Browser

Description

%BrowserPlatform

Description

%BrowserVersion

Description

%Cols

Syntax

Description

Parameters

%Component

Description

%BB

Syntax

Description

Parameters

Example

%BP

Syntax

Description

Parameters

Example

%BV

Syntax

Description

Parameters

Example

%ContentReference

Syntax

Description

Parameters

Example

%Copyright

Description

%DBName

Description

%DBType

Description

%Encode

Syntax

Description

Parameters

%ExplainMessage

Syntax

Description

Parameters

Example 1

Example 2

%FORMFACTOREXTRALARGE

Description

Example

%FORMFACTORLARGE

Description

%FORMFACTORMEDIUM

Description

%FORMFACTORSMALL

Description

%Formname

Description

%HtmlContent

Syntax

Description

Parameters

%Image

Syntax

Description

Parameters

Example

%JavaScript

Syntax

Description

Parameters

Example

%LabelTag

Description