xstructural 0.0.1

ID	d792ce57-6851-415a-b6c9-18550e512136

1. Command-Line Interface
- 1.1. Overview
- 1.2. Schema
  - 1.2.1. Name
  - 1.2.2. Description
  - 1.2.3. Example
- 1.3. Validate
  - 1.3.1. Name
  - 1.3.2. Description
  - 1.3.3. Example
- 1.4. XHTML
  - 1.4.1. Name
  - 1.4.2. Description
  - 1.4.3. Example

2. API
- 2.1. Usage
- 2.2. JavaDoc

3. Schema

1

Command-Line Interface

1. Command-Line Interface
- 1.1. Overview
- 1.2. Schema
  - 1.2.1. Name
  - 1.2.2. Description
  - 1.2.3. Example
- 1.3. Validate
  - 1.3.1. Name
  - 1.3.2. Description
  - 1.3.3. Example
- 1.4. XHTML
  - 1.4.1. Name
  - 1.4.2. Description
  - 1.4.3. Example

1.1

Overview

1

The xstructural package provides a command-line interface for performing tasks such as validating input documents, and transforming documents to various output formats. The base xstructural command is broken into a number of subcommands which are documented over the following sections.

2

1.1.2 Command-Line Overview

Usage: xstructural [options] [command] [command options]
  Options:
    --verbose
      Set the minimum logging verbosity level
      Default: info
      Possible Values: [trace, debug, info, warn, error]
  Commands:
    validate      Validate a structural document
      Usage: validate [options]
        Options:
        * --sourceFile
            The source document
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    xhtml      Transform a structural document to XHTML
      Usage: xhtml [options]
        Options:
          --brandingFile
            The branding XML file
          --copyResources
            Should resources (such as CSS) be copied into the output
            directory?
            Default: true
          --messagesFile
            The output file for XSLT messages
        * --outputDirectory
            The output directory
        * --sourceFile
            The source document
          --stylesheet
            The stylesheet
            Default: SINGLE_FILE
            Possible Values: [SINGLE_FILE, MULTIPLE_FILE]
          --traceFile
            The output file for trace messages
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    schema      Export the structural schemas to files
      Usage: schema [options]
        Options:
        * --outputDirectory
            The output directory
          --replace
            Replace output files if they already exist
            Default: false
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

1.2

Schema

1.2. Schema
- 1.2.1. Name
- 1.2.2. Description
- 1.2.3. Example

1.2.1

Name

1

schema - Export schemas

1.2.2

Description

1

The schema command exports the Structural schema files into a specified directory.

2

1.2.2.2 Parameters

Parameter	Type	Required	Description
--outputDirectory	Path	true	The path to the output directory.
--replace	Boolean	false	If set to true, any existing files will be replaced.

1.2.3

Example

1

1.2.3.1 Example

$ xstructural schema --outputDirectory xsd

$ ls -alF xsd/
total 40
drwxr-xr-x  2 xs xs  4096 Apr 28 09:59 ./
drwxr-xr-x 13 xs xs  4096 Apr 28 09:59 ../
-rw-r--r--  1 xs xs  4944 Apr 28 09:59 dc.xsd
-rw-r--r--  1 xs xs  4726 Apr 28 09:59 xml.xsd
-rw-r--r--  1 xs xs 15599 Apr 28 09:59 xstructural-1.xsd

$ xstructural schema --outputDirectory xsd
xstructural: XSCommandSchema: INFO: output file xsd/dc.xsd already exists, ignoring
xstructural: XSCommandSchema: INFO: output file xsd/xml.xsd already exists, ignoring
xstructural: XSCommandSchema: INFO: output file xsd/xstructural-1.xsd already exists, ignoring

$ echo hello > xsd/xstructural-1.xsd

$ ls -alF xsd/
total 40
drwxr-xr-x  2 xs xs  4096 Apr 28 09:59 ./
drwxr-xr-x 13 xs xs  4096 Apr 28 09:59 ../
-rw-r--r--  1 xs xs  4944 Apr 28 09:59 dc.xsd
-rw-r--r--  1 xs xs  4726 Apr 28 09:59 xml.xsd
-rw-r--r--  1 xs xs     6 Apr 28 10:13 xstructural-1.xsd

$ xstructural schema --outputDirectory xsd --replace true

