SearchMonkey > Start Overview > Event

Event - Display dates, locations, and reviews for events

Example

Description

Display event information directly in Yahoo! Search. Add code to indicate to Yahoo! that an event exists on your page, and when we next crawl your site, we'll take care of the rest. From your markup, we’ll be able to extract structured data from your site and render it automatically in an enhanced result in search results.

Details

  • Types of content permitted: information about festivals, concerts, appointments, parties, and other activities that have a defined time period.
  • How soon after I add my markup will I see my enhanced result appear? Assuming your markup is correct, your enhanced result will appear after Yahoo! recrawls your page; this can take between a few days and a few weeks depending on your site.

Get Started

1. Add code / markup to your site

Copy this code and replace the example text with your data to see enhanced local listing information in Yahoo! Search.

  • Use RDFa markup to embed event metadata directly in your markup. You can provide the event's start date and time, the event's name, the location, and more.
  • Use hcalendar, hcard and hreview markup for an alternative way to display event, address and review information in Yahoo! Search.
  • Use DataRSS XML to send your data to Yahoo! privately, using a feed. Once you have constructed your DataRSS feed, you must submit the feed to Yahoo!.

RDFa

Required

Click any item to toggle description on or off

xmlns:vcal(url)
The VCalendar namespace, used for the address, telephone, photo, and URL. Format: A valid URL. The only acceptable value is "http://www.w3.org/2002/12/cal/icaltzd#".
vcal:Event(string)
Indicates that the child markup applies to an event.

Recommended

xmlns:rdfs(url)
The RDFS namespace, used for labels and comments. Format: A valid URL. The only acceptable value is "http://www.w3.org/2000/01/rdf-schema#".
rdfs:label vcal:summary(string)
The title of the event, such as "SearchMonkey Developer Party". Format: A string of up to 60 characters.
vcal:dtstart(string)
The date and time that the event starts. Yahoo! displays the event date as part of the icon to the right of the search result. Format: A string of up to 60 characters. The date should be in RFC 3339 format: YYYY-MM-DDTHH:MM:SS+ZZ:ZZ, where only YYYY-MM-DD are required. If the date text does not conform to RFC 3339, you should supply an explicit RFC 3339 value using the content attribute. Otherwise, the system attempts to parse the date string directly. This will succeed on simple, obvious date strings such as "10 October 2009", but fail on more complicated strings or ambiguous dates such as "08/07/09".

Example 1

<div typeof="vcal:Vevent" 
  xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
  xmlns:vcal="http://www.w3.org/2002/12/cal/icaltzd#">

  <span property="rdfs:label vcal:summary">SearchMonkey Developer Event </span>

  Start at <span property="vcal:dtstart"> 6pm, June 25, 2008</span>.
</div>

NOTE: Your event code might vary.

Optional

Click any item to toggle description on or off

