hlisting-feedback: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(ladarrola)
m (Reverted edits by LetoeLtrol (Talk) to last version by OlocnAlile)
Line 1: Line 1:
monletoeltp
ouc4ter
ouc4ter
= hlisting-feedback =
= hlisting-feedback =
Line 70: Line 69:
== Desire to Inherit Context ==
== Desire to Inherit Context ==


When it comes to blog posting, I’d like to see us address the following:
When it comes to blog posting, I’d like to see us address the following:


1. '''Less is more'''. Or in reverse, people are lazy, and the less fields they need to fill in order to sell a couch or find a date, the more they'll use the plugin. So I'm trying to visualize how this plays in with the user interface and how we can keep it as simple as possible.
1. '''Less is more'''. Or in reverse, people are lazy, and the less fields they need to fill in order to sell a couch or find a date, the more they'll use the plugin. So I'm trying to visualize how this plays in with the user interface and how we can keep it as simple as possible.
Line 91: Line 90:
== '''On hReview''' ==
== '''On hReview''' ==


This draft was heavily influenced by hReview. That's a good thing. We don’t want to duplicate efforts; are learning from the mistakes of others; and converging on a cohesive set of specifications. I want to eventually add hReview and hCard to my plugin. So this strategy of borrowing from existing microformats helps me get it done quicker. It took me all of five minutes to leverage address formatting from hEvent.
This draft was heavily influenced by hReview. That's a good thing. We don’t want to duplicate efforts; are learning from the mistakes of others; and converging on a cohesive set of specifications. I want to eventually add hReview and hCard to my plugin. So this strategy of borrowing from existing microformats helps me get it done quicker. It took me all of five minutes to leverage address formatting from hEvent.


But we also need to recognize that hReview could also be more blogging friendly. The specification is great, but the implementations are lacking. I think the reason is that hReview was designed for greenfield applications that specifically deal with emitting reviews. The design did not take into consideration applications that already deal with content, but want to supplement it with reviews, listings, etc. There's no mention of such consideration in the spec.
But we also need to recognize that hReview could also be more blogging friendly. The specification is great, but the implementations are lacking. I think the reason is that hReview was designed for greenfield applications that specifically deal with emitting reviews. The design did not take into consideration applications that already deal with content, but want to supplement it with reviews, listings, etc. There's no mention of such consideration in the spec.
Line 104: Line 103:
== '''Neighborhood Name''' ==
== '''Neighborhood Name''' ==


With the exception of housing, most classified listings don’t contain a specific address (e.g., if I’m selling my couch, you don’t need to know where I live in the listing).    Some location information, however, is important.  In most suburban areas, the name of the town is sufficient.  In cities, however, neighborhood is important and more contextually relevant than zipcode (simply a region defined by the post office).
With the exception of housing, most classified listings don’t contain a specific address (e.g., if I’m selling my couch, you don’t need to know where I live in the listing).    Some location information, however, is important.  In most suburban areas, the name of the town is sufficient.  In cities, however, neighborhood is important and more contextually relevant than zipcode (simply a region defined by the post office).


This is a tough problem that needs to be solved but outside the context of this discussion.  We think there are other cases the could benefit from it, including hReview and hEvent.  We recommend that this debate be surface in the adr microformation discussion (e.g., perhaps extend the locality field (city) to optionally include a neighborhood)
This is a tough problem that needs to be solved but outside the context of this discussion.  We think there are other cases the could benefit from it, including hReview and hEvent.  We recommend that this debate be surface in the adr microformation discussion (e.g., perhaps extend the locality field (city) to optionally include a neighborhood)

Revision as of 19:21, 3 January 2009

ouc4ter

hlisting-feedback

This document is for keeping track of feedback about hlisting, one of several microformats.


Template

Consider using this format (copy and paste this to the end of the list to add your issues; replace ~~~ with an external link if preferred) to report issues or feedback, so that issues can show up in hAtom subscriptions of this issues page. If open issues lack this markup, please add it.

Please post one issue per entry, to make them easier to manage. Avoid combining multiple issues into single reports, as this can confuse or muddle feedback, and puts a burden of separating the discrete issues onto someone else who 1. may not have the time, and 2. may not understand the issue in the same way as the original reporter.

<div class="hentry">
{{OpenIssue}} 
<span class="entry-summary author vcard">
 <span class="published">2011-MM-DD</span> 
 raised by <span class="fn">~~~</span>
