Schema documentation for versionschema.experimental.next.xsd

Showing:

Annotations

Attributes

Diagrams

Facets

Instances

Model

Properties

Source

Used by

Main schema versionschema.experimental.next.xsd

Namespace

http://versionschema.org/xmlns

Annotations

Version Schema - Experimental.1 {VSchemaInDev.1}.
Copyright and license: http://versionschema.org/LICENSE.
Specification: http://versionschema.org/

Properties

attribute form default	unqualified
element form default	qualified
version	Experimental.0 {VSchemaInDev.0}

Element vs:ruleelementsGroup / vs:ChangeRule

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:changeRule_T

Properties

content	simple
final	restriction, list, union

Facets

enumeration

any_changes

The field is changed/increment for all changes of any kind.

enumeration

arbitrary

The field is changed/incremented randomly or at the whim of bipedal wetware.

enumeration

back_compat

The field is changed/incremented only for backwards compatible changes.
Can be used as a modifier, for instance documentation_new_section may or may 
not be backwards compatible. Applying back_compat to the same field refines 
the rule set. Cannot be combined with any other rule that implies a breaking 
change.

enumeration

constant

The field is a constant, relative to the rest of the fields. It cannot be
changed independantly, but it can change if any other field in the version
changes. TBD: Whether and how to tie allowance of change to other named fields?

enumeration

fixes

Changes that fix bugs, refactoring, clarifying documentation, etc., 
without introducing new features or API changes.

enumeration

new_features

The field is changed/incremented only for addition of new features 
(modification of an API) without breaking backwards compatibility.

enumeration

simple

Any simple change. Can be combined with any rule that does not imply
high complexity.

enumeration

complex

Any complex change. Can be combined with any rule that does not imply
low complexity.

enumeration

documentation_new_section

New section(s) added to documentation.

enumeration

documentation_new_paragraph

New paragraph(s) added to documentation.

enumeration

documentation_refinement

Refinements to documentation.

enumeration

not_back_compat

The field is changed/incremented only for none backwards compatible changes.
Used as a modifier, for instance documentation_new_section may or may not be
backwards compatible. Applying not_back_compat to the same field refines the
rule set. Cannot be combined with back_compat or any other rule that implies 
a non-breaking change.

enumeration

visual_changes

The field is changed/incremented for changes to images (icons, pictographs, etc) 
or the visual layout of the content.

Source

<xsd:element name="ChangeRule" type="vs:changeRule_T"/>

Element vs:ruleelementsGroup / vs:EnumerationTransition

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:transition_T

Properties

content

complex

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

from

xsd:string

required

Names the state transition source state.

name

xsd:string

optional

Optional name.

xsd:string

required

Names the state transition target state.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="EnumerationTransition" type="vs:transition_T"/>

Element vs:ruleelementsGroup / vs:SignedIntegerTransition

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:signedIntegerTransition_T

Properties

content

complex

Attributes

QName

Type

Use

Annotation

changeBy

xsd:int

optional

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="SignedIntegerTransition" type="vs:signedIntegerTransition_T"/>

Element vs:ruleelementsGroup / vs:UnsignedIntegerTransition

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:unsignedIntegerTransition_T

Properties

content

complex

Attributes

QName

Type

Default

Use

Annotation

changeBy

xsd:nonNegativeInteger

optional

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="UnsignedIntegerTransition" type="vs:unsignedIntegerTransition_T"/>

Element vs:baseelementsGroup / vs:AnyWhiteSpace

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:anywhitespace_T

Properties

content

complex

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

maxChars

xsd:unsignedShort

65535

optional

Maximum number of non-newline type characters allowed in a whitespace block. Default 65535 (max).

maxNewLines

xsd:unsignedShort

optional

Maximum number of new-lines allowed in a whitespace block. Default is 1.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="AnyWhiteSpace" type="vs:anywhitespace_T"/>

Element vs:baseelementsGroup / vs:Characters

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:characters_T

Properties

content

simple

Source

<xsd:element name="Characters" type="vs:characters_T"/>

Element vs:baseelementsGroup / vs:Delim

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:delim_T

Properties

content	simple
final	restriction, list, union

Source

<xsd:element name="Delim" type="vs:delim_T"/>

Element vs:baseelementsGroup / vs:Field

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:field_T

Properties

content

complex

Model

Children

vs:All, vs:AllowedStateTransitions, vs:AnyOf, vs:AnyWhiteSpace, vs:ChangeRule, vs:Characters, vs:Delim, vs:EnumerationTransition, vs:Field, vs:Literal, vs:OneOf, vs:Optional, vs:Range, vs:Sequence, vs:SignedIntegerTransition, vs:TypeRef, vs:UnsignedIntegerTransition, vs:VersionMetaTag

Instance

<vs:Field fragment="" inheritRules="true" name="" type="" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:Field>

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

inheritRules

xsd:boolean

true

optional

When true, rules are inherited from the first outer node they can be found in.
No rules applied if not found in the chain of containing outer elements.

name

xsd:string

required

The field name. Must be unique among its siblings in its parent element.

type

vs:fieldtype_T

required

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="Field" type="vs:field_T"/>

Element vs:controlGroup / vs:All

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:all_T

Properties

content

complex

Model

Children

Instance

<vs:All fragment="" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:All>

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="All" type="vs:all_T"/>

Element vs:controlGroup / vs:AnyOf

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:anyof_T

Properties

content

complex

Model

Children

Instance

<vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:AnyOf>

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

maxOccurs

xsd:nonNegativeInteger

optional

maxOccursUnbounded

xsd:boolean

false

optional

minOccurs

xsd:nonNegativeInteger

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="AnyOf" type="vs:anyof_T"/>

Element vs:controlGroup / vs:OneOf

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:oneof_T

Properties

content

complex

Model

Children

Instance

<vs:OneOf fragment="" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:OneOf>

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="OneOf" type="vs:oneof_T"/>

Element vs:controlGroup / vs:Optional

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:optional_T

Properties

content

complex

Model

Children

Instance

<vs:Optional fragment="" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:Optional>

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="Optional" type="vs:optional_T"/>

Element vs:controlGroup / vs:Sequence

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:sequence_T

Properties

content

complex

Model

Children

Instance

<vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:Sequence>

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

maxOccurs

xsd:nonNegativeInteger

optional

maxOccursUnbounded

xsd:boolean

false

optional

minOccurs

xsd:nonNegativeInteger

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="Sequence" type="vs:sequence_T"/>

Element vs:controlGroup / vs:VersionMetaTag

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:range_T

Properties

content	simple
final	restriction, list, union

Source

<xsd:element name="VersionMetaTag" type="vs:range_T"/>

Element vs:baseelementsGroup / vs:AllowedStateTransitions

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:allowedstatetransistions_T

