hlisting-brainstorming

From Microformats Wiki
Revision as of 16:09, 29 June 2009 by JayMyers (talk | contribs) (submitting another revised version of hlisting schema changes before posting them to main hlisting page)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

listing microformat brainstorming

This is brainstorming for a hlisting microformat per the process.

Revised Base Schema Elements (proposed, revised by Jay Myers 16:55, 29 Jun 2009 (UTC))

  • hListing (hlisting)
    • listing action. optional. one or more tags, suggested set: sell | rent | trade | meet | announce | offer | wanted | event | service
    • lister. required. hCard | (fn || email || url || tel).
    • dtlisted. optional. ISO8601 absolute date time.
    • dtexpired. optional. ISO8601 absolute date time.
    • price. optional. text. [should include a floating-point number with optional ISO currency codes] - see the currency proposal
    • item info. optional. (fn || url || photo || geo || adr) | hCard (for person or business).
    • summary. optional. text.
    • description. required. text with optional valid XHTML markup.
    • item tags. optional. keywords or phrases describing the item being offered, using rel-tag
    • permalink. optional.
    • availability. optional. text.
    • condition. optional. text. examples: 'new', 'used', 'refurbished'.
    • shipping. optional. text. text describing shipping and fulfillment

Notes

Please see hListing examples page for analysis of 80/20 use case for new attributes availability, condition and shipping. I believe condition should still be considered even though it misses the 80/20 use case mark (71.2% based on current analysis) as it is included in most product-specific data submission services (e.g., Yahoo Product Submit, Google Base).



Revised Base Schema Elements (proposed)

  • hListing (hlisting)
    • listing action. optional. one or more tags, suggested set: sell | rent | trade | meet | announce | offer | wanted | event | service
    • lister. optional. hCard | (fn || email || url || tel).
    • dtlisted. optional. ISO8601 absolute date time.
    • dtexpired. optional. ISO8601 absolute date time.
    • price. optional. text. [should include a floating-point number with optional ISO currency codes] - see the currency proposal
    • item info. optional. (fn || url || photo || geo || adr) | hCard (for person or business).
    • summary. optional. text.
    • description. required. text with optional valid XHTML markup.
    • item tags. optional. keywords or phrases describing the item being offered, using rel-tag
    • permalink. optional.
    • availability. optional. text.
    • condition. optional. text. examples: 'new', 'used', 'refurbished'.
    • shipping. optional. text. text describing shipping and fulfillment


Items removed

  • version. optional. text.
  • +1 I'm tending to agree with the removal of version, as in practice it has not been necessary for either hReview or hListing.Tantek 17:45, 16 April 2009 (UTC)
  • item info. optional. (fn || url || photo || geo || adr) | hCard (for person or business).
  • Removal of item seems to be a mistake, as that is used to indicate the item itself being listed. E.g., a nested hProduct would be <p class='item hproduct'></p>. Removal appears to leave no way to include what is being listed. --BenWard 17:38, 16 April 2009 (UTC)
    • +1 completely agreed with Ben Ward's point. Wide use of hReview in the wild has shown that having an explicit "item" is both necessary and works in practice. Tantek 17:40, 16 April 2009 (UTC)
  • Indeed it was a mistake... left it out of my edits. Replaced. JayMyers 21:04, 22 April 2009 (UTC)

Items added

  • Each of the following should cite the analysis made of real world examples that demonstrates the 80%+ use case need, otherwise, they should not be added. Tantek 17:45, 16 April 2009 (UTC)
  • availability. optional. text.
  • condition. optional. text. examples: 'new', 'used', 'refurbished'.
  • shipping. optional. text. text describing shipping and fulfillment

Items changed:

  • listing action => optional. if omitted, action assumed to be sell
  • lister => optional. if omitted, the buyer/seller is assumed to be the site where the microformat exists
  • In that case, an algorithm should be provided for how to determine the hCard for the lister, if no explicit lister is given. Tantek 17:45, 16 April 2009 (UTC)