ESS:Places

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

"Places" definition

Though an event is comprised of several attributes, one of the most important is where it takes place. An event has to take place somewhere. Location of events are represented in ESS through four <item> element "type" attributes:

one place event icon area event icon moving event icon virtual event icon

ONE PLACE EVENT

AREA EVENT

MOVING EVENT

VIRTUAL EVENT

Museum, exposition, concert, sport match...

national event, commemoration...

sport race, motor race, religion walk...

Radio show, TV entertainment, web reunion...




ESS <places> structure

ESS documents are composed by 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 belong to an other <ess> feed to describe this event parameter.
Example: every <prices> items must be valid and applicable to every <dates> and <places> items within the same <ess> feed.

<places> XML element (ess:places) must be defined within ESS Documents, it is a mandatory ESS XML element.
This section describe the interaction between ESS events and the places where the event takes place. <places> (ess:places) XML element must be composed by, at least, one <item> (ess:item) XML element.
Several <item> elements can defined within <places> XML structure to describe events with various places at the same time.
But if various events happen on various dates, they belong to several <feed> (ess:feed) feeds to describe them separately.




Places <item @attibutes>


Name Description Type Required
type The "type" attribute can take four values: "fixed", "area", "moving" or "virtual" to represent position of the event. ESS Processors should concider "fixed" as default attribute. String TRUE
moving_position The "moving_position" attribute refer to the event position to applied to each <item> XML element with the attribute type="moving". ESS processors should consider the natural XML position as the moving position if this attribute is not defined. Number FALSE
priority The "priority" attribute refer to the order and the preference to applied to each <item> XML element. ESS processors should consider the natural position as the priority if this attribute is not defined. Number FALSE



Places <item> childs elements


Name Description Type Required
<name> Language-sensitive location short name. Should not be longer then 64 characters String TRUE
<description> This optional XML element contain the venue location description. Using HTML tags inside this XML element is possible but should be limited to the minimum necessary because ESS processors could use this information in an environment that can not read HTML. String FALSE
<country_code> Defines event's country code in the international taxonomy (should be 2 chars). String ISO3166 FALSE
<country> Defines event's country name. String FALSE
<latitude> Defines event's latitude. If not applicable to the event, place the country global and central Latitude Float FALSE
<longitude> Defines event's longitude. If not applicable to the event, place the country global and central Longitude Float FALSE
<address> Defines event's address location. Should not be longer then 512 chars. String FALSE
<city> Defines event's city location name. Should not be longer then 128 characters String FALSE
<zip> Defines event's postal code value. Should not be longer then 16 chars. String FALSE
<state> Defines event's region, state or department name. String FALSE
<state_code> Defines event's region, state or department code name (should be 2 chars). String FALSE
<medium_name> Only present within <item> element with type="virtual" attribute. Defines event's channel name. Should not be longer then 128 chars. String FALSE
<medium_type> Only present within <item> element with type="virtual" attribute. Defines the type of device that can play this virtual event in the current channel. It can takes the values: "television", "radio" or "internet". String FALSE
<kml> XML element that defines kml structure (the name space xmlns:k="http://www.opengis.net/kml/2.2" must be defined), more information about how to build KML structure in ESS external libraries XML RFC3076 FALSE



ESS places 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" 
     xmlns:k="http://www.opengis.net/kml/2.2"  
     version="0.9" 
     lang="en">
   ...
   <places>
 
      <!-- 1 | Simple fixed place -->
      <item type="fixed">
         <name>Modern art, National museum</name> 
         <latitude>40.76930</latitude>
         <longitude>-73.96791</longitude>
         <address>5th avenue / 69E street</address>
         <city>New York</city>
         <zip>10020</zip>
         <state>New York</state>
         <state_code>NY</state_code>
         <country>United States of America</country>
         <country_code>US</country_code>
      </item>
 
 
      <!-- 2 | Event in all the city with KML -->
      <item type="area">
         <name>Boston tea-party celebration</name>
         <country_code>US</country_code> 
         <kml>
            <k:Style id="linecolour">
               <k:LineStyle><k:color>660000FF</k:color><k:width>3</k:width></k:LineStyle>
            </k:Style>
            <k:Placemark>
               <k:styleUrl>#linecolour</k:styleUrl>
               <k:LineString>
                  <k:coordinates>
                     -71.053734,42.368691,0 
                     -71.058197,42.36793,0 
                     -71.060944,42.367042,0 
                     -71.065063,42.368184,0 
                     -71.06987,42.364886,0 
                     -71.073303,42.362096,0 
                     -71.073475,42.356134,0 
                     -71.070728,42.352201,0 
                     -71.06884,42.348522,0 
                     -71.061459,42.347253,0 
                     -71.055622,42.347507,0 
                     -71.049099,42.357149,0 
                     -71.047897,42.361335,0 
                     -71.050301,42.368945,0 
                     -71.05368,42.368675,0 
                  </k:coordinates>
               </k:LineString>
            </k:Placemark>
         </kml>
      </item>
 
 
      <!-- 3 | Moving event -->
      <item type="moving" moving_position="1">
         <name>Motor race position 01</name>
         <country_code>US</country_code>
         <latitude>40.76930</latitude>
         <longitude>-73.96791</longitude>
         <address>5th avenue / 69E street</address>
         <city>New York</city>
         <zip>10020</zip>
         <state>New York</state>
         <state_code>NY</state_code>
         <country>United States of America</country>
         <country_code>US</country_code>
     </item>
     <item type="moving" moving_position="2">
         <name>Motor race position 02</name>
         <latitude>40.70949</latitude>
         <longitude>-74.00632</longitude>
         <address>North Manhattan</address>
         <country_code>US</country_code>
      </item>
 
 
     <!-- 4 | Radio show event -->
     <item type="virtual">
         <name>Radio show event</name> 
         <country>Spain</country>
         <country_code>ES</country_code>
         <medium_name>My favorite radio name</medium_name> 
         <medium_type>radio</medium_type> 
     </item>
 
  </places>
   ...
</ess>



Search a geographic location

Drag and drop the ESS icon to get a specific longitude / latitude



Discussions

ESS Forum Discussion > Places

Could not find wordpress article with a title like home






External documentation

Ietf logo.png

ESS standard under RFC validation process: RFC ESS Draft


IF EVENTS MATTER TO YOU

Spread the news about ESS
Personal tools
Actions
Standard


Developers


Communication