Home » Archimedes archive » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95 » !AWJan95/Goodies/Event/Docs/StrongHelp
!AWJan95/Goodies/Event/Docs/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 » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95 |
| Filename: | !AWJan95/Goodies/Event/Docs/StrongHelp |
| Read OK: | ✔ |
| File size: | 0664 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.
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 an error will be
generated.
-----------------------------------------------------------------
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 49 66 20 53 74 72 6f 6e 67 |menu...If Strong| 00000110 48 6c 70 20 63 61 6e 6e 6f 74 20 62 65 20 66 6f |Hlp cannot be fo| 00000120 75 6e 64 20 74 68 65 6e 20 74 68 65 20 69 6e 69 |und then the ini| 00000130 74 69 61 6c 69 73 61 74 69 6f 6e 0a 63 6f 6d 6d |tialisation.comm| 00000140 61 6e 64 20 69 73 20 73 74 6f 72 65 64 20 61 6e |and is stored an| 00000150 64 20 73 65 6e 74 20 77 68 65 6e 20 53 74 72 6f |d sent when Stro| 00000160 6e 67 48 6c 70 20 69 73 20 73 74 61 72 74 65 64 |ngHlp is started| 00000170 2e 0a 0a 2d 44 69 65 57 69 74 68 54 61 73 6b 20 |...-DieWithTask | 00000180 46 6c 61 67 0a 57 68 65 6e 20 54 52 55 45 20 74 |Flag.When TRUE t| 00000190 68 65 20 68 65 6c 70 20 73 79 73 74 65 6d 20 77 |he help system w| 000001a0 69 6c 6c 20 6f 6e 6c 79 20 62 65 20 61 64 64 65 |ill only be adde| 000001b0 64 20 74 6f 20 0a 74 68 65 20 53 74 72 6f 6e 67 |d to .the Strong| 000001c0 48 6c 70 20 69 63 6f 6e 20 62 61 72 20 6d 65 6e |Hlp icon bar men| 000001d0 75 20 77 68 69 6c 65 20 74 68 65 20 75 73 65 72 |u while the user| 000001e0 20 0a 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73 | .application is| 000001f0 20 61 63 74 75 61 6c 6c 79 20 72 75 6e 6e 69 6e | actually runnin| 00000200 67 2e 20 57 68 65 6e 20 46 41 4c 53 45 20 69 74 |g. When FALSE it| 00000210 0a 72 65 6d 61 69 6e 73 20 61 76 61 69 6c 61 62 |.remains availab| 00000220 6c 65 20 77 68 65 6e 20 74 68 65 20 61 70 70 6c |le when the appl| 00000230 69 63 61 74 69 6f 6e 20 71 75 69 74 73 2e 0a 0a |ication quits...| 00000240 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |.---------------| 00000250 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000280 2d 2d 0a 0a 50 52 4f 43 73 68 65 6c 6c 5f 48 65 |--..PROCshell_He| 00000290 6c 70 57 6f 72 64 28 29 0a 50 61 72 61 6d 73 20 |lpWord().Params | 000002a0 3d 3e 0a 20 20 20 20 20 20 20 20 20 73 74 72 20 |=>. str | 000002b0 77 6f 72 64 20 66 6f 72 20 77 68 69 63 68 20 68 |word for which h| 000002c0 65 6c 70 20 69 73 20 74 6f 20 62 65 20 64 69 73 |elp is to be dis| 000002d0 70 6c 61 79 65 64 0a 0a 55 73 65 64 20 74 6f 20 |played..Used to | 000002e0 73 65 6e 64 20 61 20 68 65 6c 70 20 72 65 71 75 |send a help requ| 000002f0 65 73 74 20 74 6f 20 53 74 72 6f 6e 67 48 6c 70 |est to StrongHlp| 00000300 2e 20 49 66 20 74 68 65 20 77 6f 72 64 0a 69 73 |. If the word.is| 00000310 20 66 6f 75 6e 64 20 69 6e 20 74 68 65 20 68 65 | found in the he| 00000320 6c 70 20 73 79 73 74 65 6d 20 74 68 65 20 61 70 |lp system the ap| 00000330 70 72 6f 70 72 69 61 74 65 20 68 65 6c 70 20 74 |propriate help t| 00000340 65 78 74 0a 77 69 6c 6c 20 62 65 20 64 69 73 70 |ext.will be disp| 00000350 6c 61 79 65 64 2e 0a 0a 53 74 72 6f 6e 67 48 6c |layed...StrongHl| 00000360 70 20 77 69 6c 6c 20 62 65 20 73 74 61 72 74 65 |p will be starte| 00000370 64 20 69 66 20 69 74 20 69 73 20 6e 6f 74 20 61 |d if it is not a| 00000380 6c 72 65 61 64 79 0a 72 75 6e 6e 69 6e 67 20 61 |lready.running a| 00000390 6e 64 20 53 74 72 6f 6e 67 48 65 6c 70 24 44 69 |nd StrongHelp$Di| 000003a0 72 20 68 61 73 20 62 65 65 6e 20 64 65 66 69 6e |r has been defin| 000003b0 65 64 2e 20 49 66 0a 53 74 72 6f 6e 67 48 6c 70 |ed. If.StrongHlp| 000003c0 20 63 61 6e 6e 6f 74 20 62 65 20 66 6f 75 6e 64 | cannot be found| 000003d0 20 74 68 65 6e 20 61 6e 20 65 72 72 6f 72 20 77 | then an error w| 000003e0 69 6c 6c 20 62 65 0a 67 65 6e 65 72 61 74 65 64 |ill be.generated| 000003f0 2e 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |...-------------| 00000400 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000430 2d 2d 2d 2d 0a 0a 46 4e 73 68 65 6c 6c 5f 53 74 |----..FNshell_St| 00000440 72 6f 6e 67 48 6c 70 49 73 41 76 61 69 6c 61 62 |rongHlpIsAvailab| 00000450 6c 65 0a 50 61 72 61 6d 73 20 3d 3e 0a 20 20 20 |le.Params =>. | 00000460 20 20 20 20 20 20 4e 6f 6e 65 0a 20 20 20 20 20 | None. | 00000470 20 20 3c 3d 0a 20 20 20 20 20 20 20 20 20 62 6f | <=. bo| 00000480 6f 6c 20 54 52 55 45 20 69 66 20 53 74 72 6f 6e |ol TRUE if Stron| 00000490 67 48 65 6c 70 24 44 69 72 20 69 73 20 64 65 66 |gHelp$Dir is def| 000004a0 69 6e 65 64 2c 0a 20 20 20 20 20 20 20 20 20 20 |ined,. | 000004b0 20 20 20 20 6f 74 68 65 72 77 69 73 65 20 46 41 | otherwise FA| 000004c0 4c 53 45 0a 20 20 20 20 20 20 20 20 20 20 20 20 |LSE. | 000004d0 20 20 0a 55 73 65 64 20 74 6f 20 63 68 65 63 6b | .Used to check| 000004e0 20 74 68 61 74 20 53 74 72 6f 6e 67 48 6c 70 20 | that StrongHlp | 000004f0 69 73 20 69 6e 73 74 61 6c 6c 65 64 0a 6f 6e 20 |is installed.on | 00000500 74 68 65 20 73 79 73 74 65 6d 2e 20 54 68 69 73 |the system. This| 00000510 20 63 61 6c 6c 20 63 61 6e 20 62 65 20 75 73 65 | call can be use| 00000520 64 20 74 6f 20 73 68 61 64 65 0a 61 20 27 48 65 |d to shade.a 'He| 00000530 6c 70 27 20 6d 65 6e 75 20 69 74 65 6d 20 69 66 |lp' menu item if| 00000540 20 53 74 72 6f 6e 67 48 6c 70 20 68 61 73 20 6e | StrongHlp has n| 00000550 6f 74 20 62 65 65 6e 20 73 65 65 6e 0a 62 79 20 |ot been seen.by | 00000560 74 68 65 20 46 69 6c 65 72 2c 20 6f 72 20 69 66 |the Filer, or if| 00000570 20 69 74 20 69 73 20 6e 6f 74 20 61 76 61 69 6c | it is not avail| 00000580 61 62 6c 65 2e 0a 0a 45 78 61 6d 70 6c 65 20 63 |able...Example c| 00000590 6f 64 65 2e 2e 2e 0a 0a 53 68 61 64 65 20 6d 65 |ode.....Shade me| 000005a0 6e 75 20 69 74 65 6d 20 77 69 74 68 20 74 68 65 |nu item with the| 000005b0 20 68 61 6e 64 6c 65 20 48 6c 70 49 74 65 6d 25 | handle HlpItem%| 000005c0 20 69 66 20 53 74 72 6f 6e 67 48 6c 70 0a 69 73 | if StrongHlp.is| 000005d0 20 6e 6f 74 20 61 76 61 69 6c 61 62 6c 65 3a 0a | not available:.| 000005e0 0a 50 52 4f 43 73 68 65 6c 6c 5f 4d 65 6e 75 53 |.PROCshell_MenuS| 000005f0 68 61 64 65 28 48 6c 70 49 74 65 6d 25 2c 28 46 |hade(HlpItem%,(F| 00000600 4e 73 68 65 6c 6c 5f 53 74 72 6f 6e 67 48 6c 70 |Nshell_StrongHlp| 00000610 49 73 41 76 61 69 6c 61 62 6c 65 3d 30 29 29 0a |IsAvailable=0)).| 00000620 20 20 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d | .-------------| 00000630 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000660 2d 2d 2d 2d |----| 00000664
.