Skip to content

The Elements of HVML

Hugh Guiney edited this page Aug 14, 2017 · 4 revisions

The hvml element

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

Contexts

  • Documents

Content Attributes

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

Examples

  1. A barebones configuration.

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

    <hvml></hvml>
  2. A configuration setting document language to English.

    <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).

    <hvml xmlns="http://vocab.nospoon.tv/ovml#" xml:lang="fr"></hvml>

The group element

An arbitrary grouping.

Contexts

  • As a child of hvml
  • As a child of group
  • As a child of glossary

Content Attributes

  • XML Global Attributes (e.g. xml:id)
  • type
    • Type: xs:string
    • Possible values:
      • As a child of hvml or group: series
      • As a child of glossary: profanity | nudity | sex | violence | drugs | scale

Examples

  1. As a child of hvml: Denoting an episodic television show.

    <group xml:id="hughs-vlog" type="series">
      <!---->
    </group>
  2. As a child of group: Denoting a distinct “season” or “series” of an episodic television show.

    <group xml:id="hughs-vlog" type="series">
      <group xml:id="season-01" type="series">
        <!---->
      </group>
    </group>
  3. As a child of glossary: Defining a group of content rating classifications.

    <group type="profanity">
      <rating code="L-" maturity="0" color="green">
        <title>No strong language</title>
      </rating>
      <!---->
      <rating code="L+" maturity="1" color="red">
        <title>Explicit language</title>
      </rating>
    </group>
  4. As a child of glossary: Defining a group of content ranking classifications.

    <group type="scale">
      <score xml:id="nstv-ma" code="Ma" rank="1">
        <title>Masterpiece</title>
      </score>
      <!---->
      <score xml:id="nstv-u" code="U" rank="0">
        <title>Unwatchable</title>
      </score>
    </group>

The title element

The video element

The episode element

The runtime element

The recorded element

The published element

The description element

The showing element