This document represents a draft microformat specification. Although drafts are fairly mature within the development approach, the balance of this document can't be assured, and implementers ought to be ready to keep abreast of long run developments and alterations. Check out this wiki page, or stick to discussions about the microformats-new mailing list to remain up-to-date.
adr (pronounced "adder"; FAQ: "why 'adr'?") is really a straightforward format for marking up address details, suitable for embedding in HTML, XHTML,
Microsoft Office 2010 Key, Atom, RSS, and arbitrary XML. adr is really a one:one representation of your adr residence within the vCard regular (RFC2426) in HTML, one of a number of open microformat specifications. It is usually a house of hCard.
1 Draft Specification 1.one Copyright
1.2 Patents
1.3 Inspiration and Acknowledgments two Introduction and History
three Semantic XHTML Style Rules
4 Format four.1 Singular Properties
four.two Human vs. Device readable
4.3 Price excerpting
four.four Root Class Identify
4.five Residence Checklist
4.6 XMDP Profile
4.7 Parsing Facts five Examples 5.1 Sample adr
five.2 Far more Examples 6 Examples inside the wild
7 Implementations
8 References eight.one Normative References
eight.2 Beneficial References
eight.3 Comparable Operate 9 Function in progress
ten Discussions ten.one Q&A
10.2 Issues 11 Related Pages Draft Specification Copyright
Per the public domain release on my user web page, this specification is released into the public domain.
Public Domain Contribution Requirement. Since the author(s) released this work into the public domain,
Microsoft Office 2007 Enterprise, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this web page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.
Patents
This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.
Inspiration and Acknowledgments
Thanks to everyone who participated within the Geo Microformat BOF at O'Reilly's Where two.0 conference, and in particular to Nat Torkington and Vee McMillen of O'Reilly for arranging and hosting the BOF.
Introduction and History
The vCard normal (RFC2426), has been broadly and interoperably implemented (e.g. Apple's Deal with Book application). The hCard microformat has similarly received significant adoption, from numerous sites publishing the format, to hCard to vCard proxies, to clientside javascript parsers.
At the Where 2.0 conference in June 2005, there was widespread recognition that the community needed a way to simply and easily publish visible,
Microsoft Office 2010, extractable, handle data within the Web, given how often bloggers, and numerous other sites publish handle details. The 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 your aforementioned adr property from the vCard regular, by simply reusing the adr house and sub-properties as-is from the 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 with the information in their web pages and feeds.
If the publisher knows and is publishing the title from the location in addition to its tackle, then the publisher MUST use hCard instead of just adr to publish the title and deal with of the location.
Semantic XHTML Layout Principles
Note: the Semantic XHTML Style Rules were written primarily within the context of developing hCard and hCalendar,
Office 2007 Enterprise Key, thus it may be easier to understand these concepts inside the context of your hCard design methodology (i.e. read that first). Tantek
XHTML is built on XML, and thus XHTML based formats can be used not only for convenient display presentation, but also for general purpose data exchange. In many ways, XHTML based formats exemplify the best of both HTML and XML worlds. However, when building XHTML based formats, it helps to have a guiding set of concepts.
Reuse the schema (names, objects, properties, values, types, hierarchies, constraints) as much as possible from pre-existing, established, well-supported criteria by reference. Avoid restating constraints expressed within the source regular. Educational mentions are ok. For types with multiple components, use nested elements with class names equivalent to the names of the components. Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited. Use the most accurately precise semantic XHTML building block for each object etc. Otherwise use a generic structural element (e.g. <span> or <div>), or the appropriate contextual element (e.g. an <li> inside a <ul> or <ol>). Use class names based on names from the original schema, unless the semantic XHTML building block precisely represents that part with the original schema. If names in the source schema are case-insensitive, then use an all lowercase equivalent. Components names implicit in prose (rather than explicit in the defined schema) really should also use lowercase equivalents for ease of use. Spaces in component names become dash '-' characters. Finally, if the format of your data according to the original schema is too long and/or not human-friendly, use <abbr> instead of a generic structural element, and place the literal data into the 'title' attribute (where abbr expansions go), and the much more brief and human readable equivalent into the element itself. Further useful explanation of this use of <abbr>: Human vs. ISO8601 dates problem solved Format Singular Properties
See hCard: Singular vs. Plural Properties for the listing of which "adr" properties (sub-properties in hCard) are singular. Note analysis in progress: adr-singular-properties.
Human vs. Device readable
If an <abbr> element is used for a home, then the title attribute from the <abbr> element is the worth of your home, instead from the contents with the element, which instead provide a human presentable version of your appeal.
Similarly, if an <img> element is used for one or much more properties, it must be treated as follows:
For the PHOTO house and any other residence that takes a URL as its appeal, the src attribute provides the property price. For other properties, the <img> element's alt attribute is the value of your property. Worth excerpting
Sometimes only part of an element which is the equivalent for a house needs to be used for the appeal with the home. For this purpose, the special class title value is used to excerpt out the subset of the element that is the value with the property. See hCard for specifics on this.
Root Class Name
The root class title for an adr handle is adr.
Residence Record
This is the listing of properties in adr, taken from hCard:
post-office-box extended-address street-address locality region postal-code country-name
The type sub-property is omitted because without the context of a type of handle for whom,
Office 2010 Serial, it doesn't make much sense.
XMDP Profile
See hcard-profile for the XMDP profile of hCard which contains the above complete list of properties, with references to their RFC 2426 definitions.
Parsing Particulars
See hCard parsing, with the only difference being that "adr" is the root class name, rather than "vcard".
Examples
This section is beneficial.
Sample adr
Here is a sample adr:
<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>
which might be displayed as:
Note that this can be a live adr microformat, which will be found on this page by parsers.
More Examples
See hCard example ADR for a lot more examples.
See adr examples for additional uses of ADR.
Examples within the wild
This section is beneficial.
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 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 record grows too big, we'll make a separate wiki web page.
Grows on You uses the microformat to mark up the addresses of open gardens. Stems Florist uses the microformat about the front web page to markup up the two store addresses theMechanism uses the adr microformat to mark up the locations of
their offices.
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 educational.
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 checklist. Once the list grows too big, we'll make a separate wiki page.
GreaseRoute can be a GreaseMonkey user script (also available as an easy 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 around the viewer's IP-Address as determined by the HostIP geolocation service. GreaseRouteEmbed is another GreaseMonkey user script that will actually embed a route image within the webpage when the user clicks the "route" link. GeoPress can be a WordPress plugin that supports embedding adrs, geo, maps (dynamically switchable between Google-Yahoo-Microsoft Maps), and GeoRSS feeds. pnh_mf is actually a plugin for Textpattern that supports embedding adrs and other microformats in templates and blog posts. Written by Chris Casciano. The hCard creator, though it creates complete hCards, can also be used simply to create adrs by filling out the tackle portion and simply copy and pasting the <div class="adr"> element and its contents. References Normative References hCard Informative References vCard RFC2426 (HTML reformatted version of RFC2426) XHTML one.0 SE Equivalent Function geo hCalendar XOXO Operate in progress
This specification is actually a operate in progress. As additional aspects are discussed, understood, and written, they will be added.
Discussions See blogs discussing this web page. Q&A If you have any questions about hCard, check the 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 for other methods of feedback. Issues Please add any issues with the specification to the separate hCard issues document. Ditto. Related Pages adr adr-examples adr-cheatsheet adr forms part of hcard, so for feedback and issues, please use: hcard-feedback hcard-issues