Sample Help File - Formatting and Color Example
Where applicable, please begin the helpfile with a syntax example:
Syntax: command <'argument1'> ['argument2'] [argument3]
Formatting:
* CAPITALIZE command keywords
* Put <> around required arguments
* Put [] around optional arguments
* Indicate where quotes are needed by placing them into syntax line
Example:
Syntax: cast <spell name> ['target'] [target]
Color codes:
Please use the following color standards in writing helpfiles -
} for normal help text
} for command line entries. Compulsory arguments in <>
and optional arguments in []
} for warnings, as in if you do this, you will die/get a strike
} for items in a list, as in HELP list of languages, as well as
for warnings less dire than those in red ( }) but still significant
} for references to other helpfiles in the helpfile text
} for OOC meta-commentary, usually about the inner workings of the
game and thus why things need to be a certain way, as well as examples of
echoes from the game (game output)
} for email and web addresses
}* } for a less gaudy indicator of a game mechanics comment
Notes:
It's OK to include an apostrophe in a help title or keyword, but then to
refer to it you need to put it in quotation marks, e.g.:
HEDIT NEW Aurora's Whole Realms Catalogue
is fine, but to edit it you will need to use
HEDIT "Aurora's Whole Realms Catalogue"