Properties

content

complex

Model

(vs:ChangeRule | vs:EnumerationTransition | vs:SignedIntegerTransition | vs:UnsignedIntegerTransition)

Children

vs:ChangeRule, vs:EnumerationTransition, vs:SignedIntegerTransition, vs:UnsignedIntegerTransition

Instance

<vs:AllowedStateTransitions allowParallel="true" fragment="" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:AllowedStateTransitions>

Attributes

QName

Type

Default

Use

Annotation

allowParallel

xsd:boolean

true

optional

When false, transitions represent a single track through the defined state machine.
When true (default), work may commense in or more phases simultaneously.

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="AllowedStateTransitions" type="vs:allowedstatetransistions_T"/>

Element vs:baseelementsGroup / vs:Literal

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:literal_T

Properties

content

complex

Attributes

QName

Type

Default

Use

Annotation

caseSensitive

xsd:boolean

true

optional

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

isExpression

xsd:boolean

false

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="Literal" type="vs:literal_T"/>

Element vs:baseelementsGroup / vs:Range

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:range_T

Properties

content	simple
final	restriction, list, union

Source

<xsd:element name="Range" type="vs:range_T"/>

Element vs:baseelementsGroup / vs:TypeRef

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:typeref_T

Properties

content

complex

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

name

xsd:string

optional

The name to use at the element scope in which type is referenced.

ref

xsd:NCName

optional

The type name refered to.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="TypeRef" type="vs:typeref_T"/>

Element vs:VersionSchema

Namespace

http://versionschema.org/xmlns

Annotations

Top-level container for everything in a version schema definition file. 
There MUST be exactly one VersionSchema element per schema file.

Diagram

Properties

content	complex
abstract	false

Model

vs:AncestorSchema{0,1} , vs:DataFormat , vs:Assurance+ , vs:State , (vs:Type* | vs:AnyWhiteSpace | vs:Characters | vs:Delim | vs:Field | vs:AllowedStateTransitions | vs:Literal | vs:Range | vs:TypeRef | vs:All | vs:AnyOf | vs:OneOf | vs:Optional | vs:Sequence | vs:VersionMetaTag | vs:ChangeRule | vs:EnumerationTransition | vs:SignedIntegerTransition | vs:UnsignedIntegerTransition)

Children

vs:All, vs:AllowedStateTransitions, vs:AncestorSchema, vs:AnyOf, vs:AnyWhiteSpace, vs:Assurance, vs:ChangeRule, vs:Characters, vs:DataFormat, vs:Delim, vs:EnumerationTransition, vs:Field, vs:Literal, vs:OneOf, vs:Optional, vs:Range, vs:Sequence, vs:SignedIntegerTransition, vs:State, vs:Type, vs:TypeRef, vs:UnsignedIntegerTransition, vs:VersionMetaTag

Instance

<vs:VersionSchema canonicalReference="" name="" organizationName="" organizationURI="" reportDefectsTo="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AncestorSchema fragment="" schemaURI="" uri="">{0,1}</vs:AncestorSchema>
  <vs:DataFormat>{1,1}</vs:DataFormat>
  <vs:Assurance>{1,unbounded}</vs:Assurance>
  <vs:State>{1,1}</vs:State>
  <vs:Type fragment="" name="" uri="">{0,unbounded}</vs:Type>
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
  <vs:ChangeRule>{1,1}</vs:ChangeRule>
  <vs:EnumerationTransition fragment="" from="" name="" to="" uri="">{1,1}</vs:EnumerationTransition>
  <vs:SignedIntegerTransition changeBy="" fragment="" uri="">{1,1}</vs:SignedIntegerTransition>
  <vs:UnsignedIntegerTransition changeBy="1" fragment="" uri="">{1,1}</vs:UnsignedIntegerTransition>
</vs:VersionSchema>

Attributes

QName	Type	Use
canonicalReference	xsd:anyURI	required
name	xsd:string	required
organizationName	xsd:string	optional
organizationURI	xsd:anyURI	optional
reportDefectsTo	xsd:anyURI	optional

Source

<xsd:element name="VersionSchema" abstract="false">
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve">
                Top-level container for everything in a version schema definition file. 
                There MUST be exactly one VersionSchema element per schema file. 
            </xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="AncestorSchema" type="vs:ancestorSchema_T" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="DataFormat" type="vs:dataFormat_T" minOccurs="1" maxOccurs="1"/>
      <xsd:element name="Assurance" type="vs:assurance_T" minOccurs="1" maxOccurs="unbounded"/>
      <xsd:element name="State" type="vs:documentState_T" minOccurs="1" maxOccurs="1"/>
      <xsd:sequence>
        <xsd:choice minOccurs="1" maxOccurs="unbounded">
          <xsd:element name="Type" type="vs:type_T" minOccurs="0" maxOccurs="unbounded"/>
          <xsd:group ref="vs:baseelementsGroup"/>
          <xsd:group ref="vs:controlGroup"/>
          <xsd:group ref="vs:ruleelementsGroup"/>
        </xsd:choice>
      </xsd:sequence>
    </xsd:sequence>
    <xsd:attribute name="name" type="xsd:string" use="required"/>
    <xsd:attribute name="canonicalReference" type="xsd:anyURI" use="required"/>
    <xsd:attribute name="reportDefectsTo" type="xsd:anyURI" use="optional"/>
    <xsd:attribute name="organizationName" type="xsd:string" use="optional"/>
    <xsd:attribute name="organizationURI" type="xsd:anyURI" use="optional"/>
  </xsd:complexType>
</xsd:element>

Element vs:VersionSchema / vs:AncestorSchema

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:ancestorSchema_T

Properties

content	complex
minOccurs	0
maxOccurs	1

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

schemaURI

xsd:anyURI

required

A URI pointing to the ancestor.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="AncestorSchema" type="vs:ancestorSchema_T" minOccurs="0" maxOccurs="1"/>

Element vs:VersionSchema / vs:DataFormat

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:dataFormat_T

Properties

content	simple
minOccurs	1
maxOccurs	1
final	restriction, list, union

Facets

enumeration	string
enumeration	XML
enumeration	JSON
enumeration	YAML

Source

<xsd:element name="DataFormat" type="vs:dataFormat_T" minOccurs="1" maxOccurs="1"/>

Element vs:VersionSchema / vs:Assurance

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:assurance_T

Properties

content	simple
minOccurs	1
maxOccurs	unbounded
final	restriction, list, union

Facets

enumeration

undefined

Used when no other assurances are proffered.

enumeration

reviewed

Used when reviews are performed by experts, other than the changers, for all changes in each published release.

enumeration

static_analysis_reviewed

Used when output from a static analyzer is reviewed and acted on for each published release.