xmlns:review(url)
The RDF Review namespace. This namespace is only required if you are providing aggregate review information. Format: A valid URL to the RDF Review namespace. The only acceptable value is "http://purl.org/stuff/rev#".
xmlns:xsd(url)
The XML Schema namespace. This namespace is only required if you are providing explicit data types for values, such as xsd:float or xsd:integer. Format: A valid URL to the XML Schema namespace. The only acceptable value is "http://www.w3.org/2001/XMLSchema#".
xmlns:vcard(url)
The VCard namespace, used for the address, telephone, and URL. Format: A valid URL. The only acceptable value is "http://www.w3.org/2006/vcard/ns#".
xmlns:commerce(url)
The SearchMonkey Commerce namespace, used to indicate that the organization is commercial and to provide additional optional fields, such as attire and parking options. Format: A valid URL. The only acceptable value is "http://search.yahoo.com/searchmonkey/commerce/".
vcal:dtend(string)
The date and time that the event ends. If you do not provide an end date, the default end date is set to be 30 minutes after the start date. Format: A string of up to 60 characters. The date should be in RFC 3339 format: YYYY-MM-DDTHH:MM:SS+ZZ:ZZ, where only YYYY-MM-DD are required. If the date text does not conform to RFC 3339, you should supply an explicit RFC 3339 value using the content attribute. Otherwise, the system attempts to parse the date string directly. This will succeed on simple, obvious date strings such as "10 October 2009", but fail on more complicated strings or ambiguous dates such as "08/07/09".
vcard:fn rdfs:label(string)
The name of the local listing, such as "Steven's Cheesesteaks". Format: A string of up to 60 characters.
vcal:location-
Indicates that the child VCard is the location where the event is occurring.
vcard:label rdfs:label(string)
A simple, free-form postal address. If you provide both a free-form and a unstructured address, the structured address takes precedence. Format: A string of up to 60 characters. To create a more structured address, use other VCard terms such as vcard:street-address and vcard:postal-code.
rdfs:comment(string)
When nested inside a vcard:VCard and a commerce:Business: a description of the local listing. Format: A string of up to 200 characters.
vcard:street-address(string)
The street address of a postal address, such as "2700 Mission College Blvd". Format: A string of up to 60 characters.
vcard:locality(string)
The locality (e.g., city) of a postal address. Format: A string of up to 20 characters.
vcard:region(string)
The region (e.g., state or province) of a postal address. Format: A string of up to 20 characters.
vcard:postal-code(string)
The postal code (e.g., U.S. ZIP code) of a postal address. Format: A string of up to 20 characters.
vcard:country-name(string)
The country of a postal address. Format: A string of up to 20 characters.
vcard:tel(string)
A telephone number, preferably in an international format. Format: A string of up to 20 characters.
vcard:latitude(float)
The latitude of a geographic location. If the wrapped content is not a float, you can provide an explicit float value using the content attribute. Format: A float.
vcard:longitude(float)
The longitude of a geographic location. If the wrapped content is not a float, you can provide an explicit float value using the content attribute. Format: A float.
vcard:url(url)
A URL associated with the event. Typically this is a link to the homepage of the organization. Format: A URL pointing to the event's homepage.
review:rating(float)
The aggregate numeric value of the review. By default, this ranges between 0 and 5. Yahoo! displays reviews in stars, rounding to the nearest half star. This value must represent an aggregate review. If you provide multiple review:ratings, Yahoo! will not display the review. Format: A float bounded by review:minRating and review:maxRating.
review:minRating(integer)
The minimum possible value of the review. By default, the minimum rating is 0. If you supply an explicit minimum, Yahoo! displays your rating as a numeric value rather than a star rating. Format: An integer less than review:maxRating.
review:maxRating(integer)
The maximum possible value of the review. By default, the maximum rating is 5. If you supply an explicit maximum, Yahoo! displays your rating as a numeric value rather than a star rating. Format: An integer greater than review:minRating.
review:totalRatings(integer)
The total number of user reviews represented by this aggregate rating. Format: An integer.

Example 2

