3 Installing Eloquence on Windows

The eloqcl.ini file

Section [runsrv]

DlgSrv=

command to start the DLGSRV32

Default:

DLGSRV32 -connect %s -IDMfont 1 -IDMcolor 1

Function:

The command line used to start the DLGSRV32. This should contain exactly one occurrence of the %s token which will be replaced with the connection argument at runtime.

Service=

service name or port number

Default:

runsrv

Function:

RUNSRV32 listens for incoming TCP network requests on this service/port.

Debug=

debug level

Default:

0

Function:

This is used for internal diagnostics only and should be set to 0.

DDEWait=

milliseconds

Default:

2500

Function:

Number of milliseconds to wait after a DDE server has been started and before the DDE transaction is initiated.

If you encounter the status message "Module ... is not active and I don't know how to start it" although the module is correctly defined (see Section [modules] below) you should increase this value.

TrayDoubleClick=

0 or 1

Default:

0

Function:

Whether the RUNSRV32 tray icon should open the Run server window on single (0) or double (1) mouse click.

Section [dlgsrv]

DefaultsFile=

absolute path to defaults file

Default:

The defaults.eq file in the dlg subdirectory of the Eloquence installation directory (for example:
C:\Program Files\Eloquence\dlg\defaults.eq).

Function:

Specifies the defaults file used by DLGSRV32. This file is used to provide defaults to dynamically created objects.

To use modular dialog files, change this to the dlg\module subdirectory (for example:
C:\Program Files\Eloquence\dlg\module\defaults.eq).

IdmLib=

search path for dialog files

Default:

the value of the IDMLIB environment variable

Function:

On execution of the DLG LOAD statement the specified dialog file is searched in each directory specified by the IdmLib item regardless of any directory specification named in the DLG LOAD statement. The directories are separated by ';'.

If IdmLib is specified in the [dlgsrv] section it overrides the value of the IDMLIB environment variable unless the token %IDMLIB% is included into the directory list.

If IdmLib is specified in an user-defined section it overrides the value of the IdmLib item specified in the [dlgsrv] section unless the token %IDMLIB% is included into the directory list.

Example:

IdmLib=C:\DLG\APP1;C:\DLG\APP2;%IDMLIB%

This causes every dialog file loaded by DLG LOAD to be searched in the directories C:\DLG\APP1 and C:\DLG\APP2. If the dialog file cannot be found in these locations, searching is continued using the value of the previous IdmLib item, such as the value of the IDMLIB environment variable.

DlgPath=

directory where dialog files are located

Default:

none

Function:

If defined, DLGSRV32 will expect all .idm dialog files to be located in this directory.

MemSz=

size of communication memory

Default:

8192

Function:

The communication memory size limits the amount of data which can be exchanged in a single network transaction. A value of 8192 is recommended.

Debug=

debug level

Default:

0

Function:

Specifies the debug level for diagnostic purposes (0, 1, 2 or 3).

Logfile=

absolute path to debug log file

Default:

none

Function:

If specified, debug log messages are written to this file. This is only effective if Debug is nonzero (see above).

Dlg=

dialog file extension

Default:

dlg

Function:

The file extension (case insensitive) by which Eloquence recognizes a native Eloquence dialog file (i.e. an ASCII dialog file).

Whenever Eloquence tries to load a Dlg file (e.g. sample.dlg) it will first try to locate and load an Idc (e.g. sample.idc) or Idm (e.g. sample.idm) file.

Idm=

dialog file extension

Default:

idm

Function:

The file extension (case insensitive) by which Eloquence recognizes a Dialog Manager dialog file.

Such files are usually created by the cvdlg utility or the dialog editor of the Eloquence IDE.

Idc=

dialog file extension

Default:

idc

Function:

The file extension (case insensitive) by which Eloquence recognizes a compiled Dialog Manager dialog file.

HelpDDEModule=

module name of browser to be used as on-line help viever

Default:

Netscape

Function:

