h-adr: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(dumped h-item spec)
(Undo revision 54517 by Barnabywalters (Talk))
Line 1: Line 1:
<entry-title>h-item</entry-title>
<entry-title>h-adr</entry-title>
<span class="h-card vcard"><span class="p-name fn">[[User:Tantek|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span>
<span class="h-card vcard"><span class="p-name fn">[[User:Tantek|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span>
----
----
<dfn style="font-style:normal;font-weight:bold">h-item</dfn> is a simple, open format for publishing details about arbitrary items on the web. h-item is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML/HTML5.
<dfn style="font-style:normal;font-weight:bold">h-adr</dfn> is a simple, open format for publishing postal address information on the web. h-adr is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML/HTML5.


In practise, h-item is almost never used on it’s own, but rather as the '''p-item''' in a [[h-review]] as a generic fallback if the item being reviewed cannot be accurately represented by either an [[h-card]], [[h-product]], [[h-event]], [[h-adr]] or [[h-geo]].
h-adr is the [[microformats-2]] replacement for [[adr]]. It is most commonly used as part of an [[h-card]] or [[h-event]].


== Example ==
== Example ==
Here is a simple minimal person example:


As the only properties defined by h-item are '''p-name''', '''u-url''' and '''u-photo''', in practise only the root classname is ever actually required (thanks to [[microformats-2-implied-properties]]) unless perhaps you have some unusual markup structure.
<source lang=html4strict>
<p class="p-adr h-adr">
  <span class="p-street-address">17 Austerstræti</span>
  <span class="p-locality">Reykjavík</span>
  <span class="p-country-name">Iceland</span>
  <span class="p-postal-code">107</span>
</p>
</source>
 
=== Get started ===
The class '''<code>h-adr</code>''' is a ''root class name'' that indicates the presence of an h-adr.
 
'''p-street-address''', '''p-extended-address''' and all the other h-adr property classnames define an element as a ''property'' of the h-adr.
 
See [[microformats-2-parsing]] to learn more about property classnames.
 
== Properties ==
 
* '''<code>p-street-address</code>''' - house/apartment number, floor, street name
* '''<code>p-extended-address</code>''' - additional street details
* '''<code>p-post-office-box</code>'''
* '''<code>p-locality</code>''' - city/town/village
* '''<code>p-region</code>''' - state/county/province
* '''<code>p-postal-code</code>''' - postal code, e.g. ZIP in the US
* '''<code>p-country-name</code>''' - country name
* '''<code>p-label</code>''' - new in vCard4 (RFC6350)
* '''<code>p-geo</code>''' (or u-geo with a RFC 5870 geo: URL), optionally a nested [[h-geo]]
* '''<code>p-latitude</code>''' - metric latitude
* '''<code>p-longitude</code>''' - metric longitude
* '''<code>p-altitude</code>''' - metric altitude
 
For backward compatibility, you may wish to use classic [[adr]] classnames in addition to the more future-proof h-adr properties, for example:


<source lang=html4strict>
<source lang=html4strict>
<a class="h-item" href="http://example.org/items/1">
<span class="p-street-address street-address">123 Main St.</span>
  <img src="http://example.org/items/1/photo.png" alt="" />
  The Item Name
</a>
</source>
</source>


== Properties ==
Microformats parsers should detect classic properties and parse them as microformats 2 properties. If an "h-adr" is found, don't look for an "adr" on the same element.
 
Compatibility root class name: adr
 
Properties: (parsed as p- plain text unless otherwise specified)


* '''<code>p-name</code>''' - item name
* post-office-box
* '''<code>u-url</code>''' - permalink URL
* extended-address
* '''<code>u-photo</code>''' - photo URL
* street-address
* locality
* region
* postal-code
* country-name


== Status ==
== Status ==


'''h-item''' is a microformats.org draft specification. Public discussion on h-item takes place on [[h-item-feedback]], the #microformats [[irc]] channel on irc.freenode.net, and [http://microformats.org/discuss/mail/microformats-new/ microformats-new mailing list].
'''h-adr''' is a microformats.org draft specification. Public discussion on h-adr takes place on [[h-adr-feedback]], the #microformats [[irc]] channel on irc.freenode.net, and [http://microformats.org/discuss/mail/microformats-new/ microformats-new mailing list].
 
h-adr is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-adrs up with classic [[adr]] classnames.


== Property Details ==
== Property Details ==
Line 33: Line 72:
== Examples in the Wild ==
== Examples in the Wild ==


* … add any h-item examples you find in the wild
* … add any h-adr examples you find in the wild


== Background ==
== Background ==


h-item was extracted from the classic [[hReview]] microformat as a way of referring to arbitrary reviewed items which cannot be represented by other microformats but which required a “shell” microformat due to the flat property requirement of microformats 2.
h-adr is based on the existing [[adr]] specification, which was extracted from [[hCard]] in order to allow it to be used for applications other than contact information.


== See Also ==
== See Also ==


* [[microformats-2]]
* [[microformats-2]]
* [[h-review]]
* [[h-geo]] can be nested in h-adr
* [[h-card]] and [[h-event]] often contain h-adr

Revision as of 23:14, 13 June 2013

<entry-title>h-adr</entry-title> Tantek Çelik (Editor)

h-adr is a simple, open format for publishing postal address information on the web. h-adr is one of several open microformat draft standards suitable for embedding data in HTML/HTML5.

h-adr is the microformats-2 replacement for adr. It is most commonly used as part of an h-card or h-event.

Example

Here is a simple minimal person example: 

<p class="p-adr h-adr">
  <span class="p-street-address">17 Austerstræti</span>
  <span class="p-locality">Reykjavík</span>
  <span class="p-country-name">Iceland</span>
  <span class="p-postal-code">107</span>
</p>

Get started

The class h-adr is a root class name that indicates the presence of an h-adr.

p-street-address, p-extended-address and all the other h-adr property classnames define an element as a property of the h-adr.

See microformats-2-parsing to learn more about property classnames.

Properties

  • p-street-address - house/apartment number, floor, street name
  • p-extended-address - additional street details
  • p-post-office-box
  • p-locality - city/town/village
  • p-region - state/county/province
  • p-postal-code - postal code, e.g. ZIP in the US
  • p-country-name - country name
  • p-label - new in vCard4 (RFC6350)
  • p-geo (or u-geo with a RFC 5870 geo: URL), optionally a nested h-geo
  • p-latitude - metric latitude
  • p-longitude - metric longitude
  • p-altitude - metric altitude

For backward compatibility, you may wish to use classic adr classnames in addition to the more future-proof h-adr properties, for example: 

<span class="p-street-address street-address">123 Main St.</span>

Microformats parsers should detect classic properties and parse them as microformats 2 properties. If an "h-adr" is found, don't look for an "adr" on the same element.

Compatibility root class name: adr

Properties: (parsed as p- plain text unless otherwise specified)

  • post-office-box
  • extended-address
  • street-address
  • locality
  • region
  • postal-code
  • country-name

Status

h-adr is a microformats.org draft specification. Public discussion on h-adr takes place on h-adr-feedback, the #microformats irc channel on irc.freenode.net, and microformats-new mailing list.

h-adr is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-adrs up with classic adr classnames.

Property Details

(stub, add any property explanations here)

Examples in the Wild

  • … add any h-adr examples you find in the wild

Background

h-adr is based on the existing adr specification, which was extracted from hCard in order to allow it to be used for applications other than contact information.

See Also

Retrieved from "http://microformats.org/wiki/index.php?title=h-adr&oldid=54518"