SearchMonkey > Start Overview > Documents

Documents - Presentations, spreadsheets, or other documents

Example

Open Hack 2008 Searchmonkey - SlideShare

SearchMonkey presentation for the Yahoo! Open Hack 2008 in Sunnyvale. SearchMonkey Data layer concepts and application design

  • www.slideshare.net/searchmonkey/open-hack-2008
  • 62k
Doc thumbnail Open Doc

Description

Display documents directly in Yahoo! Search. Add code to indicate to Yahoo! that an embedded document 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 documents permitted: The Yahoo! Search document reader currently supports Flash documents only. Yahoo! is committed to delivering high-quality, relevant search results. Do not mark up content that is inappropriate, misleading, or violates any applicable laws.
  • Supports document readers such as Scribd and SlideShare.
  • New document readers: Your enhanced result will only appear if you are currently using a pre-approved reader or if your reader is subsequently reviewed and approved for display. Not sure if your reader is already approved? Search on Yahoo! Search with the "site:<domain>" keyword plus 1-2 other search query terms. For example: site:scribd.com internet. If an enhanced result does not appear, please complete the player submission form to request approval.
  • How soon after I add my markup will I see my enhanced result appear? Assuming you are using a pre-existing approved reader or have had your new reader approved, 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. Use An Approved Reader

See "Details" section above

2. Add code / markup to your site

Copy this code and replace the example text with your data to read Flash documents in Yahoo! Search.

RDFa

Required

Click any item to toggle description on or off

xmlns:media(url)
The SearchMonkey Media namespace. Format: A valid URL. The only acceptable value is "http://search.yahoo.com/searchmonkey/media/".
media:document(url)
The document to display when the user clicks the "play" button. Alternatively, you can supply a media:presentation or media:spreadsheet. Format: A URL to a flash document. The flash document must be hosted on a domain from the whitelist at the top of this page. By default, the Yahoo! Search document reader will scale your flash presentation to 400 x 640 pixels. You can provide an explicit height and width using media:width and media:height.
media:presentation(url)
The presentation to display when the user clicks the "play" button. Alternatively, you can supply a media:document or media:spreadsheet. Format: A URL to a flash presentation. The flash presentation must be hosted on a domain from the whitelist at the top of this page. By default, the Yahoo! Search document reader will scale your flash presentation to 477 x 390 pixels. You can provide an explicit height and width using media:width and media:height.
media:spreadsheet(url)
The spreadsheet to display when the user clicks the "play" button. Alternatively, you can supply a media:document or media:presentation. Format: A URL to a flash spreadsheet. The flash spreadsheet must be hosted on a domain from the whitelist at the top of this page. By default, the Yahoo! Search document reader will scale your flash spreadsheet to 477 x 390 pixels. You can provide an explicit height and width using media:width and media:height.

Example 1

<object width="512" height="296" rel="media:presentation"
    resource="http://example.com/document_object.swf"
    xmlns:media="http://search.yahoo.com/searchmonkey/media/">
    <param name="movie" value="http://example.com/document_object.swf" />
    <embed src="http://example.com/document_object.swf"
        type="application/x-shockwave-flash" width="512" height="296"></embed>
</object>

NOTE: Your embed code might vary.

If your document is a spreadsheet or a presentation, use media:spreadsheet or media:presentation. If your document does not fall into either of these categories, use media:document.

Recommended

Click any item to toggle description on or off

