ESS:Dates

From ESS
Revision as of 21:35, 15 April 2013 by Admin ess (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Format ESS
Ess-feed-icon.png
.ess, .xml
application/ess+xml
version 0.9

Contents

"Dates" definition

An event is comprised of several attributes, one of the most important being when the event takes place. An event can be unique/one time or recurring. Event dates are represented in ESS through two element "type" attributes. These types represent every time and date situation:

STANDALONE EVENT

RECURRENT EVENT

PERMANENT EVENT

DATE RANGE EVENT

Less than one day.

Repeats itself recursively.

Constantly active

Happens over several days.

ESS structure

ESS documents are composed of various main XML elements. ESS processors must consider each and every element's description as valid and applicable to each and every other XML element within the same ESS document. If it is not the case, it belongs to another feed to describe this event parameter.
Example: every items must be valid and applicable to every and items within the same feed.

XML element (ess:dates) must be defined within ESS Documents, it is a mandatory ESS XML element.
This section describes the interaction between ESS events and the dates. (ess:dates) XML element must be composed by, at least, one (ess:item) XML element.
Several elements can be defined within XML structure to represent events that happen at several different times.


Dates


Name Description Type Required
type The "type" attribute can have three values: "standalone", permanent or "recurrent" to represent if the event has a simple unique date, is constantly available or repeats itself several times. In the case of a type="recurrent", the "unit" attibute must be defined. ESS Processors should consider that "standalone" is the default "type" attribute value if it is not specified. String TRUE
unit The "unit" attribute only applies if type="recurrent" is specified. The "unit" attribute can take five values: "hour", "day", "week", "month" or "year". ESS processors should consider "hour" as the default "unit" attribute if it is not specified. String TRUE
FALSE
limit The "limit" attribute only applies if type="recurrent" is specified. The "limit" attribute is optional and defines the number of times the recurrent event will happen. If the "limit" attribute is not specified or if limits equal zero ESS Processors should consider the as infinite. Number FALSE
interval The "interval" attribute only applies if type="recurrent" is specified. The "interval" attribute is optional and defines the number of times the recurrent event has to be rescheduled for the "unit" attribute to happen again. If the "interval" attribute is not specified ESS Processors should be considered the with a interval="1". Number FALSE
selected_day The "selected_day" attribute can take eight values: "number", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" or "sunday". The "selected_day" attribute only applied if type="recurrent" is specified and if the unit attribute is "week" or "month". The "selected_day" attribute is optional and defines the type of "unit" attribute that has to be considered as repeated. String FALSE
selected_week The "selected_week" attribute can take five values: "first", "second", "third", "fourth" or "last". The "selected_week" attribute only applies if type="recurrent" is specified and if the unit attribute is "month". The "selected_week" attribute is optional and defines the section of the month that has to considered to be repeated. If the "selected_zone" attribute is not specified ESS Processors should be considered the as selected_week="0". String FALSE
priority The "priority" attribute refers to the order and the preference applied to each XML element. ESS processors should consider the natural position as the priority if this attribute is not defined. Number FALSE




Dates childs elements


Name Description Type Required
Language-sensitive date name. Should not be longer then 64 chars String TRUE
Defines event starting Date. Date RFC3339 TRUE
Defines event time duration in seconds and starting from Date value. If the is with a type="recurrent", the duration value applies for each recurrency. Number FALSE




ESS dates sample

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

 version="1.0" encoding="UTF-8"?>

 xmlns="http://essfeed.org/history/0.9" version="0.9" lang="en">
   ...
   >
 
      
       type="standalone">
         >Tuesday movie>
         >2012-03-01T19:00:00Z>
         >7200>
      >
 
      
       type="recurrent" unit="month" limit="6">
         >Every month event>
         >2012-01-01T09:00:00-08:00>
         >86400>
      >
 
       
        type="recurrent" unit="month" interval="2" limit="12" selected_day="sunday" selected_week="last">
          >Bimonthly event>
          >2013-04-01T08:00:00-08:00>
          >36000>
       >
 
       
        type="recurrent" unit="week" interval="3" selected_day="friday,saturday,sunday">
          >Every two months >
          >2013-04-01T08:00:00-08:00>
          >7200>
       >
 
       
        type="recurrent" unit="year">
          >Christmas Dinner>
          >2013-12-25T20:30:00+0800>
          >7200>
       >
 
   >
   ...
>




Specific dates situations

Each XML element represents a continuous period of time (without breaks). A type="recurrent" means that the exact date replicates itself for a limit="xx" number of times (if no limit attribute is specified, it must be interpreted as an event that never ends).

Each event has its own particulars, for example if an event occurs:

  • Thursday the 27th from 8am to 10pm.
  • Friday the 28th from 9am to 11pm .
  • Saturday the 29th from 12pm to 2pm.

in Pacific Standard Time (GMT-08:00)
and repeats itself for 3 weeks.

The result will be:

 version="1.0" encoding="UTF-8"?>

 xmlns="http://essfeed.org/history/0.9" version="0.9" lang="en">
   ...
   >
 
      
       type="recurrent" unit="week" limit="3">
         >Tuesday event>
         >2013-03-27T08:00:00-0800> 
         >50400>
      >
 
      
       type="recurrent" unit="week" limit="3">
         >Friday event>
         >2013-03-28T09:00:00-0800> 
         >86400>
      >
 
      
       type="recurrent" unit="week" limit="3">
         >Saturday event>
         >2013-03-29T12:00:00-0800> 
         >10800>
      >
 
   >
   ...
>








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 3987 : Internationalized Resource Identifiers (IRIs)
  • ISO 8601 : Wikipedia ISO 8601


IF EVENTS MATTER TO YOU

Spread the news about ESS!
Personal tools
Actions
Standard

 


Developers

 


Communication