PreviousDirectives for the On-line Help Builder On-line Help TagsNext

Chapter 13: Configuration Option Tags

This chapter lists the configuration options tags available to you when you configure the behavior of the On-line Help Viewer. See the section Configuring the On-line Help Viewer in the chapter On-line Help System for details of where you specify these tags.

The configuration options must follow the [HYHELP] tag in the configuration file.

The file, or section of file, must have the following format: 

[HYHELP]
option
option
...

where the parameters are:

option One or more of the configuration options listed below.

The [ ] (brackets) are mandatory.

COLOR font foreground ON background
COLOUR font foreground ON background

Enables you to define font in colors.

Parameters:
font The type of font to configure. For example, plain, bold or italics.
foreground The color for the foreground of this font.
background The color for the background of this font.

The possible values of font are:

Font
Description
p plain
u underline
i italics
b bold
bi bold and italics
bu bold and underline
iu italic and underline
bui bold, italics and underline

Default:

The default colors for the different types of font are:

Font Type
 Default Color
p sys-att-11
u green on black
i cyan on black
b sys-att-12
bi light-cyan on black
bu sys-att-05
iu magenta on black
bui light-magenta on black

The possible values of foreground and background are: 

black
blue
brown
cyan
green
magenta
red
yellow
dark-grey
light-blue
light-cyan
light-green
light-grey
light-magenta
light-red
Example:
color iu brown on red

This causes italic and underlined text to be displayed as brown on red.

COLOR-object foreground ON background
COLOUR-object foreground ON background

Enables you to define object in colors. 

COLOR-object system-attribute
Parameters:
object The area of the interface to colorize.
foreground The color for the foreground of this area.
background The color for the background of this area.
Default:

The default colors for the different areas of the interface are:

Entry
Defaults
topic-border sys-att-04
topic-cursor sys-att-02
cursor sys-att-02
hotspot attribute defined for italics
block sys-att-02
popup-border sys-att-04
menu-text sys-att-03
menu-message sys-att-04
keytops sys-att-04
popup-text sys-att-11
popup-cursor sys-att-02

The possible values of object are:

Object
Description
topic-border The border of the topic panel.
topic-cursor The cursor in the topic window.
cursor Same as topic-cursor.
hotspot A nonhighlighted hotspot.
block Marked text.
popup-border The border of a pop-up list box.
menu-text A menu item.
menu-message A menu message.
keytops The menu item keytops.
popup-text The items in a pop-up list.
popup-cursor The cursor in a pop-up list.

The possible values of foreground and background are:

black dark-gray
blue light-blue
brown light-cyan
cyan light-green
green light-gray
magenta light-magenta
red light-red
yellow

Example:
color-hotspot white on cyan

This causes hotspots to be displayed as white on a cyan background.

FILE filename

Specifies the on-line help files which are to be made available to the On-line Help Viewer at start-up. The order of the files in this list determines the order of the files in the file list.

Parameters:
filename The name of a file to be available at start-up.

Files specified in the FILE and MFPATH configuration parameters are accessed in the order specified in the configuration file. If no on-line help files are found, the directories specified in the COBHNF environment variable are searched. If no on-line help files are found at this stage, on-line help files from the current directory are used.

You can specify only one file with the FILE option, but you can include the FILE option any number of times. The On-line Help Viewer can have a maximum of 32 files available.

MFPATH path

Specifies the path to search for Micro Focus format on-line help files.

Parameters:
path The path to use when an on-line help file is specified with no explicit path information. path can be an environment variable (preceded by $), which contains a path list.

MONO font monochrome attribute

Enables you to define the monochrome attributes of fonts used by the On-line Help Viewer.

Parameters:
font The type of font to configure. For example, plain, bold or italics.
monochrome-attributes The monochrome attributes to assign to this type of font.
Default:

Depends on the attributes defined in the configuration file.

The possible values of font are:

Font
Description
p plain
u underline
i italic
b bold
bi bold and italic
bu bold and underline
iu italic and underline
bui bold, italic and underline

Example:
mono bu underline reverse-video

This causes bold, underlined text to be displayed as underlined and in reverse video on monochrome screens.

MONO-object monochrome attribute

Enables you to define the monochrome attributes of an area of the On-line Help Viewer interface.

Parameters:
object The area of the interface to configure.
monochrome-attributes The monochrome attributes to assign to this part of the interface.
Default:

Depends on the attributes defined in the configuration file.

The possible values of object are:

Object
Description
topic-border The border of the topic panel.
topic-cursor The cursor in the topic window.
cursor Same as topic-cursor.
hotspot A nonhighlighted hotspot.
block Marked text.
popup-border The border of a pop-up list. For example, the contents list.
menu-text A menu item.
menu-message A menu message.
keytops The menu item keytops.
popup-text The items in a pop-up list.
popup-cursor The cursor in a pop-up list.

Example:
mono-hotspot highlight underline

This causes hotspots to be displayed as highlighted and underlined on monochrome screens.

PASTE-FILE filename

Parameters:
filename The file to send output to.
Default:

PASTE-FILE .\paste.txt

Specifies the filename to which help pages are output using the Copy-to-file and Append-to-file functions in the On-line Help Viewer.

PRINT-DEVICE device-name

Parameters:
device-name The name of the device to print to.
Default:

PRINT-DEVICE :lst

Specifies the device or file where lines are to be sent when the Print function is selected from the On-line Help Viewer.

Copyright © 2000 MERANT International Limited. All rights reserved.
This document and the proprietary marks and names used herein are protected by international law.

PreviousDirectives for the On-line Help Builder On-line Help TagsNext