SearchMonkey Guide

Chapter 1. Overview — Next

SearchMonkey Guide

A Manual for SearchMonkey Developers and Publishers

Copyright © 2008, Yahoo! Inc.

Abstract

The SearchMonkey Guide contains information for SearchMonkey developers and publishers. It includes full documentation for the online developer tool, tutorials and best practices, overviews of microformats and RDF, and reference material for APIs and XML schemas used to build SearchMonkey applications.

For developer assistance with SearchMonkey, join the SearchMonkey Yahoo! Group for Developers. For publisher assistance with SearchMonkey, join the SearchMonkey Yahoo! Group for Site Owners.

Table of Contents

1. Overview

About This Guide

Audience
Chapter Summaries

Understanding SearchMonkey

Example SearchMonkey Applications

Data Service Types

Developer Quickstart

Intel® Mash Maker with SearchMonkey

Intel Mash Maker

Installing Mash Maker
Using Mash Maker
Reviewing your Extraction

2. Developer Guide

Application Dashboard

DataRSS Primer for Developers

Creating Custom Data Services

Converting OpenSearch to DataRSS
Creating a (Page) Custom Data Service
Creating a (Web Service) Custom Data Service
Data Service Best Practices

Data Service Screens (Page)

Step 1: Basic Info
Step 2: URLs
Step 3: Data Extraction
Step 4: Confirmation

Data Service Screens (Web Service)

Step 1: Basic Info
Step 2: Inputs
Step 3: Test Data
Step 4: Endpoint
Step 5: Confirmation

Creating Presentation Applications

Presentation Templates

Infobars
Enhanced Results

Presentation Application Versioning

Presentation Application PHP Structure

Yahoo! Index Data

Creating a Presentation Application

Presentation Application Best Practices

Title Best Practices
Summary Best Practices
Image Best Practices
Link Best Practices
Key/Value Pair Best Practices
Getting Your Apps into the Search Gallery

Presentation Application Screens

Step 1: Basic Info
Step 2: URLs
Step 3: Data Services
Step 4: Appearance
Step 5: Confirmation
Step 6: Publication

Warnings and Errors

3. Site Owner Guide

Factors to Consider When Choosing a Data Delivery Method

Comparing Data Delivery Methods

XML-Based Atom Feeds
eRDF/RDFa Markup
Microformats
OpenSearch
Custom Data Services

Submitting Feeds

The Process of Creating a Feed

Selecting Content for the Feed

Selecting Pages (URLs)
General Content Guidelines
Ineligible Content

Understanding DataRSS

DataRSS Elements and Attributes
DataRSS in SearchMonkey Data Services

Creating the Feed

What are DataRSS and OPML Feeds?
Site Explorer Feed Requirements
OPML (Outline Processor Markup Language)
NewsML DataRSS
Google Base

SearchMonkey Feed Submission Overview

Leveraging the Data Web

Microformats
Supported Microformats
RDF

Enhanced Results User Agent

A. DataRSS Specification

DataRSS Feeds

Normative references:
The DataRSS elements
XML Schema syntax

B. SearchMonkey vocabularies

Intro
About the Examples
Defining New Classes and Properties
OWL Definitions
Predefined Prefixes
Datatypes

Business Addresses and Reviews

Components
Simple Local Listing Example
Advanced Local Listing Example

Personal Profiles and Social Networks

Components
Simple Social Profile Example
Advanced Social Profile Example

Friend-Of-A-Friend

GoodRelations

gr:AcceptedPaymentMethods
gr:ActualProductOrServiceInstance
gr:AvailableDeliveryMethods
gr:BusinessEntity
gr:BusinessEntityType
gr:BusinessFunction
gr:DayOfWeek
gr:DeliveryChargeSpecification
gr:DeliveryMethod
gr:DeliveryModeParcelService
gr:LocationOfSalesOrServiceProvisioning
gr:N-Ary-Relations
gr:Offering
gr:OpeningHoursSpecification
gr:PaymentChargeSpecification
gr:PaymentMethod
gr:PaymentMethodCreditCard
gr:PriceSpecification
gr:ProductOrService
gr:ProductOrServiceModel
gr:ProductOrServicesSomeInstancesPlaceholder
gr:QualitativeValue
gr:QuantitativeValue
gr:QuantitativeValueFloat
gr:QuantitativeValueInteger
gr:TypeAndQuantityNode
gr:UnitPriceSpecification
gr:WarrantyPromise
gr:WarrantyScope
gr:acceptedPaymentMethods
gr:amountOfThisGood
gr:appliesToDeliveryMethod
gr:appliesToPaymentMethod
gr:availableAtOrFrom
gr:availableDeliveryMethods
gr:closes
gr:datatypeProductOrServiceProperty
gr:description
gr:durationOfWarrantyInMonths
gr:eligibleCustomerTypes
gr:eligibleRegions
gr:hasBusinessFunction
gr:hasCurrency
gr:hasCurrencyValue
gr:hasDUNS
gr:hasEAN_UCC-13
gr:hasEligibleQuantity
gr:hasGTIN-14
gr:hasGlobalLocationNumber
gr:hasMakeAndModel
gr:hasMaxCurrencyValue
gr:hasMaxValue
gr:hasMaxValueFloat
gr:hasMaxValueInteger
gr:hasMinCurrencyValue
gr:hasMinValue
gr:hasMinValueFloat
gr:hasMinValueInteger
gr:hasOpeningHoursDayOfWeek
gr:hasPriceSpecification
gr:hasUnitOfMeasurement
gr:hasValueFloat
gr:hasValueInteger
gr:hasWarrantyPromise
gr:hasWarrantyScope
gr:includesObject
gr:isAccessoryOrSparePartFor
gr:isConsumableFor
gr:isListPrice
gr:isSimilarTo
gr:legalName
gr:offers
gr:opens
gr:qualitativeProductOrServiceProperty
gr:quantitativeProductOrServiceProperty
gr:typeOfGood
gr:validFrom
gr:validThrough
gr:valueAddedTaxIncluded