$ ls -alF xsd/
total 40
drwxr-xr-x  2 xs xs  4096 Apr 28 10:14 ./
drwxr-xr-x 13 xs xs  4096 Apr 28 10:10 ../
-rw-r--r--  1 xs xs  4944 Apr 28 10:14 dc.xsd
-rw-r--r--  1 xs xs  4726 Apr 28 10:14 xml.xsd
-rw-r--r--  1 xs xs 15599 Apr 28 10:14 xstructural-1.xsd

1.3

Validate

1.3. Validate
- 1.3.1. Name
- 1.3.2. Description
- 1.3.3. Example

1.3.1

Name

1

validate - Validate input documents

1.3.2

Description

1

The validate command validates a given document against the Structural schema.

2

1.3.2.2 Parameters

Parameter	Type	Required	Description
--sourceFile	Path	true	The path to the input document.

1.3.3

Example

1

1.3.3.1 Example

$ xstructural validate --sourceFile com.io7m.xstructural.documentation/target/documentation/main.xml
xstructural: XSValidator: INFO: validate (xstructural) com.io7m.xstructural.documentation/target/documentation/main.xml

$ echo $?
0

$ xstructural validate --sourceFile README-CHANGES.xml
xstructural: XSValidator: INFO: validate (xstructural) README-CHANGES.xml
xstructural: validation: ERROR: README-CHANGES.xml:2:82: cvc-elt.1.a: Cannot find the declaration of element 'c:changelog'.
xstructural: XSValidator: ERROR: one or more validation errors occurred
xstructural: Main: ERROR: com.io7m.xstructural.api.XSValidationException: Document README-CHANGES.xml is not a valid structural document

$ echo $?
1

1.4

XHTML

1.4. XHTML
- 1.4.1. Name
- 1.4.2. Description
- 1.4.3. Example

1.4.1

Name

1

xhtml - Produce XHTML

1.4.2

Description

1

The xhtml command produces XHTML pages for the given input document.

2

1.4.2.2 Parameters

Parameter	Type	Required	Description
--brandingFile	Path	false	The path to the branding document.
--copyResources	Boolean	false	If set to true, resources such as the default Structural CSS files will be copied to the output directory.
--messagesFile	Path	false	A file that will contain XSLT debugging messages.
--traceFile	Path	false	A file that will contain XSLT trace messages.
--sourceFile	Path	true	The path to the input document.
--outputDirectory	Path	true	The directory to which output files will be written.
--stylesheet	Stylesheet	false	The XSLT stylesheet that will be used.

1.4.3

Example

1

1.4.3.1 Example

$ xstructural xhtml \
  --sourceFile com.io7m.xstructural.documentation/target/documentation/main.xml \
  --stylesheet SINGLE_FILE \
  --outputDirectory out
xstructural: XSValidator: INFO: validate (xstructural) com.io7m.xstructural.documentation/target/documentation/main.xml
xstructural: XSTransformer: INFO: copy resource reset.css
xstructural: XSTransformer: INFO: copy resource structural.css
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/index.xhtml

$ ls -alF out/
total 116
drwxr-xr-x  2 xs xs  4096 Apr 28 10:26 ./
drwxr-xr-x 14 xs xs  4096 Apr 28 10:26 ../
-rw-r--r--  1 xs xs 30783 Apr 28 10:26 index.xhtml
-rw-r--r--  1 xs xs   272 Apr 28 10:26 messages.log
-rw-r--r--  1 xs xs  6138 Apr 28 10:26 reset.css
-rw-r--r--  1 xs xs  6881 Apr 28 10:26 structural.css
-rw-r--r--  1 xs xs 57239 Apr 28 10:26 trace.xml

$ xstructural xhtml \
  --sourceFile com.io7m.xstructural.documentation/target/documentation/main.xml \
  --stylesheet MULTIPLE_FILE \
  --outputDirectory out
xstructural: XSValidator: INFO: validate (xstructural) com.io7m.xstructural.documentation/target/documentation/main.xml
xstructural: XSTransformer: INFO: copy resource reset.css
xstructural: XSTransformer: INFO: copy resource structural.css
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e104.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e298.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e300.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e12.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e163.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e28.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/index-m.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/index.xhtml
xstructural: XSXHTMLValidator: INFO: validate (xhtml 1.1) out/d2e14.xhtml