enumeration

third_party_audit

Used when a third party autdior or standards entity revews all changes for each published release.

enumeration

tested

Used when some testing has been performed for each published release.

enumeration

changed_features_tested

Used when tests cover the changed features for each published release.

enumeration

50_percent_coverage_tested

Used when 50% or more of product (code paths) is tested for each published release.

enumeration

75_percent_coverat_tested

Used when 75% or more of product (code paths) is tested for each published release.

enumeration

100_percent_coverage_tested

Used when 100% or more of product (code paths) is tested for each published release.

enumeration

third_party_tested

Used when an independent auditor or standards entity runs compliance tests for each published release.

Source

<xsd:element name="Assurance" type="vs:assurance_T" minOccurs="1" maxOccurs="unbounded"/>

Element vs:VersionSchema / vs:State

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:documentState_T

Properties

content	simple
minOccurs	1
maxOccurs	1
final	restriction, list, union

Facets

enumeration

draft

The schema document is subject to revision.

enumeration

permanentDraft

The schema document is a "living document", subject to change foreever.
The state tag can never be changed.

enumeration

final

Except for this state tag, the document is no longer subject to revision.
The docuement cannot be changed, except to modify the state to deprecated.

enumeration

deprecated

The schema is deprecated.
The document is no longer subject to revision of any kind.
New dependencies should not be taken on this document.
The document may be removed from public feeds.

Source

<xsd:element name="State" type="vs:documentState_T" minOccurs="1" maxOccurs="1"/>

Element vs:VersionSchema / vs:Type

Namespace

http://versionschema.org/xmlns

Diagram

Type

vs:type_T

Properties

content	complex
minOccurs	0
maxOccurs	unbounded

Model

Children

vs:All, vs:AllowedStateTransitions, vs:AnyOf, vs:AnyWhiteSpace, vs:Characters, vs:Delim, vs:Field, vs:Literal, vs:OneOf, vs:Optional, vs:Range, vs:Sequence, vs:TypeRef, vs:VersionMetaTag

Instance

<vs:Type fragment="" name="" uri="" xmlns:vs="http://versionschema.org/xmlns">
  <vs:AnyWhiteSpace fragment="" maxChars="65535" maxNewLines="1" uri="">{1,1}</vs:AnyWhiteSpace>
  <vs:Characters>{1,1}</vs:Characters>
  <vs:Delim>{1,1}</vs:Delim>
  <vs:Field fragment="" inheritRules="true" name="" type="" uri="">{1,1}</vs:Field>
  <vs:AllowedStateTransitions allowParallel="true" fragment="" uri="">{1,1}</vs:AllowedStateTransitions>
  <vs:Literal caseSensitive="true" fragment="" isExpression="false" uri="">{1,1}</vs:Literal>
  <vs:Range>{1,1}</vs:Range>
  <vs:TypeRef fragment="" name="" ref="" uri="">{1,1}</vs:TypeRef>
  <vs:All fragment="" uri="">{1,1}</vs:All>
  <vs:AnyOf fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:AnyOf>
  <vs:OneOf fragment="" uri="">{1,1}</vs:OneOf>
  <vs:Optional fragment="" uri="">{1,1}</vs:Optional>
  <vs:Sequence fragment="" maxOccurs="1" maxOccursUnbounded="false" minOccurs="1" uri="">{1,1}</vs:Sequence>
  <vs:VersionMetaTag>{1,1}</vs:VersionMetaTag>
</vs:Type>

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

name

xsd:NCName

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:element name="Type" type="vs:type_T" minOccurs="0" maxOccurs="unbounded"/>

Simple Type vs:assurance_T

Namespace

http://versionschema.org/xmlns

Annotations

Applied quality assurance practices.
Applies to the product on any change in the version representation (i.e., a version bump of any kind).
There can be as many of these as actually apply to your product release gates.

Diagram

Type

restriction of xsd:string

Properties

final

restriction, list, union

Facets

enumeration

undefined

Used when no other assurances are proffered.

enumeration

reviewed

Used when reviews are performed by experts, other than the changers, for all changes in each published release.

enumeration

static_analysis_reviewed

Used when output from a static analyzer is reviewed and acted on for each published release.

enumeration

third_party_audit

Used when a third party autdior or standards entity revews all changes for each published release.

enumeration

tested

Used when some testing has been performed for each published release.

enumeration

changed_features_tested

Used when tests cover the changed features for each published release.

enumeration

50_percent_coverage_tested

Used when 50% or more of product (code paths) is tested for each published release.

enumeration

75_percent_coverat_tested

Used when 75% or more of product (code paths) is tested for each published release.

enumeration

100_percent_coverage_tested

Used when 100% or more of product (code paths) is tested for each published release.

enumeration

third_party_tested

Used when an independent auditor or standards entity runs compliance tests for each published release.

Used by

Element

vs:VersionSchema/vs:Assurance

Source

<xsd:simpleType name="assurance_T" final="#all">
  <!-- TODO {CBF5A103-9140-4910-AD5E-607DBD3B0284}: Convert to complex type and provide mechanism for users to annotate each assurance. -->
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve">
                Applied quality assurance practices.
                Applies to the product on any change in the version representation (i.e., a version bump of any kind).
                There can be as many of these as actually apply to your product release gates.
            </xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="undefined">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when no other assurances are proffered.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="reviewed">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when reviews are performed by experts, other than the changers, for all changes in each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="static_analysis_reviewed">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when output from a static analyzer is reviewed and acted on for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="third_party_audit">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when a third party autdior or standards entity revews all changes for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="tested">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when some testing has been performed for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="changed_features_tested">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when tests cover the changed features for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="50_percent_coverage_tested">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when 50% or more of product (code paths) is tested for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="75_percent_coverat_tested">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when 75% or more of product (code paths) is tested for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="100_percent_coverage_tested">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when 100% or more of product (code paths) is tested for each published release.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="third_party_tested">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Used when an independent auditor or standards entity runs compliance tests for each published release. 
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <!-- Template            
            <xsd:enumeration value="">
                <xsd:annotation>
                    <xsd:documentation xml:lang="en" xml:space="preserve">                        
                    </xsd:documentation>
                </xsd:annotation>                
            </xsd:enumeration>
-->
  </xsd:restriction>
</xsd:simpleType>

Simple Type vs:changeRule_T

Namespace

http://versionschema.org/xmlns

Annotations

Rules that specify why a version field is incremented or changed.

Diagram

Type

restriction of xsd:string

Properties

final

restriction, list, union

Facets

enumeration

any_changes

The field is changed/increment for all changes of any kind.

enumeration

arbitrary

The field is changed/incremented randomly or at the whim of bipedal wetware.

enumeration

back_compat