review:Comment
review:Feedback
review:Review
review:commenter
review:hasComment
review:hasFeedback
review:hasReview
review:positiveVotes
review:rating
review:reviewer
review:text
review:title
review:totalVotes
review:type

SearchMonkey Actions

action:addFriend
action:append
action:checkAvailability
action:compare
action:delete
action:discuss
action:edit
action:give
action:locateStore
action:map
action:notify
action:perform
action:procure
action:readDocumentation
action:reserve
action:sendEmail
action:sendToPhone
action:viewHistory
action:viewImages

SearchMonkey Commerce

commerce:Business
commerce:Hotel
commerce:Restaurant
commerce:acceptsCredit
commerce:accessibility
commerce:ambience
commerce:attire
commerce:businessCategory
commerce:corkage
commerce:cuisine
commerce:features
commerce:hoursOfOperation
commerce:mealOptions
commerce:parkingOptions
commerce:priceRange
commerce:priceRangeHighest
commerce:priceRangeLowest
commerce:seatingOptions
commerce:serviceOptions
commerce:smoking
commerce:takesReservations

SearchMonkey Feeds

feed:Entry
feed:Feed
feed:hasEntry

SearchMonkey Jobs

job:JobListing
job:degree
job:duration
job:experience
job:expires
job:function
job:hireType
job:industry
job:location
job:published
job:salaryFrom
job:salaryTo
job:salaryType

SearchMonkey Media

media:Article
media:Audio
media:Image
media:Media
media:Photo
media:Photoset
media:Text
media:Thumbnail
media:Video
media:Videoset
media:audio
media:bitrate
media:channels
media:duration
media:fileSize
media:framerate
media:height
media:image
media:region
media:samplingrate
media:thumbnail
media:type
media:video
media:views
media:width

SearchMonkey Product

product:Flight
product:Product
product:Service
product:availability
product:brand
product:category
product:color
product:condition
product:height
product:identifier
product:invoice
product:length
product:listPrice
product:manufacturer
product:maxInvoice
product:maxMSRP
product:minInvoice
product:minMSRP
product:msrp
product:priceFrom
product:priceTo
product:shippingCost
product:shippingWeight
product:weight
product:width

SearchMonkey Resume

resume:Resume
resume:contact
resume:duration
resume:education
resume:experience
resume:org
resume:summary

The rel Vocabulary (Deprecated)

C. PHP Reference

SearchMonkey PHP Whitelist

DOM Class Whitelist
Other Class Whitelist
String Functions Whitelist
Array Functions Whitelist
Variable Functions Whitelist
Output Functions Whitelist
Date Functions Whitelist
Regex Functions Whitelist
JSON Functions Whitelist
Math Functions Whitelist
Reflection Functions Whitelist
Other Functions Whitelist

The Data Class

public static function get()

Parameters
Returns

public static function getImage()

Parameters
Returns

public static function getStars()

Parameters
Returns

public static function getStarsFromNum()

Parameters
Returns

public static function xpath()

Parameters
Returns

public static function xpathString()

Parameters
Returns

D. FAQ: SearchMonkey and the Semantic Web

List of Figures

1.1. From Basic to Enhanced
1.2. Structure of a SearchMonkey Application
1.3. You are Done!
2.1. Application Dashboard
2.2. Basic Info Screen
2.3. URLs Screen
2.4. Data Extraction Screen
2.5. Preview Pane: Data Extraction Screen
2.6. Confirmation Screen
2.7. Data Services Library Submission Screen
2.8. Basic Info Screen
2.9. Inputs Screen
2.10. Test Data Screen
2.11. Endpoint Screen
2.12. Preview Pane: Endpoint Screen
2.13. Confirmation Screen
2.14. Data Services Library Submission Screen
2.15. Example Infobar: Acme Movies
2.16. Example Enhanced Result: Acme Movies
2.17. Basic Info Screen
2.18. URLs Screen
2.19. Data Services Screen
2.20. Appearance Screen
2.21. Preview Pane: Appearance Screen
2.22. Confirmation Screen
2.23. Confirmation Screen
3.1. Triples Diagram
3.2. Mapping the Data Service to the Application
3.3. RDF Triples for Joe's Home Page
C.1. PHP Insert Buttons

List of Tables

C.1. SearchMonkey Icons

List of Examples

2.1. Example DataRSS
2.2. Extracting a Photo from a Page with XSLT
3.1. Example DataRSS
3.2. Contact Information in hCard Format
3.3. Joe's Home Page with RDFa Markup
3.4. Joe's Home Page with eRDF Markup