ESS structure

From ESS
(Redirected from XML structure)
Jump to: navigation, search
Format ESS
Ess-feed-icon.png
.ess, .xml
application/ess+xml
version 0.9

Contents

ESS Structure

ESS Document is an XML (Extensible Markup Language) standard format RFC 3076 inherited from Atome / RSS Feeds Standard RFC 4287 as explained in sections ESS History and ESS Document. "ess:feed" element is the Feed Document, acting as a container for metadata and data associated with the feed. Its children element consist of metadata elements that describe Event.
This section discribe and defined imediate childs of "ess:feed" element, those childs are divided in two groups:

  1. Group of "first XML childs without descendants" with String content that must respect XML encoding protocol describe by the XML header structure.
  2. Group of "main XML elements" that must contain, if they are present, at least, one XML element as imediate child.




Childs without descendants

This section describe first XML elements of "ess:feed" that do not have XML children but String content. If element is present, it must respect XML encoding protocol describe in current XML header. The elements: title, id and link are mandatory. published element should be present in a ESS document. Other XML elements are recommended to be present but are not mandatory.
ESS processors should consider as valid or invalid ESS documents according to the recommended elements. Each of this "First childs of "ess:feed" without descendants" must be unique, they must not be be repeated within ESS Documents.




Structure

Name Description Type Required
Define the language-sensitive feed title. Should not be longer then 128 characters String TRUE
Define the language-sensitive feed subtitle. Should not be longer then 256 characters String FALSE
Define the feed URL. Must be a valid URL Constructor. ESS processors should validate the feed origine with XML section (ess:authors). URL RFC3986 TRUE
Define a unique feed IRI ID. ESS processors should save and record ess IDs during feed live to link it with other IDs defined in XML section (ess:relations). IRI RFC3987 TRUE
Define the Feed publishing Date. Date RFC3339 FALSE
Define the Feed updating Date. Date RFC3339 FALSE
Define the Feed generator (script library, ESS CMS module, portal name), more details in ESS libraries and ESS generator. Should not be longer then 64 chars. String FALSE
Define the Feed proprietary rights. Should not be longer then 512 chars. String FALSE
Event Feed description. This XML element contain the main text event description. ESS processors should use this content as main event description. Using HTML inside this section is not recommended because ESS processors could use this information in an environment that can not read HTML (car device interface, iCal on mac...). String FALSE



Structure sample

DTD description [https://eventstandardsyndication.org/history/0.9 ]

 version="1.0" encoding="UTF-8"?>
 xmlns="https://eventstandardsyndication.org/history/0.9" version="0.9" lang="en">
   >
      >Football match of saturday>
      >Match every saturdays>
      >https://eventstandardsyndication.org/feeds/sample.ess>
      >[email protected]>
      >2011-12-13T08:29:29-04:00>
      >2011-12-13T18:30:02Z>
      >ess:js:generator:v0.9.156>
      >Copyright (c) 2012, John Doe>
      >
        
            Welcome to my first football match event.
 
            This football match is very important.
            As our teem meet the main compeitor of the league. 
 
            I hope to see you soon ! 
        ]]>
      >
 
      />
      />
      />
      /> 
      />  
      />
      /> 
      />  
 
   >
>




Structure

XML Name Description Type Required
XML section that define Event categories through one or various XML elements. items structure is defined in section. This XML element is mandatory, it must be present in a valide ESS document. ess:item RFC3076 TRUE
XML section that define event dates through one or various XML elements. items structure is defined in section. This XML element is mandatory, it must be present in a valide ESS document. ess:item RFC3076 TRUE
XML section that define event places through one or various XML elements. items structure is defined in section. This XML element is mandatory, it must be present in a valide ESS document. ess:item RFC3076 TRUE
XML section that define event prices categories through one or various XML elements. items structure is defined in section. This XML element is mandatory, it must be present in a valide ESS document. ess:item RFC3076 TRUE
XML section that define interation between event and people through one or various XML elements. items structure is defined in section. ess:item RFC3076 FALSE
XML section that defined Event Feed categories through one or various XML elements. items structure is defined in section. ess:item RFC3076 FALSE
XML section that defined Event Feed categories through one or various XML elements. items structure is defined in section. ess:item RFC3076 FALSE
XML section that defined Event Feed categories through one or various XML elements. items structure is defined in section. ess:item RFC3076 FALSE



Structure sample

DTD description [https://eventstandardsyndication.org/history/0.9 ]

 version="1.0" encoding="UTF-8"?>
 xmlns="https://eventstandardsyndication.org/history/0.9" version="0.9" lang="en">
   >
      ...
      >
        >...>
      >
 
      >
        >...>
      >
 
      >
        >...>
      >
 
      >
        >...>
      >
 
      >
        >...>
      >
 
      >
        >...>
      >
 
      >
        >...>
      >
 
      >
        >...>
      >
       ...
   >
>







External documentation

Ietf logo.png

ESS standard under RFC validation process: RFC ESS Draft

  • RFC 3076 : Canonical XML Version 1.0
  • RFC 3339 : Date and Time on the Internet: Timestamps
  • RFC 3986 : Uniform Resource Identifier (URI): Generic Syntax
  • RFC 3987 : Internationalized Resource Identifiers (IRIs)
  • RFC 4287 : The Atom Syndication Format




Discussion


Leave your comment

Personal tools
Namespaces
Variants
Actions
Standard

 

Developers