:ctrl. (Control Area)

Defines the contents of the control area.

Syntax

┌───────────────┬───────────────┬───────────────┬───────────────┐
│Tag            │Element        │Attributes     │End            │
├───────────────┼───────────────┼───────────────┼───────────────┤
│:ctrl          │Control area   │ctrlid=        │               │
│               │               │controls=' '   │               │
│               │               │page           │               │
│               │               │coverpage      │               │
└───────────────┴───────────────┴───────────────┴───────────────┘

Attributes

ctrlid=

Specifies the identification value for the control area. The identification value can be either alpha or alphanumeric, and is referenced by the heading tag.
controls=' '
Specifies the identification values of the push buttons that you want included in the control area of a window. Push buttons are displayed in the order in which they are defined. The values that can be specified are:

Search

Specifies the Search push button. This push button displays a window that lets the user search for a word or phrase.
Print
Specifies the Print push button. This push button displays a window that lets the user print one or more topics.
Index
Specifies the Index push button. This push button displays an alphabetic list to the topics in the document.
Contents
Specifies the Contents push button. This push button displays the Contents window.
Esc
Specifies the Previous push button. This push button lets the user see information from an earlier request.
Back
Specifies the Back push button. This push button displays the previous page in the table of contents hierarchy.
Forward
Specifies the Forward push button. This push button displays the next page in the table of contents hierarchy.
Note: An identification value for the Tutorial push button is not provided because it is displayed automatically if a tutorial exists.

If you are defining your own push buttons, use id= attribute of the push button tag (:pbutton.). See :pbutton. (Push Button).

The identification values for the predefined push buttons are defined in the PMHELP.H file.

page
Specifies that a set of push buttons is displayed in the control area of an IPF text window . You can use this attribute to override the default set of push buttons that is displayed in the control area of an IPF text window.
coverpage
Specifies the set of push buttons that is displayed in the control area of the coverpage window . The control area in the coverpage window is at the very bottom of a window. You can use this attribute to override the default set of push buttons that is displayed in the coverpage window.

Example: The following tagging specifies the Previous, Forward, and Back push buttons display in the coverpage window:

:ctrl ctrlid=new1 controls='ESC FORWARD BACK' coverpage.

Description

The control area tag (:ctrl.) specifies where push buttons are displayed, and which push buttons you want displayed. You can display push buttons in the control areas of coverpage window or an IPF text window.

The default control area for online documents and Help windows is the coverage page window, and the default push buttons that display are:

Online documents

Previous
Search
Print
Index
Contents
Back
Forward
Tutorial (only if a tutorial is available).

Help windows

Previous
Search
Print
Index
Tutorial (only if a tutorial is available).

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

The default set of push buttons for an IPF text window can be overridden by defining a new default or by referring to the control area definition with the heading tag (see :h1. through :h6. (Headings)). For more information about push buttons, see Push Buttons.

Conditions

• The control area tag (:ctrl.) must be enclosed within the control area definition tag (:ctrldef.) and associated end tag (:ectrldef.) (see :ctrldef (Control Area Definition)).

• The :ctrl. tag must follow all push button tags (:pbutton.) (see :pbutton. (Push Button)).

---

[Back: :color. (Color)]
[Next: :ctrldef (Control Area Definition)]