Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Requirement: This is populated with 1 of 3 values, applicable to the element as a whole entity. Note that the Requirement's values "Required" and "Optional", as well as the Cardinality information, are indicated in the element's parent element definition. Therefore, element tables will normally include the conditionality information under this heading.
  • "Required" when at least 1 instance of the element is required
  • "Optional" when the element is optional
  • "Conditional" when at least 1 instance of the element is required under certain conditions. It will include the conditions under which the element is Required.
  • Cardinality: This indicates the number of instances expected (e.g., "Exactly one", "One or more")
    Element NameName of the element
    Parent Element(s)ElementsA comma-delimited list of the elements that have this element as a child element. A link to each parent element will be provided.
    Element XPath(s)List of different XPath values showing where the element belongs in the XML
    Element Textual ValueA description of the value of the element. If an element has no text value (e.g., it has child elements instead), then this cell is populated with "None".
    AttributesA comma-delimited list of the attributes of this element. If the element has no attributes, this is populated with "None".
    Child Elements
    • A comma-delimited list of the immediate child elements of this element. If the element has no child elements, this is populated with "None". The order of child elements shown in the specification is the order in which they must appear in a ODM document.
    • A link to a child element will be provided when the child element is described in a different section of the document and not under a subsection of the element being described or in the section or subsection immediately following the current element.
    • In some cases, a subset of the child elements may be part of an element group.  When this occurs, the members of the element group are included in parenthesis.
    • When a child element or element group is followed by a question mark ("?"), the element or group is optional. When followed by an asterisk ("*"), zero or more are allowed. When followed by a plus sign ("+"), there must be 1 but may be many occurrences of the  element or group.
    Usage/Business Rules

    An element group enclosed in parentheses.

    • An element group consists of one or more element names, or element groups enclosed in parentheses, and separated with commas or vertical bars.
    • Commas indicate that the elements (or element groups) must occur in the XML sequentially in the order listed in the group. Vertical bars indicate that exactly one of the elements (or element groups) must occur (is required).
    • An element or element group can be followed by one of the following characters:
      • ? (meaning optional, with zero or one occurrence)
      • * (meaning optional, with zero or more occurrences)
      • + (meaning required, with one or more occurrences)
    • When an element or element group is not followed by ?, *, or + it means that the element or element group occurs exactly once.

    If the element has no child elements, this is populated with "None".

    A link to each child element will be provided.

    Usage/Business Rules
    • Business Rule(s): Beyond what is required for schema validation, these represent conformance rules that must be satisfied for a ODM document to be considered compliant with this specification.
    • Other Information: This is populated with any other information about the element, including the conditions under which the element is included, how the schema is applied to support the model, relative position of the element in the model, general information about usage of related element attributes or related child elements, and so on.