Field Help - Revision history

Laura at 15:22, 21 May 2016

2016-05-21T15:22:08Z

← Older revision		Revision as of 15:22, 21 May 2016
Line 2:		Line 2:

	The "Field help specifications" portion of the full screen processing syntax identifies the user level, window placement, and text that is to be displayed in field help windows.		The "Field help specifications" portion of the full screen processing syntax identifies the user level, window placement, and text that is to be displayed in field help windows.

			It can also be used with print fields statements, for example, with buttons.

	===Comments and Examples===		===Comments and Examples===

Gordon.dye: /* Supplemental Syntax ("helpstring" parameter) */

2015-03-19T22:50:37Z

Supplemental Syntax ("helpstring" parameter)

← Older revision		Revision as of 22:50, 19 March 2015
Line 37:		Line 37:
	*"L" is to the left of the field, and		*"L" is to the left of the field, and
	*"R" is to the right of the field.		*"R" is to the right of the field.
	A greater-than (>) or less-than (<) sign may be specified along with either A or B. Greater-than (points to the right) specifies that the window is to be placed flush right with the field. Less- than (points to the left) specifies flush left placement. When neither sign is specified, the window is centered above or below the field. Business Rules always attempt to use the specified placement instructions. However, if the amount of room on the screen does not permit this, default placement will occur.		A greater-than (>) or less-than (<) sign may be specified along with either A or B. Greater-than (points to the right) specifies that the window is to be placed flush right with the field. Less-than (points to the left) specifies flush left placement. When neither sign is specified, the window is centered above or below the field. Business Rules always attempt to use the specified placement instructions. However, if the amount of room on the screen does not permit honoring this specification, default placement will occur.

	The "int" parameter may also be used to identify window position. It allows field help windows to directly interact with I/O windows. "Int" represents an integer from 1 to 999 (inclusive) that identifies the number of an open window file. It causes the field help text to be sent to a window which is already displayed on the screen. If the number specified is not a valid window file, default field help window placement will occur.		The "int" parameter may also be used to identify window position. It allows field help windows to directly interact with I/O windows. "Int" represents an integer from 1 to 999 (inclusive) that identifies the number of an open window file. It causes the field help text to be sent to a window which is already displayed on the screen. If the number specified is not a valid window file, default field help window placement will occur.

Laura: /* Supplemental Syntax ("helpstring" parameter) */

2014-09-23T15:58:11Z

Supplemental Syntax ("helpstring" parameter)

← Older revision		Revision as of 15:58, 23 September 2014
Line 25:		Line 25:
	The above syntax may be inserted where the "helpstring" parameter appears in the main diagram for full screen processing statements. If the "string-expr" or "MAT string-array" parameters are used to specify field help text, each must include the same elements that are identified in the "helpstring" specification. Business Rules assumes that multiple field help specifications will be identified in the same field order which is indicated in the field definition string.		The above syntax may be inserted where the "helpstring" parameter appears in the main diagram for full screen processing statements. If the "string-expr" or "MAT string-array" parameters are used to specify field help text, each must include the same elements that are identified in the "helpstring" specification. Business Rules assumes that multiple field help specifications will be identified in the same field order which is indicated in the field definition string.

	The "1", "2" and "3" parameters denote the user level for which the field should be automatically displayed. (This option works in conjunction with the WBConfig.sys file's USERLEVEL specification.)		The "1", "2","3", and "4" HELPLEVEL parameters denote the user level for which the field should be automatically displayed. (This option works in conjunction with the WBConfig.sys file's USERLEVEL specification.)
	*"1" indicates that the information provided in this field help text is very important and it should be automatically displayed to most users -even those who are experienced.		*"1" indicates that the information provided in this field help text is very important and it should be automatically displayed to most users -even those who are experienced.
	*"2" indicates that the information should be automatically displayed to anybody who is at an intermediate level (or less) of experience with the software.		*"2" indicates that the information should be automatically displayed to anybody who is at an intermediate level (or less) of experience with the software.
	*"3" indicates that the information should be automatically displayed only to novice users of the software.		*"3" indicates that the information should be automatically displayed only to novice users of the software.
			*"4" supports windows tooltips, but suppresses field help windows entirely (4.2). This is the recommended setting.
	Automatic display of all field help text, regardless of the user level specified here, can be turned off when the WBConfig.sys file's USERLEVEL specification is set to 0. Field help text remains available to all users, even if it isn't automatically displayed to them, when they press the <HELP> key. (Pressing <HELP> a second time initiates regular help processing.)		Automatic display of all field help text, regardless of the user level specified here, can be turned off when the WBConfig.sys file's USERLEVEL specification is set to 0. Field help text remains available to all users, even if it isn't automatically displayed to them, when they press the <HELP> key. (Pressing <HELP> a second time initiates regular help processing.)

Laura: /* Helpstring Syntax */

2014-05-05T15:13:54Z

Helpstring Syntax

