'''adr''' (pronounced "adder"; FAQ: [[hcard-faq#Should_I_use_ADDRESS_for_hCards|"why 'adr'?"]]) is a simple format for marking up address information, suitable for embedding in HTML, XHTML, Atom, RSS, and arbitrary XML. '''adr''' is a 1:1 representation of the ''adr'' property in the vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]) in HTML, one of several open [[microformats|microformat]] standards. It is also a property of [[hCard]].
== Draft Specification ==
; <span class="role">Editor</span>/<span class="role">Author</span>
: <span class="fn">[[User:Tantek|Tantek Çelik]]</span> (<span class="url">http://tantek.com/</span>, and before at [http://technorati.com Technorati, Inc.])
=== Copyright ===
Per the public domain release on [[User:Tantek|my user page]], this specification is released into the public domain.
=== Patents ===
=== Inspiration and Acknowledgments ===
Thanks to everyone who participated in the [[geo-bof-2005-06-30|Geo Microformat BOF at O'Reilly's Where 2.0 conference]], and in particular to [http://radar.oreilly.com/nat/ Nat Torkington] and Vee McMillen of [http://oreilly.com O'Reilly] for [http://conferences.oreillynet.com/cs/where2005/view/e_sess/7476 arranging and hosting the BOF].
== Introduction and Background ==
At the [http://conferences.oreillynet.com/where/ Where 2.0 conference] in June 2005, there was widespread recognition that the community needed a way to simply and easily publish visible, extractable, address information on the Web, given how often bloggers, and numerous other sites publish address information. The [[geo-bof-2005-06-30|geo microformat BOF]] discussed this very topic, and concluded with a consensus decision to just try using ''adr'' from vCard/hCard.
This specification introduces the '''adr''' microformat, which is a 1:1 representation of the aforementioned ''adr'' property from the vCard standard, by simply reusing the ''adr'' property and sub-properties as-is from the [[hcard|hCard]] microformat.
Publishers can both embed '''adr''' addresses directly in their web pages and feeds, as well as markup existing addresses in the context of the rest of the information in their web pages and feeds.
If the publisher knows and is publishing the ''name'' of the location in addition to its address, then the publisher MUST use [[hcard|hCard]] instead of just '''adr''' to publish the name and address of the location.
== Semantic XHTML Design Principles ==
== Format ==
=== Singular Properties ===
See [[hcard#Singular_vs._Plural_Properties|hCard: Singular vs. Plural Properties]] for the list of which "adr" properties (sub-properties in hCard) are singular. Note analysis in progress: [[adr-singular-properties]].
=== Human vs. Machine readable ===
If an <code><abbr></code> element is used for a property, then the <code>title</code> attribute of the <code><abbr></code> element is the value of the property, instead of the contents of the element, which instead provide a human presentable version of the value.
Similarly, if an <code><img></code> element is used for one or more properties, it must be treated as follows:
# For the <code>PHOTO</code> property and any other property that takes a <abbr title="Uniform Resource Locator">URL</abbr> as its value, the <code>src</code> attribute provides the property value.
# For other properties, the <code><img></code> element's <code>alt</code> attribute is the value of the property.
=== Value excerpting ===
Sometimes only part of an element which is the equivalent for a property should be used for the value of the property. For this purpose, the special class name <code>value</code> is used to excerpt out the subset of the element that is the value of the property. See [[hcard|hCard]] for details on this.
=== Root Class Name ===
The root class name for an '''adr''' address is <code>adr</code>.
=== Property List ===
This is the list of properties in '''adr''', taken from [[hcard|hCard]]:
The <code>type</code> sub-property is omitted because without the context of a type of address for ''whom'', it doesn't make much sense.
=== XMDP Profile ===
See [[hcard-profile]] for the [http://gmpg.org/xmdp XMDP] profile of hCard which contains the above complete list of properties, with references to their RFC 2426 definitions.
=== Parsing Details ===
See [[hcard-parsing|hCard parsing]], with the only difference being that "adr" is the root class name, rather than "vcard".
== Examples ==
This section is informative.
=== Sample adr ===
Here is a sample <code>adr</code>:
<div class="street-address">665 3rd St.</div>
<div class="extended-address">Suite 207</div>
<span class="locality">San Francisco</span>,
which might be displayed as:
<div class="adr"><div class="street-address">'''665 3rd St.'''</div> <div class="extended-address">'''Suite 207'''</div> <span class="locality">'''San Francisco'''</span>, <span class="region">'''CA'''</span> <span class="postal-code">'''94107'''</span> <div class="country-name">'''U.S.A.'''</div> </div>
Note that this is a '''live''' <code>adr</code> microformat, which will be found on this page by parsers.
=== More Examples ===
See [http://microformats.org/wiki/hcard-examples#3.2.1_ADR_Type_Definition hCard example ADR] for more examples.
See [http://microformats.org/wiki/adr-examples adr examples] for additional uses of ADR.
== Examples in the wild ==
This section is '''informative'''.
The following sites have published adrs, outside their normal context of hCards, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc., in addition to [[hcard|hCard]] examples in the wild. If you find adrs outside of hCards anywhere else, feel free to add them to the top of this list. Once the list grows too big, we'll make a separate wiki page.
* [http://iprefer.com/ I Prefer Guest Benefit Program] uses adr on search results pages for city/state/country information, example: [http://iprefer.com/luxury-hotel/Bangalore/ Search page for Bangalore]
* [http://preferredhotels.com/ Preferred Hotels and Resorts] uses adr on search results pages for city/state/country information, example: [http://preferredhotels.com/luxury-hotel/London/ Search page for London]
* [http://sterlinghotels.com Sterling Hotels] uses adr on search results pages for city/state/country information, example: [http://sterlinghotels.com/smart-hotel/Barcelona/ Search page for Barcelona]
* [http://sterlingdesignhotels.com Sterling Design Hotels] uses adr for city/state/country information on search results pages, example: [http://sterlingdesignhotels.com/design-hotel/Miami/ Search page for Miami]
* [http://www.growsonyou.com/visit Grows on You] uses the microformat to mark up the addresses of open gardens.
* [http://www.stems-florist.co.uk/ Stems Florist] uses the microformat on the front page to markup up the two store addresses
* [http://themechanism.com/locations/ theMechanism] uses the adr microformat to mark up the locations of
* [http://www.mister-map.com/ Mister-Map.com] uses the adr microformat to mark up the streets, zip-codes, regions and country names.
(See also [[hcard-examples-in-wild]])
== Implementations ==
This section is '''informative'''.
The following implementations have been developed which either generate or parse adrs outside the context of hCards. If you have an adr implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.
* [http://code.highearthorbit.com/greaseroute/index.php GreaseRoute] is a GreaseMonkey user script (also available as a simple Firefox Extension) which will add icons for displaying the location, or route to, an [[adr]] using a MapQuest map. The route is displayed from the starting location based on the viewer's IP-Address as determined by the [http://hostip.info HostIP] geolocation service.
* [http://code.highearthorbit.com/greaseroute/index.php GreaseRouteEmbed] is another GreaseMonkey user script that will actually embed a route image in the webpage when the user clicks the "route" link.
* [http://georss.org/geopress GeoPress] is a [http://wordpress.org WordPress] plugin that supports embedding adrs, geo, maps (dynamically switchable between Google-Yahoo-Microsoft Maps), and [http://georss.org GeoRSS] feeds.
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding adrs and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* The [http://tantek.com/microformats/hcard-creator.html hCard creator], though it creates complete hCards, can also be used simply to create adrs by filling out the address portion and simply copy and pasting the <div class="adr"> element and its contents.
== References ==
=== Normative References ===
=== Informative References ===
* [http://www.ietf.org/rfc/rfc2426.txt vCard RFC2426] ([http://www.w3.org/2002/12/cal/rfc2426 HTML reformatted version of RFC2426])
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
=== Similar Work ===
== Work in progress ==
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.
== Discussions ==
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
=== Q&A ===
* If you have any questions about hCard, check the [[hcard-faq|hCard FAQ]] first, and if you don't find answers, add your questions! (Odds are that any '''adr''' question will apply to [[hCard]] as well).
* See also [http://microformats.org/discuss/ for other methods of feedback].
=== Issues ===
* Please add any issues with the specification to the separate [[hcard-issues|hCard issues]] document. Ditto.
== Related Pages ==