TextMedia XML Schema v1

From Xibo

The following schema defines the XML returned by the TextMediaModule in the server codebase, which is then rendered by the Xibo Client.

Items marked "required" are returned by the server currently, and are required for the client to successfully render the media. Other items may be returned by the server currently, but are either deprecated, or ignored by the Client.

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:element name="media">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="options">
                   <xs:complexType>
                       <xs:sequence>
                           <xs:element name="direction" default="none">
                               <xs:simpleType>
                                   <xs:restriction base="xs:string">
                                       <xs:enumeration value="none"/>
                                       <xs:enumeration value="up"/>
                                       <xs:enumeration value="down"/>
                                       <xs:enumeration value="left"/>
                                       <xs:enumeration value="right"/>
                                   </xs:restriction>
                               </xs:simpleType>
                           </xs:element>
                       </xs:sequence>
                   </xs:complexType>
               </xs:element>
               <xs:element name="raw">
                   <xs:complexType>
                       <xs:sequence>
                           <xs:element name="text" type="xs:CDATA" minOccurs="1"/>
                       </xs:sequence>
                   </xs:complexType>
               </xs:element>
           </xs:sequence>
           <xs:attribute name="id" type="xs:string" use="required"/>
           <xs:attribute name="schemaVersion" type="xs:integer" use="required" fixed="1"/>
           <xs:attribute name="duration" type="xs:positiveInteger" use="required" default="0"/>
           <xs:attribute name="type" type="xs:string" use="required" fixed="text"/>
           <xs:attribute name="lkid" type="xs:integer" use="required"/>
       </xs:complexType>
   </xs:element>
</xs:schema>

Example XML Output:

<media id="47cc1ffacdabb" type="text" duration="60" lkid="" schemaVersion="1">
   <options>
       <direction>none</direction>
   </options>
   <raw>
       <text>
           <![CDATA[

This is a piece of basic text

            ]]>
       </text>
   </raw>
</media>