$ ls -alF out/
total 172
drwxr-xr-x  2 xs xs  4096 Apr 28 10:35 ./
drwxr-xr-x 14 xs xs  4096 Apr 28 10:26 ../
-rw-r--r--  1 xs xs  7187 Apr 28 10:35 d2e104.xhtml
-rw-r--r--  1 xs xs  5251 Apr 28 10:35 d2e12.xhtml
-rw-r--r--  1 xs xs  5914 Apr 28 10:35 d2e14.xhtml
-rw-r--r--  1 xs xs  7405 Apr 28 10:35 d2e163.xhtml
-rw-r--r--  1 xs xs  8016 Apr 28 10:35 d2e28.xhtml
-rw-r--r--  1 xs xs  3175 Apr 28 10:35 d2e298.xhtml
-rw-r--r--  1 xs xs  3366 Apr 28 10:35 d2e300.xhtml
-rw-r--r--  1 xs xs  5746 Apr 28 10:35 index-m.xhtml
-rw-r--r--  1 xs xs 30783 Apr 28 10:26 index.xhtml
-rw-r--r--  1 xs xs     0 Apr 28 10:35 messages.log
-rw-r--r--  1 xs xs  6138 Apr 28 10:35 reset.css
-rw-r--r--  1 xs xs  6881 Apr 28 10:35 structural.css
-rw-r--r--  1 xs xs 60237 Apr 28 10:35 trace.xml

2

API

2. API
- 2.1. Usage
- 2.2. JavaDoc

2.1

Usage

1

2.1.1 Usage

var factory =
  ServiceLoader.load(XSProcessorFactoryType.class)
    .findFirst()
    .orElseThrow(() -> new IllegalStateException("Missing factory service"));

final var request =
  XSProcessorRequest.builder()
    .setOutputDirectory(Paths.get(...))
    .setSourceFile(Paths.get(...))
    .setTask(Task.TRANSFORM_XHTML)
    .setStylesheet(Stylesheet.SINGLE_FILE)
    .build();

final var processor = processors.create(request);
processor.execute();

2.2

JavaDoc

1

Please see the included JavaDoc for API reference documentation.

3

Schema

1

The Structural language is defined by a strict XSD schema. Documents not conforming to the schema MUST be rejected by renderers.

2

3.2 xstructural Schema

<?xml version="1.0" encoding="UTF-8" ?>

