2 Eloquence ASCII Windows

Helpfile Format

; anything with a semicolon in the 1st column is a comment

<helptag> (names the help window)

[<<]<helptag> (names the previous window in chain)

[>>]<helptag> (names the next window in chain)

Help text follows until next helptag occurs

Hypertext reference [->keyword]<helptag> embedded in text

<helptag> (names another window)

<end>

Notes:

1. A text reference, when selected, causes the associated help window named by the helptag to become the active help window.

2. The [->] and helptag marks are not displayed.

Example:

; This is a comment line
<Dialog>
This is a help Text for Help tag DIALOG.
There are 2 associated Text references:

    [->Field 1]<Ref1> chains to text Ref1
    [->Field 2]<Ref2> chains to text Ref2
<Ref1>
[>>]<Ref2>

Sample Help Field #1
<Ref2>
[<<]<Ref1>

Sample Help Field #2
<HelpHelp>
This is Help text for Help.
<end>

You can use the following program to display the help.

10 DLG LOAD "help.dlg"
20 DLG SET "Help.Text.File","/users/eloq/dlg/demo"
30 DLG HELP "Dialog"
40 STOP

Sample Help Dialog

Required:

• Root object type must be of class Dialog.

• Help dialog must be named with "Help".

• Inside the root dialog must be a HelpText object named "text".

• You must specify two pushbuttons named: Close and Return.

• pushbutton named "Next"

• push button named "Prev"

Set the .f1 attribute to 5 and the .help attribute of your help dialog to the desired help tag e.g., "HelponHelp". Create a pushbutton named Help with a .rule attribute value of 5.

# help.dlg

#

# Default help dialog

#

# This dialog is intended to be used as a template for your own

# help dialog.

dialog Help {

.x = 1

.y = 1

.w = 70

.h = 20

.title = " Help Title "

# to provide help for help

.f1 = 5

.help = "HelpHelp"

helptext text {

.x = 2

.y = 2

.w = 66

.h = 15

# uncomment if you like it

# .title = " Help Dialog "

.border = 0

}

pushbutton Close {

.x = 2

.y = 18

.w = 8

.text = " CLOSE "

}

pushbutton Return {

.x = 12

.y = 18

.w = 8

.text = "RETURN "

}

# PushButton Prev and Next are optional.

pushbutton Prev {

.x = 30

.y = 18

.w = 8

.text = " << "

}

pushbutton Next {

.x = 40

.y = 18

.w = 8

.text = " >> "

}

# Help button is optional

pushbutton Help {

.x = 60

.y = 18

.w = 8

.text = " HELP "

.rule = 5

}

}