Improve documentation in header for quest description files.

git-svn-id: svn://svn.code.sf.net/p/crossfire/code/maps/trunk@18938 282e977c-c81d-0410-88c4-b93c2d0d6712

world.quests

@@ -1,28 +1,33 @@
-# Quest definition file
+# world.quests -- global quest definition file
-# This file describes the various quests known to the game, and used through the functions in quest.c
 #
-# Format is pretty simple:
+# This file describes the various quests known in the game. It is used by the
-# quest "internal code, whatever you wand but must be unique"
+# functions in 'server/quest.c'.
-# title "one-line to describe the quest"
+#
-# description
+# This file describes the various quests known in the game, which is used by
-# "multi-line"
+# the functions in 'server/quest.c'. For the most part, this file pulls in
-# "description if you feel like it"
+# additional quest description files that are region-specific.
-# end_description
+#
-# restart "optional integer, if non zero the quest can be done multiple times"
+# Quest definition files are written much like other files in the game. Each
-# (then multiple "step/end_step" blocks)
+# quest is defined by several keys, which are read from the file line-by-line.
-# step "integer value for the step"
+# Some keys contain fields that may span multiple lines (i.e. 'description').
-# description
+# The best way to understand the format is to look at an existing example.
-# "multi-line step"
+#
-# "description"
+# Key Reference:
-# end_description
+#   quest           - internal name, which must be globally unique
-# end_step
+#   title           - short, one-line descriptive title for the quest
-# (then after all steps)
+#   description     - start of a description field for the block it is in
-# end_quest
+#   end_description - end a description field
-# you can include other quest files by using
+#   restart         - (optional) when set to a non-zero integer, the quest can
-# include path/to/file.quests
+#                     is replayable (can be completed multiple times)
-# the include path can be either relative or absolute to the maps/ directory
+#   step            - integer value for the beginning of a step block; this
-# (this can be done by starting the path with a /)
+#                     block must also contain its own description block (see
-# any files that are included may have other files included from them.
+#                     examples for details)
+#   end_step        - end a step field
+#   end_quest       - end of a quest definition
+#
+#   include         - include another quest file, either as a relative path to
+#                     the current directory or an absolute path from the top
+#                     level maps directory
 
 include darcap/darcap.quests