xmlns:dc(url)
The Dublin Core namespace. This namespace is only required if you are using Dublin Core metadata such as dc:description. NOTE: You may add more namespaces in order to include data from other vocabularies. Format: A valid URL to the Dublin Core namespace. The only acceptable value is "http://purl.org/dc/terms/".
dc:creator(string)
The name of the person or organization that created the document. Format: A string of up to 60 characters.
dc:date(date)
A date or timestamp indicating when the document was last uploaded or modified. Format: A date or timestamp, as defined by http://www.w3.org/TR/NOTE-datetime.
dc:description(string)
A short description of the document. Format: A string of up to 200 characters.
dc:identifier(string)
An unambiguous reference to the document, such as the document's unique URL. Format: A string of up to 200 characters.
dc:license(url)
Indicates the license for this content. You may use dc:license or cc:license. If you supply a Creative Commons license URL using cc:license, Yahoo! Search may use this information to help users find content that is in the public domain or under a Creative Commons license. Format: A URL pointing to a human-readable license file.
dc:subject(string)
The document's category or subject. Format: A string of up to 60 characters.
media:height(integer)
The document's height in pixels, including any "chrome" provided by the third party player. By default, the Yahoo! Search document reader scales the object it receives to 477 x 390 pixels (for presentations and spreadsheets) or 400 x 640 pixels (documents). If you provide an explicit height < 390 or 640 pixels, Yahoo! Search will confine your document to the specified height. Use this feature to adjust Yahoo!'s aspect ratio from the default. Format: An integer value equal to or less than 390 (presentations and spreadsheets) or 640 (documents).
media:player(string)
A string identifier for the player used to display the document. Format: A string of up to 60 characters.
media:thumbnail(gif, jpg, png)
An image that previews the presentation before the user clicks the "play" button. The preview thumbnail only displays if the URL is a valid GIF, JPG, or PNG image and the document is a media:presentation. Otherwise, Yahoo! Search displays a default icon. Format: A URL to a GIF, PNG, or JPG image. The preview thumbnail must be hosted on the same domain as the game. The image should be N x M pixels large.
media:region(string)
An international region where the document may be read. You may provide multiple media:region fields. Acceptable values include:
ValueRegion
*Play in all regions (default)
nonePlay in no regions
arArgentina - Spanish
auAustralia - English
brBrazil - Portuguese
caCanada - English
clChile - Spanish
coColombia - Spanish
deGermany - German
esSpain - Spanish
frFrance - French
idIndonesia - Bahasa Indonesian
itItalia - Italian
jpJapan - Japanese
mxMexico - Spanish
myMalaysia - English
nzNewZealand - English
pePeru - Spanish
phPhilippines - English
qcQuebec - French
sgSingapore - English
ukUnited Kingdom - English
usUnited States - English
veVenezuela - Spanish
vnVietnam - Vietnamese
Format: A keyword or two-character region code.
  • the keyword "*": play in all regions. If media:region is not present, the value is assumed to be *.
  • the keyword "none": play in no regions. This overrides all other media:regions that might be specified.
  • an intl such as "uk": play in the specified region. This overrides a media:region of *. You may provide multiple media:regions.
media:title(string)
The document's title. Format: A string of up to 60 characters.
media:type(mime-type)
The document's MIME-type. Format: A valid MIME-type string. Currently, the only acceptable value is "application/x-shockwave-flash".
media:views(integer)
The number of times the document has been viewed. Format: An integer.
media:width(integer)
The document's width in pixels, including any "chrome" provided by the third party reader. By default, the Yahoo! Search document reader scales the object it receives to 477 x 390 pixels (for presentations and spreadsheets) or 400 x 640 pixels (documents). If you provide an explicit width < 477 or 400 pixels, Yahoo! Search will confine your document to the specified width. Use this feature to adjust Yahoo!'s aspect ratio from the default. Format: An integer value equal to or less than 477 (presentations and spreadsheets) or 400 (documents).
review:rating(number)
The numeric rating of the document. Ideally, a number from 0 to 5 corresponding to a star rating. Format: A number.

Example 2

<object width="512" height="296" rel="media:presentation"
      resource="http://example.com/document_object.swf"
      xmlns:media="http://search.yahoo.com/searchmonkey/media/"
      xmlns:dc="http://purl.org/dc/terms/">
    <param name="movie" value="http://example.com/document_object.swf"/>
    <embed src="http://example.com/document_object.swf"
        type="application/x-shockwave-flash" width="512" height="296"></embed>
    <a rel="media:thumbnail" href="http://example.com/thumbnail_preview.jpg" />
    <a rel="dc:license" href="http://example.com/terms_of_service.html" />
    <span property="dc:creator" content="Chris Lindsey" />
    <span property="dc:description" content="Learn how to use SearchMonkey to customize search engine results" />
    <span property="media:title" content="SearchMonkey Tutorial" />
    <span property="media:width" content="512" />
    <span property="media:height" content="296" />
    <span property="media:type" content="application/x-shockwave-flash" />
    <span property="media:region" content="us" />
    <span property="media:region" content="uk" />
</object>

You may include even more data than this, such as user information and review information. 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">

Feed

Minimum

Click any item to toggle description on or off

media:document(url)
The document to display when the user clicks the "play" button. Alternatively, you can supply a media:presentation or media:spreadsheet. Format: A URL to a flash document. The flash document must be hosted on a domain from the whitelist at the top of this page. By default, the Yahoo! Search document reader will scale your flash presentation to 400 x 640 pixels. You can provide an explicit height and width using media:width and media:height.
media:presentation(url)
The presentation to display when the user clicks the "play" button. Alternatively, you can supply a media:document or media:spreadsheet. Format: A URL to a flash presentation. The flash presentation must be hosted on a domain from the whitelist at the top of this page. By default, the Yahoo! Search document reader will scale your flash presentation to 477 x 390 pixels. You can provide an explicit height and width using media:width and media:height.
media:spreadsheet(url)
The spreadsheet to display when the user clicks the "play" button. Alternatively, you can supply a media:document or media:presentation. Format: A URL to a flash spreadsheet. The flash spreadsheet must be hosted on a domain from the whitelist at the top of this page. By default, the Yahoo! Search document reader will scale your flash spreadsheet to 477 x 390 pixels. You can provide an explicit height and width using media:width and media:height.

Example 1

