Re: Help File structure missing?

From: Alex (fletchra@qsilver.queensu.ca)
Date: 01/06/01


>         From what I can tell, stock help files are something like:
> index file=
> ----------
> <filename>
> <filename>
>     .
>     .
>     .
> $~
This is the format for all index files in CircleMUD.  Actually, come to
think of it, the file end marker is a simple '$'.  You do not need the
'~'.

> <list of single word keywords>
>
> <multiline description of help entry>
> #
This is 'stock' CircleMUD help format.

For example:

--8<--
NORTH  SOUTH  "NEW DIRECTIONS"

This is a stupid little sample help file to show the format.

#
--8<--

The help file also ends with a '$'.  The entry that comes up with 'help'
is found in the 'screen' file.  Any variations on this are due to
non-stock patches (ie, hedit).  I can't help you with those formats at
all (since I have never used them, never seen them, and use a better
system on my own mud anyhow.  (= )

Ae.

--
   +---------------------------------------------------------------+
   | FAQ: http://qsilver.queensu.ca/~fletchra/Circle/list-faq.html |
   | Archives: http://post.queensu.ca/listserv/wwwarch/circle.html |
   +---------------------------------------------------------------+



This archive was generated by hypermail 2b30 : 12/03/01 PST