Quick help for aliases

Any chance of making it user customizable? For example, I have the following alias

alias cd=call c:\cmd\cd.btm

so quick help displays call c:\cmd\cd.btm --- not very helpful.

An easy way of doing the customization would be to check for another alias of the form qh_alias-name and display its value if present. Then I could

alias qh_cd=`cd [ /P | /A ] [ /N ] [ /? | /H ] [ ~ | - | ? | path ]`

to get some useful help. Would be nice---I always forget that I implemented the ? special character for the path (uses @getfolder to get a directory to cd to).

Obviously one can come up with other mechanisms to associate the custom help. For example, a command aliashelp alias=help-text; but this would need an internal table of help texts and a /R style load mechanism.

My suggestion above probably requires the least amount of modification to TCC. In addtion, this could also work for anything, not just aliases. You could check for the alias qh_name where name would be the cmd/btm/bat/exe/executable-extension/etc name with extension but without path.
 

rconn

Administrator
Staff member
May 14, 2008
12,406
152
> Any chance of making it user customizable? For example, I have the
> following alias
>
> alias cd=call c:\cmd\cd.btm
>
> so quick help displays call c:\cmd\cd.btm --- not very helpful.
>
> An easy way of doing the customization would be to check for another alias
> of the form qh_alias-name and display its value if present. Then I could
>
> alias qh_cd=`cd [ /P | /A ] [ /N ] [ /? | /H ] [ ~ | - | ? | path ]`
>
> to get some useful help. Would be nice---I always forget that I
> implemented the ? special character for the path (uses @getfolder to get a
> directory to cd to).

I'll add it to the suggestion list for v11.

Rex Conn
JP Software
 

Charles Dye

Super Moderator
Staff member
May 20, 2008
4,496
91
Albuquerque, NM
prospero.unm.edu
Alternatively, you could read quickhelp from a text file (and fall back on the current behavior if no matching command is found in that file.) That way, users could easily customize quickhelp for batch files, external utilities, or even internal commands, if they wish.
 
... read quickhelp from a text file...

This makes sense too---as I said lots of alternatives for implementation. This then leads to asking support for optional extra CHM file(s) (perhaps pointed to by an INI file directive). These could be searched before the standard help file. Then users who have CHM build capability/inclination could add full custom help as well.
 
Similar threads
Thread starter Title Forum Replies Date
Joe Caverly Quick Search in eWriter Help Support 1
vefatica Quick help nit Support 0
C Documentation GOSUB quick help Support 6
Fross Quick Function Question Support 17
M Quick tip: Close tabs in TCMD Support 0
vefatica History recall turns off Quick-Edit Support 4
S How to? Mark threads for quick retrieval Support 3
C Add link to ewriter help to program group... Support 3
samintz How to? Search for %(command) in Help? Support 1
Joe Caverly Favorites in eWriter Help Support 6
vefatica Online help? Support 2
fishman@panix.com HELP!! I just updated to Version 28 and as usual I cannot make extended directory search work. Support 2
JohnQSmith New online help file wrong logo Support 7
Jay Sage Documentation Function @DRIVE Missing in Help Lists Support 0
Charles Dye More help nits Support 0
D Documentation Typo in COPY help Support 0
FreezerBurnt Help making a CMD and TCC compatible batch file Support 7
Joe Caverly Documentation COMMANDS in Version 27 help Support 8
K_Meinhard How to? Help window position Support 7
U Command help on file names Support 5
D Documentation Help "Startup" page does not describe global lists Support 0
vefatica Help disappears? Support 6
rchapmanitt Help Purchasing Support 2
Charles Dye Documentation Help nits: @ZIPFILECRC Support 0
C version help Support 3
C Documentation Help Nit. REN / RENAME Support 0
Dmitry L. Kobyakov Documentation Error in the Help: the WINDOW command Support 0
vefatica Help for @PID Support 2
vefatica Need help with XML Support 3
Alpengreis Documentation Minor issue in help file for view /E Support 1
R Documentation Advanced Directives Help Support 0
R Documentation Help Nit with SETP Support 0
R wmic command help Support 9
R Documentation Help Nit > bdebugger View Menu Support 0
R Documentation A couple of Help nits Support 0
R Documentation Help typo Support 1
MikeBaas How to? I need help with RD Support 5
R Documentation v25 Help Comments Support 1
Joe Caverly DIRectory Colorization in v25 Help File Support 0
vefatica Help nit Support 0
D error in help documentation? Support 0
Joe Caverly _EXPANSION in help file Support 0
K_Meinhard Help file error Support 1
Joe Caverly JOBMONITOR in Help File Support 1
A Documentation [Help file] OPTION "//" synopsis formatting issue Support 0
D The local HELP viewer... Support 0
Chen Touboul Overtyping issue - i press the Insert key, help till press enter for new line in TCC Support 2
C Documentation Help nix ZIP /M Support 0
Joe Caverly v24 Help File - DATEMONITOR Support 1
Joe Caverly 7zip command links to zip help Support 0

Similar threads