Specifies which web browser shall be used as on-line help viewer.

Example:

HelpDDEModule=iexplore

This specifies to use the Microsoft Internet Explorer as on-line help viewer.

HelpDDEWait=

milliseconds

Default:

2500

Function:

Number of milliseconds to wait after the on-line viewer has been started and before the DDE transaction is initiated.

If you encounter the status message "Module ... is not active and I don't know how to start it" although the on-line viewer is correctly defined (see Section [modules] below) you should increase this value.

HelpDDETimeout=

milliseconds

Default:

15000

Function:

Number of milliseconds to wait for a DDE transaction to finish.

If you encounter the status message "DDE server did not acknowledge" you should increase this value.

HelpBaseURL=

URL

Default:

none

Function:

Specifies the base URL of the on-line help files.

Example:

HelpBaseURL=http://www/help/

FileBaseURL=

URL

Default:

none

Function:

Specifies the base URL for the function EqHelpViewFile.

Example:

FileBaseURL=http://www/files/

ManBaseURL=

URL

Default:

none

Function:

Specifies the base URL for the function EqHelpManPage.

Example:

ManBaseURL=http://www/cgi-bin/man2html

Section [modules]

It associates Windows module identifiers with executable programs to enable RUNSRV32 and DLGSRV32 to start-up the required DDE server program in case it is not already running.

If you want to communicate with any Windows program using DDE, knowledge about the Windows module identifier and the communication topics specific to the program is required. Normally, these informations are contained in the program's (developer) documentation.

Example:

[modules]
WinWord=C:\Program Files\Microsoft Office\WINWORD.EXE

DLGSRV32 has built-in support for DDE communication with a web browser to operate as on-line help viewer. To use this, you do not need any information regarding the browser's DDE implementation. All you need to do is to add an entry in the section [modules] so that the browser can be started in case it is not already running.

Example:

[modules]
Netscape=C:\Program Files\Netscape\Navigator\NETSCAPE.EXE
iexplore=C:\Program Files\Plus!\Microsoft Internet\Iexplore.exe

User-defined sections

DLG SET ".driver","driver_spec [ini_section [arguments]]"

driver_spec:

@hostname

hostname is the name of the system where DLGSRV32 shall be executed.

ini_section:

Optional name of an user-defined section in the eloqcl.ini file which shall override the defaults specified in the [dlgsrv] section.

arguments:

Additional arguments can optionally be specified here and will be passed-through to the Dialog Manager.

1. DLGSRV32 sets up the Dialog Manager argument list from the arguments specified in the DLG SET ".driver" statement, if any. It then reads the configuration items in the section [dlgsrv] (please refer to the previous description of Section [dlgsrv]).

2. If ini_section is specified in the DLG SET ".driver" statement, DLGSRV32 reads additional configuration items from this user-defined section. If these items have been previously specified in the section [dlgsrv], the previous values are overridden.

[debug]
DefaultsFile = C:\DLG\DEBUG\DEFAULTS.EQ

This user-defined section named [debug] defines one item DefaultsFile. In order to activate this item, the name of this section must be specified in the DLG SET ".driver" statement, e.g.:

DLG SET ".driver","@my-pc debug"

Any previous DefaultsFile definition in section [dlgsrv] is overridden with the new value from section [debug].

1. If ini_section is specified in the DLG SET ".driver" statement, DLGSRV32 searches this user-defined section for an item named Arguments. If this item exists, its value is appended to the Dialog Manager argument list.

[debug]
Arguments = -IDMtracefile C:\TMP\IDMTRACE.TXT

This enables an additional Dialog Manager argument which creates a trace file for debugging purposes.

1. Finally, the composed Dialog Manager argument list is passed to the Dialog Manager runtime system start-up function.

Additionally, user-defined sections may specify the following configuration item:

Arguments=

additional arguments

Default:

none

Function:

Additional arguments specific to the current user-defined section can optionally be specified here and will be passed-through to the Dialog Manager as described above.