The field is changed/incremented only for backwards compatible changes.
Can be used as a modifier, for instance documentation_new_section may or may 
not be backwards compatible. Applying back_compat to the same field refines 
the rule set. Cannot be combined with any other rule that implies a breaking 
change.

enumeration

constant

The field is a constant, relative to the rest of the fields. It cannot be
changed independantly, but it can change if any other field in the version
changes. TBD: Whether and how to tie allowance of change to other named fields?

enumeration

fixes

Changes that fix bugs, refactoring, clarifying documentation, etc., 
without introducing new features or API changes.

enumeration

new_features

The field is changed/incremented only for addition of new features 
(modification of an API) without breaking backwards compatibility.

enumeration

simple

Any simple change. Can be combined with any rule that does not imply
high complexity.

enumeration

complex

Any complex change. Can be combined with any rule that does not imply
low complexity.

enumeration

documentation_new_section

New section(s) added to documentation.

enumeration

documentation_new_paragraph

New paragraph(s) added to documentation.

enumeration

documentation_refinement

Refinements to documentation.

enumeration

not_back_compat

The field is changed/incremented only for none backwards compatible changes.
Used as a modifier, for instance documentation_new_section may or may not be
backwards compatible. Applying not_back_compat to the same field refines the
rule set. Cannot be combined with back_compat or any other rule that implies 
a non-breaking change.

enumeration

visual_changes

The field is changed/incremented for changes to images (icons, pictographs, etc) 
or the visual layout of the content.

Used by

Element

vs:ruleelementsGroup/vs:ChangeRule

Source

<xsd:simpleType name="changeRule_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Rules that specify why a version field is incremented or changed.</xsd:documentation>
  </xsd:annotation>
  <!-- Change rules in alphabetical order -->
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="any_changes">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The field is changed/increment for all changes of any kind.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="arbitrary">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The field is changed/incremented randomly or at the whim of bipedal wetware.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="back_compat">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The field is changed/incremented only for backwards compatible changes. Can be used as a modifier, for instance documentation_new_section may or may not be backwards compatible. Applying back_compat to the same field refines the rule set. Cannot be combined with any other rule that implies a breaking change.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="constant">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The field is a constant, relative to the rest of the fields. It cannot be changed independantly, but it can change if any other field in the version changes. TBD: Whether and how to tie allowance of change to other named fields?
          <!-- TODO {ABF2FD34-1AB6-462E-29D5-518D0D7503A7}: See TBD above. -->
        </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="fixes">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">Changes that fix bugs, refactoring, clarifying documentation, etc., without introducing new features or API changes.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="new_features">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The field is changed/incremented only for addition of new features (modification of an API) without breaking backwards compatibility.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="simple">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">Any simple change. Can be combined with any rule that does not imply high complexity.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="complex">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">Any complex change. Can be combined with any rule that does not imply low complexity.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="documentation_new_section">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">New section(s) added to documentation.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="documentation_new_paragraph">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">New paragraph(s) added to documentation.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="documentation_refinement">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">Refinements to documentation.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="not_back_compat">
      <xsd:annotation>
        <xsd:documentation>The field is changed/incremented only for none backwards compatible changes. Used as a modifier, for instance documentation_new_section may or may not be backwards compatible. Applying not_back_compat to the same field refines the rule set. Cannot be combined with back_compat or any other rule that implies a non-breaking change.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="visual_changes">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">The field is changed/incremented for changes to images (icons, pictographs, etc) or the visual layout of the content.</xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
  </xsd:restriction>
</xsd:simpleType>

Simple Type vs:characters_T

Namespace

http://versionschema.org/xmlns

Diagram

Type

xsd:string

Used by

Element

vs:baseelementsGroup/vs:Characters

Source

<xsd:simpleType name="characters_T">
  <!-- TODO {C541A77A-D882-41E9-602D-DC6A616A19BC}: Annotation -->
  <!-- TODO {C1E6D8F7-0DA3-4FBB-1D48-30F8AFEE19B8}: This should be a complex type so we can use expressions or lists of characters. -->
  <xsd:restriction base="xsd:string"/>
</xsd:simpleType>

Simple Type vs:dataFormat_T

Namespace

http://versionschema.org/xmlns

Annotations

Defines the data format. (string, XML/JSON/YAML).
Only string is supported at this time.

Diagram

Type

restriction of xsd:string

Properties

final

restriction, list, union

Facets

enumeration	string
enumeration	XML
enumeration	JSON
enumeration	YAML

Used by

Element

vs:VersionSchema/vs:DataFormat

Source

<xsd:simpleType name="dataFormat_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve">
                Defines the data format. (string, XML/JSON/YAML).
                Only string is supported at this time.
            </xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="string"/>
    <xsd:enumeration value="XML"/>
    <xsd:enumeration value="JSON"/>
    <xsd:enumeration value="YAML"/>
  </xsd:restriction>
</xsd:simpleType>

Simple Type vs:delim_T

Namespace

http://versionschema.org/xmlns

Annotations

List of delimiter characters.

Diagram

Type

xsd:string

Properties

final

restriction, list, union

Used by

Element

vs:baseelementsGroup/vs:Delim

Source

<xsd:simpleType name="delim_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">List of delimiter characters.</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string"/>
</xsd:simpleType>

Simple Type vs:documentState_T

Namespace

http://versionschema.org/xmlns

Annotations

Indicates whether the schema is a draft, living document, final or deprecated version.

Diagram

Type

restriction of xsd:string

Properties

final

restriction, list, union

Facets

enumeration

draft

The schema document is subject to revision.

enumeration

permanentDraft

The schema document is a "living document", subject to change foreever.
The state tag can never be changed.

enumeration

final

Except for this state tag, the document is no longer subject to revision.
The docuement cannot be changed, except to modify the state to deprecated.

enumeration

deprecated

The schema is deprecated.
The document is no longer subject to revision of any kind.
New dependencies should not be taken on this document.
The document may be removed from public feeds.

Used by

Element

vs:VersionSchema/vs:State

Source

<xsd:simpleType name="documentState_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve"> 
                Indicates whether the schema is a draft, living document, final or deprecated version.
            </xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="draft">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        The schema document is subject to revision.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="permanentDraft">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        The schema document is a "living document", subject to change foreever.
                        The state tag can never be changed.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="final">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        Except for this state tag, the document is no longer subject to revision.
                        The docuement cannot be changed, except to modify the state to deprecated.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="deprecated">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        The schema is deprecated.
                        The document is no longer subject to revision of any kind.
                        New dependencies should not be taken on this document.
                        The document may be removed from public feeds.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
  </xsd:restriction>
</xsd:simpleType>

Simple Type vs:fieldtype_T

Namespace

http://versionschema.org/xmlns

Annotations

The type of the field being defined.

