Skip to content

Helpfile Editing

UndeadNappist edited this page Jun 11, 2022 · 9 revisions

To edit a helpfile type HELPEDIT or HELPEDIT NEW.

Part of writing helpfiles is ensuring not only all necessary information is available but also that the helpfile itself is in a small, easy to digest chunk. If you make one too big - or accidentally make the helpfile name too similar to others - you will end up with a block of text newer players will have more trouble absorbing.

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. They were fixed by changing "PUYALLUP" PUYALLUP to PUYALLUP. 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.

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
Clone this wiki locally