[Enigma-cvs] enigma/doc/refman enigma-ref.texi,1.6,1.7

[Ralf Westram <address@hidden>]

Update of /cvsroot/enigma/enigma/doc/refman
In directory subversions:/tmp/cvs-serv13697/doc/refman

Modified Files:
        enigma-ref.texi 
Log Message:
- updated description of index format



Index: enigma-ref.texi
===================================================================
RCS file: /cvsroot/enigma/enigma/doc/refman/enigma-ref.texi,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** enigma-ref.texi     24 Oct 2003 14:31:43 -0000      1.6
--- enigma-ref.texi     27 Oct 2003 11:58:42 -0000      1.7
***************
*** 220,240 ****
  
  @example
! welcome                     | Welcome                | Daniel Heck
! martin06                    | Is It Easy?            | Martin Hawlisch
! lasers101                   | Lasers 101             | Daniel Heck
! level3a                     | Feel Your Way          | Siegfried Fennig
! martin04                    | Sokoban Revival        | Martin Hawlisch
  @end example
  
! Every line in this file describes one landscape in the level pack.  There are 
up to
! three entries in every line, separated by vertical bars @code{|}:
  
! @enumerate
! @item The file name of the level (@emph{excluding} the @file{.lua} 
extension).  This
! entry mandatory!
! @item The full name of the level.  This is the name the player will see in 
the level
! menu.  You can leave this field empty if you prefer to leave your level 
unnamed.
! @item The landscape's author.
! @end enumerate
  
  When Enigma starts up it automatically tries to load an index file called
--- 220,283 ----
  
  @example
! {file=welcome              name="Welcome"                        
author="Daniel Heck"         }
! {file=martin06             name="Is It Easy?"                    
author="Martin Hawlisch"     }
! {file=lasers101            name="Lasers 101"                     
author="Daniel Heck"         }
! {file=level3a              name="Feel Your Way"                  
author="Siegfried Fennig"    }
! {file=martin04             name="Sokoban Revival"                
author="Martin Hawlisch"     }
  @end example
  
! Every line in this file describes one landscape in the level pack.
! The general format of these lines is
  
! @example
! { tag1=content1 tag2=content2 ... }
! @end example
! 
! One line normally contains many different @code{tag=content} pairs.
! 
! If your content contains spaces, surround the content with quotes
! (e.g. @code{name="Is It Easy?"}). If you want the string to contain quotes,
! escape them with @code{\} (e.g. @code{author = "Petr \"ant\" Machata"}).
! 
! Here's a description of all supported tags:
! 
! @table @code
! @item file
! Defines the file name of the level (@emph{excluding} the @file{.lua} 
extension).
! This entry is mandatory!
! 
! @item name
! Defines the full name of the level. This is the name the player will see in 
the level
! menu. You can leave this field empty if you prefer to leave your level 
unnamed.
! 
! @item author
! Defines the name of the autor. It will be displayed together with the full 
name at level startup.
! 
! @item revision
! Defines the revision number of the level (defaults to 1)
! When the revision number is increased, a small red ! appears in the level 
menu.
! 
! If you do changes to the level that affect the way the level
! is solved, you should increase the revision number.
! If you only did cosmetic changes, you should @emph{NOT} increase the revision.
! 
! @item easymode
! Set this to 1 when the level supports different difficulties.
! [not implemented - has no effect yet]
! 
! @item par_time
! Defines the par time for your level, i.e. the maximum amount
! of time a good player needs to solve the level.
! [not implemented - has no effect yet]
! 
! @item par_moves
! Defines the par moves (i.e. the maximum number of moves a good player needs) 
for your level.
! [not implemented - has no effect yet]
! 
! @item hint1, hint2
! Define two hints how to solve the level. 
! [not implemented - has no effect yet]
! 
! @end table
  
  When Enigma starts up it automatically tries to load an index file called