<div typeof="vcal:Vevent" 
  xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
  xmlns:vcal="http://www.w3.org/2002/12/cal/icaltzd#"
  xmlns:vcard="http://www.w3.org/2006/vcard/ns#"
  xmlns:review="http://purl.org/stuff/rev#"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema#"
  xmlns:commerce="http://search.yahoo.com/searchmonkey/commerce/">

  <span property="rdfs:label vcal:summary">SearchMonkey Developer Event </span>

  Start at <span property="vcal:dtstart" datatype="xsd:dateTime" content="2008-06-25T18:00:00+00:00"> 6pm, June 25, 2008</span>
  ends at <span property="vcal:dtend" datatype="xsd:dateTime" content="2008-06-25T22:00:00+00:00"> 10pm, June 25, 2008</span>

  <a rel="vcal:url rdfs:seeAlso" resource="http://developer.yahoo.com/searchmonkey/"></a>

  <span property="vcal:description rdfs:comment">
     Let's Party! SearchMonkey Style

     If you're a web developer, come party with us at the SearchMonkey Developer Event.
     There will be a tech talk by the engineers who built the platform. We'll be doing 
     live demos, sharing schwag, and serving substantial amounts of free food and beer!

     SearchMonkey allows developers and site owners to use semantic web standards and 
     structured data to enhance Yahoo! Search results and make them more useful,
     relevant, and visually appealing. Come meet the guys who created the product, 
     and feel free to monkey around with them as you wish.

     If you want to join us then please click "I'm Going" right here in Upcoming 
     or alternatively RSVP by sending your full name to searchmonkeyevent@yahoo-inc.com.

     Hope to see you there!
  </span>

  <div rel="vcal:location">
    <div typeof="vcard:VCard commerce:Business">
      <span property="vcard:fn">WallaceSpace</span>
      <div rel="vcard:adr">
        <div typeof="vcard:Address">
          <!-- If address is not available in parsed form, use
          <span property="rdfs:label">2 Dryden Street, Covent Garden, London, England WC2E 9NA</span>
           -->
          <span property="vcard:street-address">2 Dryden Street</span>
          <span property="vcard:locality">London</span>
          <span property="vcard:region">England</span>
          <span property="vcard:postal-code">WC2E 9NA</span>
          <span property="vcard:country-name">United Kingdom</span>
        </div>
      </div>
      <span property="vcard:tel">+44(0)20 7395 1265</span>
      <div rel="vcard:geo">
        <span property="vcard:latitude" datatype="xsd:float">51.514828</span>
        <span property="vcard:longitude" datatype="xsd:float">-0.122604</span>
      </div>
    </div>
  </div>

  <!--Review -->
  <div rel="review:hasReview">
    <div typeof="review:Review">
      Rated <span property="review:rating" datatype="xsd:float">3.5</span> on a scale of
      <span property="review:minRating" datatype="xsd:integer">1</span>	to
      <span property="review:maxRating" datatype="xsd:integer">5</span>

      Rated <span property="review:totalRatings" datatype="xsd:integer">14</span> times.
    </div>
  </div>
</div>

This metadata will be available in SearchMonkey and Yahoo! Search BOSS for further use. For more information, refer to the RDFa specification or the RDFa wiki.

NOTE: To validate your markup with RDFa attributes, use this W3C DOCTYPE:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">

Microformats

Required

Click any item to toggle description on or off

vevent(string)
Indicates that the markup below refers to an event.
summary(string)
The title of the event, such as "SearchMonkey Developer Party". Format: A string of up to 60 characters.
dtstart(string)
The date and time that the event starts. Yahoo! displays the event date as part of the icon to the right of the search result. Format: A string of up to 60 characters. The date should be in RFC 3339 format: YYYY-MM-DDTHH:MM:SS+ZZ:ZZ, where only YYYY-MM-DD are required. If the date text does not conform to RFC 3339, you should supply an explicit RFC 3339 value using the content attribute. Otherwise, the system attempts to parse the date string directly. This will succeed on simple, obvious date strings such as "10 October 2009", but fail on more complicated strings or ambiguous dates such as "08/07/09".

Example 1

<div class="vevent">
 <h3 class="summary">SearchMonkey Developer Event</h3>

 <p>To be held on <span class="dtstart">6pm, June 25, 2008</span>.</p>
</div>

This is the minimum markup you need to display event information on your page when that page turns up in search results.

Recommended

Click any item to toggle description on or off

