-
Notifications
You must be signed in to change notification settings - Fork 31
Helpfile Editing
To edit a helpfile type HELPEDIT exact and full title of the help file to edit
, HELPEDIT DEPRECIATED, or HELPEDIT NEW. Helpfiles cannot be deleted, so if it is now redundant, rename the file to DEPRECIATED.
When formatting the helpfile title, try to pluralize and gerund to ensure that players who use those versions of the word will be correctly pointed to the helpfile. Furthermore if it consists of a particularly long sequence of words or if there will be substantial overlap between other helpfiles, try to place the single word in quotation marks. A good example is "ARMOUR SETS" helpfile versus the ARMOR BALLISTIC IMPACT FORMFITTING FORM-FITTING helpfile.
The converse of this is this sequence of files:
"PUYALLUP EAST" "EAST PUYALLUP" "E PUYALLUP" "PUYALLUP E" "CENTRAL PUYALLUP"
"PUYALLUP W" "PUYALLUP WEST" "WEST PUYALLUP" "W PUYALLUP"
"PUYALLUP" PUYALLUP
If you searched for PUYALLUP you would get all three of these helpfiles. However, in this example:
"PUYALLUP EAST" "EAST PUYALLUP" "E PUYALLUP" "PUYALLUP E" "CENTRAL PUYALLUP"
"PUYALLUP W" "PUYALLUP WEST" "WEST PUYALLUP" "W PUYALLUP"
PUYALLUP
You would only get the PUYALLUP helpfile and not the other two. This was done in-MUD to fix the map indexes and a few other things. When you search for the FULL AND EXACT NAME of a helpfile, you will only get that singular helpfile, regardless of how many terms it shares with other helpfiles. Test it out by typing help i-5
Helpfiles accept all normal formatting of the rest of the mud. If you are using a client that likes to devour empty lines, using ^n can force a new line.
EXAMPLE
^n
See Also: ^WEXAMPLE^n, ^WEXAMPLETWO^n
% is unusable in MUD in the helpfiles, as it will always add a slash.