Done v11 suggestion: plugin online help interface

Charles Dye

Super Moderator
Staff member
May 20, 2008
4,461
88
Albuquerque, NM
prospero.unm.edu
It would be nice if the online help features could be made plugin-aware. I propose something along these lines:

When help is requested via the HELP command or the F1 or Ctrl-F1 keys, TCC checks whether the specified word is a command, variable, or function provided by a plugin; and if so, whether that plugin exports a function named F1_help(). If the word is not provided by a plugin, or if that plugin does not offer an F1_help() function, then the help system is launched as usual. But if the plugin does provide F1_help(), TCC calls that instead and passes it a string containing the command/variable/function name, lowercased and with @ or _ prefixed as appropriate. The plugin is responsible for deciphering the name and launching a .CHM / .PDF / .TXT / .HTML, popping up a message box, or whatever else the author chooses.

It might also be useful to pass a second parameter to differentiate the HELP command from the F1 and Ctrl-F1 keystrokes. In the case of HELP, it might be appropriate to just dump text to stdout; for F1 and Ctrl-F1 probably not.
 
Similar threads
Thread starter Title Forum Replies Date
G Done V11 Suggestion Suggestions 3
J Done Suggestion for V11 Suggestions 8
S Declined V11 desiderata Suggestions 9
p.f.moore Done V11 suggestions Suggestions 0
S Declined V11 suggestions Suggestions 0
J Done v11 idea del by date Suggestions 2
Charles Dye v11 idea - Numeric range comparison operators Suggestions 0
Charles Dye Done v11 idea - Date picker function Suggestions 3
Charles Dye Done HASH suggestion for v27 Suggestions 6
Charles Dye Done ASSOCIATE suggestion for v27 Suggestions 1
D Suggestion: VIEW option to open VIEW over tab window but not keep it there Suggestions 0
Alpengreis Done Suggestion for full osbuild internal variable Suggestions 2
L Done Suggestion for TCC 'ver' command Suggestions 8
D Done Suggestion: Add VIEW option to open in same position as current window Suggestions 0
D Suggestion: Tab or button to open new tab window in horizontal group Suggestions 1
Charles Dye @VERINFO suggestion Suggestions 0
D Done Suggestion: keystroke to copy previous argument Suggestions 3
H Done DEDUPE suggestion Suggestions 8
C Done Help suggestion TCMD Suggestions 3
C Declined copy /w suggestion Suggestions 2
J Done Everything Search Suggestion Suggestions 8
Fross Done sendmail suggestion Suggestions 1
K_Meinhard Declined Renewed suggestion Suggestions 0
S Declined TAIL suggestion Suggestions 0
A Done Cosmetic suggestion on displaying version number Suggestions 0
M Done TC 11 suggestion Suggestions 0
D Done Suggestion for commands to move/copy a folder Suggestions 7
J Done Variable Name Completion Suggestion Suggestions 0
Charles Dye Done Startup Tabs / Tab Toolbar suggestion Suggestions 1
Charles Dye Done PLUGIN completion Suggestions 0
rconn Enhanced Plugin SDK Suggestions 0
S Declined Plugin Help Suggestions 2
p.f.moore Done Plugin hook corresponding to special aliases Suggestions 0
S Done Better PLUGIN support Suggestions 0

Similar threads