The controls= attribute of :ctrl. identifies the push buttons that you want in the control area of a window. Push buttons are displayed in the order in which they are defined. Values that can be specified are:

Search

Specifies the Search push button. When selected, this push button displays a window that lets the user search for a word or phrase.
Print
Specifies the Print push button. When selected, this push button displays a window that lets the user print one or more topics.
Index
Specifies the Index push button. When selected, this push button displays an alphabetic list of the topics in the document.
Contents
Specifies the Contents push button. When selected, this push button displays the Contents window.
Esc
Specifies the Previous push button. When selected, this push button lets the user see information from an earlier request.
Back
Specifies the Back push button. When selected, this push button displays the previous page in the table of contents hierarchy.
Forward
Specifies the Forward push button. When selected, this push button displays the next page in the table of contents hierarchy.

Note: A value for the Tutorial push button is not provided because it is displayed automatically if a tutorial exists.

Both the page and coverpage attributes of :ctrl. affect where push buttons are displayed. For example, you use page to specify that push buttons are to be in the IPF text window; similarly, you use coverpage to specify that push buttons are to be in the IPF coverpage window.

A control area also can have a value associated with it. The ctrlid= attribute specifies the value, which can be either alpha or alphanumeric, and is referred to by a heading tag. In the following example, ctrlid= specifies a window identifier, and instructs the compiler to display the Previous, Forward, and Back push buttons in the control area of the coverpage window:

:docprof toc=123.:ctrldef.
:ctrl ctrlid=new1 controls='ESC FORWARD BACK' coverpage.
:ectrldef.

Conversely, the following example shows the tagging for an online document that will display the Previous, Forward, and Back push buttons in the control area of an IPF page window.

:docprof toc=123 ctrlarea=page.
:ctrldef.
:ctrl ctrlid=new1 controls='ESC FORWARD BACK' page.
:ectrldef.

Notice the ctrlarea=page attribute of :docprof.. When the IPF compiler encounters ctrlarea=page, it defines the control area as the IPF page window and removes the push buttons from the control area of the coverpage window. You must ALWAYS specify the ctrlarea= attribute in :docprof. when overriding the default control area in a window.

Other values for ctrlarea= are:

coverpage

Identifies the control area as the bottom of the coverpage window. This is the default value.
both
Specifies both the control area within an IPF text window, and the coverpage window.
none
Specifies that you do not want a control area (that is, you do not want push buttons).

You can define more than one control area with different sets of push buttons for the IPF text window; however, only one set of push buttons can be defined for the coverpage window.

---

[Back] [Next]