SchemaWML - Revision history

Celtic Minstrel: /* Defining a type */ Document allow_translatable

2021-06-20T06:16:37Z

‎Defining a type: Document allow_translatable

Celtic Minstrel: /* Defining a type */ Fix another improper plural

2021-06-20T06:14:17Z

‎Defining a type: Fix another improper plural

Celtic Minstrel: /* Defining a type */ Fix improper plural

2021-06-20T06:13:50Z

‎Defining a type: Fix improper plural

Celtic Minstrel: /* Finding the definition of a type */ Add a note about FORMULA_TYPE

2021-06-15T04:05:45Z

‎Finding the definition of a type: Add a note about FORMULA_TYPE

Celtic Minstrel: /* Finding the definition of a type */ Add a note about the new built-in t_string

2021-06-15T04:03:51Z

‎Finding the definition of a type: Add a note about the new built-in t_string

Celtic Minstrel: /* Defining a type */ typo

2020-10-24T23:57:03Z

‎Defining a type: typo

Celtic Minstrel: /* Defining a tag */ Document the new subtag restrictions

2020-10-24T19:57:18Z

‎Defining a tag: Document the new subtag restrictions

Octalot: Link to ValidationFaq, and add to Category:Validation

2020-02-09T20:26:19Z

Link to ValidationFaq, and add to Category:Validation

Octalot: Added new "Finding the definition of a type" section

2019-08-19T17:42:56Z

Added new "Finding the definition of a type" section

Josteph: Add sidebar

2019-03-09T18:41:20Z

Add sidebar

@@ Line 9: / Line 9: @@
 * '''name''': The name of the type, to be referenced from elsewhere in the schema.
 * '''value''': A regular expression that matches the type. Note that anchors (<tt>^</tt> and <tt>$</tt>) are not automatically added, so the expression will match if it can match any substring of the key's value. {{DevFeature1.15|0}} Regular expressions are now anchored. To obtain the previous behaviour, add <tt>.*</tt> at the beginning and end of the expression.
 * '''link''': {{DevFeature1.15|0}} Use instead of '''value''' to define an alias for another type. The value of '''link''' must name another defined type.
 * '''[union]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as a union of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The union type matches any value that matches one of the subtypes.

@@ Line 11: / Line 11: @@
 * '''link''': {{DevFeature1.15|0}} Use instead of '''value''' to define an alias for another type. The value of '''link''' must name another defined type.
 * '''[union]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as a union of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The union type matches any value that matches one of the subtypes.
-* '''[intersection]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as an intersection of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The intersection type matches only values that matches ''all'' of the subtypes.
+* '''[intersection]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as an intersection of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The intersection type matches only values that match ''all'' of the subtypes.
 * '''[list]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a list type. Supports the following additional keys and tags:
 ** '''min''': The minimum number of list elements

@@ Line 11: / Line 11: @@
 * '''link''': {{DevFeature1.15|0}} Use instead of '''value''' to define an alias for another type. The value of '''link''' must name another defined type.
 * '''[union]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as a union of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The union type matches any value that matches one of the subtypes.
-* '''[intersection]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as an intersection of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The intersections type matches only values that matches ''all'' of the subtypes.
+* '''[intersection]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a type as an intersection of one or more other types. It contains one or more '''[type]''' subtags, without the '''name''' key. The intersection type matches only values that matches ''all'' of the subtypes.
 * '''[list]''': {{DevFeature1.15|0}} Use instead of '''value''' to define a list type. Supports the following additional keys and tags:
 ** '''min''': The minimum number of list elements

@@ Line 22: / Line 22: @@
 SchemaWML is run through the usual WML preprocessor, and some of the frequently-used types' definitions are created with macros, therefore a search for a type's name won't find its definition.
-Several types with names beginning '''s_''' created with the '''SUBST_TYPE''' macro, which accepts any value that includes a WML variable substitution. For example '''x,y=$Chantal.x,$Chantal.y''' validates by assuming that the WML variables contain valid values.
+Several types with names beginning '''s_''' created with the '''SUBST_TYPE''' macro, which accepts any value that includes a WML variable substitution. For example '''x,y=$Chantal.x,$Chantal.y''' validates by assuming that the WML variables contain valid values. Similarly, types with names beginning '''f_''' are usually created with the '''FORMULA_TYPE''' macro, which accepts any value enclose in parentheses (assumed to be [[Wesnoth Formula Language]]) in addition to the base type.
 Types with names ending '''_list''' might use one of the '''LIST_TYPE''' macros.

@@ Line 30: / Line 30: @@
 * range_list is defined by '''{LIST_TYPE_COMPLEX range ( ...'''
 * to find the definition, try '''git grep 'LIST_TYPE.*range' data/schema'''
 == Defining a tag ==

@@ Line 16: / Line 16: @@
 ** '''max''': The maximum number of list elements
 ** '''split''': A regular expression used to split the key value up into list elements; defaults to <tt>\s*,\s*</tt>.
-** '''[element]''': One or more of these tags is required; they are equivalent to the '''[type]''' subtags in '''[union]''' and '''[intersection]''', and specify possible types for the list elements. Each list element must match at lease one of these subtypes for the whole list to match.
+** '''[element]''': One or more of these tags is required; they are equivalent to the '''[type]''' subtags in '''[union]''' and '''[intersection]''', and specify possible types for the list elements. Each list element must match at least one of these subtypes for the whole list to match.
 ===Finding the definition of a type===

@@ Line 42: / Line 42: @@
 * '''min''': The minimum number of times this tag may occur. {{DevFeature1.15|0}} Defaults to 0.
 * '''max''': The maximum number of times this tag may occur. Specify -1 if it may occur an unlimited number of times. {{DevFeature1.15|0}} Defaults to 1. Also, you can now use '''infinite''' instead of -1.
-* '''super''': The path to a defined tag that is used as a starting point for this tag. That is, anything defined in the supertag is also allowed in this tag. Note that '''min''' and '''max''' are ''not'' inherited from the parent tag, though '''any_tag''' is. {{DevFeature1.15|0}} This can also be a comma-separated list of paths, supporting multiple inheritance of tag definitions.
+* '''min_tags''': {{DevFeature1.15|7}} The minimum number of subtags this tag must have, regardless of the tag name. Defaults to 0.
 * '''any_tag''': {{DevFeature1.15|0}} If set to '''true''', this tag will accept any subtag without error. Known subtags that match a tag definition will be validated as normal; unknown subtags will simply be ignored.
 * '''deprecated''': {{DevFeature1.15|0}} Set to '''true''' to mark the tag as deprecated. A warning will be issued if it is used.

@@ Line 1: / Line 1: @@
 {{WML Tags}}
-SchemaWML is a way of describing the form of a WML document using WML. A WML schema consists of a root '''[wml_schema]''' tag containing a single '''[tag]''' tag and possibly some '''[type]''' tags.
+SchemaWML is a way of describing the form of a WML document using WML. A WML schema consists of a root '''[wml_schema]''' tag containing a single '''[tag]''' tag and possibly some '''[type]''' tags. The [[ValidationFAQ]] describes how to run the corresponding tool.
 == Defining a type ==

← Older revision		Revision as of 18:41, 9 March 2019
Line 1:		Line 1:
		+	{{WML Tags}}
	SchemaWML is a way of describing the form of a WML document using WML. A WML schema consists of a root '''[wml_schema]''' tag containing a single '''[tag]''' tag and possibly some '''[type]''' tags.		SchemaWML is a way of describing the form of a WML document using WML. A WML schema consists of a root '''[wml_schema]''' tag containing a single '''[tag]''' tag and possibly some '''[type]''' tags.