dtend(string)
The date and time that the event ends. If you do not provide an end date, the default end date is set to be 30 minutes after the start date. Format: A string of up to 60 characters. The date should be in RFC 3339 format: YYYY-MM-DDTHH:MM:SS+ZZ:ZZ, where only YYYY-MM-DD are required. If the date text does not conform to RFC 3339, you should supply an explicit RFC 3339 value using the content attribute. Otherwise, the system attempts to parse the date string directly. This will succeed on simple, obvious date strings such as "10 October 2009", but fail on more complicated strings or ambiguous dates such as "08/07/09".
fn org summary(string)
The name of the local listing, such as "Steven's Cheesesteaks". The name must be included with a postal address and telephone number in order for the Local enhanced result to display. Format: A string of up to 60 characters.
tel(string)
A telephone number, preferably in an international format. The telephone number must be included with a name and postal address in order for the Local enhanced result to display. Format: A string of up to 20 characters.
street-address(string)
The street address of a postal address, such as "2700 Mission College Blvd". Format: A string of up to 60 characters.
locality(string)
The locality (e.g., city) of a postal address. Format: A string of up to 20 characters.
region(string)
The region (e.g., state or province) of a postal address. Format: A string of up to 20 characters.
postal-code(string)
The postal code (e.g., U.S. ZIP code) of a postal address. Format: A string of up to 20 characters.
country-name(string)
The country of a postal address. Format: A string of up to 20 characters.
description(string)
A description of the local listing. Format: A string of up to 200 characters.
latitude(float)
The latitude of a geographic location. If the wrapped content is not a float, you can provide an explicit float value using the title attribute. Format: A float.
longitude(float)
The longitude of a geographic location. If the wrapped content is not a float, you can provide an explicit float value using the title attribute. Format: A float.
url(url)
A URL associated with the event. Typically this is a link to the homepage of the organization. Format: A URL pointing to the event's homepage.
rating(float)
The aggregate numeric value of the review. By default, this ranges between 0 and 5. Yahoo! displays reviews in stars, rounding to the nearest half star. This value must represent an aggregate review. If you provide multiple ratings, Yahoo! will not display the review. Format: A float bounded by review:minRating and review:maxRating.
worst(integer)
The minimum possible value of the review. By default, the minimum rating is 0. If you supply a different minimum, Yahoo! can use this value to interpolate and generate a more accurate star rating. Format: An integer.
best(integer)
The maximum possible value of the review. By default, the maximum rating is 5. If you supply a different maximum, Yahoo! can use this value to interpolate and generate a more accurate star rating. Format: An integer greater than review:minRating.
num(integer)
The total number of user reviews represented by this aggregate rating.

Example 2

<div class="vevent hreview-aggregate">
  <div class="item">
    <h3 class="summary fn">SearchMonkey Developer Event</h3>

    <p class="description">
      Let's Party! SearchMonkey Style

      If you're a web developer, come party with us at the SearchMonkey Developer Event.
      There will be a tech talk by the engineers who built the platform. We'll be doing
      live demos, sharing schwag, and serving substantial amounts of free food and beer!

      SearchMonkey allows developers and site owners to use semantic web standards and
      structured data to enhance Yahoo! Search results and make them more useful,
      relevant, and visually appealing. Come meet the guys who created the product,
      and feel free to monkey around with them as you wish.

      If you want to join us then please click "I'm Going" right here in Upcoming
      or alternatively RSVP by sending your full name to searchmonkeyevent@yahoo-inc.com.

      Hope to see you there!
    </p>
    <p>For more info, see <a class="url" href="http://developer.yahoo.com/searchmonkey/">SearchMonkey Home</a></p>
  </div>
  <p>To be held on <abbr class="dtstart" title="2008-06-25T18:00:00+00:00">6pm, June 25, 2008</abbr>
      until <abbr class="dtend" title="2008-06-25T22:00:00+00:00">10pm, June 25, 2008</abbr></p>
  <div class="location vcard">
     Location: <span class="fn org">WallaceSpace</span>
     <span class="adr">
        <span class="street-address">2 Dryden Street</span>,
        <span class="locality">London</span>,
        <span class="region">England</span>,
        <span class="country-name">United Kingdom</span>,
        <span class="postal-code">WC2E 9NA</span>,
     </span>
    <span class="tel">+44(0)20 7395 1265 </span>

    <div class="geo">
      <abbr class="latitude" title="37.408183">51.514828</abbr>
      <abbr class="longitude" title="-122.13855">-0.122604</abbr>
    </div>
  </div>
  <div>
      Rated <span class="rating">4.5</span> out of <span class="best">5</span> stars based on <span class="count"> 29</span>ratings.
  </div>
