Introducing help text

The system includes help text for all the Blueworx Voice Response windows. This is the text that you see when you click Help —> On Window, or when you display the information in the help index.

The help text for each window is in a separate file. These files are cataloged by window name and type. The types are:

Main
Work
Field

The help text in a main file describes how to use a main window. Blueworx Voice Response displays a main window when you click an action from one of the menus on the Welcome window. The help text in a work file describes how to use a work window. A work window is any window that is not a main window. The help text in a field file describes an action on a menu.

To format help information for display, Blueworx Voice Response uses a set of Generalized Markup Language (GML) tags. Each tag controls a different format characteristic. For example, one tag specifies that text be displayed in bold-faced type. Another tag specifies that text be displayed as a bulleted list. The tags, and what each tag controls, are listed in Table 1.

Table 1. GML tags for formatting help information
Tags	Usage	Example	Formatted Result
:h1. :h2.	Headings	:h1.Heading Level 1 :h2.Heading Level 2	Heading Level 1 Heading Level 2
:p.	Paragraph	:p.Put this tag at the start of a paragraph. :p.The tag leaves a blank line.	Put this tag at the start of a paragraph. The tag leaves a blank line.
:hp1. :ehp1. :hp2. :ehp2.	Highlighted phrases. One tag starts the highlighting and the other tag stops it.	:hp1.Italics:ehp1. introduce new terms. Boldface is used for :hp2.window items:ehp2.. Note the double period when a tag also ends a sentence.	Italics introduce new terms. Boldface is used for window items. Note the double period when a tag also ends a sentence.
:xph. :exph. :xmp. :exmp.	Examples	Window :xph.input/output:exph. is shown in example font. :xmp. Program example line 1 Program example line 2 :exmp.	Window `input/output` is shown in example font. Program example line 1 Program example line 2
:ul. :eul. :ol. :eol. :li.	Bulleted list Numbered list Item in either list	:p.You can: :ul. :li.Add a user profile :li.Modify a user profile :li.Delete a user profile :eul.	You can: Add a user profile Modify a user profile Delete a user profile
:dl. :edl. :dt. :dd.	Definition list Term Definition	:p.This window displays the following fields: :dl. :dt.Relation :dd.Specifies ... :dt.Record :dd.Identifies ... :edl.	This window displays the following fields: Relation Specifies ... Record Identifies ...