Diagram

Type

restriction of xsd:string

Properties

final

restriction, list, union

Facets

enumeration

alhpa

The field type is pure alpha characters.

enumeration

alphanumeric

The field type is mixed alpha and numeric characters.

enumeration

enumeration

The field type defines enumerations.

enumeration

numeric

The field type is pure numeric.

Used by

Attribute

vs:field_T/@type

Source

<xsd:simpleType name="fieldtype_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The type of the field being defined.</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="alhpa">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        The field type is pure alpha characters.                       
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="alphanumeric">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">
                        The field type is mixed alpha and numeric characters.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="enumeration">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">                        
                        The field type defines enumerations.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
    <xsd:enumeration value="numeric">
      <xsd:annotation>
        <xsd:documentation xml:lang="en" xml:space="preserve">                        
                        The field type is pure numeric.
                    </xsd:documentation>
      </xsd:annotation>
    </xsd:enumeration>
  </xsd:restriction>
</xsd:simpleType>

Simple Type vs:range_T

Namespace

http://versionschema.org/xmlns

Annotations

Diagram

Type

xsd:string

Properties

final

restriction, list, union

Used by

Elements

vs:baseelementsGroup/vs:Range, vs:controlGroup/vs:VersionMetaTag

Source

<xsd:simpleType name="range_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve">
                <!-- TODO {379E6FDE-98D3-4EE7-E5AB-7F5EA6A1239B}: Annotations -->
                <!-- TODO {E93FFC74-F167-49A4-8222-69E6D9B219A3}: Add pattern/restrictions for range notation.
                    Range should restrict the format to LowChar-HighChar, or use the set notation form [i,e), (e,i], [i,i], (e,e).                  
                -->
            </xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string"/>
</xsd:simpleType>

Complex Type vs:allowedstatetransistions_T

Namespace

http://versionschema.org/xmlns

Annotations

Lists the kinds of transitions that field value can pass through.
TBD: Syntax/semantic definition.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:baseelementsGroup/vs:AllowedStateTransitions

Model

(vs:ChangeRule | vs:EnumerationTransition | vs:SignedIntegerTransition | vs:UnsignedIntegerTransition)

Children

vs:ChangeRule, vs:EnumerationTransition, vs:SignedIntegerTransition, vs:UnsignedIntegerTransition

Attributes

QName

Type

Default

Use

Annotation

allowParallel

xsd:boolean

true

optional

When false, transitions represent a single track through the defined state machine.
When true (default), work may commense in or more phases simultaneously.

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="allowedstatetransistions_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve">
                Lists the kinds of transitions that field value can pass through.
                TBD: Syntax/semantic definition.
            </xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attribute name="allowParallel" type="xsd:boolean" default="true">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">When false, transitions represent a single track through the defined state machine. When true (default), work may commense in or more phases simultaneously.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:transition_T

Namespace

http://versionschema.org/xmlns

Annotations

Defines allowed transition states.

Diagram

Used by

Element

vs:ruleelementsGroup/vs:EnumerationTransition

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

from

xsd:string

required

Names the state transition source state.

name

xsd:string

optional

Optional name.

xsd:string

required

Names the state transition target state.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="transition_T">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Defines allowed transition states.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="name" type="xsd:string" use="optional">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">Optional name.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="to" type="xsd:string" use="required">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">Names the state transition target state.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="from" type="xsd:string" use="required">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">Names the state transition source state.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:signedIntegerTransition_T

Namespace

http://versionschema.org/xmlns

Annotations

Defines a transition type for signed integer numeric fields.
Useful for count to zero from +/- starting point or anything else that needs a signed integer transition.
You must provide a value for this type, no default is provided.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:ruleelementsGroup/vs:SignedIntegerTransition

Attributes

QName

Type

Use

Annotation

changeBy

xsd:int

optional

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="signedIntegerTransition_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Defines a transition type for signed integer numeric fields. Useful for count to zero from +/- starting point or anything else that needs a signed integer transition. You must provide a value for this type, no default is provided.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="changeBy" type="xsd:int"/>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:unsignedIntegerTransition_T

Namespace

http://versionschema.org/xmlns

Annotations

Defines a transition type for unsigned integer numeric fields.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:ruleelementsGroup/vs:UnsignedIntegerTransition

Attributes

QName

Type

Default

Use

Annotation

changeBy

xsd:nonNegativeInteger

optional

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="unsignedIntegerTransition_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Defines a transition type for unsigned integer numeric fields.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="changeBy" type="xsd:nonNegativeInteger" default="1"/>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:all_T

Namespace

http://versionschema.org/xmlns

Annotations

All of the child elements, must be present in the version string or record, in any order.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:controlGroup/vs:All

Model

Children

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="all_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">All of the child elements, must be present in the version string or record, in any order.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:anywhitespace_T

Namespace

http://versionschema.org/xmlns

Annotations

A place holder for any quantity of any kind of whitepspace, including new-line characters.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:baseelementsGroup/vs:AnyWhiteSpace

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

maxChars

xsd:unsignedShort

65535

optional

Maximum number of non-newline type characters allowed in a whitespace block. Default 65535 (max).

maxNewLines

xsd:unsignedShort

optional

Maximum number of new-lines allowed in a whitespace block. Default is 1.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="anywhitespace_T" final="#all">
  <xsd:annotation>
    <xsd:documentation>A place holder for any quantity of any kind of whitepspace, including new-line characters.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="maxNewLines" type="xsd:unsignedShort" default="1">
    <xsd:annotation>
      <xsd:documentation>Maximum number of new-lines allowed in a whitespace block. Default is 1.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="maxChars" type="xsd:unsignedShort" default="65535">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">Maximum number of non-newline type characters allowed in a whitespace block. Default 65535 (max).</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:field_T

Namespace

http://versionschema.org/xmlns

Annotations

Designates a section of the version string or record that represents a named/referencable field.
Fields contain a type attribute and any of the elements in the vs:baseelementsGroup, vs:controlGroup 
and vs:ruleelementsGroup.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:baseelementsGroup/vs:Field

Model

Children

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

inheritRules

xsd:boolean

true

optional

When true, rules are inherited from the first outer node they can be found in.
No rules applied if not found in the chain of containing outer elements.

name

xsd:string

required

The field name. Must be unique among its siblings in its parent element.

type

vs:fieldtype_T

required

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="field_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Designates a section of the version string or record that represents a named/referencable field. Fields contain a type attribute and any of the elements in the vs:baseelementsGroup, vs:controlGroup and vs:ruleelementsGroup.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attribute name="name" type="xsd:string" use="required">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">The field name. Must be unique among its siblings in its parent element.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="inheritRules" type="xsd:boolean" default="true">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">When true, rules are inherited from the first outer node they can be found in. No rules applied if not found in the chain of containing outer elements.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="type" type="vs:fieldtype_T" use="required">
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:anyof_T

