hedit

Posted by Nick Gammon on Tue 06 Jun 2006 06:06 AM — 1 posts, 8,306 views.

Australia Forum Administrator #0
Command:   hedit
Handler:   do_hedit
Min level: 59
Min posn:  any (dead)
Log:       always

Syntax: hedit [help topic]
 
This command allows you to edit a help topic.  If the specified help topic
does not exist, it will be created for you. The default help page (summary)
will be selected if you do not specify a page.
 
NOTE - Always, when creating a new help entry, type Help <new entry name> 
       prior to creating your entry. A pre-existing help file associated 
       with that keyword may already exist.

Colors can now be added to help files using the same command set that changes
a player's prompt. Multiple color combinations can be set on a given line
including ^bbackground^x colors. However there are a couple of quirks to take 
note of:

    1) At the very least, the first character of a help file cannot be
       either the symbol '&&' or the symbol '^^'.
    2) Color changes have to be separated by at least one character. ie,
       '&.^^r' will work, '&^^r' will cause problems. 
    3) Color codes are imbedded within text and _do_ count in note buffers
       for line length. ie, watch out for <Long Line Trimmed>.

Colors should be used to enhance the help file, or specific parts of the 
help file. Tact and restraint should be used if considering the use of colors.
 
 
See HSET, PCOLORS.




Add comments here ...