<y:adjunct xmlns:y="http://search.yahoo.com/datarss/" version="1.0" name="YOURID" >
  <y:item rel="dc:subject" resource="http://example.com/document_object.swf">
      <y:type typeof="media:Presentation" resource="http://example.com/document_object.swf">
          <y:item rel="media:thumbnail media:image" resource="http://example.com/thumbnail_preview.jpg"/>
          <y:item rel="dc:license" resource="http://example.com/terms_of_service.html" />
          <y:meta property="dc:title media:title">SearchMonkey Tutorial</y:meta>
          <y:meta property="dc:description media:description">Learn how to use SearchMonkey to customize search engine results</y:meta>
          <y:meta property="dc:creator">Chris Lindsey</y:meta>
          <y:meta property="media:height" datatype="xsd:integer">358</y:meta>
          <y:meta property="media:width" datatype="xsd:integer">576</y:meta>
          <y:meta property="media:region">us</y:meta>
          <y:meta property="media:region">uk</y:meta>
      <y:meta property="media:type dc:type">application/x-shockwave-flash</y:meta>
      </y:type>
  </y:item>
</y:adjunct>

Recommended

Click any item to toggle description on or off

dc:creator(string)
The name of the person or organization that created the document. Format: A string of up to 60 characters.
dc:date(date)
A date or timestamp indicating when the document was last uploaded or modified. Format: A date or timestamp, as defined by http://www.w3.org/TR/NOTE-datetime.
dc:description(string)
A short description of the document. Format: A string of up to 200 characters.
dc:identifier(string)
An unambiguous reference to the document, such as the document's unique URL. Format: A string of up to 200 characters.
dc:license(url)
Indicates the license for this content. You may use dc:license or cc:license. If you supply a Creative Commons license URL using cc:license, Yahoo! Search may use this information to help users find content that is in the public domain or under a Creative Commons license. Format: A URL pointing to a human-readable license file.
dc:subject(string)
The document's category or subject. Format: A string of up to 60 characters.
media:height(integer)
The document's height in pixels, including any "chrome" provided by the third party player. By default, the Yahoo! Search document reader scales the object it receives to 477 x 390 pixels (for presentations and spreadsheets) or 400 x 640 pixels (documents). If you provide an explicit height < 390 or 640 pixels, Yahoo! Search will confine your document to the specified height. Use this feature to adjust Yahoo!'s aspect ratio from the default. Format: An integer value equal to or less than 390 (presentations and spreadsheets) or 640 (documents).
media:player(string)
A string identifier for the player used to display the document. Format: A string of up to 60 characters.
media:thumbnail(gif, jpg, png)
An image that previews the presentation before the user clicks the "play" button. The preview thumbnail only displays if the URL is a valid GIF, JPG, or PNG image and the document is a media:presentation. Otherwise, Yahoo! Search displays a default icon. Format: A URL to a GIF, PNG, or JPG image. The preview thumbnail must be hosted on the same domain as the game. The image should be N x M pixels large.
media:region(string)
An international region where the document may be read. You may provide multiple media:region fields. Acceptable values include:
ValueRegion
*Play in all regions (default)
nonePlay in no regions
arArgentina - Spanish
auAustralia - English
brBrazil - Portuguese
caCanada - English
clChile - Spanish
coColombia - Spanish
deGermany - German
esSpain - Spanish
frFrance - French
idIndonesia - Bahasa Indonesian
itItalia - Italian
jpJapan - Japanese
mxMexico - Spanish
myMalaysia - English
nzNewZealand - English
pePeru - Spanish
phPhilippines - English
qcQuebec - French
sgSingapore - English
ukUnited Kingdom - English
usUnited States - English
veVenezuela - Spanish
vnVietnam - Vietnamese
Format: A keyword or two-character region code.
  • the keyword "*": play in all regions. If media:region is not present, the value is assumed to be *.
  • the keyword "none": play in no regions. This overrides all other media:regions that might be specified.
  • an intl such as "uk": play in the specified region. This overrides a media:region of *. You may provide multiple media:regions.
media:title(string)
The document's title. Format: A string of up to 60 characters.
media:type(mime-type)
The document's MIME-type. Format: A valid MIME-type string. Currently, the only acceptable value is "application/x-shockwave-flash".
media:views(integer)
The number of times the document has been viewed. Format: An integer.
media:width(integer)
The document's width in pixels, including any "chrome" provided by the third party reader. By default, the Yahoo! Search document reader scales the object it receives to 477 x 390 pixels (for presentations and spreadsheets) or 400 x 640 pixels (documents). If you provide an explicit width < 477 or 400 pixels, Yahoo! Search will confine your document to the specified width. Use this feature to adjust Yahoo!'s aspect ratio from the default. Format: An integer value equal to or less than 477 (presentations and spreadsheets) or 400 (documents).
review:rating(number)
The numeric rating of the document. Ideally, a number from 0 to 5 corresponding to a star rating. Format: A number.

3. Validate your markup

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

4. 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