← Older revision		Revision as of 15:13, 5 May 2014
Line 19:		Line 19:

	===Helpstring Syntax===		===Helpstring Syntax===
	"{{1\|2\|3} {A\|B\|L\|R\|<integer>}[<\|>] <separator> <text> <separator> \|X\|&<Field Num>;}[;...]"		"{{1\|2\|3} {A\|B\|L\|R\|<integer>}[<\|>] <separator> <text> <separator> \|X\|&<Field Num>;}[,...]"
	[[file:helpstring.png\|800px]]		[[file:helpstring.png\|800px]]

Laura: /* Helpstring Syntax */

2014-05-05T15:13:30Z

Helpstring Syntax

← Older revision		Revision as of 15:13, 5 May 2014
Line 19:		Line 19:

	===Helpstring Syntax===		===Helpstring Syntax===
	"{ {1\|2\|3} {A\|B\|L\|R\|<integer>}[<\|>] <separator> <text> <separator> \|X\|&<Field Num>;}[;...]"		"{{1\|2\|3} {A\|B\|L\|R\|<integer>}[<\|>] <separator> <text> <separator> \|X\|&<Field Num>;}[;...]"
	[[file:helpstring.png\|800px]]		[[file:helpstring.png\|800px]]

Laura: /* Helpstring Syntax */

2014-05-05T15:12:54Z

Helpstring Syntax

← Older revision		Revision as of 15:12, 5 May 2014
Line 19:		Line 19:

	===Helpstring Syntax===		===Helpstring Syntax===
			"{ {1\|2\|3} {A\|B\|L\|R\|<integer>}[<\|>] <separator> <text> <separator> \|X\|&<Field Num>;}[;...]"
	[[file:helpstring.png\|800px]]		[[file:helpstring.png\|800px]]

Laura at 17:25, 13 July 2013

2013-07-13T17:25:23Z

← Older revision		Revision as of 17:25, 13 July 2013
Line 57:		Line 57:
	===Technical Considerations===		===Technical Considerations===
	:1.)There may be more or fewer fields identified in the helpstring than there are defined in the full screen processing statement.		:1.)There may be more or fewer fields identified in the helpstring than there are defined in the full screen processing statement.


			<noinclude>
			[[Category:Help]]
			</noinclude>

Laura at 18:20, 27 March 2013

2013-03-27T18:20:49Z

← Older revision		Revision as of 18:20, 27 March 2013
Line 1:		Line 1:
	For disambiguation purposes, see also BRConfig.sys [[~~Fieldhelp~~]]		For disambiguation purposes, see also BRConfig.sys [[FieldHelp]]

	The "Field help specifications" portion of the full screen processing syntax identifies the user level, window placement, and text that is to be displayed in field help windows.		The "Field help specifications" portion of the full screen processing syntax identifies the user level, window placement, and text that is to be displayed in field help windows.

Laura at 18:20, 27 March 2013

2013-03-27T18:20:28Z

← Older revision		Revision as of 18:20, 27 March 2013
Line 1:		Line 1:
			For disambiguation purposes, see also BRConfig.sys [[Fieldhelp]]

	The "Field help specifications" portion of the full screen processing syntax identifies the user level, window placement, and text that is to be displayed in field help windows.		The "Field help specifications" portion of the full screen processing syntax identifies the user level, window placement, and text that is to be displayed in field help windows.

	===Comments and Examples===		===Comments and Examples===
	The border type and attributes for field help windows may be specified by the ~~WBConfig~~.sys [[FIELDHELP]] specification. The border types which are available for field help windows are the same as the border types which are available for regular windows.		The border type and attributes for field help windows may be specified by the BRConfig.sys FIELDHELP specification. The border types which are available for field help windows are the same as the border types which are available for regular windows.

	The following helpstring specification provides no field help text for the first through fourth fields. The fifth field has a 3 x 16 window that displays if [[USERLEVEL]] is set to either 2 or 3. Default positioning (to the right of the field if possible) is used for window placement.		The following helpstring specification provides no field help text for the first through fourth fields. The fifth field has a 3 x 16 window that displays if [[USERLEVEL]] is set to either 2 or 3. Default positioning (to the right of the field if possible) is used for window placement.

Laura: /* Comments and Examples */

2013-03-27T18:19:30Z

Comments and Examples

← Older revision		Revision as of 18:19, 27 March 2013
Line 2:		Line 2:

	===Comments and Examples===		===Comments and Examples===
	The border type and attributes for field help windows may be specified by the WBConfig.sys FIELDHELP specification. The border types which are available for field help windows are the same as the border types which are available for regular windows.		The border type and attributes for field help windows may be specified by the WBConfig.sys [[FIELDHELP]] specification. The border types which are available for field help windows are the same as the border types which are available for regular windows.

	The following helpstring specification provides no field help text for the first through fourth fields. The fifth field has a 3 x 16 window that displays if [[USERLEVEL]] is set to either 2 or 3. Default positioning (to the right of the field if possible) is used for window placement.		The following helpstring specification provides no field help text for the first through fourth fields. The fifth field has a 3 x 16 window that displays if [[USERLEVEL]] is set to either 2 or 3. Default positioning (to the right of the field if possible) is used for window placement.