aggregate-microformat-template-brainstorming

(Difference between revisions)

Jump to: navigation, search
(New page: Ideas/proposal for how to mark up aggregate or summary information about a collection of related microformats (i.e. aggregation of user reviews, summary of product offers, summary of posts...)
Line 2: Line 2:
Since summary information can be relevant for many different types of microformats, it seems useful to design a system of marking up aggregate/summary information that generalizes to any existing or future microformat.  
Since summary information can be relevant for many different types of microformats, it seems useful to design a system of marking up aggregate/summary information that generalizes to any existing or future microformat.  
 +
 +
 +
== Why do we need to mark this information up at all? ==
 +
 +
Why can't the parser reconstruct the aggregate information by reading each individual microformat?
 +
 +
Although doing so is possible in some cases, in real-life scenarios it is often infeasible (or at a minimum much less efficient) to reconstruct aggregate info rather than reading the summary data written on the page directly, since the content being aggregated can be voluminous and spread across many web pages.
Line 11: Line 18:
* For prices, the range (low and high price) are relevant
* For prices, the range (low and high price) are relevant
* For message board posts, the most recent post date is relevant
* For message board posts, the most recent post date is relevant
-
 
-
 
-
== Why do we need to mark this information up at all? ==
 
-
 
-
Why can't the parser reconstruct the aggregate information by reading each individual microformat?
 
-
 
-
Although doing so is possible in some cases, in real-life scenarios it is often infeasible (or at a minimum much less efficient) to reconstruct aggregate info rather than reading the summary data written on the page directly, since the content being aggregated can be voluminous and spread across many web pages.
 
Line 24: Line 24:
Here is a proposed template for defining aggregate microformats:
Here is a proposed template for defining aggregate microformats:
-
* Any existing microformat has a corresponding aggregate microformat that follows a consistent naming convention. For example, an aggregate hReview could be "hReview-aggregate" and an aggregate hAtom could be "hAtom-aggregate."
+
* For any microformat "hX" there is a corresponding aggregate microformat that follows a consistent naming convention. For example, an aggregate hReview could be "hReview-aggregate" and an aggregate hAtom could be "hAtom-aggregate."
* The aggregate microformat contains all of the same attributes as the original microformat.
* The aggregate microformat contains all of the same attributes as the original microformat.
* Each attribute from the existing microformat can also take on some sub-attributes -- min, max, average, or sample. So an average rating would be class="rating average", a lowest price would be class="price min", a most recent blog post date would be class="updated max" (where max here is interpreted as the latest date), and a sample summary from a review would be class="summary sample".
* Each attribute from the existing microformat can also take on some sub-attributes -- min, max, average, or sample. So an average rating would be class="rating average", a lowest price would be class="price min", a most recent blog post date would be class="updated max" (where max here is interpreted as the latest date), and a sample summary from a review would be class="summary sample".
* Aggregate microformats contain an additional attribute that isn't imported from the original microformat -- for purposes of discussion, let's call this "count." It contains the number of objects that are being summarized.
* Aggregate microformats contain an additional attribute that isn't imported from the original microformat -- for purposes of discussion, let's call this "count." It contains the number of objects that are being summarized.
* Aggregate microformats can optionally contain one or more sample instances of the microformats that are being aggregated. So an hReview-aggregate could contain sample hReviews. The reason for this is that there are often highlighted instances on summary pages. Amazon shows the most popular reviews on the first page for a product and shopping aggregator sites usually show the best deal first in a list of offers.
* Aggregate microformats can optionally contain one or more sample instances of the microformats that are being aggregated. So an hReview-aggregate could contain sample hReviews. The reason for this is that there are often highlighted instances on summary pages. Amazon shows the most popular reviews on the first page for a product and shopping aggregator sites usually show the best deal first in a list of offers.
 +
 +
=== Example: aggregate review on Yelp ===
 +
 +
URL: http://www.yelp.com/biz/vive-sol-restaurant-mountain-view
 +
 +
<pre><nowiki>
 +
<div class="hReview-aggregate">
 +
<span class="fn">Vive Sol Restaurant</span>
 +
<span class="rating average">4</span> star rating
 +
based on <span class="count">180</span> reviews.
 +
</div>
 +
</nowiki></pre>
 +

Revision as of 08:01, 9 April 2009

Ideas/proposal for how to mark up aggregate or summary information about a collection of related microformats (i.e. aggregation of user reviews, summary of product offers, summary of posts on a message board, etc).

Since summary information can be relevant for many different types of microformats, it seems useful to design a system of marking up aggregate/summary information that generalizes to any existing or future microformat.


Contents

Why do we need to mark this information up at all?

Why can't the parser reconstruct the aggregate information by reading each individual microformat?

Although doing so is possible in some cases, in real-life scenarios it is often infeasible (or at a minimum much less efficient) to reconstruct aggregate info rather than reading the summary data written on the page directly, since the content being aggregated can be voluminous and spread across many web pages.


Types of information that appear in the examples


Proposal

Here is a proposed template for defining aggregate microformats:

Example: aggregate review on Yelp

URL: http://www.yelp.com/biz/vive-sol-restaurant-mountain-view

<div class="hReview-aggregate">
 <span class="fn">Vive Sol Restaurant</span>
 <span class="rating average">4</span> star rating 
 based on <span class="count">180</span> reviews.
</div>


See also

aggregate-microformat-template-brainstorming was last modified: Wednesday, December 31st, 1969

Views