hListing Profile

From Microformats Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.


The following is an XMDP profile for the hListing specification.

URLs

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

Usage

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

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

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:
  </p>
  <dl>
   <dt id="self">self</dt>
   <dd>Indicates that the referred resource serves as a permalink, for the referring hListing.</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 hListing). Based on the <a rel="help start" href="http://microformats.org/wiki/rel-tag">
   rel-tag</a> specification.
</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/hlisting">
   hListing specification</a>.
  </p>
  <dl>
   <dt id="hlisting">hlisting</dt>
    <dd>The root class name and container for a listing.
   </dd>

   <dt id="version">version</dt>
    <dd>This optional property permits hListing publishers to specify a particular version of hListing that their content uses. By omitting this property, the publisher is stating that implementations may interpret the hListings according to any version of the hListing specification v0.0 or later. In practice the authors of this specification are committed 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 listing. Re-used from hReview which re-uses it from hCalendar which re-uses it from iCalendar (section 4.8.1.12 of RFC 2445).
    </dd>

   <dt id="listing-action">listing-action</dt>
    <dd>This property provides the general kind of listing being published, one or more of several enumerated values listed here:
     <dl>
      <dt>sell</dt>
      <dt>rent</dt>
      <dt>trade</dt>
      <dt>meet</dt>
      <dt>offer</dt>
      <dt>wanted</dt>
      <dt>event</dt>
      <dt>service</dt>
     </dl>
    </dd>

   <dt id="item">item</dt>
   <dd>The item the listing is about. It may 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="lister">lister</dt>
    <dd>This optional property provides information about the person who is offering the listing. If the value is provided then the same element that 
    has the class name of "lister" should use the class name of "vcard" and thus represent an embedded hCard.</dd>

   <dt id="dtlisted">dtlisted</dt>
    <dd>This optional property specifies the date and time (in ISO8601 date or date-time) that the listing was first offered.
    </dd>

   <dt id="dtexpired">dtexpired</dt>
    <dd>This optional property specifies the date and time (in ISO8601 date or date-time) that the listing expires or has expired.
    </dd>

   <dt id="location">location</dt>
   <dd>This optional property specifies the location of the item, which may be different than the location of the lister. 
  May be represented by an embedded 
    <a href="http://microformats.org/wiki/hcard">hCard</a>,  
    <a href="http://microformats.org/wiki/adr">adr</a>,  
    <a href="http://microformats.org/wiki/geo">geo</a>, or combination thereof. 
    Re-used from hCalendar which re-uses it from iCalendar (sections 4.8.1.7 and 4.8.1.6 of RFC 2445).
   </dd>

   <dt id="price">price</dt>
   <dd>This optional property specifies a fixed point integer (two decimal points of precision) with optional ISO currency code indicating a price for the item.
   </dd>

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

   <dt id="category">category</dt>
   <dd>This optional property indicates a category of the listing.  
    Note: this property may be repeated (a listing may belong in several categories). Re-used from hReview which re-uses it 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

Template:hlisting-related-pages