</span>
<div class="entry-content discussion issues">
* <strong class="entry-title">«Short title of issue»</strong>. «Description of Issue»
** Follow-up comment #1
** Follow-up comment #2
</div>
</div>

Schema Issues

Item

  • is class="item" a part of the spec? It is not clear from the highlight in the proposal.
  • if it is, is it optional (as in the schema) or required (as implied by the item item metadata section). My feeling is that it should be required

-- DavidJanes 2006-11-18

Listing Action

  • "listing action" is another one that confuses me, is that two words, one word "listing-action" or just a tag with some of the recommended values... it is required, but i don't see it in action on edgeio.com or Dealtagger

-- BrianSuda 2006-11-18

  • I think the listing action semantics are all wrong. Actions should not be hidden in class attributes. These are not classes of data. The class of data is "listing-action". The action itself is content. I think <span class="offer rent">for rent</span> should be more like <abbr title="offer" class="listing-action">for</abbr> <span class="listing-aciton">rent</span> ScottReynen 20:52, 17 Apr 2007 (PDT)
  • I'm not convinced that this should be a tag; how many of the sites used as evidence have a link on the word "sale" or "wanted"? Whether or not it is a tag, the default value, if none is stated, should be "sale". Andy Mabbett 08:52, 8 Jan 2008 (PST)

Make Info/Photo fields Optional

WordPress has a great WYSIWYG editor that lets you drag & drop images. But the only semantic identification it uses is the HTML <img> element. So how do we get a photo to be identified from all the images inside the description?

1. Manually edit the HTML that WordPress creates to add the class. 2. Add another UI doubling the one already used by WordPress, sans drag & drop, strictly for images designated as photos. 3. Tag every single image as photo. 4. Have the crawler interpret every single image as photo.

I'm not sure we want to push the complexity to the edge, that's like asking people to create only valid XHTML pages and not rendering anything that refuses to validate. This is about humans first, machines second. If complexity needs to exist, it should be not in the blog, but in the crawlers.

-- Assaf Arkin

Permalink

There should be no "MUST" rel attributes for permalink, since pages should not, for accessisbility and usability reasons, link to themselves (do those in the evidence do this?), and it may be desirable to wrap the relevant URL in a span, rather than an anchor. Andy Mabbett 09:33, 8 Jan 2008 (PST)


Price

  • To allow for auctions, a "minimum price (i.e., the next permissible bid) and/ or "current-bid" is needed.
  • What about solicitations for an "offer"?

Item info

This should be called "location", taking a string or an hCard, as in hCalendar. Andy Mabbett 09:54, 8 Jan 2008 (PST)

Default Action

I think it's good form to have a default for every required field, since someone out there is going to drop any given requried field in the land of microformats. In that spirit, the default for listing type is offer, since wanted ads are << 10% in the real world. What I don't know is what the default action should be; the most neutral of them is announce, which I am using in my parser.

-- Rohit

Donations

Sell and Rent are obvious enough verbs; what does Trade mean, though? Barter? And what about one-sided gifts, like donations or "free to recycle"? Should we replace Trade and offer Donate in its place?

-- Rohit

Desire to Inherit Context

When it comes to blog posting, I’d like to see us address the following:

1. Less is more. Or in reverse, people are lazy, and the less fields they need to fill in order to sell a couch or find a date, the more they'll use the plugin. So I'm trying to visualize how this plays in with the user interface and how we can keep it as simple as possible.

2. DRY. We want to capture as much information as possible from what is already available in the blog post. We already have summary (title), listing date/time (post date/time), permalink, author information, tags/categories.

3. Keep it simple. And here I'm talking about setup and being able to extend your blog's functionality without too much fuss. This one is a bit more tricky, so I'll go into details.

WordPress uses templates to render the blog post. The template then calls the WordPress API to render the title, a second call to render the content, and another call to render any additional metadata (e.g. publish date, categories, author). These separate calls allow people to play with the formatting and apply any styling they like.

The way uPress works, is by processing the blog post before it goes back to the filter, creating the hEvent (to be: hListing) element around it, and adding any relevant fields into the blog post. So what you fill in the form, finds its way to the post content. As a result, setting up the plugin requires two steps: drop it to the plugins directory, and activate.

Unfortunately, I only get to process the content of the post. I can't easily include the title inside the hListing element, or any other metadata about the post, even though I have access to it. If I duplicate that information, the post stops being readable. And to wrap the entire post (not just body) inside a microformat element, I need to tweak the template. Except people use different templates, and I can't tweak all of them.

