HVML

Hypervideo Markup Language

The hvml Element

Last updated:

Contexts

  • Documents

Content Attributes

  • XML Root Node Attributes (e.g. xmlns)
  • XML Global Attributes (e.g. xml:id)

Definition

This is the root node. Limit one per document. Required.

Authoring

When using the XML serialization of HVML, one and only one XML prolog—e.g. <?xml version="1.0" encoding="UTF-8"?>SHOULD be specified before the root node, for the benefit of XML parsers. If an HVML document omits the prolog, or omits either of the two prolog attributes, the document will be assumed to be an XML 1.0 document, and/or encoded using UTF-8, respectively.

Examples

  1. A barebones configuration.

    Note: Although an attribute-less root element is conforming, this does not provide much context for the document’s contents, and is not recommended in most cases.

    <?xml version="1.0" encoding="UTF-8"?>
    <hvml></hvml>
  2. A configuration setting document language to English.

    <?xml version="1.0" encoding="UTF-8"?>
    <hvml xml:lang="en"></hvml>
  3. A configuration specifying the HVML namespace, and setting document language to French.

    Note: This is the recommended minimum configuration (with document language set appropriately).

    <?xml version="1.0" encoding="UTF-8"?>
    <hvml xmlns="https://hypervideo.tech/hvml#" xml:lang="fr"></hvml>