:docprof. (Document Profile)

Specifies the heading-level entries to be displayed in the Contents window.

Syntax

┌───────────────┬───────────────┬───────────────┬───────────────┐
│Tag            │Element        │Attributes     │End            │
├───────────────┼───────────────┼───────────────┼───────────────┤
│:docprof.      │Contents window│toc=           │               │
│               │entries        │               │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │Global         │dll=' '        │               │
│               │communications │objectname=' ' │               │
│               │dynamic-link   │objectinfo=' ' │               │
│               │library        │               │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │Push button    │ctrlarea=      │               │
│               │support        │               │               │
└───────────────┴───────────────┴───────────────┴───────────────┘

Attributes

toc=

Enables you to control the heading levels displayed in the table of contents. For example, if you want only heading levels 1 and 2 to appear, the tagging is:

:docprof toc=12.

If no toc= value is specified, heading levels 1 through 3 appear in the Contents window. Heading levels 4 through 6 appear as part of the text when the window is displayed.

If a heading tag also specifies a value for toc=, the heading-tag value overrides the :docprof. value until either the end of the file is reached, or another heading toc= value is encountered.

dll=' '
Specifies the communication dynamic-link library that IPF loads so that a communication object in the library can be used to alter the behavior of IPF. For author-defined push buttons, this is the communication object that will receive the HM_NOTIFY message. For a Tutorial push button, this is the communication object that will receive the HM_TUTORIAL message.
objectname=' '
Identifies the entry point of the communication object in the dynamic-link library. The value for this attribute is case sensitive.
objectinfo=' '
Identifies parameters to be passed to the object.
ctrlarea=
Defines the control areas in a window where you want to display push buttons. For more information on control areas in a window, see Push Buttons.

Possible values are:

page

Identifies the control area within the IPF text window.
coverpage
Identifies the control area as the bottom of the coverpage window. This is the default value.
both
Specifies that you want a control area in both the 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).

Description

:docprof. is placed at the beginning of the file. It follows the title tag (:title.), if a title is specified; otherwise, it follows the user-document tag (:userdoc.).

The :docprof. tag also provides the ability to alter the behavior of IPF by loading any dynamic-link modules specified in the dll= attribute. It is possible to have multiple windows and multiple entry points within a dynamic-link module. There is no guarantee that the ACVP structure that is passed into the object will be maintained across multiple calls.

You also can use this tag to change the size and function of the coverpage and its client and control windows.

The :docprof. tag can be used to define the control area in a window where you want to display push buttons.

Conditions

None

Example

:userdoc.:title.
:docprof toc=123 ctrlarea=none.
:euserdoc.

Output

When the user selects the "+" icon in the Contents window, heading levels 1 through 4 are displayed in a tree-structured format. There are no push buttons because of ctrlarea=none.

---

[Back: :dl. (Definition List)]
[Next: :fig. (Figure)]