So the more context we use, the better the plugin becomes.

-- Assaf Arkin

On hReview

This draft was heavily influenced by hReview. That's a good thing. We don’t want to duplicate efforts; are learning from the mistakes of others; and converging on a cohesive set of specifications. I want to eventually add hReview and hCard to my plugin. So this strategy of borrowing from existing microformats helps me get it done quicker. It took me all of five minutes to leverage address formatting from hEvent.

But we also need to recognize that hReview could also be more blogging friendly. The specification is great, but the implementations are lacking. I think the reason is that hReview was designed for greenfield applications that specifically deal with emitting reviews. The design did not take into consideration applications that already deal with content, but want to supplement it with reviews, listings, etc. There's no mention of such consideration in the spec.

We want to appeal to the wide populace of bloggers who just want to get stuff done. Rather than put the burden on millions of bloggers out there, we should place the burden on the few companies developing crawlers.

What would Tantek say? I think he'd ask us to focus on use cases, real examples. I'm presenting one such example. The use case involves a blogger who just wants to sell something on their blog, with the minimum amount of effort and cognitive friction. They want the listing to be discovered, aggregated and searched by others.

-- Assaf Arkin


Neighborhood Name

With the exception of housing, most classified listings don’t contain a specific address (e.g., if I’m selling my couch, you don’t need to know where I live in the listing). Some location information, however, is important. In most suburban areas, the name of the town is sufficient. In cities, however, neighborhood is important and more contextually relevant than zipcode (simply a region defined by the post office).

This is a tough problem that needs to be solved but outside the context of this discussion. We think there are other cases the could benefit from it, including hReview and hEvent. We recommend that this debate be surface in the adr microformation discussion (e.g., perhaps extend the locality field (city) to optionally include a neighborhood)

-- Craig Donato & Assaf Arkin

Listing Action, Listing Type, Item Type

We heavily debated how to classify a listing. Search engines or marketplaces typically need to understand what type of listing it is (e.g., personal ad, house for sale, music) to effectively reference or index a listing.

We initially considered proposing a single category field that contained tags (in addition to the tags field). Not only did this seem duplicative, it also seemed like too much of a good thing. In a previous project, Assaf managed to successfully overload everything into tags (including dates and locations), and run time-based and location-based searches, and ended up concluding it's a bad idea.

