XTG Documentation for version 1.2
The XTG format (extensible TreeGraph format) is a XML format used by TreeGraph 2 to read and write its documents. This page is the documentation of the XML Schema for XTG.
Available format versions
Note that version 1.0 was only used during the development stage and is not documented here.
See also
- XML Schema source
- XTG article in the user help (includes a XTG example)
Table of Contents
- Schema Document Properties
- Global Declarations
-
Global Definitions
- Complex Type: BranchType
- Complex Type: DataIdType
- Complex Type: DataIdsType
- Complex Type: GlobalFormatsType
- Complex Type: IconLabelType
- Complex Type: InvisibleDataType
- Complex Type: LegendType
- Complex Type: LineType
- Complex Type: MarginType
- Complex Type: NodeType
- Complex Type: PieChartLabelType
- Complex Type: ScaleBarType
- Complex Type: TextLabelType
- Complex Type: TextLineType
- Complex Type: TextType
- Complex Type: TreeType
- Complex Type: TreegraphDocumentType
- Simple Type: BranchLengthType
- Simple Type: ColorType
- Simple Type: DistanceValueType
- Simple Type: LegendOrientationType
- Simple Type: LegendStyleType
- Simple Type: LocaleType
- Simple Type: ScaleBarAlignType
- Simple Type: ScaleValueType
- Simple Type: TextStyleType
Schema Document Properties
Target Namespace | http://bioinfweb.info/xmlns/xtg |
---|---|
Element and Attribute Namespaces |
|
Documentation |
XTG is the XML format used by the phylogenetic tree editor TreeGraph 2. http://treegraph.bioinfweb.info/ Copyright (C) 2007-2010 Ben Stöver Version: 1.2 (corrected version) |
Declared Namespaces
Prefix | Namespace |
---|---|
xml | http://www.w3.org/XML/1998/namespace |
xtg | http://bioinfweb.info/xmlns/xtg |
xsd | http://www.w3.org/2001/XMLSchema |
Global Declarations
Element: TreegraphDocument
Name | TreegraphDocument |
---|---|
Type | xtg:TreegraphDocumentType |
Nillable | no |
Abstract | no |
Documentation | This is the root element of a XTG document. |
Global Definitions
Complex Type: BranchType
Super-types: | xsd:anyType < LineType (by restriction) < BranchType (by extension) |
---|---|
Sub-types: | None |
Name | BranchType |
---|---|
Abstract | no |
Documentation |
This class is used by the The attribute Related java class: |
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]"
Length=" xtg:BranchLengthType [0..1]"
ConstantWidth=" xsd:boolean [0..1]"
MinLength=" xtg:DistanceValueType [0..1]"
MinSpaceAbove=" xtg:DistanceValueType [0..1]"
MinSpaceBelow=" xtg:DistanceValueType [0..1]">
End Choice
</...>
Complex Type: DataIdType
Super-types: | xsd:string < DataIdType (by extension) |
---|---|
Sub-types: | None |
Name | DataIdType |
---|---|
Abstract | no |
Documentation | Contains the left stem of an inverted repeat. |
Complex Type: DataIdsType
Super-types: | None |
---|---|
Sub-types: | None |
Name | DataIdsType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
</...>
Complex Type: GlobalFormatsType
Super-types: | None |
---|---|
Sub-types: | None |
Name | GlobalFormatsType |
---|---|
Abstract | no |
Documentation |
This class is used by the GlobalFormats element, which specifies the
global document formats. The
attributes and subelements store the values of the single formats which are described
here.
|
Complex Type: IconLabelType
Super-types: | xsd:anyType < LineType (by restriction) < IconLabelType (by extension) |
---|---|
Sub-types: | None |
Name | IconLabelType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]"
Icon=" xsd:string [0..1]"
Width=" xtg:DistanceValueType [0..1]"
Height=" xtg:DistanceValueType [0..1]"
IconFilled=" xsd:boolean [0..1]"
Id=" xsd:string [0..1]"
Above=" xsd:boolean [0..1]"
LineNo=" xsd:int [0..1]"
LinePos=" xsd:int [0..1]">
Complex Type: InvisibleDataType
Super-types: | xsd:anyType < InvisibleDataType (by restriction) |
---|---|
Sub-types: | None |
Name | InvisibleDataType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
Complex Type: LegendType
Super-types: | xsd:anyType < TextType (by restriction) < TextLineType (by extension) < LegendType (by extension) |
---|---|
Sub-types: | None |
Name | LegendType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
Text=" xsd:string [0..1]"
IsDecimal=" xsd:boolean [0..1]"
TextColor=" xtg:ColorType [0..1]"
TextHeight=" xtg:DistanceValueType [0..1]"
TextStyle=" xtg:TextStyleType [0..1]"
FontFamily=" xsd:string [0..1]"
DecimalFormat=" xsd:string [0..1]"
LocaleLang=" xtg:LocaleType [0..1]"
LocaleCountry=" xtg:LocaleType [0..1]"
LocaleVariant=" xtg:LocaleType [0..1]"
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]"
Anchor0=" xsd:string [0..1]"
LegendPos=" xsd:int [0..1]"
MinTreeDistance=" xtg:DistanceValueType [0..1]"
LegendSpacing=" xtg:DistanceValueType [0..1]"
LegendStyle=" xtg:LegendStyleType [0..1]"
Orientation=" xtg:LegendOrientationType [0..1]"
EdgeRadius=" xtg:DistanceValueType [0..1]">
Complex Type: LineType
Super-types: | xsd:anyType < LineType (by restriction) |
---|---|
Sub-types: |
|
Name | LineType |
---|---|
Abstract | yes |
Documentation |
This abstract class defines the attributes used by the type of line elements which are not text elements at the same time (BranchType and IconLabelType). Types of other line elements inherit from TextLineType instead. Related java class: |
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]">
Complex Type: MarginType
Super-types: | xsd:anyType < MarginType (by restriction) |
---|---|
Sub-types: | None |
Name | MarginType |
---|---|
Abstract | no |
Documentation | This class is used by elements specifying the margin around a document element or the whole document. |
Left=" xtg:DistanceValueType [0..1]"
Top=" xtg:DistanceValueType [0..1]"
Right=" xtg:DistanceValueType [0..1]"
Bottom=" xtg:DistanceValueType [0..1]">
Complex Type: NodeType
Super-types: | xsd:anyType < TextType (by restriction) < TextLineType (by extension) < NodeType (by extension) |
---|---|
Sub-types: | None |
Name | NodeType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
Text=" xsd:string [0..1]"
IsDecimal=" xsd:boolean [0..1]"
TextColor=" xtg:ColorType [0..1]"
TextHeight=" xtg:DistanceValueType [0..1]"
TextStyle=" xtg:TextStyleType [0..1]"
FontFamily=" xsd:string [0..1]"
DecimalFormat=" xsd:string [0..1]"
LocaleLang=" xtg:LocaleType [0..1]"
LocaleCountry=" xtg:LocaleType [0..1]"
LocaleVariant=" xtg:LocaleType [0..1]"
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]"
UniqueName=" xsd:string [0..1]"
EdgeRadius=" xtg:DistanceValueType [0..1]">
Complex Type: PieChartLabelType
Super-types: | xsd:anyType < LineType (by restriction) < PieChartLabelType (by extension) |
---|---|
Sub-types: | None |
Name | PieChartLabelType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]"
Width=" xtg:DistanceValueType [0..1]"
Height=" xtg:DistanceValueType [0..1]"
InternalLines=" xsd:boolean [0..1]"
NullLines=" xsd:boolean [0..1]"
Id=" xsd:string [0..1]"
Above=" xsd:boolean [0..1]"
LineNo=" xsd:int [0..1]"
LinePos=" xsd:int [0..1]">
Complex Type: ScaleBarType
Super-types: | xsd:anyType < TextType (by restriction) < TextLineType (by extension) < ScaleBarType (by extension) |
---|---|
Sub-types: | None |
Name | ScaleBarType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
Text=" xsd:string [0..1]"
IsDecimal=" xsd:boolean [0..1]"
TextColor=" xtg:ColorType [0..1]"
TextHeight=" xtg:DistanceValueType [0..1]"
TextStyle=" xtg:TextStyleType [0..1]"
FontFamily=" xsd:string [0..1]"
DecimalFormat=" xsd:string [0..1]"
LocaleLang=" xtg:LocaleType [0..1]"
LocaleCountry=" xtg:LocaleType [0..1]"
LocaleVariant=" xtg:LocaleType [0..1]"
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]"
Align=" xtg:ScaleBarAlignType [0..1]"
TreeDistance=" xtg:DistanceValueType [0..1]"
Width=" xtg:ScaleValueType [0..1]"
Height=" xtg:DistanceValueType [0..1]"
SmallInterval=" xtg:DistanceValueType [0..1]"
LongInterval=" xsd:nonNegativeInteger [0..1]"
StartLeft=" xsd:boolean [0..1]"
Increasing=" xsd:boolean [0..1]">
Complex Type: TextLabelType
Super-types: | xsd:anyType < TextType (by restriction) < TextLabelType (by extension) |
---|---|
Sub-types: | None |
Name | TextLabelType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
Text=" xsd:string [0..1]"
IsDecimal=" xsd:boolean [0..1]"
TextColor=" xtg:ColorType [0..1]"
TextHeight=" xtg:DistanceValueType [0..1]"
TextStyle=" xtg:TextStyleType [0..1]"
FontFamily=" xsd:string [0..1]"
DecimalFormat=" xsd:string [0..1]"
LocaleLang=" xtg:LocaleType [0..1]"
LocaleCountry=" xtg:LocaleType [0..1]"
LocaleVariant=" xtg:LocaleType [0..1]"
Id=" xsd:string [0..1]"
Above=" xsd:boolean [0..1]"
LineNo=" xsd:int [0..1]"
LinePos=" xsd:int [0..1]">
Complex Type: TextLineType
Super-types: | xsd:anyType < TextType (by restriction) < TextLineType (by extension) |
---|---|
Sub-types: |
|
Name | TextLineType |
---|---|
Abstract | yes |
Documentation |
This abstract class adds the attributes used by the type of a line elements which are also text elements (NodeType, LegendType and ScaleBarType). The other line element types (BranchType and IconLabelType) declare these attributes independently, since inheriting from multiple types is not possible in XSD. Related java classes: |
Text=" xsd:string [0..1]"
IsDecimal=" xsd:boolean [0..1]"
TextColor=" xtg:ColorType [0..1]"
TextHeight=" xtg:DistanceValueType [0..1]"
TextStyle=" xtg:TextStyleType [0..1]"
FontFamily=" xsd:string [0..1]"
DecimalFormat=" xsd:string [0..1]"
LocaleLang=" xtg:LocaleType [0..1]"
LocaleCountry=" xtg:LocaleType [0..1]"
LocaleVariant=" xtg:LocaleType [0..1]"
LineColor=" xtg:ColorType [0..1]"
LineWidth=" xtg:DistanceValueType [0..1]">
Complex Type: TextType
Super-types: | xsd:anyType < TextType (by restriction) |
---|---|
Sub-types: |
|
Name | TextType |
---|---|
Abstract | yes |
Documentation |
This abstract class defines the attributes used by the type of text elements (NodeType, LegendType, ScaleBarType and TextLabelType).
The attribute Related java classes: |
Text=" xsd:string [0..1]"
IsDecimal=" xsd:boolean [0..1]"
TextColor=" xtg:ColorType [0..1]"
TextHeight=" xtg:DistanceValueType [0..1]"
TextStyle=" xtg:TextStyleType [0..1]"
FontFamily=" xsd:string [0..1]"
DecimalFormat=" xsd:string [0..1]"
LocaleLang=" xtg:LocaleType [0..1]"
LocaleCountry=" xtg:LocaleType [0..1]"
LocaleVariant=" xtg:LocaleType [0..1]">
Complex Type: TreeType
Super-types: | None |
---|---|
Sub-types: | None |
Name | TreeType |
---|---|
Abstract | no |
Documentation |
This class is used by the Related java class: |
Complex Type: TreegraphDocumentType
Super-types: | None |
---|---|
Sub-types: | None |
Name | TreegraphDocumentType |
---|---|
Abstract | no |
Documentation | This is the type of the root element of a XTG document. |
Simple Type: BranchLengthType
Super-types: | xsd:double < BranchLengthType (by restriction) |
---|---|
Sub-types: | None |
Name | BranchLengthType |
---|---|
Content |
|
Documentation |
This class is used by the Length element, which specifies the length of a
branch. It restricts xsd:double
to non negative values.
|
Simple Type: ColorType
Super-types: | xsd:string < ColorType (by restriction) |
---|---|
Sub-types: | None |
Name | ColorType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to all valid color values. A valid color value in XTG starts
with a # followed by six hexadecimal charcters (e.g. #FF0000 for red).
|
Simple Type: DistanceValueType
Super-types: | xsd:float < DistanceValueType (by restriction) |
---|---|
Sub-types: | None |
Name | DistanceValueType |
---|---|
Content |
|
Documentation |
This class is used by elements specifying a non negative distance value. It restricts xsd:float .
|
Simple Type: LegendOrientationType
Super-types: | xsd:string < LegendOrientationType (by restriction) |
---|---|
Sub-types: | None |
Name | LegendOrientationType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to a enumeration of all valid
legend orientation values.
|
Simple Type: LegendStyleType
Super-types: | xsd:string < LegendStyleType (by restriction) |
---|---|
Sub-types: | None |
Name | LegendStyleType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to a enumeration of all valid
legend style values.
|
Simple Type: LocaleType
Super-types: | xsd:string < LocaleType (by restriction) |
---|---|
Sub-types: | None |
Name | LocaleType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to an empty string or a sequence of characters (a..z, A..Z).
It is used for the attributes of TextType which specify the locale information
used to format numeric values.
|
Simple Type: ScaleBarAlignType
Super-types: | xsd:string < ScaleBarAlignType (by restriction) |
---|---|
Sub-types: | None |
Name | ScaleBarAlignType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to a enumeration of all valid scale bar align values.
|
Simple Type: ScaleValueType
Super-types: | xsd:string < ScaleValueType (by restriction) |
---|---|
Sub-types: | None |
Name | ScaleValueType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to all valid scale bar width values. The width of a
scale bar is a float value followed by a unit identifier (mm for millimeters or
u for branch length units).
|
Simple Type: TextStyleType
Super-types: | xsd:string < TextStyleType (by restriction) |
---|---|
Sub-types: | None |
Name | TextStyleType |
---|---|
Content |
|
Documentation |
This type restricts a xsd:string to all valid text style values. A valid text style value in
XTG can consists of the combination of b (bold), i (italic) and
u (underlined).
|
Legend
Complex Type:
AusAddress
Super-types: | Address < AusAddress (by extension) |
---|---|
Sub-types: |
|
Name | AusAddress |
---|---|
Abstract | no |
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>
The XML Instance Representation table above shows the schema component's content as an XML instance.
- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
Glossary
Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.
Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.
Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions
(Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type
attribute.
Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.
Nillable
(Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil
attribute. The xsi:nil
attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil
attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.
Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.
Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.