git » fp-git.git » commit 3dd3772

Improved documentation

author ecalot
2005-12-17 05:18:50 UTC
committer ecalot
2005-12-17 05:18:50 UTC
parent 006578cf62908cd45cb0df874731fcc04ae68b22

Improved documentation

PR/src/xml/resources.xml +14 -9

diff --git a/PR/src/xml/resources.xml b/PR/src/xml/resources.xml
index 51ee535..2873c8a 100644
--- a/PR/src/xml/resources.xml
+++ b/PR/src/xml/resources.xml
@@ -3019,8 +3019,8 @@ Attributes:
  resources:
   o version: the version of the file (mandatory)
  folder:
-  o type (inheritable): the type of the items below (if not specified)
-    * autodetect
+  o type (inheritable): one of the list below
+    * autodetect (default)
     * level
     * image
     * wave
@@ -3031,7 +3031,6 @@ Attributes:
     * information
     Note:
      - See PR readme for details on item types
-     - If no type is provided, PR will try to autodetect it
   o palette (inheritable): 
     * number: the palette ID associated to the images in this folder if applicable
     * "monochrome": this means the image has a black and white monochrome palette
@@ -3041,8 +3040,8 @@ Attributes:
        palette from the file or a random generated palette.
 	o paletteindex (inheritable): the name of the index the palette has to be looked into
 	  Note:
-		 - If not speficied the index value will be used
-  o name (not inheritable): the name of the folder
+		 - If not speficied current item index value will be used
+  o name or title (not inheritable): the name of the folder
   o desc (not inheritable): a description
   o path (partially inheritable): a path where the folder is extracted to.
     Contained items will inherit this path. There must be only one path per item.
@@ -3050,13 +3049,19 @@ Attributes:
   o file (inheritable): the file where the item is located
  item:
   o value: the item ID (mandatory)
-  o index: the index name (mandatory)
-  o file: see itemtype file (mandatory but may be inherited from a folder)
-  o type: see folder type. May be inherited, omissions means autodetect
+  o index (inheritable): the index name (mandatory but may be inherited from a folder)
+  o order (inheritable): after the value and index, the order varies to make an item
+    unique (defaults to 0)
+  o flags (inheritable): some pop2 file format flags (mandatory for pop2 files)
+  o file: see folder file (mandatory but may be inherited from a folder).
+  o type: see folder type. May be inherited, omissions means autodetect.
   o palette: see folder palette. Mandatory for image types but may be inherited,
     when omited a default palette will be used. This attribute is ignored in other items
   o paletteindex: see folder paletteindex. Mandatory for image types but may be inherited.
-  o desc: a description
+  o paletteorder: in case two palettes with the same index and value appears, this option
+    lets you choose the right one. Defaults to 0.
+  o desc: a description (mostly used by PR to add in the .plv files)
+  o name or title: the name of the item (mostly used by PR to add in the .plv files)
   o path: the name of the file it will be extracted
   o number or levelnumber: an additional resource or level number