We eventually decided to propose the use three parametric field that when used together could define any type of listing independent of the words use to describe. These ended up being: listing-type (are you offering something or looking for something; listing-action (are you trying to sell, rent, or announce something); and item type (what item is referenced by the action such as a job opening, product, housing). By making small modifications to this vocabulary, users can specify an extremely wide range of potential transactions. This seemed more feasible given that the UI used to produce the hListing could abstract some of this from the user (as Assaf demonstrated in his demo plugin).

For example:

Desired Transaction Listing Type Listing Action Item Type
Merchandise For Sale Offer Sell Product
Looking to Buy Merchandise Wanted Sell Product
Selling Tickets Offer Sell Event
Apartment For Rent Offer Rent Housing
Looking for Apartment Wanted Rent Housing
Room for Rent (Roommate) Offer Rent Housing
Looking for a Date Offer Wanted Announce, Meet
Job Opening Offer Announce Opening
Looking for a Job (Resume) Wanted Announce Opening
Music Lessons Offer Service Business
Trade Couch for TV Offer Trade Product
Pet for Adoption Offer Announce Animal?

-- Craig Donato

Vertical

Adding "vertical" to the schema would take this idea a lot further and would add enough flexibility to kill off the need for further formats like hJob etc. Specific verticals could be set (jobs, real estate, rentals, auto, other) with additional fields added as subsets of each vertical.

  • vertical: rentals
  • listing type: offer
  • item type: house (vs. appartment)
  • listing action: rent

-- Aaron Mentele (2006-12-26)

Eliminate Item Type

Can we eliminate item type and simply use tags? Or perhaps inferred item type from the item info?

hClassified?

There are meanings of "listing" that wouldn't fit this format.. might not hClassified be a more descriptive name? It's not overconstraining... 'classifieds' being very broad in practice and the meaning very informally/functionally defined. Or has the 'listing' train left the station?

What about retail?

Retail is out of scope for hListing, sure -- but what microformat should a retail seller of (e.g. mass-produced) goods use? hForSale? hProduct?

  • I don't think that's necessarily true. Let's say I have a site with some retail items and I'd like to get listed on edgeio...if I use hListing I broaden my reach. What's out of scope is a fully transactional description of a product, one that would allow a checkout engine to sell the listed item. We could add vertical specifics as children within the listing that are largly ignored my most hListing agregators. Consider hCalendar. hBreakfast, hWakeup, hStartJob, hBreath, hBreathAgain
  • Why is it out of scope? Do we want two microformats to do the same thing, depending on whether it's done by a person or a company? What about all the grey areas between those two extremes? Andy Mabbett 09:59, 8 Jan 2008 (PST)

Retail

I feel like there are significant enough differences between "Products" and "Listings" to fork them into two separate microformats. Some examples: most products have ratings, which aren't part of the listing spec. Listing doesn't have any mention of things like "brand" or specific pricing attributes which are characteristic of a "product". An attractive aspect of the hProduct proposal is the p-v listings, which could provide additional custom attributes that would extend the hProduct microformat.

Jay Myers


Funnily enough, hProduct is always something that I've thought about.

I'd be bold enough to say that it will be one of the main uses of microformats in the future. Imagine the amount of shops, price comparison, product review and many more type of sites. It doesn't have to be for profit, it could just be someones product, on their site, that they are displaying.

I'd be willing to help and continue development of a spec for 'hProduct'.

Adam Craven

What I've found is that hListing would still be able to do all that. The use case I'm imagining would be a kaboodle'ish wish list. Kaboodle only has snippets of the web, it doesn't know much about what has been snipped. hListing mapped to Ray Ozzie's liveclipboard idea. hProduct, hClassified are like having an hConcert, hBizMeeting, hDatenight...all of those are just hCalendar.

TaylorCowan

Thubnail Class

Hello. I'm not sure I understand everything correctly, but from reading the hListing proposal it seems that one should put pictures of the listed subject into the "photo" class. I'm wondering if also we may wish to have a "thumnail" class or perhaps something like "photo-thumbnail" to denote thumbnail images. -Andrew


Validator

Perhaps to foster development of this type, someone (who knows a lot more about microformats than I) should put a validator type page out there. I realize that microformats, by their nature are a loose specification (it's not as strict as validating say an XML rss feed). But having something that I can use to at least verify that what I'm coding is actually recognized as an hListing by someone other than myself would be very helpful. -Andrew

The Optimus microformat transformer can validate hListing starting Apr-2008 -Mtm

Extraction of hProduct

I think it would be wise to extract product information into hProduct and simply maintain the listing for listing-specific data (such as actual price/suggested price, location, timeframe, etc.).

Also, regarding price, I think going with the currency microformat makes sense, but I also think there should be specifics around the type of price being shown. For instance, there is a MSRP which is tied to the product (and should be in hProduct), then there is the asking price (or in the case of cars, the dealer invoice, sticker price, etc.). Perhaps going the route of

<p class="price actual money">
  <abbr class="currency" title="USD">$</abbr>3.00
</p>

would make more sense? - Aaron Gustafson


Use for Microphilanthropy and Volunteer listings

Adding 'Donate', as Rohit suggested, would open up hListing for use by microphilanthropy sites like www.Kiva.org or www.DonorsChoose.org (I work there.) See here for an example of one of our listings:

http://www.donorschoose.org/donors/proposal.html?id=64964

So an organization seeking a donation would format it Listing Type: Wanted, Listing Action: Donate, Listing Item: Cash

Someone looking to donate an old PC would format it Listing Type: Offer, Listing Action: Donate, Listing Item: Product

An organization trying to find a volunteer would have Listing Type: Wanted, Listing Action: Donate, Listing Item: Service

Note that some organizations (like Kiva) are doing microloans, instead of microphilanthropy. So in addition to Sell, Rent, Trade, Meet, Announce, and Donate, "Loan" would be useful as a Listing Action. (Could also be useful for facilitating borrowing relationships of items.)

One other addition to hListing that might be useful in this context is Cost. In a commercial setting (say, you're trying to sell a used item on eBay), Cost would represent what you paid for the item. So Price - Cost would get you the markup (or markdown). In a philanthropic context, Cost would represent the cost to make a project happen. If the project were already partially funded, then Price < Cost, and Price / Cost would give you the % remaining to completely fund that project. (Many microphilanthropy sites bundle lots of donations to make up one project.)

-- Mike Everett-Lane