Done Augmented Help

This is a rather large request. The intent is to make Help more useful, and immediately useful.

Perhaps it could handled as a collaborative user project to take some of the burden off JPSoft.

What I would like is:

1. a realistiic example of use of every function, and syntax element, showing it in enough context you can pretty well just plug it into a script without needing a lot of other knowledge to set up. It should show the expected result. Perhaps this could be mechanised to actually run the script and caputure output automatically. This would help proofread.

2. attaching muliple keywords to every help element that are indexed so that yiou don't need to know the name of something to look it up.

The way it is now ,almost never in the help sufficient. I always have to search for examples before I can understand how to use it. Any kind of BNF is just obfuscation since there are so many variants. IF you must use it , use two different fonts/colours for things you type as is vs things you replace or are meta syntax.
 
Similar threads
Thread starter Title Forum Replies Date
Joe Caverly Link in Help File to Blog Articles Suggestions 0
Joe Caverly Declined Update FFIND in Help File with example for ORing expressions to search for Suggestions 6
R Declined Help system improvements Suggestions 11
x13 Done Typo in help file (including PDF) | v24.02.46 Suggestions 0
R User-created extended help (probably in a text file): DIRHISTORY /?x Suggestions 10
R Done Add to Pause Help text re indenting the prompt Suggestions 0
N Done Update help (more) and new tutorials Suggestions 8
Joe Caverly Declined Help File "See Also" Suggestions 4
rps Declined Remember the Help "Select Topic" window settings Suggestions 4
C Done Help suggestion TCMD Suggestions 3
M Declined A sticky thread to report HELP issues Suggestions 0
rconn Declined Help file organization Suggestions 0
rconn In the Help tab let the user add links either to files or web pages, with an icon & label. Suggestions 0
R Documentation CLARIFY START /C HELP Suggestions 0
R Done Just a Help addition - Alias name can use variables Suggestions 1
R Done Just a Help addition - Set can indirectly set variables Suggestions 0
Alpengreis Declined Any chance for quick help with all command-options? Suggestions 3
Roedy Done better redirection help Suggestions 1
T Done Help for SET to include @ExecStr[] hint Suggestions 1
S Declined Plugin Help Suggestions 2
S Done Command and help enhancement, esp. ALIAS, FUNCTION and SET Suggestions 2
Charles Dye Done v11 suggestion: plugin online help interface Suggestions 0
Charles Dye Declined Help file request Suggestions 2
S Done Debugger window HELP pulldown menu Suggestions 3
E Done move @unquote, @unquotes in help docs Suggestions 0

Similar threads