Changes between Version 9 and Version 10 of Development/FileFormatsExplained

Timestamp:

07/06/10 21:04:19 (10 years ago)

Author:

ibboard

Comment:

--

Development/FileFormatsExplained

@@ -3 +3 @@
 
 The following page will contain details of the [../FileFormats WarFoundry XML file structure] in plain English. If you just want to view the schemas then please look at the [browser:IBBoard.WarFoundry.API/trunk/dtds source code viewer]. Details of the rest of the file format (e.g. the Zip file that contains the XML) are in the [../FileFormats main file format page].
+
+Each of the following file formats is designed to be extensible. This means that it should be possible to add extensions for future use or even embed entirely new elements for completely separate applications that also support the WarFoundry file formats.
 
 == Game Systems ==
@@ -36 +38 @@
  * {{{id}}}: the unique (to the race) ID of the unit type
  * {{{typeName}}}: the name of the unit type that will be shown in unit selection lists
- * {{{cat}}}: the ID of the category that the unit belongs to
+ * {{{cat}}}: the ID of the category that the unit belongs to - this can be used for single categories, or {{{<unitCategories>}}} can be used when a unit can be a member of multiple categories
  * {{{minSize}}}/{{{maxSize}}}: limits on the number of troops in a single unit
  * {{{minNum}}}/{{{maxNum}}}: limits on the number of times the unit type can be taken
@@ -100 +102 @@
 ==== <notes> ====
 
-Currently loaded but not yet displayed (ticket:196). Notes are a single block of text containing additional "design notes" that help people when selecting units but which aren't shown in the final army.
+Currently loaded but not yet displayed in all GUIs. Notes are a single block of text containing additional "design notes" that help people when selecting units but which aren't shown in the final exported army.
+
+==== <unitMembers> and <unitMember> ====
+
+A new addition in the later v0.1 beta releases, the {{{<unitMember>}}} elements let file writers re-use stat lines by referring to a {{{typeID}}} that is defined later. These member types may also be used in future for more advanced functionality. If some unit members are defined and a stat line is defined the the unit will reference the member type but the stat line shown will be the one declared in the {{{<stats>}}} element for the unit type. You must include a {{{<stats>}}} block OR one or more {{{<unitMember>}}} elements for each unit.
+
+==== <unitCategories> and <unitCategory> ====
+
+A new addition in the later v0.1 beta releases, the {{{<unitCategory>}}} elements override the {{{category}}} attribute of the main {{{<unit>}}} and provide a way of adding one unit to multiple categories. The {{{catID}}} must refer to a category from the race's System or from the Race.
 
 === <categories> ===