Home » Archimedes archive » Acorn Computing » 1994 08 subscription disc.adf » 9408s » Shareware/Event/Documents/!EShellDoc/TextHelp/StrongHelp
Shareware/Event/Documents/!EShellDoc/TextHelp/StrongHelp
This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.
Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.
| Tape/disk: | Home » Archimedes archive » Acorn Computing » 1994 08 subscription disc.adf » 9408s |
| Filename: | Shareware/Event/Documents/!EShellDoc/TextHelp/StrongHelp |
| Read OK: | ✔ |
| File size: | 06ED bytes |
| Load address: | 0000 |
| Exec address: | 0000 |
File contents
PROCshell_InitHelpSystem()
Params =>
str path name of help files
bool DieWithTask flag
Used to register a new help system with StrongHlp.
After making this call StrongHlp will add the help
system found in the given path to its icon bar menu.
StrongHlp will be started if it is not already
running and StrongHelp$Dir has been defined. If
StrongHlp cannot be found then the initialisation
command is stored and sent when StrongHlp is started.
-DieWithTask Flag
When TRUE the help system will only be added to
the StrongHlp icon bar menu while the user
application is actually running. When FALSE it
remains available when the application quits.
-----------------------------------------------------------------
PROCshell_HelpWord()
Params =>
str word for which help is to be displayed
Used to send a help request to StrongHlp. If the word
is found in the help system the appropriate help text
will be displayed.
StrongHlp will be started if it is not already
running and StrongHelp$Dir has been defined. If
StrongHlp cannot be found then the initialisation
command is stored and sent when StrongHlp is started.
-----------------------------------------------------------------
FNshell_StrongHlpIsAvailable
Params =>
None
<=
bool TRUE if StrongHelp$Dir is defined,
otherwise FALSE
Used to check that StrongHlp is installed
on the system. This call can be used to shade
a 'Help' menu item if StrongHlp has not been seen
by the Filer, or if it is not available.
Example code...
Shade menu item with the handle HlpItem% if StrongHlp
is not available:
PROCshell_MenuShade(HlpItem%,(FNshell_StrongHlpIsAvailable=0))
----------------------------------------------------------------- 00000000 50 52 4f 43 73 68 65 6c 6c 5f 49 6e 69 74 48 65 |PROCshell_InitHe| 00000010 6c 70 53 79 73 74 65 6d 28 29 0a 50 61 72 61 6d |lpSystem().Param| 00000020 73 20 3d 3e 0a 20 20 20 20 20 20 20 20 20 73 74 |s =>. st| 00000030 72 20 20 70 61 74 68 20 6e 61 6d 65 20 6f 66 20 |r path name of | 00000040 68 65 6c 70 20 66 69 6c 65 73 0a 20 20 20 20 20 |help files. | 00000050 20 20 20 20 62 6f 6f 6c 20 44 69 65 57 69 74 68 | bool DieWith| 00000060 54 61 73 6b 20 66 6c 61 67 0a 0a 55 73 65 64 20 |Task flag..Used | 00000070 74 6f 20 72 65 67 69 73 74 65 72 20 61 20 6e 65 |to register a ne| 00000080 77 20 68 65 6c 70 20 73 79 73 74 65 6d 20 77 69 |w help system wi| 00000090 74 68 20 53 74 72 6f 6e 67 48 6c 70 2e 0a 41 66 |th StrongHlp..Af| 000000a0 74 65 72 20 6d 61 6b 69 6e 67 20 74 68 69 73 20 |ter making this | 000000b0 63 61 6c 6c 20 53 74 72 6f 6e 67 48 6c 70 20 77 |call StrongHlp w| 000000c0 69 6c 6c 20 61 64 64 20 74 68 65 20 68 65 6c 70 |ill add the help| 000000d0 0a 73 79 73 74 65 6d 20 66 6f 75 6e 64 20 69 6e |.system found in| 000000e0 20 74 68 65 20 67 69 76 65 6e 20 70 61 74 68 20 | the given path | 000000f0 74 6f 20 69 74 73 20 69 63 6f 6e 20 62 61 72 20 |to its icon bar | 00000100 6d 65 6e 75 2e 0a 0a 53 74 72 6f 6e 67 48 6c 70 |menu...StrongHlp| 00000110 20 77 69 6c 6c 20 62 65 20 73 74 61 72 74 65 64 | will be started| 00000120 20 69 66 20 69 74 20 69 73 20 6e 6f 74 20 61 6c | if it is not al| 00000130 72 65 61 64 79 0a 72 75 6e 6e 69 6e 67 20 61 6e |ready.running an| 00000140 64 20 53 74 72 6f 6e 67 48 65 6c 70 24 44 69 72 |d StrongHelp$Dir| 00000150 20 68 61 73 20 62 65 65 6e 20 64 65 66 69 6e 65 | has been define| 00000160 64 2e 20 49 66 0a 53 74 72 6f 6e 67 48 6c 70 20 |d. If.StrongHlp | 00000170 63 61 6e 6e 6f 74 20 62 65 20 66 6f 75 6e 64 20 |cannot be found | 00000180 74 68 65 6e 20 74 68 65 20 69 6e 69 74 69 61 6c |then the initial| 00000190 69 73 61 74 69 6f 6e 0a 63 6f 6d 6d 61 6e 64 20 |isation.command | 000001a0 69 73 20 73 74 6f 72 65 64 20 61 6e 64 20 73 65 |is stored and se| 000001b0 6e 74 20 77 68 65 6e 20 53 74 72 6f 6e 67 48 6c |nt when StrongHl| 000001c0 70 20 69 73 20 73 74 61 72 74 65 64 2e 0a 0a 2d |p is started...-| 000001d0 44 69 65 57 69 74 68 54 61 73 6b 20 46 6c 61 67 |DieWithTask Flag| 000001e0 0a 57 68 65 6e 20 54 52 55 45 20 74 68 65 20 68 |.When TRUE the h| 000001f0 65 6c 70 20 73 79 73 74 65 6d 20 77 69 6c 6c 20 |elp system will | 00000200 6f 6e 6c 79 20 62 65 20 61 64 64 65 64 20 74 6f |only be added to| 00000210 20 0a 74 68 65 20 53 74 72 6f 6e 67 48 6c 70 20 | .the StrongHlp | 00000220 69 63 6f 6e 20 62 61 72 20 6d 65 6e 75 20 77 68 |icon bar menu wh| 00000230 69 6c 65 20 74 68 65 20 75 73 65 72 20 0a 61 70 |ile the user .ap| 00000240 70 6c 69 63 61 74 69 6f 6e 20 69 73 20 61 63 74 |plication is act| 00000250 75 61 6c 6c 79 20 72 75 6e 6e 69 6e 67 2e 20 57 |ually running. W| 00000260 68 65 6e 20 46 41 4c 53 45 20 69 74 0a 72 65 6d |hen FALSE it.rem| 00000270 61 69 6e 73 20 61 76 61 69 6c 61 62 6c 65 20 77 |ains available w| 00000280 68 65 6e 20 74 68 65 20 61 70 70 6c 69 63 61 74 |hen the applicat| 00000290 69 6f 6e 20 71 75 69 74 73 2e 0a 0a 0a 2d 2d 2d |ion quits....---| 000002a0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 000002d0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a |--------------..| 000002e0 50 52 4f 43 73 68 65 6c 6c 5f 48 65 6c 70 57 6f |PROCshell_HelpWo| 000002f0 72 64 28 29 0a 50 61 72 61 6d 73 20 3d 3e 0a 20 |rd().Params =>. | 00000300 20 20 20 20 20 20 20 20 73 74 72 20 77 6f 72 64 | str word| 00000310 20 66 6f 72 20 77 68 69 63 68 20 68 65 6c 70 20 | for which help | 00000320 69 73 20 74 6f 20 62 65 20 64 69 73 70 6c 61 79 |is to be display| 00000330 65 64 0a 0a 55 73 65 64 20 74 6f 20 73 65 6e 64 |ed..Used to send| 00000340 20 61 20 68 65 6c 70 20 72 65 71 75 65 73 74 20 | a help request | 00000350 74 6f 20 53 74 72 6f 6e 67 48 6c 70 2e 20 49 66 |to StrongHlp. If| 00000360 20 74 68 65 20 77 6f 72 64 0a 69 73 20 66 6f 75 | the word.is fou| 00000370 6e 64 20 69 6e 20 74 68 65 20 68 65 6c 70 20 73 |nd in the help s| 00000380 79 73 74 65 6d 20 74 68 65 20 61 70 70 72 6f 70 |ystem the approp| 00000390 72 69 61 74 65 20 68 65 6c 70 20 74 65 78 74 0a |riate help text.| 000003a0 77 69 6c 6c 20 62 65 20 64 69 73 70 6c 61 79 65 |will be displaye| 000003b0 64 2e 0a 0a 53 74 72 6f 6e 67 48 6c 70 20 77 69 |d...StrongHlp wi| 000003c0 6c 6c 20 62 65 20 73 74 61 72 74 65 64 20 69 66 |ll be started if| 000003d0 20 69 74 20 69 73 20 6e 6f 74 20 61 6c 72 65 61 | it is not alrea| 000003e0 64 79 0a 72 75 6e 6e 69 6e 67 20 61 6e 64 20 53 |dy.running and S| 000003f0 74 72 6f 6e 67 48 65 6c 70 24 44 69 72 20 68 61 |trongHelp$Dir ha| 00000400 73 20 62 65 65 6e 20 64 65 66 69 6e 65 64 2e 20 |s been defined. | 00000410 49 66 0a 53 74 72 6f 6e 67 48 6c 70 20 63 61 6e |If.StrongHlp can| 00000420 6e 6f 74 20 62 65 20 66 6f 75 6e 64 20 74 68 65 |not be found the| 00000430 6e 20 74 68 65 20 69 6e 69 74 69 61 6c 69 73 61 |n the initialisa| 00000440 74 69 6f 6e 0a 63 6f 6d 6d 61 6e 64 20 69 73 20 |tion.command is | 00000450 73 74 6f 72 65 64 20 61 6e 64 20 73 65 6e 74 20 |stored and sent | 00000460 77 68 65 6e 20 53 74 72 6f 6e 67 48 6c 70 20 69 |when StrongHlp i| 00000470 73 20 73 74 61 72 74 65 64 2e 0a 0a 2d 2d 2d 2d |s started...----| 00000480 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 000004b0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a 46 |-------------..F| 000004c0 4e 73 68 65 6c 6c 5f 53 74 72 6f 6e 67 48 6c 70 |Nshell_StrongHlp| 000004d0 49 73 41 76 61 69 6c 61 62 6c 65 0a 50 61 72 61 |IsAvailable.Para| 000004e0 6d 73 20 3d 3e 0a 20 20 20 20 20 20 20 20 20 4e |ms =>. N| 000004f0 6f 6e 65 0a 20 20 20 20 20 20 20 3c 3d 0a 20 20 |one. <=. | 00000500 20 20 20 20 20 20 20 62 6f 6f 6c 20 54 52 55 45 | bool TRUE| 00000510 20 69 66 20 53 74 72 6f 6e 67 48 65 6c 70 24 44 | if StrongHelp$D| 00000520 69 72 20 69 73 20 64 65 66 69 6e 65 64 2c 0a 20 |ir is defined,. | 00000530 20 20 20 20 20 20 20 20 20 20 20 20 20 6f 74 68 | oth| 00000540 65 72 77 69 73 65 20 46 41 4c 53 45 0a 20 20 20 |erwise FALSE. | 00000550 20 20 20 20 20 20 20 20 20 20 20 0a 55 73 65 64 | .Used| 00000560 20 74 6f 20 63 68 65 63 6b 20 74 68 61 74 20 53 | to check that S| 00000570 74 72 6f 6e 67 48 6c 70 20 69 73 20 69 6e 73 74 |trongHlp is inst| 00000580 61 6c 6c 65 64 0a 6f 6e 20 74 68 65 20 73 79 73 |alled.on the sys| 00000590 74 65 6d 2e 20 54 68 69 73 20 63 61 6c 6c 20 63 |tem. This call c| 000005a0 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 73 68 |an be used to sh| 000005b0 61 64 65 0a 61 20 27 48 65 6c 70 27 20 6d 65 6e |ade.a 'Help' men| 000005c0 75 20 69 74 65 6d 20 69 66 20 53 74 72 6f 6e 67 |u item if Strong| 000005d0 48 6c 70 20 68 61 73 20 6e 6f 74 20 62 65 65 6e |Hlp has not been| 000005e0 20 73 65 65 6e 0a 62 79 20 74 68 65 20 46 69 6c | seen.by the Fil| 000005f0 65 72 2c 20 6f 72 20 69 66 20 69 74 20 69 73 20 |er, or if it is | 00000600 6e 6f 74 20 61 76 61 69 6c 61 62 6c 65 2e 0a 0a |not available...| 00000610 45 78 61 6d 70 6c 65 20 63 6f 64 65 2e 2e 2e 0a |Example code....| 00000620 0a 53 68 61 64 65 20 6d 65 6e 75 20 69 74 65 6d |.Shade menu item| 00000630 20 77 69 74 68 20 74 68 65 20 68 61 6e 64 6c 65 | with the handle| 00000640 20 48 6c 70 49 74 65 6d 25 20 69 66 20 53 74 72 | HlpItem% if Str| 00000650 6f 6e 67 48 6c 70 0a 69 73 20 6e 6f 74 20 61 76 |ongHlp.is not av| 00000660 61 69 6c 61 62 6c 65 3a 0a 0a 50 52 4f 43 73 68 |ailable:..PROCsh| 00000670 65 6c 6c 5f 4d 65 6e 75 53 68 61 64 65 28 48 6c |ell_MenuShade(Hl| 00000680 70 49 74 65 6d 25 2c 28 46 4e 73 68 65 6c 6c 5f |pItem%,(FNshell_| 00000690 53 74 72 6f 6e 67 48 6c 70 49 73 41 76 61 69 6c |StrongHlpIsAvail| 000006a0 61 62 6c 65 3d 30 29 29 0a 20 20 0a 2d 2d 2d 2d |able=0)). .----| 000006b0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 000006e0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |-------------| 000006ed
.