Namespace

http://versionschema.org/xmlns

Annotations

Any of the child elements, can be present in the version string or record, in any order.
There must be at least one.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:controlGroup/vs:AnyOf

Model

Children

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

maxOccurs

xsd:nonNegativeInteger

optional

maxOccursUnbounded

xsd:boolean

false

optional

minOccurs

xsd:nonNegativeInteger

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="anyof_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Any of the child elements, can be present in the version string or record, in any order. There must be at least one.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
  <xsd:attributeGroup ref="vs:minmaxAttributesGroup"/>
</xsd:complexType>

Complex Type vs:oneof_T

Namespace

http://versionschema.org/xmlns

Annotations

One and only one of the child elements may be present in the version string or record.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:controlGroup/vs:OneOf

Model

Children

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="oneof_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">One and only one of the child elements may be present in the version string or record.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:optional_T

Namespace

http://versionschema.org/xmlns

Annotations

Declares an optional segment of the version string or record.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:controlGroup/vs:Optional

Model

Children

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="optional_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Declares an optional segment of the version string or record.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:sequence_T

Namespace

http://versionschema.org/xmlns

Annotations

Declares an ordered list of elements.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:controlGroup/vs:Sequence

Model

Children

Attributes

QName

Type

Default

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

maxOccurs

xsd:nonNegativeInteger

optional

maxOccursUnbounded

xsd:boolean

false

optional

minOccurs

xsd:nonNegativeInteger

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="sequence_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Declares an ordered list of elements.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
      <xsd:group ref="vs:ruleelementsGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
  <xsd:attributeGroup ref="vs:minmaxAttributesGroup"/>
</xsd:complexType>

Complex Type vs:literal_T

Namespace

http://versionschema.org/xmlns

Annotations

Defines the presense of a string literal within the vesion string or record.

Diagram

Type

extension of xsd:string

Properties

final

extension, restriction

Used by

Element

vs:baseelementsGroup/vs:Literal

Attributes

QName

Type

Default

Use

Annotation

caseSensitive

xsd:boolean

true

optional

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

isExpression

xsd:boolean

false

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="literal_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Defines the presense of a string literal within the vesion string or record.</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleContent>
    <xsd:extension base="xsd:string">
      <xsd:attribute name="caseSensitive" type="xsd:boolean" default="true"/>
      <xsd:attribute name="isExpression" type="xsd:boolean" default="false"/>
      <!--<xsd:attributeGroup ref="vs:minmaxGroup"/>-->
      <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

Complex Type vs:typeref_T

Namespace

http://versionschema.org/xmlns

Annotations

Use to reference a defined type.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:baseelementsGroup/vs:TypeRef

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

name

xsd:string

optional

The name to use at the element scope in which type is referenced.

ref

xsd:NCName

optional

The type name refered to.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="typeref_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Use to reference a defined type.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="ref" type="xsd:NCName" use="optional">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">The type name refered to.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="name" type="xsd:string" use="optional">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">The name to use at the element scope in which type is referenced.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:ancestorSchema_T

Namespace

http://versionschema.org/xmlns

Annotations

Declare ancestor schemas and transition rules. Allows seperate prerelease
and release schemas to be related to each other by some simple rules.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:VersionSchema/vs:AncestorSchema

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

schemaURI

xsd:anyURI

required

A URI pointing to the ancestor.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="ancestorSchema_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Declare ancestor schemas and transition rules. Allows seperate prerelease and release schemas to be related to each other by some simple rules.</xsd:documentation>
  </xsd:annotation>
  <!-- TODO {FC722C21-5F03-44C3-CBB9-A2A90252B790} Expand on this! -->
  <xsd:attribute name="schemaURI" type="xsd:anyURI" use="required">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">A URI pointing to the ancestor.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:type_T

Namespace

http://versionschema.org/xmlns

Annotations

Use to define types (essentially macros) to reference.
Required for recursive definitions and also saves some space and typing.

Diagram

Properties

final

extension, restriction

Used by

Element

vs:VersionSchema/vs:Type

Model

Children

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

name

xsd:NCName

optional

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="type_T" final="#all">
  <xsd:annotation>
    <xsd:documentation xml:lang="en" xml:space="preserve">
                Use to define types (essentially macros) to reference.
                Required for recursive definitions and also saves some space and typing.
            </xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:choice>
      <xsd:group ref="vs:baseelementsGroup"/>
      <xsd:group ref="vs:controlGroup"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attribute name="name" type="xsd:NCName" use="optional"/>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Complex Type vs:versionmetatag_T

Namespace

http://versionschema.org/xmlns

Annotations

Defines that a VersionMeta tag appears at the specified location in the vesion string or record.

Diagram

Properties

final

extension, restriction

Attributes

QName

Type

Fixed

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

prefix

xsd:string

https//versionschema.org/Schemas/

optional

Defines default prefix used for all VersionMeta tags that do not begin with "https://" or "http://".

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:complexType name="versionmetatag_T" final="#all">
  <!-- Except for the sake of completeness, this element will be of little value.
             It is retained for version schemes that require the VersionMeta tag, but that's not
             enforceable until tooling has discovered the tag and pulled the referenced schema.
             I suppose a strict mode could simply reject the version string if after reading
             through the tag, we find that it's not placed correctly?
        -->
  <xsd:annotation>
    <xsd:documentation>Defines that a VersionMeta tag appears at the specified location in the vesion string or record.</xsd:documentation>
  </xsd:annotation>
  <xsd:attribute name="prefix" type="xsd:string" fixed="https//versionschema.org/Schemas/">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">Defines default prefix used for all VersionMeta tags that do not begin with "https://" or "http://".</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="vs:annotationsAttributeGroup"/>
</xsd:complexType>

Attribute vs:transition_T / @name

Namespace

No namespace

Annotations

Optional name.

Type

xsd:string

Properties

use	optional

Used by

Complex Type

vs:transition_T

Source

<xsd:attribute name="name" type="xsd:string" use="optional">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Optional name.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:transition_T / @to

Namespace

No namespace

Annotations

Names the state transition target state.

Type

xsd:string

Properties

use	required

Used by

Complex Type

vs:transition_T

Source

<xsd:attribute name="to" type="xsd:string" use="required">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Names the state transition target state.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:transition_T / @from

Namespace

No namespace

Annotations

Names the state transition source state.

Type

xsd:string

Properties

use	required

Used by

Complex Type

vs:transition_T

Source

<xsd:attribute name="from" type="xsd:string" use="required">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Names the state transition source state.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:annotationsAttributeGroup / @uri

Namespace

No namespace

Annotations

