Documentation

= The GoodRelations User's Guide =

Note: The new GoodRelations User's Guide is still under development.

In the meantime, you can use the 2008 version of the GoodRelations primer, available at


 * http://www.heppnetz.de/projects/goodrelations/primer/

I. Quickstart (to be completed)


 * 1) What is GoodRelations?
 * 2) Adding GoodRelations to Your Site
 * 3) Minimal Example for Google, Yahoo, and Facebook
 * 4) Adding GoodRelations to Standard Web Shop Software
 * 5) Feature Comparison

'''II. Preliminaries''' (to be completed)


 * 1) Design Goals and Considerations
 * 2) GoodRelations vs. the Semantic Web, Linked Data, and the Opengraph Protocol
 * 3) RDF, RDF/XML, RDFa, Microdata, and SPARQL
 * 4) Understanding the New Role of URIs for Data Markup
 * 5) The Single, Most Productive Way of Developing RDFa Markup
 * 6) GoodRelations in Microdata syntax and in combination with schema.org
 * 7) Tool Recommendations for Developers

'''III. GoodRelations in Depth''' (to be completed)


 * 1) Understanding the Conceptual Model
 * 2) Representing Quantitative Values (Examples: 220 volts, 5 to 10 miles, 5400 rpm)
 * 3) Representing Qualitative Values and Enumerations (Examples: Garment sizes, product colors, plug types)
 * 4) Offer (gr:Offering)
 * 5) Company or Person (gr:BusinessEntity)
 * 6) Store or Point of Sale (gr:Location)
 * 7) Opening Hours
 * 8) Product or Service (gr:ProductOrService, gr:SomeItems, gr:Individual)
 * 9) Pricing
 * 10) Bundles
 * 11) Options, Add-ons, Extensions
 * 12) Product Models
 * 13) Product Variants
 * 14) Structured Values and Value References
 * 15) Consumables, Accessories, Spare Parts, and Similar Products
 * 16) GoodRelations and Product Ontologies
 * 17) Developing Extensions for Vertical Industries
 * 18) Explicating Demand: Wish-lists, Tendering, Interest to Buy
 * 19) Exposing Ownership: Global Shopping History
 * 20) Reviews
 * 21) Images and Logos
 * 22) Geo Data

'''IV. Publishing GoodRelations Data''' (to be completed)


 * 1) Overview
 * 2) Only RDFa
 * 3) Only Microdata
 * 4) Only RDF/XML
 * 5) SPARQL Endpoints
 * 6) Combining RDFa and RDF/XML
 * 7) Sitemaps, Semantic Sitemaps, and Dumps
 * 8) Spreading the Word: Ping Services and Search Engine Submission
 * 9) Access Control

V. Consuming GoodRelations Data (to be completed)


 * 1) Overview
 * 2) Offers
 * 3) Model master data
 * 4) Stores
 * 5) Matchmaking

'''VI. Annex''' (to be completed)


 * 1) Popular UN/CEFACT Common Codes for Units of Measurement