hreview-profile: Difference between revisions

Latest revision as of 16:28, 18 July 2020

The following is an XMDP profile for the hReview specification.

URLs

This profile is hosted as a separate XMDP file on microformats.org:

http://microformats.org/profile/hreview
shortURL: http://ufs.cc/x/hreview

Usage

Profiles are referenced in (X)HTML files in the <head> tag, e.g.:

<head profile='http://microformats.org/profile/hreview'>

Profile

<dl class="profile">
 <dt id="rel">rel</dt>
 <dd><p>
   <a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rel">
     HTML4 definition of the 'rel' attribute.</a>  
   Here are additional values as defined in the
   <a rel="help start" href="http://microformats.org/wiki/rel-license">
   rel-license</a> and
   <a rel="help start" href="http://microformats.org/wiki/rel-tag">
   rel-tag</a> 
   specifications.</p>
  <dl>
   <dt id="license">license</dt>
   <dd>Indicates that the referred resource is a license for the referring hReview.</dd>
   <dt id="self">self</dt>
   <dd>Indicates that the referred resource serves as a permalink, for the referring hReview.</dd>
   <dt id="tag">tag</dt>
   <dd>Indicates that the referred resource serves as a "tag", 
       or keyword/subject, for the referring page, or some portion of the referring page (such as an hReview).</dd>
  </dl>
 </dd>
 <dt>class</dt>
 <dd><p>
   <a href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
   HTML4 definition of the 'class' attribute.</a>
   This meta data profile defines some 'class' attribute values (class names) 
   and their meanings as suggested by a 
   <a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
   draft of "Hypertext Links in HTML"</a>.
   All values are defined according to the semantics defined in the 
   <a rel="help start" href="http://microformats.org/wiki/hreview">
   hReview specification</a>.
  </p>
  <dl>
   <dt id="hreview">hreview</dt>
    <dd>The root class name and container for a review.
   </dd>

   <dt id="version">version</dt>
    <dd>This optional property permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this property, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This property is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". 
    </dd>

   <dt id="summary">summary</dt>
    <dd>This optional property serves as a short synopsis, title, or name of the review. Re-used from hCalendar which re-uses it from iCalendar (section 4.8.1.12 of RFC 2445).
    </dd>

   <dt id="type">type</dt>
    <dd>This optional property provides the type of the item being reviewed, one of several enumerated values listed here:
     <dl>
      <dt>product</dt>
      <dt>business</dt>
      <dt>place</dt>
      <dt>person</dt>
      <dt>event</dt>
      <dt>website</dt>
      <dt>url</dt>
     </dl>
    </dd>

   <dt id="item">item</dt>
   <dd>The item the review is about. Depending on the type, it must be represented by a microformat on the item element itself: 
    <a href="http://microformats.org/wiki/hcard">hCard</a> (for a business, place, or person),  
    <a href="http://microformats.org/wiki/adr">adr</a> (for a place),  
    <a href="http://microformats.org/wiki/geo">geo</a> (for a place), or
    <a href="http://microformats.org/wiki/hcalendar">hCalendar event</a> (for an event).
   </dd>

   <dt id="fn">fn</dt>
    <dd>item subproperty. The formatted name of an item. Re-used from hCard which re-uses it from vCard (section 3.1.1 of RFC 2426).</dd>

   <dt id="url">url</dt>
    <dd>item subproperty. A URL of an item. This subproperty must be provided if the item is a "website" or "url". Re-used from hCard which re-uses it from vCard (section 3.6.8 of RFC 2426).</dd>

   <dt id="photo">photo</dt>
    <dd>item subproperty. A URL to a photo of an item. Re-used from hCard which re-uses it from vCard (section 3.1.4 of RFC 2426).</dd>

   <dt id="reviewer">reviewer</dt>
    <dd>This optional property provides information about the person who authored the review. If the value is a provided then the same element that 
    has the class name of "reviewer" should use the class name of "vcard" and thus represent an embedded hCard.</dd>

   <dt id="dtreviewed">dtreviewed</dt>
    <dd>This optional property specifies the date and time (in ISO8601 date or date-time) that the review was written or otherwise authored.
    </dd>

   <dt id="rating">rating</dt>
   <dd>This optional property specifies a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default.  
Optionally a different integral "worst" value and/or "best" subproperty may be specified to indicate a different range (e.g. 6 from 0-10).
   </dd>

   <dt id="worst">worst</dt>
    <dd>rating subproperty. a rating value denoting the poorest rating possible for the item. default: 1.0.</dd>

   <dt id="best">best</dt>
    <dd>rating subproperty. a rating value denoting the best rating possible for the item. The "best" value may be numerically smaller than the "worst" value. default: 5.0.</dd>

   <dt id="description">description</dt>
    <dd>This optional property serves as a more detailed synopsis of the review than that provided by summary. Re-used from hCalendar which re-uses it from iCalendar (section 4.8.1.5 of RFC 2445.).
    </dd>

   <dt id="category">category</dt>
   <dd>Category of the review object.  
    Note: this property may be repeated (an event may belong in several categories). Re-used from hCalendar which re-uses it from iCalendar (section 4.8.1.2 of RFC 2445).
   </dd>
   
   <dt id="value">value</dt>
    <dd>This class name is used to distinguish the <em>actual</em> value
     of a property from any other cruft that may be in 
     the containing element representing the property.
     See the 
     <a href="http://microformats.org/wiki/value-class-pattern"> 
      value-class-pattern</a> for details.</dd>

   <dt id="value-title">value-title</dt>
    <dd>This class name is used to distinguish the <em>actual</em> value
     of a property, specifically in the 'title' attribute of the element,
     from the element contents and the element representing 
     the containing property.
     See the 
     <a href="http://microformats.org/wiki/value-class-pattern#Parsing_value_from_a_title_attribute"> 
      value-class-pattern value-title description</a> for details.</dd>
  </dl>
 </dd>
</dl>

Related Pages

hreview
hReview-aggregate - microformat for specifying summary information from a collection of reviews about a product or service
hReview creator (feedback) - create your own hReview.
hReview authoring - learn how to add hReview mark-up to your existing contact info.
hReview brainstorming - thoughts for improving hReview.
hReview cheatsheet - hCard properties.
hReview examples in the wild - an on-going list of websites which use hReview.
hReview FAQ - If you have any questions about hReview, check here, and if you don't find answers, add your questions!
hReview feedback - Feedback is encouraged!
hReview implementations - websites or tools which either generate or parse hReviews.
hReview issues - Please add any issues with the specification to the issues page.
hReview parsing - Normatively details of how to parse hReviews.
hReview profile - The XMDP profile for hReview.
hReview tests - a wiki page with actual embedded hReviews to try parsing.
hReview advocacy - encourage others to use hReview.
review-examples
- hreview-examples
review-formats
review-brainstorming - where we brainstormed about review formats before coming up with hReview.
currency - proposal for marking up amounts of money (e.g. prices of reviewed items).
Aggregate reviews - examples - formats - brainstorming

hreview-profile: Difference between revisions

Latest revision as of 16:28, 18 July 2020

Contents

URLs

Usage

Profile

Related Pages

Navigation menu

hreview-profile: Difference between revisions

Latest revision as of 16:28, 18 July 2020

URLs

Usage

Profile

Related Pages

Navigation menu

Search