A fully qualified URL referencing human readable documentation for the containing element.

Type

xsd:anyURI

Properties

content

simple

Used by

Attribute Group

vs:annotationsAttributeGroup

Source

<xsd:attribute name="uri" type="xsd:anyURI">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">A fully qualified URL referencing human readable documentation for the containing element.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:annotationsAttributeGroup / @fragment

Namespace

No namespace

Annotations

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

Type

xsd:anyURI

Properties

content

simple

Used by

Attribute Group

vs:annotationsAttributeGroup

Source

<xsd:attribute name="fragment" type="xsd:anyURI">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:signedIntegerTransition_T / @changeBy

Namespace

No namespace

Type

xsd:int

Properties

content

simple

Used by

Complex Type

vs:signedIntegerTransition_T

Source

<xsd:attribute name="changeBy" type="xsd:int"/>

Attribute vs:unsignedIntegerTransition_T / @changeBy

Namespace

No namespace

Type

xsd:nonNegativeInteger

Properties

default

Used by

Complex Type

vs:unsignedIntegerTransition_T

Source

<xsd:attribute name="changeBy" type="xsd:nonNegativeInteger" default="1"/>

Attribute vs:allowedstatetransistions_T / @allowParallel

Namespace

No namespace

Annotations

When false, transitions represent a single track through the defined state machine.
When true (default), work may commense in or more phases simultaneously.

Type

xsd:boolean

Properties

default

true

Used by

Complex Type

vs:allowedstatetransistions_T

Source

<xsd:attribute name="allowParallel" type="xsd:boolean" default="true">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">When false, transitions represent a single track through the defined state machine. When true (default), work may commense in or more phases simultaneously.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:anywhitespace_T / @maxNewLines

Namespace

No namespace

Annotations

Maximum number of new-lines allowed in a whitespace block. Default is 1.

Type

xsd:unsignedShort

Properties

default

Used by

Complex Type

vs:anywhitespace_T

Source

<xsd:attribute name="maxNewLines" type="xsd:unsignedShort" default="1">
  <xsd:annotation>
    <xsd:documentation>Maximum number of new-lines allowed in a whitespace block. Default is 1.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:anywhitespace_T / @maxChars

Namespace

No namespace

Annotations

Maximum number of non-newline type characters allowed in a whitespace block. Default 65535 (max).

Type

xsd:unsignedShort

Properties

default

65535

Used by

Complex Type

vs:anywhitespace_T

Source

<xsd:attribute name="maxChars" type="xsd:unsignedShort" default="65535">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Maximum number of non-newline type characters allowed in a whitespace block. Default 65535 (max).</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:minmaxAttributesGroup / @minOccurs

Namespace

No namespace

Type

xsd:nonNegativeInteger

Properties

default

Used by

Attribute Group

vs:minmaxAttributesGroup

Source

<xsd:attribute name="minOccurs" type="xsd:nonNegativeInteger" default="1"/>

Attribute vs:minmaxAttributesGroup / @maxOccurs

Namespace

No namespace

Type

xsd:nonNegativeInteger

Properties

default

Used by

Attribute Group

vs:minmaxAttributesGroup

Source

<xsd:attribute name="maxOccurs" type="xsd:nonNegativeInteger" default="1"/>

Attribute vs:minmaxAttributesGroup / @maxOccursUnbounded

Namespace

No namespace

Type

xsd:boolean

Properties

default

false

Used by

Attribute Group

vs:minmaxAttributesGroup

Source

<xsd:attribute name="maxOccursUnbounded" type="xsd:boolean" default="false"/>

Attribute vs:field_T / @name

Namespace

No namespace

Annotations

The field name. Must be unique among its siblings in its parent element.

Type

xsd:string

Properties

use	required

Used by

Complex Type

vs:field_T

Source

<xsd:attribute name="name" type="xsd:string" use="required">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The field name. Must be unique among its siblings in its parent element.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:field_T / @inheritRules

Namespace

No namespace

Annotations

When true, rules are inherited from the first outer node they can be found in.
No rules applied if not found in the chain of containing outer elements.

Type

xsd:boolean

Properties

default

true

Used by

Complex Type

vs:field_T

Source

<xsd:attribute name="inheritRules" type="xsd:boolean" default="true">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">When true, rules are inherited from the first outer node they can be found in. No rules applied if not found in the chain of containing outer elements.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:field_T / @type

Namespace

No namespace

Type

vs:fieldtype_T

Properties

use	required

Facets

enumeration

alhpa

The field type is pure alpha characters.

enumeration

alphanumeric

The field type is mixed alpha and numeric characters.

enumeration

enumeration

The field type defines enumerations.

enumeration

numeric

The field type is pure numeric.

Used by

Complex Type

vs:field_T

Source

<xsd:attribute name="type" type="vs:fieldtype_T" use="required">
</xsd:attribute>

Attribute vs:literal_T / @caseSensitive

Namespace

No namespace

Type

xsd:boolean

Properties

default

true

Used by

Complex Type

vs:literal_T

Source

<xsd:attribute name="caseSensitive" type="xsd:boolean" default="true"/>

Attribute vs:literal_T / @isExpression

Namespace

No namespace

Type

xsd:boolean

Properties

default

false

Used by

Complex Type

vs:literal_T

Source

<xsd:attribute name="isExpression" type="xsd:boolean" default="false"/>

Attribute vs:typeref_T / @ref

Namespace

No namespace

Annotations

The type name refered to.

Type

xsd:NCName

Properties

use	optional

Used by

Complex Type

vs:typeref_T

Source

<xsd:attribute name="ref" type="xsd:NCName" use="optional">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The type name refered to.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:typeref_T / @name

Namespace

No namespace

Annotations

The name to use at the element scope in which type is referenced.

Type

xsd:string

Properties

use	optional

Used by

Complex Type

vs:typeref_T

Source

<xsd:attribute name="name" type="xsd:string" use="optional">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">The name to use at the element scope in which type is referenced.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:ancestorSchema_T / @schemaURI

Namespace

No namespace

Annotations

A URI pointing to the ancestor.

Type

xsd:anyURI

Properties

use	required

Used by

Complex Type

vs:ancestorSchema_T

Source

<xsd:attribute name="schemaURI" type="xsd:anyURI" use="required">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">A URI pointing to the ancestor.</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:type_T / @name

Namespace

No namespace

Type

xsd:NCName

Properties

use	optional

Used by

Complex Type

vs:type_T

Source

<xsd:attribute name="name" type="xsd:NCName" use="optional"/>

Attribute vs:versionmetatag_T / @prefix

Namespace

No namespace

Annotations

Defines default prefix used for all VersionMeta tags that do not begin with "https://" or "http://".

Type

xsd:string

Properties

fixed

https//versionschema.org/Schemas/