<!--
  Copyright © 2020 Mark Raynsford <code@io7m.com> http://io7m.com

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
  IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-->

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:xsl="http://www.w3.org/2001/XMLSchema"
            elementFormDefault="qualified"
            xmlns:dc="http://purl.org/dc/elements/1.1/"
            xmlns:s="urn:com.io7m.structural:7:0"
            targetNamespace="urn:com.io7m.structural:7:0">

  <xsd:import namespace="http://purl.org/dc/elements/1.1/"
              schemaLocation="dc.xsd"/>
  <xsd:import namespace="http://www.w3.org/XML/1998/namespace"
              schemaLocation="xml.xsd"/>

  <xsd:simpleType name="uuidType">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A UUID value.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:simpleType name="imageTextType">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The type of text that appears in image elements. This is required to be of non-zero length in order to ensure
        that authors add useful text that will then be used in the 'alt' elements of XHTML generated from the document
        sources.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:string">
      <xsd:minLength value="1"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:simpleType name="typeType">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The type of type names. Type names are used to categorize elements and are somewhat analogous to CSS classes,
        except that they are intended to be used for more than just styling documents.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="[a-zA-Z][a-zA-Z0-9_\.\-]*"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:attributeGroup name="standardXMLAttributes">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The standard elements expected to appear in XML texts.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:attribute ref="xml:base"/>
    <xsd:attribute ref="xml:lang"/>
  </xsd:attributeGroup>

  <xsd:attributeGroup name="tableOfContentAttributes">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The attributes used to describe tables of content.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:attribute name="tableOfContents"
                   use="optional"
                   default="true"
                   type="xsd:boolean">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          If the value of the attribute is 'true', then a table of contents will be generated in the respective element.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="tableOfContentsDepth"
                   use="optional"
                   default="3"
                   type="xsd:positiveInteger">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          The maximum relative depth of sections and subsections that will appear in a generated table of contents.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:attributeGroup>

  <xsd:element name="Image">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        An element used to describe an image. The text content of the image element SHOULD be used to provide an
        accessible description of the image. This description is expected to be used by screen readers, and may also be
        displayed by browsers if the referenced image cannot be loaded for any reason.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:simpleContent>
        <xsd:extension base="s:imageTextType">
          <xsd:attributeGroup ref="s:standardXMLAttributes"/>

          <xsd:attribute name="type"
                         type="s:typeType"
                         use="optional">
            <xsd:annotation>
              <xsd:documentation xml:lang="en">
                The type of the image.
              </xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="width"
                         type="xsd:nonNegativeInteger"
                         use="optional">
            <xsd:annotation>
              <xsd:documentation xml:lang="en">
                The width of the image.
              </xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="height"
                         type="xsd:nonNegativeInteger"
                         use="optional">
            <xsd:annotation>
              <xsd:documentation xml:lang="en">
                The height of the image.
              </xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="source"
                         type="xsd:anyURI"
                         use="required">
            <xsd:annotation>
              <xsd:documentation xml:lang="en">
                The source location of the image.
              </xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
        </xsd:extension>
      </xsd:simpleContent>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Item">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        An item appearing in a list.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:sequence minOccurs="0"
                    maxOccurs="unbounded">
        <xsd:group ref="s:ListContent"/>
      </xsd:sequence>
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>
      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the list item.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:group name="ListContent">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The elements that may appear in list items.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:choice>
      <xsd:element ref="s:Image"/>
      <xsd:element ref="s:Link"/>
      <xsd:element ref="s:LinkExternal"/>
      <xsd:element ref="s:LinkFootnote"/>
      <xsd:element ref="s:ListOrdered"/>
      <xsd:element ref="s:ListUnordered"/>
      <xsd:element ref="s:Term"/>
    </xsd:choice>
  </xsd:group>

  <xsd:element name="ListOrdered">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        An ordered list.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence minOccurs="1"
                    maxOccurs="unbounded">
        <xsd:element ref="s:Item"/>
      </xsd:sequence>
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>
      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the list.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="ListUnordered">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        An unordered list.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence minOccurs="1"
                    maxOccurs="unbounded">
        <xsd:element ref="s:Item"/>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the list.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Column">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A description of a column in a table.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the column.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Columns">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A set of table column descriptions.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence minOccurs="1"
                    maxOccurs="unbounded">
        <xsd:element ref="s:Column"/>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the columns.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:group name="TableContent">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The type of content that may appear in table cells.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:choice>
      <xsd:element ref="s:Link"/>
      <xsd:element ref="s:LinkExternal"/>
      <xsd:element ref="s:LinkFootnote"/>
      <xsd:element ref="s:Term"/>
    </xsd:choice>
  </xsd:group>

  <xsd:element name="Cell">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A cell in a table.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:sequence minOccurs="0"
                    maxOccurs="unbounded">
        <xsd:group ref="s:TableContent"/>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the cell.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Row">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A row of cells in a table.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence minOccurs="1"
                    maxOccurs="unbounded">
        <xsd:element ref="s:Cell"/>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>
      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the row.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Table">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A table. A table consists of a list of column definitions, followed by a sequence of rows consisting of the
        table cells.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence>
        <xsd:element ref="s:Columns"/>
        <xsd:sequence minOccurs="1"
                      maxOccurs="unbounded">
          <xsd:element ref="s:Row"/>
        </xsd:sequence>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the table.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Term">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A term acts as a simple container of one or more words in a sentence. Term elements can be used to denote the
        semantics of words, such as wrapping the name of a mathematical function in a &lt;Term type="function"&gt;
        element.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute type="s:typeType"
                     name="type"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the term.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Link">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A Link element describes a link to an element within the current document. Links may only refer to elements that
        contain an appropriate 'id' attribute.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute type="s:uuidType"
                     name="target"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The target of the link, which must be an element with an appropriate 'id' attribute.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the link.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="LinkFootnote">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A LinkFootnote element describes a link to a footnote within the current section.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute type="s:uuidType"
                     name="target"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The target of the link, which must be a Footnote with a matching 'id' attribute.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the link.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="LinkExternal">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A LinkExternal element describes a link to an external URI.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute type="xsd:anyURI"
                     name="target"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The target URI.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the link.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Verbatim">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A Verbatim element contains text that should be reproduced exactly, with almost all whitespace intact. Renderers
        are permitted to trim leading and trailing whitespace.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the verbatim text.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:group name="FormalItemContent">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The type of content that can appear in formal items.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:choice>
      <xsd:element ref="s:Image"/>
      <xsd:element ref="s:Link"/>
      <xsd:element ref="s:LinkExternal"/>
      <xsd:element ref="s:LinkFootnote"/>
      <xsd:element ref="s:ListOrdered"/>
      <xsd:element ref="s:ListUnordered"/>
      <xsd:element ref="s:Table"/>
      <xsd:element ref="s:Term"/>
      <xsd:element ref="s:Verbatim"/>
    </xsd:choice>
  </xsd:group>

  <xsd:group name="ParagraphContent">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The type of content that can appear in paragraphs.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:choice>
      <xsd:element ref="s:Link"/>
      <xsd:element ref="s:LinkExternal"/>
      <xsd:element ref="s:LinkFootnote"/>
      <xsd:element ref="s:ListOrdered"/>
      <xsd:element ref="s:ListUnordered"/>
      <xsd:element ref="s:Term"/>
    </xsd:choice>
  </xsd:group>

  <xsd:element name="Metadata">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        An element containing document metadata.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:group ref="dc:elementsGroup"/>
      <xsd:attributeGroup ref="s:standardXMLAttributes"/>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Paragraph">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A paragraph denotes a self-contained series of sentences.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:sequence minOccurs="0"
                    maxOccurs="unbounded">
        <xsd:group ref="s:ParagraphContent"/>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the paragraph.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="id"
                     type="s:uuidType"
                     use="optional"/>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="FormalItem">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A formal item is analogous to a "figure" in printed text. Formal items are used to significant images, tables of
        data, code listings, and other important objects into texts. They are considered to be at the same level of
        structural significance as paragraphs.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:group ref="s:FormalItemContent"/>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="id"
                     type="s:uuidType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The unique identifier of the formal item.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="title"
                     type="xsd:string"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The title of the formal item.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:group name="SubsectionContent">
    <xsd:choice>
      <xsd:element ref="s:Paragraph"/>
      <xsd:element ref="s:FormalItem"/>
    </xsd:choice>
  </xsd:group>

  <xsd:element name="Subsection">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A Subsection is a structural element that denotes a part of the document similar to a chapter.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsl:choice>
        <xsd:sequence minOccurs="1"
                      maxOccurs="unbounded">
          <xsd:element ref="s:Subsection"/>
        </xsd:sequence>
        <xsd:sequence minOccurs="1"
                      maxOccurs="unbounded">
          <xsd:group ref="s:SubsectionContent"/>
        </xsd:sequence>
      </xsl:choice>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the subsection.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="id"
                     type="s:uuidType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The unique identifier of the subsection.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="title"
                     type="xsd:string"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The title of the subsection.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:group name="FootnoteContent">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The type of content that may appear in footnotes.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:choice>
      <xsd:element ref="s:Image"/>
      <xsd:element ref="s:Link"/>
      <xsd:element ref="s:LinkExternal"/>
      <xsd:element ref="s:LinkFootnote"/>
      <xsd:element ref="s:ListOrdered"/>
      <xsd:element ref="s:ListUnordered"/>
      <xsd:element ref="s:Table"/>
      <xsd:element ref="s:Term"/>
      <xsd:element ref="s:Verbatim"/>
    </xsd:choice>
  </xsd:group>

  <xsd:element name="Footnote">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A Footnote is a note of referenc or comment usually placed at the bottom of a page. Footnotes may be referenced
        by LinkFootnote elements.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType mixed="true">
      <xsd:sequence minOccurs="0"
                    maxOccurs="unbounded">
        <xsd:group ref="s:FootnoteContent"/>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>

      <xsd:attribute name="id"
                     type="s:uuidType"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The unique identifier of the footnote.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>

  <xsd:element name="Section">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        A Section is a structural element that denotes a part of the document similar to a chapter. Renderers that
        produce multiple pages MUST insert whatever is analogous to a page break at the end of a section.
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence>
        <xsd:choice>
          <xsd:sequence minOccurs="1"
                        maxOccurs="unbounded">
            <xsd:element ref="s:Section"/>
          </xsd:sequence>
          <xsd:sequence minOccurs="1"
                        maxOccurs="unbounded">
            <xsd:element ref="s:Subsection"/>
          </xsd:sequence>
          <xsd:sequence minOccurs="1"
                        maxOccurs="unbounded">
            <xsd:group ref="s:SubsectionContent"/>
          </xsd:sequence>
        </xsd:choice>
        <xsd:sequence minOccurs="0"
                      maxOccurs="unbounded">
          <xsd:element ref="s:Footnote"/>
        </xsd:sequence>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>
      <xsd:attributeGroup ref="s:tableOfContentAttributes"/>

      <xsd:attribute name="type"
                     type="s:typeType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The type of the section.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="id"
                     type="s:uuidType"
                     use="optional">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The unique identifier of the section.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>

      <xsd:attribute name="title"
                     type="xsd:string"
                     use="required">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            The title of the section.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>

    <xsd:unique name="SectionFootnoteKey">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All footnotes within a section must have unique identifiers.
        </xsd:documentation>
      </xsd:annotation>
      <xsd:selector xpath="s:Footnote"/>
      <xsd:field xpath="@id"/>
    </xsd:unique>

    <xsd:keyref name="SectionFootnoteReferences"
                refer="s:SectionFootnoteKey">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All footnote links must refer to footnotes that exist.
        </xsd:documentation>
      </xsd:annotation>
      <xsd:selector xpath=".//s:LinkFootnote"/>
      <xsd:field xpath="@target"/>
    </xsd:keyref>
  </xsd:element>

  <xsd:element name="Document">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The Document element represents the top-level structure of a document. The name 'document' is somewhat of a
        misnomer, as nothing prevents the document from being structured as a book (with chapters, etc). The document
        begins with standard Dublin Core metadata, and contains _either_ a series of sections _or_ a series of
        subsections (but not both).
      </xsd:documentation>
    </xsd:annotation>

    <xsd:complexType>
      <xsd:sequence>
        <xsd:element ref="s:Metadata"/>
        <xsd:choice>
          <xsd:sequence minOccurs="1"
                        maxOccurs="unbounded">
            <xsd:element ref="s:Section"/>
          </xsd:sequence>
          <xsd:sequence minOccurs="1"
                        maxOccurs="unbounded">
            <xsd:element ref="s:Subsection"/>
          </xsd:sequence>
        </xsd:choice>
        <xsd:sequence minOccurs="0"
                      maxOccurs="unbounded">
          <xsd:element ref="s:Footnote"/>
        </xsd:sequence>
      </xsd:sequence>

      <xsd:attributeGroup ref="s:standardXMLAttributes"/>
      <xsd:attributeGroup ref="s:tableOfContentAttributes"/>
    </xsd:complexType>

    <xsd:unique name="ItemIDsAreUnique">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All 'id' attributes specified on objects within the document must be unique.
        </xsd:documentation>
      </xsd:annotation>

      <xsd:selector xpath=".//s:FormalItem|.//s:Paragraph|.//s:Subsection|.//s:Section|.//s:Footnote"/>
      <xsd:field xpath="@id"/>
    </xsd:unique>

    <xsd:unique name="LinkReferencesAreUnique">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All 'id' attributes specified on objects within the document must be unique.
        </xsd:documentation>
      </xsd:annotation>

      <xsd:selector xpath=".//s:FormalItem|.//s:Paragraph|.//s:Subsection|.//s:Section"/>
      <xsd:field xpath="@id"/>
    </xsd:unique>

    <xsd:keyref name="LinkReferences"
                refer="s:LinkReferencesAreUnique">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All Link elements must refer to elements with existing 'id' attributes.
        </xsd:documentation>
      </xsd:annotation>

      <xsd:selector xpath=".//s:Link"/>
      <xsd:field xpath="@target"/>
    </xsd:keyref>

    <xsd:unique name="DocumentFootnoteKey">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All 'id' attributes specified on footnotes within the document must be unique.
        </xsd:documentation>
      </xsd:annotation>

      <xsd:selector xpath="s:Footnote"/>
      <xsd:field xpath="@id"/>
    </xsd:unique>

    <xsd:keyref name="DocumentFootnoteReferences"
                refer="s:DocumentFootnoteKey">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
          All footnote references must refer to footnotes that exist.
        </xsd:documentation>
      </xsd:annotation>

      <xsd:selector xpath="s:Subsection/*/s:LinkFootnote"/>
      <xsd:field xpath="@target"/>
    </xsd:keyref>
  </xsd:element>

</xsd:schema>