Help$ - Revision history

Snafoo972 at 01:52, 1 December 2022

2022-12-01T01:52:25Z

← Older revision		Revision as of 01:52, 1 December 2022
Line 1:		Line 1:
	HELP$("[*]<topic>[,<filename>]"[,<mark>])		HELP$("[*]<topic>[,<filename>]"[,<mark>])

	The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.		The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.

Laura at 17:20, 22 May 2014

2014-05-22T17:20:41Z

← Older revision		Revision as of 17:20, 22 May 2014
Line 1:		Line 1:
	~~Help~~$("[*]<topic>[,<filename>]"[,<mark>])		HELP$("[*]<topic>[,<filename>]"[,<mark>])

	The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.		The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.

Laura at 19:37, 21 May 2014

2014-05-21T19:37:15Z

← Older revision		Revision as of 19:37, 21 May 2014
Line 1:		Line 1:
	Help$("[*]topic[,filename]"[,mark])		Help$("[*]<topic>[,<filename>]"[,<mark>])

	The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.		The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.

John: moved HELP$ to Help$ over redirect

2014-02-27T13:05:23Z

moved HELP$ to Help$ over redirect

← Older revision	Revision as of 13:05, 27 February 2014
(No difference)

Laura at 21:49, 18 July 2013

2013-07-18T21:49:02Z

← Older revision		Revision as of 21:49, 18 July 2013
Line 1:		Line 1:
	Help$("[*]topic[,filename]"[,mark])		Help$("[*]topic[,filename]"[,mark])

	The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[~~HLPDFLT~~]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.		The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HELPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.

	If the topic name starts with an asterisk (*), the screen is not saved or restored by the help call. The asterisk has no affect on the search for the topic within the text.		If the topic name starts with an asterisk (*), the screen is not saved or restored by the help call. The asterisk has no affect on the search for the topic within the text.

Mikhail.zheleznov: *

2012-01-26T17:12:15Z

← Older revision		Revision as of 17:12, 26 January 2012
Line 1:		Line 1:
	Help$("[*]topic[,filename]"[,mark])		Help$("[*]topic[,filename]"[,mark])

	The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HLPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command~~; if~~ HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.		The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HLPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command. If HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.

	If the topic name starts with an asterisk (*), the screen is not saved or restored by the help call. The asterisk has no affect on the search for the topic within the text.		If the topic name starts with an asterisk (*), the screen is not saved or restored by the help call. The asterisk has no affect on the search for the topic within the text.

	"Mark" is an optional number that indicates which part of the topic text to display first. It correlates to a ~~carat~~ (^) character in the text. If mark is specified as 3, the text located after the third ~~carat~~ in the topic text will be displayed on the screen first, although the operator still will be able to review all text associated with the topic.		"Mark" is an optional number that indicates which part of the topic text to display first. It correlates to a caret '''(^)''' character in the text. If mark is specified as 3, the text located after the third caret in the topic text will be displayed on the screen first, although the operator still will be able to review all text associated with the topic.

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

Mikhail.zheleznov: moved Help$ to HELP$

2012-01-18T16:29:08Z

moved Help$ to HELP$

← Older revision	Revision as of 16:29, 18 January 2012
(No difference)

Mikhail.zheleznov: *

2012-01-18T16:28:31Z

← Older revision		Revision as of 16:28, 18 January 2012
Line 18:		Line 18:

	See [[Help Facility]] for information about preparing and using on-line help screens.		See [[Help Facility]] for information about preparing and using on-line help screens.

			<noinclude>
			[[Category:Internal Functions]]
			</noinclude>

Mikhail.zheleznov: edit

2012-01-12T10:17:34Z

edit

New page

Help$("[*]topic[,filename]"[,mark])

The '''Help$''' [[internal function]] displays a help screen. "Topic" is the name of the help topic to be displayed. The "filename" is optional. When a file name is not specified, the system uses the file named in the [[HLPDFLT]] specification in the [[BRConfig.sys]] file or with the [[CONFIG]] command; if HELPDFLT has not been coded and HELP$ is used without a file name, an error will occur.

If the topic name starts with an asterisk (*), the screen is not saved or restored by the help call. The asterisk has no affect on the search for the topic within the text.

"Mark" is an optional number that indicates which part of the topic text to display first. It correlates to a carat (^) character in the text. If mark is specified as 3, the text located after the third carat in the topic text will be displayed on the screen first, although the operator still will be able to review all text associated with the topic.

====Comments and Examples====

110 LET X$ = HELP$("HOURS.ENTRY",CURFLD)

====Related Functions====

*[[CURFLD]]

====Technical Considerations====

See [[Help Facility]] for information about preparing and using on-line help screens.