ESS structure

From ESS
Jump to: navigation, search
Format ESS
Ess-feed-icon.png
.ess, .xml
application/ess+xml
version 0.9

ESS Structure

ESS Document is an XML (Extensible Markup Language) standard format RFC 3076 inherited from Atom/ 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 child elements consist of metadata elements that describe Events.




The <ess @attributes>


Name Description Type Required
xmlns Define the main XMLNS name for the current ESS Document. This value must be http://essfeed.org/history/0.9 String TRUE
version Define the current ESS feed encoding version. ESS processors should consider the last version as the one used to encode the current ESS Document. The current version id 0.9 String TRUE
lang Define a unique feed IRI ID. ESS processors should consider en (English) as the default language if the attribute is not specified. String ISO6391 TRUE



The <channel> XML child elements


Name Description Type Required
<title> Define the language-sensitive feed title. Should not be longer then 128 characters String TRUE
<link> Define the feed URL. Must be a valid URL Constructor. ESS processors should validate the feed origine with <people> <item type="author"> XML element (ess:people). URL RFC3986 TRUE
<id> Define a unique ESS feed IRI ID. ESS processors should use the <link> value to generate a unique IRI ID value. The <id> value should start with: ESSID:. IRI RFC3987 TRUE
<published> Define the Feed publishing Date. Date RFC3339 TRUE
<updated> Define the Feed updating Date. Date RFC3339 FALSE
<generator> 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
<rights> Define the Feed proprietary rights. Should not be longer then 512 chars. String FALSE



The <feed> XML child elements


Name Description Type Required
<title> Define the language-sensitive feed title. Should not be longer then 128 characters String TRUE
<uri> Define a unique Event page URL. Must be a valid URL. URL RFC3986 FALSE
<id> Define a unique Event ID. ESS processors should use the <uri> value to generate a unique IRI ID value. The <id> value should start with: EVENTID:. ESS processors should save and record ess IDs during feed live to link it with other IDs defined in <relations> XML section (ess:relations). IRI RFC3987 TRUE
<published> Define the Feed publishing Date. Date RFC3339 TRUE
<updated> Define the Feed updating Date. Date RFC3339 FALSE
<access> Define if the event have a public access. The value can only be PUBLIC or PRIVATE. String TRUE
<description> Event Feed description. This XML element contain the main event's description. ESS processors should use this content as the only event description. Using HTML inside this section is possible but should be limited to minimum necessary because ESS processors could use this information in an environment that can not read HTML (iCalendar format, mobile devices). String TRUE
<tags> XML structure that numerates an infinite number of <tag> XML childs elements with keywords content. ESS processors should use those keywords to specify the correct category that match with the event purpose. XML RFC3076 FALSE



Structure sample

DTD description [http://essfeed.org/history/0.9 ]

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ess PUBLIC "-//ESS//DTD" "http://essfeed.org/history/0.9/index.dtd">
<ess xmlns="http://essfeed.org/history/0.9" version="0.9" lang="en">
   <channel>
      <title>Football Stadium Events</title>
      <link>http://sample.com/feeds/sample.ess</link>
      <id>ESSID:3578:870970:76433:999</id>
      <published>2012-12-13T08:29:29:00Z</published>
      <updated>2012-12-13T18:30:02Z</updated>
      <generator>ess:php:generator:version:0.91</generator>
      <rights>Copyright (c) 2012, John Doe</rights>
 
      <feed>
          <title>Football match of saturday</title>
          <id>EVENTID:53578:857509570:7564533:979797</id>
          <uri>http://sample.com/events/specific-and-unique-event-page/</uri>
          <published>2012-12-13T08:29:29:00Z</published>
          <updated>2012-12-13T18:30:02Z</updated>
          <access>PUBLIC</access>
          <description>
              <![CDATA[
                  Welcome to my first football game.
                  This game is crucial.
                  Our team is up against the main league competitor. 
                  I hope to see you there! 
               ]]>
          </description>
          <tags>
              <tag>Sport<tag> 
              <tag>Football<tag> 
              <tag>Match<tag> 
          <tags>
 
           <categories/>  <!--  Defines event subject from a general to a precise category. -->
           <places/>      <!--  Defines where the event takes place. -->
           <dates/>       <!--  Defines when the event will happen. -->
           <prices/>      <!--  [OPTIONAL] Defines how much it will cost to attend the event. -->
           <people/>      <!--  [OPTIONAL] Caracterizes the attendees, organizers, participants and feed writers. -->
           <media/>       <!--  [OPTIONAL] Broadcasts several media files that present the event. -->
           <relations/>   <!--  [OPTIONAL] Connects events that share some elements (date, category, place...). -->
 
       </feed>
   </channel>
</ess>




Structure

XML Name Description Type Required
Ico ess categories.png <categories> XML section that defines event categories through one or various <item> XML elements. items structure is defined in <categories> section. This XML element is mandatory, it must be present in a valid ESS document. ess:item RFC3076 TRUE
Ico ess dates.png <dates> XML section that defines event dates through one or various <item> XML elements. items structure is defined in <dates> section. This XML element is mandatory, it must be present in a valid ESS document. ess:item RFC3076 TRUE
Ico ess places.png <places> XML section that define event places through one or various <item> XML elements. items structure is defined in <places> section. This XML element is mandatory, it must be present in a valide ESS document. ess:item RFC3076 TRUE
Ico ess prices.png <prices> XML section that define event prices categories through one or various <item> XML elements. items structure is defined in <prices> section. This XML element is not mandatory, ESS:Processors should consider the event as type="free" if it is not defined. ess:item RFC3076 FALSE
Ico ess peoples.png <people> XML section that defines interaction between event and people through one or various <item> XML elements. items structure is defined in <people> section. ess:item RFC3076 FALSE
Ico ess medias.png <media> XML section that defined Event Feed categories through one or various <item> XML elements. items structure is defined in <media> section. ess:item RFC3076 FALSE
Ico interactions.png <relations> XML section that defined Event Feed categories through one or various <item> XML elements. items structure is defined in <relations> section. ess:item RFC3076 FALSE



Structure sample

DTD description [http://essfeed.org/history/0.9 ]

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ess PUBLIC "-//ESS//DTD" "http://essfeed.org/history/0.9/index.dtd">
<ess xmlns="http://essfeed.org/history/0.9" version="0.9" lang="en">
 <channel>
   <feed>
      ...
      <categories>
        <item type="xxxx">...</item>
      </categories>
 
      <places>
        <item type="xxxx">...</item>
      </places>
 
      <dates>
        <item type="xxxx">...</item>
      </dates>
 
      <prices>
        <item type="xxxx" mode="xxxx">...</item>
      </prices>
 
      <people>
        <item type="xxxx">...</item>
      </people>
 
      <media>
        <item type="xxxx">...</item>
      </media>
 
      <relations>
        <item type="xxxx">...</item>
      </relations>
       ...
   </feed>
 </channel>
</ess>



Discussions

ESS Forum Discussion > General

Could not find wordpress article with a title like home







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

IF EVENTS MATTER TO YOU

Spread the news about ESS
Personal tools
Actions
Standard


Developers


Communication