</div>

This markup not only displays event information, but address information and the aggregate review rating.

DataRSS XML

Required

Click any item to toggle description on or off

vcal:Event(string)
Indicates that the child markup applies to an event.

Recommended

rdfs:label vcal:summary(string)
The title of the event, such as "SearchMonkey Developer Party". Format: A string of up to 60 characters.
vcal:dtstart(string)
The date and time that the event starts. Yahoo! displays the event date as part of the icon to the right of the search result. Format: A string of up to 60 characters. The date should be in RFC 3339 format: YYYY-MM-DDTHH:MM:SS+ZZ:ZZ, where only YYYY-MM-DD are required. If the date text does not conform to RFC 3339, you should supply an explicit RFC 3339 value using the content attribute. Otherwise, the system attempts to parse the date string directly. This will succeed on simple, obvious date strings such as "10 October 2009", but fail on more complicated strings or ambiguous dates such as "08/07/09".

Example 1

<y:adjunct xmlns:y="http://search.yahoo.com/datarss/" version="1.0" name="YOURID">
  <y:item rel="dc:subject">
    <y:type typeof="vcal:Vevent">
      <y:meta property="rdfs:label vcal:summary">SearchMonkey Developer Event </y:meta>    
      <y:meta property="vcal:dtstart" datatype="xsd:dateTime" content="2008-06-25T18:00:00+00:00"> 6pm, June 25, 2008</y:meta>
      <y:meta property="vcal:dtend" datatype="xsd:dateTime" content="2008-06-25T22:00:00+00:00"> 10pm, June 25, 2008</y:meta>

      <y:item rel="vcal:url rdfs:seeAlso" resource="http://developer.yahoo.com/searchmonkey/"/>

      <y:meta property="vcal:description rdfs:comment">
         Let's Party! SearchMonkey Style

         If you're a web developer, come party with us at the SearchMonkey Developer Event.
         There will be a tech talk by the engineers who built the platform. We'll be doing 
         live demos, sharing schwag, and serving substantial amounts of free food and beer!

         SearchMonkey allows developers and site owners to use semantic web standards and
         structured data to enhance Yahoo! Search results and make them more useful,
         relevant, and visually appealing. Come meet the guys who created the product,
         and feel free to monkey around with them as you wish.

         If you want to join us then please click "I'm Going" right here in Upcoming
         or alternatively RSVP by sending your full name to searchmonkeyevent@yahoo-inc.com.

         Hope to see you there!
      </y:meta>

      <y:item rel="vcal:location">
        <y:type typeof="vcard:VCard commerce:Business">
          <y:meta property="vcard:fn">WallaceSpace</y:meta>
          <y:item rel="vcard:adr">
            <y:type typeof="vcard:Address">
              <!-- If address is not available in parsed form, use
              <y:meta property="rdfs:label">2 Dryden Street, Covent Garden, London, England WC2E 9NA</y:meta>
               -->
              <y:meta property="vcard:street-address">2 Dryden Street</y:meta>
              <y:meta property="vcard:locality">London</y:meta>
              <y:meta property="vcard:region">England</y:meta>
              <y:meta property="vcard:postal-code">WC2E 9NA</y:meta>
              <y:meta property="vcard:country-name">United Kingdom</y:meta>
            </y:type>
          </y:item>
          <y:meta property="vcard:tel">+44(0)20 7395 1265 </y:meta>
          <y:item rel="vcard:geo">
            <y:meta property="vcard:latitude" datatype="xsd:float">51.514828</y:meta>
            <y:meta property="vcard:longitude" datatype="xsd:float">-0.122604</y:meta>
          </y:item>
        </y:type>
      </y:item>

      <!--Review -->
      <y:item rel="review:hasReview">
        <y:type typeof="review:Review">
          <y:meta property="review:rating" datatype="xsd:float">3.5</y:meta>
          <y:meta property="review:minRating" datatype="xsd:integer">1</y:meta>
          <y:meta property="review:maxRating" datatype="xsd:integer">5</y:meta>
          <y:meta property="review:totalRatings" datatype="xsd:integer">14</y:meta>
        </y:type>
      </y:item>
    </y:type>
  </y:item>
