W3C home > Mailing lists > Public > public-vocabs@w3.org > July 2012

Re: Review example inconsistencies

From: Stéphane Corlosquet <scorlosquet@gmail.com>
Date: Sat, 30 Jun 2012 20:17:55 -0400
Message-ID: <CAGR+nnHtud_SSQtQMj-wt_=ug8WtsRCr7TwEkteShoW-iSWj2A@mail.gmail.com>
To: Robert Schroeder <bobsc@charter.net>
Cc: public-vocabs@w3.org
Hi Robert,

I'm not sure to 100% understand what you're asking but I'll give it a try

On Sat, Jun 30, 2012 at 5:10 PM, Robert Schroeder <bobsc@charter.net> wrote:

>   I noticed some property inconsistencies for Review.
> Which one is correct:
> 1. <span itemprop="name">Not a happy camper</span>
> 2. <span itemprop="description">Not a happy camper</span>

Usually, if possible, it's best practice to give a name (or title) to your
data object. There might be cases though where depending on your web
application, there might be no title available (it can be the case for
comments in Drupal for example, whose title can be disabled). Same could
apply for reviews. Schema.org recommends to have a name for data items, I
don't see Review being an exception here. Ultimately it's up to the
consumer to decide what to do with this value, and what to do if it is
missing. The value "Not a happy camper" in the example 1 of schema.org is
IMO the name/title of the review as it was entered by the person who wrote
the review. So I don't think 'description' is the right property to use (in
other words it seems to me that the example is correct on
schema.org/Reviewby using 'name').

> Which one is correct:
> 1. <span itemprop="description">The lamp burned out and now I have to
> replace it.</span>
> 2. <span itemprop="reviewBody">The lamp burned out and now I have to
> replace it.</span>

Here I'm assuming you're asking which property should be used for the
actual content of the review. The example 1 of schema.org uses
'description' for the review content, and the example 2 uses 'reviewBody'.
You might be asking when to use one and when to use the other. I can't
speak for the person who wrote these example, but in my opinion the full
length review should go in 'reviewBody', I tend the consider the
description as a kind of teaser for the data item content (this teaser
could be generated from the full length review perhaps). I'm basing this
opinion on the definition of the description property: "A short description
of the item.". If you were to put the full length review in 'description',
you'd have a hard time guaranteeing that it remains short. The application
might truncate it, but in the case you would need a property for the full
length review, which would be 'reviewBody'.

So there is some inconsistency here between the two examples, and it might
be worth indicating which property should be used for the content of the
review. (I'd personally vote for reviewBody based on my analysis above).
Again, the consumers are free to pick the property they want, but some form
of agreement or recommendation here would help both authors and consumers.

These are only my 2cts!

Received on Sunday, 1 July 2012 00:18:23 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 17:48:47 UTC