hreview-faq: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
mNo edit summary
 
(37 intermediate revisions by 12 users not shown)
Line 1: Line 1:
= hReview FAQ =
= hReview FAQ =


This page is for documenting Q&A about [[hreview|hReview]].
This page is for documenting Q&A about [[hreview|hReview]].  If you have a new question to ask, Please consider first asking your question on the [ircs://irc.libera.chat:6697/microformats microformats irc channel] (preferably) or the [http://microformats.org/mailman/listinfo/microformats-discuss/ microformats-discuss] list.


# ''Some of the values for the 'type' field could use some more details, and some specific examples might be useful. In particular, I wonder about the 'product' type. If you are reviewing a book, a movie on DVD (or in a theater, for that matter), or a music CD, should you use the product type? Or since you're typically reviewing the content, and not the literal, physical product, should you just not specify a type? Or should there be a 'media' type? Also, what is the difference between the 'website' and 'url' type? --[[User:Dougal Campbell|Dougal Campbell]] 11:54, 21 Jun 2005 (PDT) ''
== Q&A ==
#*  Tantek says: I'll get to this in a few minutes.  Have to go have brunch with parents now!
 
# ''I'm curious as to why the limited list of types, and why it needs to be limited to the 7 values listed.  I can see the benefit of limiting it somewhat, but limiting it also assumes in a sense that nothing else would be reviewed, or that users of the structured data don't care to know the type of those other items.  What if I want to use hReview to review a podcast, for example?  I could shove that into one of the types already defined, but none are quite the right fit.
# What is the purpose of the hReview microformat (i.e. why is it important for it to exist)?
#*
 
# What are the advantages of using the hReview microformat?
 
# ''How do you specify more detail for the 'type' field, e.g. for an item of type "product" that is a book, or a movie (on DVD or in a theater), or a music CD? -- paraphrased from [[User:Dougal Campbell|Dougal Campbell]] 11:54, 21 Jun 2005 (PDT)''
#* The 'type' field was kept delibrately coarse and simple.  Any attempt to build a thorough and meaningful taxonomy of all specific types of things that can be reviewed would be futile.  Instead, the set of reviewed item types is kept small and fairly generic.  Specific "typing" information about the item being reviewed should be published as tags as defined in [[hreview|hReview]].  E.g. a review of a book would be tagged with a [http://en.wikipedia.org/wiki/Book book tag]: <code><a rel="tag" href="http://en.wikipedia.org/wiki/Book">book</a></code> .  Similarly a movie that was a DVD should be tagged with both: <code><a rel="tag" href="http://en.wikipedia.org/wiki/Movie">movie</a> <a rel="tag" href="http://en.wikipedia.org/wiki/DVD">DVD</a></code> . Or a music CD: <code><a rel="tag" href="http://en.wikipedia.org/wiki/music">music</a> <a rel="tag" href="http://en.wikipedia.org/wiki/CD">CD</a></code> .
# ''What is the difference between the 'website' and 'url' type? --[[User:Dougal Campbell|Dougal Campbell]] 11:54, 21 Jun 2005 (PDT)''
#* A 'website' presumably includes everything located on that site, whereas 'url' refers only to the particular page located at the given 'url'.
# ''What if I want to use hReview to review a podcast? Which type should I use?''
#* As a podcast is typically a specific URL (often ending with ".mp3") the "url" item type should be used when publishing an hReview of a podcast.
# ''What is the proper 'type' to use for a restaurant?''
#* A restaurant is a "business".
# ''Is there a standard way to add information that isn't in the default list of fields? It seems like book reviews should include the author's name, but there's no obvious way to add it to the markup.  The example reviews include it in the text, but it's not part of their markup. [[User:Chris Hibbert|Chris Hibbert]]''
#* See [http://microformats.org/discuss/mail/microformats-discuss/2005-September/000985.html email answer on microformats-discuss] - [http://tantek.com/log/ Tantek]
# ''How do I state the scale of the rating field? [http://k.digitalfarmers.com/ Kal Ström]''
#* Please read the [http://microformats.org/wiki/hreview#Field_details rating field description].  The default scale is 1 (worst) to 5 (best) and either can be changed by the author.  See the [http://microformats.org/wiki/hreview#Multidimensional_Restaurant_Review multidimensional restaurant review] for an example of this. - [http://tantek.com/log/ Tantek]
# ''Is there some recommendation as to the url for movies, imdb perhaps?'' - [[User:Judson Dunn|Judson Dunn]] 12:40, 17 Dec 2005 (PST)
#* Many users use imdb.com URLs to refer to movies.  Others use amazon.com or other DVD etc. product URLs to refer to movies.  Some even use the URLs to specific movie sites themselves, e.g. whatisthematrix.com.  Some also use URLs to movie traliers on movie trailer sites.  You should use whatever you think best represents the specific item you are reviewing.  Microformats.org does not make a recommendation to use one of the above in particular. - [http://tantek.com/log/ Tantek]
# ''Can the item being reviewed have more than one photo?''
#* Yes.  In general if the specification does not explicitly forbid it, a property may take multiple values (or be specified multiple times).
# ''Is there a recommended way to use hReview to "rate" stocks?''
#* Typically what you are rating is not the stock, but the company behind the stock, which would simply be an item of 'type' 'business', and you would include an [[hcard|hCard]] for the company.  If you are actually rating a specific stock (for example in the case where a company has more than one type of stock for trade), then in essence you are reviewing a 'product' which is bought and sold.  In that case, you can specify the item 'type' to be a 'product', and then use a standard stock market name for the stock symbol, e.g. "[http://finance.yahoo.com/q?s=T NYSE:T]" for AT&T stock, "[http://finance.yahoo.com/q?s=MSFT NasdaqNM:MSFT]" for Microsoft stock, "[http://finance.yahoo.com/q?s=%5EDJI DJI:^DJI]" for the Dow Jones Industrial Average.  More such scoped names for stocks can be found by looking them up on [http://finance.yahoo.com/ Yahoo! Finance], and you could even use a stock's Yahoo! Finance URL as the item's 'url' in the hReview, e.g. as linked from the examples listed.
#* In addition, see the FAQ#1 above.  As a "stock" is a particular kind of product, you should probably tag the item in the hReview with a set of tags, e.g.:
#** <code><nowiki><a href="http://technorati.com/tag/stock" rel="tag">stock</a></nowiki></code>
#** <code><nowiki><a href="http://technorati.com/tag/msft" rel="tag">msft</a></nowiki></code>
#** ... etc.
# ''Should rated tags show up alongside other tags in an hReview?''
#* Both rated tags and normal tags apply to the item being reviewed, and thus both are in the total set of tags for the item.  As far as where they should show up, that is up to the user interface of the software or service that is displaying the hReviews.
# ''Are decimal-number ratings allowed?  (ie 4.5)''
#* One decimal point of precision is added in hReview 0.3 based on analysis of common rating behaviors on the Web.
# ''How do you markup a page for an item that has multiple reviews on that page (without having to repeat the information about the item in each review? Ning could use this, specifically in their default http://reviewit.ning.com/ , see also http://hreviewit.ning.com''
#* Possibly use the object inclusion method from [[resume-brainstorming]].
# ''For a music review, is there a standard for designating/tagging the Artist name separate from the Album name or Track name etc?''
#* It depends on what specifically you are reviewing.  If you are reviewing the Artist as a whole, then the Artist is the item.  If you are reviewing a specific Album, then the Album is the item.  If you are reviewing a particular Track, then the Track is the item.  You can then just use tags for the rest of the information.
#*# ''Is there a standard way of specifying what the tag is addressing semantically?  That is, say I were reviewing the album OK Computer from Radiohead - the item is of course OK Computer - and I can have a tag to Radiohead - but is there an accepted practice as marking it as an "artist" tag?''
#*#* The short answer is no, tags are a relatively flat set of "aspects" of the item, and you can't give tags a "type" like that.  The longer answer is, you could tag it Radiohead using a tagspace (see [[rel-tag]] for details) that specifically defined Radiohead as an artist, e.g. perhaps the [http://en.wikipedia.org/wiki/Radiohead Wikipedia page for Radiohead].
# ''Does anyone have a examples of hReview documents? I.e.  both valid and invalid examples to test a parser against?''
#* Please see [[hreview-examples-in-wild|hReview Examples in the Wild]].
 
==Related pages==
{{hreview-related-pages}}

Latest revision as of 16:42, 16 February 2022

hReview FAQ

This page is for documenting Q&A about hReview. If you have a new question to ask, Please consider first asking your question on the microformats irc channel (preferably) or the microformats-discuss list.

Q&A

  1. What is the purpose of the hReview microformat (i.e. why is it important for it to exist)?
  1. What are the advantages of using the hReview microformat?
  1. How do you specify more detail for the 'type' field, e.g. for an item of type "product" that is a book, or a movie (on DVD or in a theater), or a music CD? -- paraphrased from Dougal Campbell 11:54, 21 Jun 2005 (PDT)
  2. What is the difference between the 'website' and 'url' type? --Dougal Campbell 11:54, 21 Jun 2005 (PDT)
    • A 'website' presumably includes everything located on that site, whereas 'url' refers only to the particular page located at the given 'url'.
  3. What if I want to use hReview to review a podcast? Which type should I use?
    • As a podcast is typically a specific URL (often ending with ".mp3") the "url" item type should be used when publishing an hReview of a podcast.
  4. What is the proper 'type' to use for a restaurant?
    • A restaurant is a "business".
  5. Is there a standard way to add information that isn't in the default list of fields? It seems like book reviews should include the author's name, but there's no obvious way to add it to the markup. The example reviews include it in the text, but it's not part of their markup. Chris Hibbert
  6. How do I state the scale of the rating field? Kal Ström
  7. Is there some recommendation as to the url for movies, imdb perhaps? - Judson Dunn 12:40, 17 Dec 2005 (PST)
    • Many users use imdb.com URLs to refer to movies. Others use amazon.com or other DVD etc. product URLs to refer to movies. Some even use the URLs to specific movie sites themselves, e.g. whatisthematrix.com. Some also use URLs to movie traliers on movie trailer sites. You should use whatever you think best represents the specific item you are reviewing. Microformats.org does not make a recommendation to use one of the above in particular. - Tantek
  8. Can the item being reviewed have more than one photo?
    • Yes. In general if the specification does not explicitly forbid it, a property may take multiple values (or be specified multiple times).
  9. Is there a recommended way to use hReview to "rate" stocks?
    • Typically what you are rating is not the stock, but the company behind the stock, which would simply be an item of 'type' 'business', and you would include an hCard for the company. If you are actually rating a specific stock (for example in the case where a company has more than one type of stock for trade), then in essence you are reviewing a 'product' which is bought and sold. In that case, you can specify the item 'type' to be a 'product', and then use a standard stock market name for the stock symbol, e.g. "NYSE:T" for AT&T stock, "NasdaqNM:MSFT" for Microsoft stock, "DJI:^DJI" for the Dow Jones Industrial Average. More such scoped names for stocks can be found by looking them up on Yahoo! Finance, and you could even use a stock's Yahoo! Finance URL as the item's 'url' in the hReview, e.g. as linked from the examples listed.
    • In addition, see the FAQ#1 above. As a "stock" is a particular kind of product, you should probably tag the item in the hReview with a set of tags, e.g.:
      • <a href="http://technorati.com/tag/stock" rel="tag">stock</a>
      • <a href="http://technorati.com/tag/msft" rel="tag">msft</a>
      • ... etc.
  10. Should rated tags show up alongside other tags in an hReview?
    • Both rated tags and normal tags apply to the item being reviewed, and thus both are in the total set of tags for the item. As far as where they should show up, that is up to the user interface of the software or service that is displaying the hReviews.
  11. Are decimal-number ratings allowed? (ie 4.5)
    • One decimal point of precision is added in hReview 0.3 based on analysis of common rating behaviors on the Web.
  12. How do you markup a page for an item that has multiple reviews on that page (without having to repeat the information about the item in each review? Ning could use this, specifically in their default http://reviewit.ning.com/ , see also http://hreviewit.ning.com
  13. For a music review, is there a standard for designating/tagging the Artist name separate from the Album name or Track name etc?
    • It depends on what specifically you are reviewing. If you are reviewing the Artist as a whole, then the Artist is the item. If you are reviewing a specific Album, then the Album is the item. If you are reviewing a particular Track, then the Track is the item. You can then just use tags for the rest of the information.
      1. Is there a standard way of specifying what the tag is addressing semantically? That is, say I were reviewing the album OK Computer from Radiohead - the item is of course OK Computer - and I can have a tag to Radiohead - but is there an accepted practice as marking it as an "artist" tag?
        • The short answer is no, tags are a relatively flat set of "aspects" of the item, and you can't give tags a "type" like that. The longer answer is, you could tag it Radiohead using a tagspace (see rel-tag for details) that specifically defined Radiohead as an artist, e.g. perhaps the Wikipedia page for Radiohead.
  14. Does anyone have a examples of hReview documents? I.e. both valid and invalid examples to test a parser against?

Related pages

Retrieved from "http://microformats.org/wiki/index.php?title=hreview-faq&oldid=70488"