</y:adjunct>

This markup would be included in a DataRSS feed.

Optional

Click any item to toggle description on or off

vcal:dtend(string)
The date and time that the event ends. If you do not provide an end date, the default end date is set to be 30 minutes after the start date. Format: A string of up to 60 characters. The date should be in RFC 3339 format: YYYY-MM-DDTHH:MM:SS+ZZ:ZZ, where only YYYY-MM-DD are required. If the date text does not conform to RFC 3339, you should supply an explicit RFC 3339 value using the content attribute. Otherwise, the system attempts to parse the date string directly. This will succeed on simple, obvious date strings such as "10 October 2009", but fail on more complicated strings or ambiguous dates such as "08/07/09".
vcard:fn rdfs:label(string)
The name of the local listing, such as "Steven's Cheesesteaks". Format: A string of up to 60 characters.
vcal:location-
Indicates that the child VCard is the location where the event is occurring.
vcard:label rdfs:label(string)
A simple, free-form postal address. If you provide both a free-form and a unstructured address, the structured address takes precedence. Format: A string of up to 60 characters. To create a more structured address, use other VCard terms such as vcard:street-address and vcard:postal-code.
rdfs:comment(string)
When nested inside a vcard:VCard and a commerce:Business: a description of the local listing. Format: A string of up to 200 characters.
vcard:street-address(string)
The street address of a postal address, such as "2700 Mission College Blvd". Format: A string of up to 60 characters.
vcard:locality(string)
The locality (e.g., city) of a postal address. Format: A string of up to 20 characters.
vcard:region(string)
The region (e.g., state or province) of a postal address. Format: A string of up to 20 characters.
vcard:postal-code(string)
The postal code (e.g., U.S. ZIP code) of a postal address. Format: A string of up to 20 characters.
vcard:country-name(string)
The country of a postal address. Format: A string of up to 20 characters.
vcard:tel(string)
A telephone number, preferably in an international format. Format: A string of up to 20 characters.
vcard:latitude(float)
The latitude of a geographic location. If the wrapped content is not a float, you can provide an explicit float value using the content attribute. Format: A float.
vcard:longitude(float)
The longitude of a geographic location. If the wrapped content is not a float, you can provide an explicit float value using the content attribute. Format: A float.
vcard:url(url)
A URL associated with the event. Typically this is a link to the homepage of the organization. Format: A URL pointing to the event's homepage.
review:rating(float)
The aggregate numeric value of the review. By default, this ranges between 0 and 5. Yahoo! displays reviews in stars, rounding to the nearest half star. This value must represent an aggregate review. If you provide multiple review:ratings, Yahoo! will not display the review. Format: A float bounded by review:minRating and review:maxRating.
review:minRating(integer)
The minimum possible value of the review. By default, the minimum rating is 0. If you supply an explicit minimum, Yahoo! displays your rating as a numeric value rather than a star rating. Format: An integer less than review:maxRating.
review:maxRating(integer)
The maximum possible value of the review. By default, the maximum rating is 5. If you supply an explicit maximum, Yahoo! displays your rating as a numeric value rather than a star rating. Format: An integer greater than review:minRating.
review:totalRatings(integer)
The total number of user reviews represented by this aggregate rating. Format: An integer.

2. Validate your markup

Test your markup to make sure your enhanced result will appear.

3. Wait until we recrawl your site for your enhanced result to appear on the search results page

This can take up to a few weeks depending on your site.

Copyright © 2009 Yahoo! Inc. All rights reserved. Copyright | Privacy Policy | Terms of Service

Help us continue to improve the Yahoo! Developer Network: Send Your Suggestions