Used by

Complex Type

vs:versionmetatag_T

Source

<xsd:attribute name="prefix" type="xsd:string" fixed="https//versionschema.org/Schemas/">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">Defines default prefix used for all VersionMeta tags that do not begin with "https://" or "http://".</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>

Attribute vs:VersionSchema / @name

Namespace

No namespace

Type

xsd:string

Properties

use	required

Used by

Element

vs:VersionSchema

Source

<xsd:attribute name="name" type="xsd:string" use="required"/>

Attribute vs:VersionSchema / @canonicalReference

Namespace

No namespace

Type

xsd:anyURI

Properties

use	required

Used by

Element

vs:VersionSchema

Source

<xsd:attribute name="canonicalReference" type="xsd:anyURI" use="required"/>

Attribute vs:VersionSchema / @reportDefectsTo

Namespace

No namespace

Type

xsd:anyURI

Properties

use	optional

Used by

Element

vs:VersionSchema

Source

<xsd:attribute name="reportDefectsTo" type="xsd:anyURI" use="optional"/>

Attribute vs:VersionSchema / @organizationName

Namespace

No namespace

Type

xsd:string

Properties

use	optional

Used by

Element

vs:VersionSchema

Source

<xsd:attribute name="organizationName" type="xsd:string" use="optional"/>

Attribute vs:VersionSchema / @organizationURI

Namespace

No namespace

Type

xsd:anyURI

Properties

use	optional

Used by

Element

vs:VersionSchema

Source

<xsd:attribute name="organizationURI" type="xsd:anyURI" use="optional"/>

Element Group vs:ruleelementsGroup

Namespace

http://versionschema.org/xmlns

Diagram

Used by

Complex Types	vs:all_T, vs:allowedstatetransistions_T, vs:anyof_T, vs:field_T, vs:oneof_T, vs:optional_T, vs:sequence_T
Element	vs:VersionSchema

Model

vs:ChangeRule | vs:EnumerationTransition | vs:SignedIntegerTransition | vs:UnsignedIntegerTransition

Children

vs:ChangeRule, vs:EnumerationTransition, vs:SignedIntegerTransition, vs:UnsignedIntegerTransition

Source

<xsd:group name="ruleelementsGroup">
  <xsd:choice>
    <xsd:element name="ChangeRule" type="vs:changeRule_T"/>
    <xsd:element name="EnumerationTransition" type="vs:transition_T"/>
    <xsd:element name="SignedIntegerTransition" type="vs:signedIntegerTransition_T"/>
    <xsd:element name="UnsignedIntegerTransition" type="vs:unsignedIntegerTransition_T"/>
  </xsd:choice>
</xsd:group>

Element Group vs:baseelementsGroup

Namespace

http://versionschema.org/xmlns

Diagram

Used by

Complex Types	vs:all_T, vs:anyof_T, vs:field_T, vs:oneof_T, vs:optional_T, vs:sequence_T, vs:type_T
Element	vs:VersionSchema

Model

Children

vs:AllowedStateTransitions, vs:AnyWhiteSpace, vs:Characters, vs:Delim, vs:Field, vs:Literal, vs:Range, vs:TypeRef

Source

<xsd:group name="baseelementsGroup">
  <xsd:choice>
    <xsd:element name="AnyWhiteSpace" type="vs:anywhitespace_T"/>
    <xsd:element name="Characters" type="vs:characters_T"/>
    <xsd:element name="Delim" type="vs:delim_T"/>
    <xsd:element name="Field" type="vs:field_T"/>
    <xsd:element name="AllowedStateTransitions" type="vs:allowedstatetransistions_T"/>
    <xsd:element name="Literal" type="vs:literal_T"/>
    <xsd:element name="Range" type="vs:range_T"/>
    <xsd:element name="TypeRef" type="vs:typeref_T"/>
  </xsd:choice>
</xsd:group>

Element Group vs:controlGroup

Namespace

http://versionschema.org/xmlns

Diagram

Used by

Complex Types	vs:all_T, vs:anyof_T, vs:field_T, vs:oneof_T, vs:optional_T, vs:sequence_T, vs:type_T
Element	vs:VersionSchema

Model

Children

vs:All, vs:AnyOf, vs:OneOf, vs:Optional, vs:Sequence, vs:VersionMetaTag

Source

<xsd:group name="controlGroup">
  <xsd:choice>
    <xsd:element name="All" type="vs:all_T"/>
    <xsd:element name="AnyOf" type="vs:anyof_T"/>
    <xsd:element name="OneOf" type="vs:oneof_T"/>
    <xsd:element name="Optional" type="vs:optional_T"/>
    <xsd:element name="Sequence" type="vs:sequence_T"/>
    <xsd:element name="VersionMetaTag" type="vs:range_T"/>
  </xsd:choice>
</xsd:group>

Attribute Group vs:annotationsAttributeGroup

Namespace

http://versionschema.org/xmlns

Diagram

Used by

Complex Types

vs:all_T, vs:allowedstatetransistions_T, vs:ancestorSchema_T, vs:anyof_T, vs:anywhitespace_T, vs:field_T, vs:literal_T, vs:oneof_T, vs:optional_T, vs:sequence_T, vs:signedIntegerTransition_T, vs:transition_T, vs:type_T, vs:typeref_T, vs:unsignedIntegerTransition_T, vs:versionmetatag_T

Attributes

QName

Type

Use

Annotation

fragment

xsd:anyURI

optional

A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.

uri

xsd:anyURI

optional

A fully qualified URL referencing human readable documentation for the containing element.

Source

<xsd:attributeGroup name="annotationsAttributeGroup">
  <xsd:attribute name="uri" type="xsd:anyURI">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">A fully qualified URL referencing human readable documentation for the containing element.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="fragment" type="xsd:anyURI">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">A URN that, when appended to the VersionSchema's canonicalReference content, yields the human readable documentation for the containing element.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
</xsd:attributeGroup>

Attribute Group vs:minmaxAttributesGroup

Namespace

http://versionschema.org/xmlns

Diagram

Used by

Complex Types

vs:anyof_T, vs:sequence_T

Attributes

QName	Type	Default	Use
maxOccurs	xsd:nonNegativeInteger	1	optional
maxOccursUnbounded	xsd:boolean	false	optional
minOccurs	xsd:nonNegativeInteger	1	optional

Source

<xsd:attributeGroup name="minmaxAttributesGroup">
  <xsd:attribute name="minOccurs" type="xsd:nonNegativeInteger" default="1"/>
  <xsd:attribute name="maxOccurs" type="xsd:nonNegativeInteger" default="1"/>
  <xsd:attribute name="maxOccursUnbounded" type="xsd:boolean" default="false"/>
</xsd:attributeGroup>