Microformats Wiki - User contributions [en]

adr

2008-11-17T17:28:08Z

91.84.42.38:

<entry-title>adr</entry-title>
{{DraftSpecification}}

'''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 ==
<div class="vcard">
; <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.])
</div>

=== Copyright ===
Per the public domain release on [[User:Tantek|my user page]], this specification is released into the public domain.

{{MicroFormatPublicDomainContributionStatement}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== 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 ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]), has been broadly and interoperably implemented (e.g. Apple's Address Book application). The [[hcard|hCard]] microformat has similarly received significant adoption, from numerous sites publishing the format, to hCard to vCard proxies, to clientside javascript parsers.

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 ==
{{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]]:

* <code>post-office-box</code>
* <code>extended-address</code>
* <code>street-address</code>
* <code>locality</code>
* <code>region</code>
* <code>postal-code</code>
* <code>country-name</code>

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>:

<pre><nowiki>
<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>
</nowiki></pre>

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://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 their offices.

(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 ===
* [[hcard|hCard]]

=== 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 ===
* [[geo]]
* [[hcalendar|hCalendar]]
* [[XOXO]]

== 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 ==
{{adr}}

[[Category:Draft_Specifications]]
[[Category:hCard]]
[[Category:adr]]

wiki-2

2008-11-17T17:27:22Z

91.84.42.38:

<entry-title>Microformats.org Wiki 2.0</entry-title>
<p class="entry-summary">Microformats.org has been served by a near-default MediaWiki theme since it first went live in 2005. Over the years the kind of content published on the wiki has been established, and the editing practices of our community better understood. The ‘Wiki 2.0’ project is a medium-sized undertaking to update our wiki software to better suit the communities needs, and take the opportunity to add some visual sparkle too.</p>
__TOC__

==Summary of Changes==

* MediaWiki has been updated from version 1.4 to version 1.13.2.
* The visual styling of the wiki has been upgraded to a completely custom skin, based on Dan Cederholm's original microformats.org design.
* The search feature is now located at the top-right of the page, because having it buried further down was silly.
* The header now links to other vital parts of the microformats site — the blog and the mailing list archives.
* Some new extensions have been added to the MediaWiki install
** HTML phrase elements are now fully supported
** Code syntax highlighting has been added
** Page titles can now be overwritten in mark-up (e.g. ‘hcard’ can become ‘hCard’, or more ambitious transformations)
* ‘Talk’ pages have been <strong>completely</strong> disabled, rather than just ‘hidden’.
* All wiki pages are marked up with [[hAtom]] and [[hCalendar]]
* We will now be using MediaWiki's categories feature to better organize our content.
** Pages placed into the Specifications category gets special ‘spec-like’ styling (see [[hCard]]).
** Pages places into the Draft Specifications category get different special ‘spec-like’ styling (see [[hResume]])
** Pages placed into either specification category will generate links to their respective -issues pages
* TOC — table of contents — is now properly styled in the theme. There is nolonger a need to use inline styles to align the TOC to the right
* There is now styling support for both inline issues tracking and discussions within list nesting. Previously it was hard to identify discussion documentation from proposed content, and hard to follow threads. Mark-up is now supported to style these more apporpriately
* Your username now has a [http://gravatar.com Gravatar] displayed alongside, as in blog comments.
* When editing, the ‘Save’ and ‘Preview’ buttons have been reversed to try and encourage people to preview more before posting

==How to Use Wiki 2.0==

The following tries to explain how best to use the new features in Wiki 2.0.

===Page Titles===

Between version 1.4 and 1.13 MediaWiki fixed a bug whereby headings marked up with HTML elements were excluded from the generated Table of Contents on pages. We have since used <code>H1</code> elements to override the headings of pages whilst not offsetting the TOC numbering into 1.1, 1.2, 1.3, etc. Since that bug is fixed, this hack has been replaced with a more robust mechanism.

<em>Rather than use <code>H1</code> elements to title your pages, instead use the new <code>entry-title</code> element</em>. This is parsed by a MediaWiki extension and overrides the entry title as displayed on the page, whilst excluding it from the TOC. It is so named, because it corresponds to the entry-title element in the underlying hAtom that each entry is now marked up with.

===Writing Specifications===

The new wiki supports special display of specification documents, different from regular pages. The pages are styled more plainly and content spans the full width of the page, akin to documentation from the W3C, WHATWG and other bodies. The sidebar is pushed down into an expanded footer, so all functionality remains.

To enable these views, you must add your page to a particular category.

* Specifications should be added to the ‘Specifications’ category, by including <nowiki>[[Category:Specifications]]</nowiki> at the base of the document.
* Draft Specifications should be added to the ‘Draft Specifications’ category, by including <nowiki>[[Category:Draft Specifications]]</nowiki> at the base of the document. You '''must''' also include the <nowiki>{{DraftSpecification}}</nowiki> template at the head of your document, to provide textual differentiation of the draft.

Please note that issues pages, brainstorming pages, straw-men and anything else not explicitly a Draft Specification or Specification document should not be added to these categories and should continue to be presented as regular wiki pages.

Categories should be declared at the base of articles, please.

===Discussions and Issues===

Within documents discussions are often represented through nested lists. They are hard to follow, and hard to differentiate from the actual content of the document. You can now mark them up and have them presented more appropriately, and hopefully more clearly.

* For <em>discussions</em>: Surround the thread with <code><div class="discussion"></div></code>.
* For raising <em>issues</em>: Surround the thread with <code><div class="discussion issues"></div></code>.

The following are examples to show the rendering:

<div class="discussion">
* I'm not happy with the phrasing of the above. --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
** I disagree, I think it's fine! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
</div>

<div class="discussion issues">
* '''New wiki does not support declarative creation of animated GIFs on profile pages'''. This is a big deal for me! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
** No. Just… no! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
</div>

'''Always''' sign your contributions to discussions using the string <nowiki>--~~~~</nowiki> at the end of your text.

===Code Highlighting===

We've installed a [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi Syntax Highlighting extension]. This allows you to have nicer highlighting of many languages used in examples and code snippets on the wiki.

* To use syntax highlighted source blocks, use the new <code><source></code> element. E.g.

<pre><nowiki>
<source lang=html4strict>
<div class="vcard">
<a class="fn org" href="http://microformats.org">Microformats.org</a>
</div>
</source>
</nowiki></pre>

Produces:

<source lang=html4strict>
<div class="vcard">
<a class="fn org" href="http://microformats.org">Microformats.org</a>
</div>
</source>

Note that the language name for HTML is <code>html4strict</code>, not just ‘HTML’. You can find the full list of supported languages on the Syntax Highlighter extension page: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages

==Credits==

The Wiki 2.0 project was implemented by [[User:BenWard]]. The visual style is derived from the original microformats.org theme by [http://simplebits.com Dan Cederholm]. The wiki also uses the wonderfully useful [http://famfamfam.com/lab/icons/silk//Fam Fam Fam Silk icons] by Mark James.

==Issues==

Please report, bugs issues and requests on the [[wiki-2-issues]] page.

[[Category:Microformats.org]]
[[Category:Wiki]]

geo

2008-11-17T17:26:53Z

91.84.42.38:

<entry-title>Geo</entry-title>
{{Template:DraftSpecification}}

'''geo''' (pronounced "gee-oh") is a simple format for marking up [http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates (latitude; longitude), suitable for embedding in HTML or XHTML, Atom, RSS, and arbitrary XML. '''geo''' is a 1:1 representation of the "geo" property in the vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]) in HTML, one of several open [[microformats|microformat]] standards.

== Draft Specification ==

;Editor/Author
: [http://tantek.com/ Tantek Çelik] ([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.

{{MicroFormatPublicDomainContributionStatement}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== 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]. Thanks to Chris Hibbbert for providing the [http://www.geocaching.com/seek/cache_details.aspx?guid=dc4754bf-64d5-4f28-8715-45ad2505c86f real world geo-caching example].

== Introduction and Background ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]), has been broadly and interoperably implemented (e.g. Apple's Address Book application). The [[hcard|hCard]] microformat has similarly received significant adoption, from numerous sites publishing the format, to hCard to vCard proxies, to clientside javascript parsers.

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, geographic location information on the Web, given how often bloggers, and numerous other sites publish such information. The [[geo-bof-2005-06-30|geo microformat BOF]] discussed this very topic, and concluded with a consensus decision to just try using ''geo'' from vCard/hCard.

This specification introduces the '''geo''' microformat, which is a 1:1 representation of the aforementioned ''geo'' property from the vCard standard, by simply reusing the ''geo'' property and sub-properties as-is from the [[hcard|hCard]] microformat.

Publishers can both embed '''geo''' addresses directly in their web pages and feeds, as well as markup existing latitude/longitude coordinates 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 geo lat/long, then the publisher {{must}} use [[hcard|hCard]] instead of just '''geo''' to publish the name and geo lat/long of the location.

If the publisher knows and is publishing the address of the location, OR if the address of the location was what was actually entered by a human, and the publisher simply turned that into lat/long using some sort of a service, then the publisher {{should}} use [[adr]] to publish the actual human entered address information since that communicates far more semantic information than a simple geo lat/long coordinate.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
=== Singular Properties ===

Note that all the properties in '''geo''' are singular properties, and thus the first descendant element with that class should take effect, any others being ignored.

=== 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.

=== 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 geo location is <code>geo</code>.

=== Property List ===

This is the list of properties in geo, taken from [[hcard|hCard]]:

* latitude
* longitude

=== 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 "geo" is the root class name, rather than "vcard".

== Examples ==

This section is informative.

=== Example from RFC2426 ===

Section 3.4.2 of RFC2426 has a simple geo example:

<pre><nowiki>
GEO:37.386013;-122.082932
</nowiki></pre>

this vCard fragment as a geo, as [http://microformats.org/wiki/hcard-examples#3.4.2_GEO_Type_Definition first documented on the hCard examples page]:

<pre><nowiki>
<div class="geo">GEO:
<span class="latitude">37.386013</span>,
<span class="longitude">-122.082932</span>
</div>
</nowiki></pre>

this geo could be displayed as: 

<div class="geo">GEO: <span class="latitude">37.386013</span>, <span class="longitude">-122.082932</span></div>

Note that this is a '''live''' geo microformat, which will be found on this page by parsers.

=== Real world geo example ===

Here is a sample of published lat/long info (from [http://www.geocaching.com/seek/cache_details.aspx?guid=dc4754bf-64d5-4f28-8715-45ad2505c86f geocaching: Noble Steed]):

<pre><nowiki>
N 37° 24.491 W 122° 08.313
</nowiki></pre>

With geo markup:

<pre><nowiki>
<div class="geo">
<abbr class="latitude" title="37.408183">N 37° 24.491</abbr>
<abbr class="longitude" title="-122.13855">W 122° 08.313</abbr>
</div>
</nowiki></pre>

This geo might be displayed as: 

<div class="geo"><abbr class="latitude" title="37.408183">N 37° 24.491</abbr> <abbr class="longitude" title="-122.13855">W 122° 08.313</abbr>
</div>

Again, this is a '''live''' example.

Note that since the real world example used a more human readable presentation of the geo coordinates, we use the [[abbr-design-pattern]] to keep that more human readable presentation, and in addition provide the respective absolute numerical values for the geo.

== Examples in the wild ==

This section is '''informative'''. The number of Geo examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a separate page, [[geo-examples-in-wild|Geo examples in the wild]].

== Implementations ==
This section is '''informative'''.

The following implementations have been developed which either generate or parse geos outside the context of hCards. If you have an geo 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.

*Clem Rutter's "[http://www.rutter.uklinux.net/ostowiki.html OSGBGridRefs to WGS84]" converter - Takes UK or Irish OS grid references and converts them to WGS84 coordinates, with two types of Geo mark-up (<code>SPAN</code> and <code>ABBR</code>) available to copy & paste.
*I've added Geo mark-up to the output of Wikipedia's [http://en.wikipedia.org/wiki/Template:GeoTemplate GeoTemplate] which is called by '''many thousands''' of other Wikipedia pages. Example: the coordinates (top right) in [http://en.wikipedia.org/wiki/Great_Barr] link to [http://tools.wikimedia.de/~magnus/geo/geohack.php?params=52.54833_N_1.93212_W_region:GB_source:enwiki-osgb36(SP047945)]; the latter now has Geo mark-up in the "[http://tools.wikimedia.de/~magnus/geo/geohack.php?params=52.686_N_2.193_W_region:GB_type:landmark#Mark-up Mark-up]" section. [[User:AndyMabbett|Andy Mabbett]] 03:10, 13 Jul 2007 (PDT)
* [http://www.sydneydirectory.org/ Sydney Directory Wiki] supports geographical coordinates for locations
*GIS-Wiki's "[http://www.giswiki.org/hjl_get_CoorE.htm hjl_getCoor]" now outputs Geo markup, from a Google Maps API.
*[http://www.addressfix.com/ AddressFix] takes any valid address in the listed countries (as at 2003-07) or map point (using GoogleMaps API) and outputs geo markup.
**Countries: Andorra, Australia, Austria, Belgium, Canada, France, Germany, Gibraltar, Italy, Japan (but only in Japanese), Liechtenstein, Luxembourg, Monaco, Netherlands, New Zealand, San Marino, Spain, Sweden, Switzerland, United States of America and the Vatican City.
**For countries other than the UK, the British Isles and China it provides geocoding for country names and city names (e.g. "Nairobi, Kenya").
**For UK, the British Isles and China, Google returns an error.
* [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 MapQuest map of a [[geo]]. Written by [http://highearthorbit.com Andrew Turner]
* [http://www.podster.de/page/geotest podster.de] finds geo markups in podcast RSS Feeds and maps soundseeing episodes on a map (German only)
* [http://blog.codeeg.com/ Calvin Yu] has written a [http://blog.codeeg.com/2006/01/28/using-microformats-to-plot-my-favorite-places/ web service that will allow you plot and describe places on a Yahoo Map easily] using [[hreview|hReview]] and [[geo]].
* [http://bluesmoon.blogspot.com/ Philip Tellis] has written a [http://bluesmoon.blogspot.com/2006/01/of-microformats-and-geocoding.html javascript to add maps to geo markup on pages]
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding geos and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* [http://bluesmoon.blogspot.com/ Philip Tellis] has written some javascript to [http://bluesmoon.blogspot.com/2006/01/of-microformats-and-geocoding.html convert the geo microformat to a google map] using [[geo]].
* Brian Suda has written some [http://suda.co.uk/projects/microformats/geo/ geo extracting] code to convert geo microformats to KML for use with Google Maps and Google Earth. There is also a bookmarklet to extract the data and pass it to google maps automatically. He is working on a GeoRSS version for Yahoo! Maps as well.
**GPX export is done, but needs some tweaking and testing. Just change &type=(kml|georss|gpx). Not quite ready for primetime yet. Feel free to test and send feedback.
* Fil explains [http://www.jquery.info/spip.php?article7 how to use the geo microformat with the javascript library jQuery] [http://jquery.com].
* [http://georss.org/geopress GeoPress] is a WordPress (http://wordpress.org) plugin that supports embedding adrs, geo, maps (dynamically switchable between Google-Yahoo-Microsoft Maps), and GeoRSS (http://georss.org) feeds. Written by [http://highearthorbit.com Andrew Turner]
* [http://www.openstreetmap.org OpenStreetMap] uses the geo microformat on its wiki for place pages (added by [http://wiki.openstreetmap.org/index.php/User:Pigsonthewing Andy Mabbett]) and also on the GPS trace pages and diary entry pages ([http://www.dankarran.com/blog/archives/2007/09/04/pinpoint_your_openstreetmap_diary_entries.php added] by [http://www.dankarran.com Dan Karran]).
* [http://www.locify.com Locify] uses [[geo]] format for presenting waypoints stored from the mobile client.
* [http://mmm.iamnear.net Magical Microformat Maker - a Geo Microformat Generator with a big map]

== References ==
=== Normative References ===
* [[hcard|hCard]]

=== 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]
* [http://www.census.gov/geo/www/tiger/tigermap.html TIGER Map Service]
* [http://en.wikipedia.org/wiki/Geotagging Wikipedia article on GeoTagging]

== Work in progress ==
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.

* Proposals for changes, additions and other thoughts about [[geo]] may be found at [[geo-brainstorming]].

== Related Work ==
* [[luna]] (proposal for geo-style microformat for co-ordinates on The Moon)
* [[mars]] (proposal for geo-style microformat for co-ordinates on the planet Mars)
* [[geo-extension-strawman]] - extends [[geo]] to include the above, and for representing coordinates on other planets, moons etc.
* [[thoughts-on-extending-the-geo-microformat|thoughts on addind time and reference system]] to the geo microformat, that could also be used for places on other celestial bodies

== Similar Work ==
* [[adr]]
* [[hcalendar|hCalendar]]
* [[XOXO]]

== See Also ==
* [http://en.wikipedia.org/wiki/Geo_%28microformat%29 Geo on Wikipedia]
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page]
* [http://wikitravel.org/en/Wikitravel:Geocoding#Sources_for_lat.2Flongs Sources for latitude/ longitude coordinates]

== Related Pages ==
{{geo-related-pages}}

[[Category:Draft_Specifications]]
[[Category:Geo]]
[[Category:hCard]]

geo

2008-11-17T17:25:41Z

91.84.42.38: also still a draft

<entry-title>Geo</entry-title>
{{DraftSpecifications}}

'''geo''' (pronounced "gee-oh") is a simple format for marking up [http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates (latitude; longitude), suitable for embedding in HTML or XHTML, Atom, RSS, and arbitrary XML. '''geo''' is a 1:1 representation of the "geo" property in the vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]) in HTML, one of several open [[microformats|microformat]] standards.

== Draft Specification ==

;Editor/Author
: [http://tantek.com/ Tantek Çelik] ([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.

{{MicroFormatPublicDomainContributionStatement}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== 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]. Thanks to Chris Hibbbert for providing the [http://www.geocaching.com/seek/cache_details.aspx?guid=dc4754bf-64d5-4f28-8715-45ad2505c86f real world geo-caching example].

== Introduction and Background ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]), has been broadly and interoperably implemented (e.g. Apple's Address Book application). The [[hcard|hCard]] microformat has similarly received significant adoption, from numerous sites publishing the format, to hCard to vCard proxies, to clientside javascript parsers.

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, geographic location information on the Web, given how often bloggers, and numerous other sites publish such information. The [[geo-bof-2005-06-30|geo microformat BOF]] discussed this very topic, and concluded with a consensus decision to just try using ''geo'' from vCard/hCard.

This specification introduces the '''geo''' microformat, which is a 1:1 representation of the aforementioned ''geo'' property from the vCard standard, by simply reusing the ''geo'' property and sub-properties as-is from the [[hcard|hCard]] microformat.

Publishers can both embed '''geo''' addresses directly in their web pages and feeds, as well as markup existing latitude/longitude coordinates 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 geo lat/long, then the publisher {{must}} use [[hcard|hCard]] instead of just '''geo''' to publish the name and geo lat/long of the location.

If the publisher knows and is publishing the address of the location, OR if the address of the location was what was actually entered by a human, and the publisher simply turned that into lat/long using some sort of a service, then the publisher {{should}} use [[adr]] to publish the actual human entered address information since that communicates far more semantic information than a simple geo lat/long coordinate.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
=== Singular Properties ===

Note that all the properties in '''geo''' are singular properties, and thus the first descendant element with that class should take effect, any others being ignored.

=== 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.

=== 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 geo location is <code>geo</code>.

=== Property List ===

This is the list of properties in geo, taken from [[hcard|hCard]]:

* latitude
* longitude

=== 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 "geo" is the root class name, rather than "vcard".

== Examples ==

This section is informative.

=== Example from RFC2426 ===

Section 3.4.2 of RFC2426 has a simple geo example:

<pre><nowiki>
GEO:37.386013;-122.082932
</nowiki></pre>

this vCard fragment as a geo, as [http://microformats.org/wiki/hcard-examples#3.4.2_GEO_Type_Definition first documented on the hCard examples page]:

<pre><nowiki>
<div class="geo">GEO:
<span class="latitude">37.386013</span>,
<span class="longitude">-122.082932</span>
</div>
</nowiki></pre>

this geo could be displayed as: 

<div class="geo">GEO: <span class="latitude">37.386013</span>, <span class="longitude">-122.082932</span></div>

Note that this is a '''live''' geo microformat, which will be found on this page by parsers.

=== Real world geo example ===

Here is a sample of published lat/long info (from [http://www.geocaching.com/seek/cache_details.aspx?guid=dc4754bf-64d5-4f28-8715-45ad2505c86f geocaching: Noble Steed]):

<pre><nowiki>
N 37° 24.491 W 122° 08.313
</nowiki></pre>

With geo markup:

<pre><nowiki>
<div class="geo">
<abbr class="latitude" title="37.408183">N 37° 24.491</abbr>
<abbr class="longitude" title="-122.13855">W 122° 08.313</abbr>
</div>
</nowiki></pre>

This geo might be displayed as: 

<div class="geo"><abbr class="latitude" title="37.408183">N 37° 24.491</abbr> <abbr class="longitude" title="-122.13855">W 122° 08.313</abbr>
</div>

Again, this is a '''live''' example.

Note that since the real world example used a more human readable presentation of the geo coordinates, we use the [[abbr-design-pattern]] to keep that more human readable presentation, and in addition provide the respective absolute numerical values for the geo.

== Examples in the wild ==

This section is '''informative'''. The number of Geo examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a separate page, [[geo-examples-in-wild|Geo examples in the wild]].

== Implementations ==
This section is '''informative'''.

The following implementations have been developed which either generate or parse geos outside the context of hCards. If you have an geo 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.

*Clem Rutter's "[http://www.rutter.uklinux.net/ostowiki.html OSGBGridRefs to WGS84]" converter - Takes UK or Irish OS grid references and converts them to WGS84 coordinates, with two types of Geo mark-up (<code>SPAN</code> and <code>ABBR</code>) available to copy & paste.
*I've added Geo mark-up to the output of Wikipedia's [http://en.wikipedia.org/wiki/Template:GeoTemplate GeoTemplate] which is called by '''many thousands''' of other Wikipedia pages. Example: the coordinates (top right) in [http://en.wikipedia.org/wiki/Great_Barr] link to [http://tools.wikimedia.de/~magnus/geo/geohack.php?params=52.54833_N_1.93212_W_region:GB_source:enwiki-osgb36(SP047945)]; the latter now has Geo mark-up in the "[http://tools.wikimedia.de/~magnus/geo/geohack.php?params=52.686_N_2.193_W_region:GB_type:landmark#Mark-up Mark-up]" section. [[User:AndyMabbett|Andy Mabbett]] 03:10, 13 Jul 2007 (PDT)
* [http://www.sydneydirectory.org/ Sydney Directory Wiki] supports geographical coordinates for locations
*GIS-Wiki's "[http://www.giswiki.org/hjl_get_CoorE.htm hjl_getCoor]" now outputs Geo markup, from a Google Maps API.
*[http://www.addressfix.com/ AddressFix] takes any valid address in the listed countries (as at 2003-07) or map point (using GoogleMaps API) and outputs geo markup.
**Countries: Andorra, Australia, Austria, Belgium, Canada, France, Germany, Gibraltar, Italy, Japan (but only in Japanese), Liechtenstein, Luxembourg, Monaco, Netherlands, New Zealand, San Marino, Spain, Sweden, Switzerland, United States of America and the Vatican City.
**For countries other than the UK, the British Isles and China it provides geocoding for country names and city names (e.g. "Nairobi, Kenya").
**For UK, the British Isles and China, Google returns an error.
* [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 MapQuest map of a [[geo]]. Written by [http://highearthorbit.com Andrew Turner]
* [http://www.podster.de/page/geotest podster.de] finds geo markups in podcast RSS Feeds and maps soundseeing episodes on a map (German only)
* [http://blog.codeeg.com/ Calvin Yu] has written a [http://blog.codeeg.com/2006/01/28/using-microformats-to-plot-my-favorite-places/ web service that will allow you plot and describe places on a Yahoo Map easily] using [[hreview|hReview]] and [[geo]].
* [http://bluesmoon.blogspot.com/ Philip Tellis] has written a [http://bluesmoon.blogspot.com/2006/01/of-microformats-and-geocoding.html javascript to add maps to geo markup on pages]
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding geos and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* [http://bluesmoon.blogspot.com/ Philip Tellis] has written some javascript to [http://bluesmoon.blogspot.com/2006/01/of-microformats-and-geocoding.html convert the geo microformat to a google map] using [[geo]].
* Brian Suda has written some [http://suda.co.uk/projects/microformats/geo/ geo extracting] code to convert geo microformats to KML for use with Google Maps and Google Earth. There is also a bookmarklet to extract the data and pass it to google maps automatically. He is working on a GeoRSS version for Yahoo! Maps as well.
**GPX export is done, but needs some tweaking and testing. Just change &type=(kml|georss|gpx). Not quite ready for primetime yet. Feel free to test and send feedback.
* Fil explains [http://www.jquery.info/spip.php?article7 how to use the geo microformat with the javascript library jQuery] [http://jquery.com].
* [http://georss.org/geopress GeoPress] is a WordPress (http://wordpress.org) plugin that supports embedding adrs, geo, maps (dynamically switchable between Google-Yahoo-Microsoft Maps), and GeoRSS (http://georss.org) feeds. Written by [http://highearthorbit.com Andrew Turner]
* [http://www.openstreetmap.org OpenStreetMap] uses the geo microformat on its wiki for place pages (added by [http://wiki.openstreetmap.org/index.php/User:Pigsonthewing Andy Mabbett]) and also on the GPS trace pages and diary entry pages ([http://www.dankarran.com/blog/archives/2007/09/04/pinpoint_your_openstreetmap_diary_entries.php added] by [http://www.dankarran.com Dan Karran]).
* [http://www.locify.com Locify] uses [[geo]] format for presenting waypoints stored from the mobile client.
* [http://mmm.iamnear.net Magical Microformat Maker - a Geo Microformat Generator with a big map]

== References ==
=== Normative References ===
* [[hcard|hCard]]

=== 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]
* [http://www.census.gov/geo/www/tiger/tigermap.html TIGER Map Service]
* [http://en.wikipedia.org/wiki/Geotagging Wikipedia article on GeoTagging]

== Work in progress ==
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.

* Proposals for changes, additions and other thoughts about [[geo]] may be found at [[geo-brainstorming]].

== Related Work ==
* [[luna]] (proposal for geo-style microformat for co-ordinates on The Moon)
* [[mars]] (proposal for geo-style microformat for co-ordinates on the planet Mars)
* [[geo-extension-strawman]] - extends [[geo]] to include the above, and for representing coordinates on other planets, moons etc.
* [[thoughts-on-extending-the-geo-microformat|thoughts on addind time and reference system]] to the geo microformat, that could also be used for places on other celestial bodies

== Similar Work ==
* [[adr]]
* [[hcalendar|hCalendar]]
* [[XOXO]]

== See Also ==
* [http://en.wikipedia.org/wiki/Geo_%28microformat%29 Geo on Wikipedia]
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page]
* [http://wikitravel.org/en/Wikitravel:Geocoding#Sources_for_lat.2Flongs Sources for latitude/ longitude coordinates]

== Related Pages ==
{{geo-related-pages}}

[[Category:Draft_Specifications]]
[[Category:Geo]]
[[Category:hCard]]

adr

2008-11-17T17:24:23Z

91.84.42.38: According to Main_Page this is still a draft.

<entry-title>adr</entry-title>
__TOC__

'''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 ==
<div class="vcard">
; <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.])
</div>

=== Copyright ===
Per the public domain release on [[User:Tantek|my user page]], this specification is released into the public domain.

{{MicroFormatPublicDomainContributionStatement}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== 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 ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]), has been broadly and interoperably implemented (e.g. Apple's Address Book application). The [[hcard|hCard]] microformat has similarly received significant adoption, from numerous sites publishing the format, to hCard to vCard proxies, to clientside javascript parsers.

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 ==
{{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]]:

* <code>post-office-box</code>
* <code>extended-address</code>
* <code>street-address</code>
* <code>locality</code>
* <code>region</code>
* <code>postal-code</code>
* <code>country-name</code>

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>:

<pre><nowiki>
<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>
</nowiki></pre>

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://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 their offices.

(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 ===
* [[hcard|hCard]]

=== 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 ===
* [[geo]]
* [[hcalendar|hCalendar]]
* [[XOXO]]

== 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 ==
{{adr}}

[[Category:Draft_Specifications]]
[[Category:hCard]]
[[Category:adr]]

User:TobyInk

2008-11-17T17:15:11Z

91.84.42.38:

<entry-title>Toby Inkster (TobyInk)</entry-title>

= About me =

<div class="vcard">
<span class="fn">Toby Inkster</span>
<<span class="url">http://tobyinkster.co.uk</span>>,<br>
<span class="adr"><span class="locality">Lewes</span>, <span class="region">East Sussex</span>, <span class="country-name">England</span>.</span>
</div>

== Misconceptions ==

* [[User:Tantek|Tantek]] believes me to have [[value-excerption-pattern-brainstorming#misconceptions|misconceptions]].

= Current Interests =

* [http://demiblog.org/ demiblog] — CMS/blogging engine with metadata capabilities
* [http://buzzword.org.uk/cognition/ Cognition] — HTML/RDF/microformats/etc parser
* [[profile-uris]] — XMDP profiles for microformats

== Draft Microformats ==

I'm working on these:

* [[User:TobyInk/hcalendar-1.1|hcalendar 1.1]] — Update to hCalendar
* [[figure]] — Microformat for annotating images
* [[measure]] — measurements and money
* [[jCard]] — JSON-based format for contact cards
* [[citation-strawman-01|h3988]] — citation format

= Parsing =

== Microformats Parsing Algorithms ==

* [[parsing-brainstorming|Parsing brainstorming]] — working towards the golden algorithm. I encourage other parser developers to join in.
* [[compositing]] — adventures in compositing microformats.

== Converting to RDF ==

Best practice suggestions for mapping microformats to RDF:

* [[xfn-to-foaf|XFN→FOAF]]
* [[xfolk-to-rdf|xFolk→RDF]]

== Test Pages ==

* [http://examples.tobyinkster.co.uk/hcal-1.1 hCalendar 1.1 + RDFa]
* [http://examples.tobyinkster.co.uk/hcalendar-acid1.html hCalendar Acid Test #1]
* [http://examples.tobyinkster.co.uk/hcard hCard + RDFa]

= Public Domain =

{{cc-public-domain-release}}

User:91.84.42.38

2008-11-17T17:14:28Z

91.84.42.38: New page: Edits from this IP address are probably TobyInk.

Edits from this IP address are probably [[User:TobyInk|TobyInk]].

wiki-2-issues

2008-11-17T17:12:40Z

91.84.42.38:

<entry-title>Wiki 2.0 Issues</entry-title>
The following documents issues and bugs with the new wiki 2.0 launch.
__TOC__
==Known Issues==

===Syntax Highlighting is Ugly===
<div class="discussion issues">
* '''The default syntax highlighting stylesheet does not match the look and feel of microformats.org'''. This is because the extension has been installed as is, and a custom stylesheet hasn't been produced for languages.
</div>

===Many pages have duplicate headings===
<div class="discussion issues">
* '''Some pages are displayed with two titles'''. These are pages which haven't been updated to use the <code><nowiki><entry-title></nowiki></code> mark-up for page headings yet. They are currently displaying the MediaWiki default heading, as well as the heading from the previous wiki install. The page needs to be updated to use the new mark-up.
</div>

===User Preferences have been reset===
<div class="discussion issues">
* '''All user preferences have been reset to defaults.''' To switch to the new theme, user preferences had to be overwritten. Sensible defaults have been applied, but apologies to those who had customised their profiles. You need to adjust your setting again from the [[Special:Preferences]] page.
</div>

===IRC Bot===
<div class="discussion issues">
* '''The #microformats IRC bot is nolonger reporting page edits'''. Edits of either major or minor type are nolonger echoed into #microformats IRC
** Need to check with Ryan King or Tantek regarding how to reconfigure that. --[[User:BenWard|BenWard]] 10:16, 17 November 2008 (UTC)
</div>

===Top Navigation Bar===
<div class="discussion issues">
* Absolutely beautiful upgrade, Ben. But because the wiki is now ''so'' integrated with the uf look and feel, people are going to wonder where the About/Code+Tools/Get Started links have gone. [[Special:Contributions/91.84.42.38|91.84.42.38]] 17:12, 17 November 2008 (UTC)
</div>

==Fixed Issues==

===TOC overlaps preceding text===
<div class="discussion issues">
* '''The TOC overlaps preceding paragraphs of text'''. This is an error in the stylesheet. For visual effect the TOC gets pulled upward to overlap titles, but does not account for being preceded by a paragraph, rather than the page heading.
** Fixed 2008-11-17 by [[User:BenWard]]
</div>

==Related Pages==

* [[wiki-2]]

[[Category:Wiki]]
[[Category:Issues Tracking]]

profile-uris

2008-11-17T16:56:41Z

91.84.42.38: /* Individual Microformats */ fix definition list

<entry-title>Profile URIs</entry-title>
{{TOC-right}}

== Introduction ==

In [[hcalendar-issues]], it is ACCEPTED that each microformat should have a profile URI, like [http://gmpg.org/xfn/11 the XFN profile].

==Known URIs==

This section lists known profile URIs for microformats. To promote cacheability and recognisability of profile URIs, authors {{should}} avoid minting new URIs for existing microformats, and {{should}} re-use existing well-known profile URIs.

=== Combined Profile ===

The following URL covers all non-draft Microformats as of March 2008, except XMDP. You can mix and match it with other XMDP profiles for new/draft microformats.

http://purl.org/uF/2008/03/

=== Individual Microformats ===

<dl>
<dt>adr
<dd>(Use an hCard profile.)
<dd>(Or use the combined profile.)
<dt>figure
<dd>http://purl.org/uF/figure/draft
<dt>geo
<dd>http://purl.org/uF/geo/0.9/
<dd>(Or use an hCard profile.)
<dd>(Or use the combined profile.)
<dt>hAtom
<dd>http://purl.org/uF/hAtom/0.1/
<dt>hAudio
<dd>http://purl.org/NET/haudio &dagger;
<dd>http://purl.org/uF/hAudio/0.9/ &dagger;
<dt>hCalendar
<dd>http://purl.org/uF/hCalendar/1.0/ &dagger;
<dd>http://www.w3.org/2002/12/cal/hcal ¶&dagger;
<dd>http://dannyayers.com/microformats/hcalendar-profile &dagger;
<dd>(Or use the combined profile.)
<dt>hCard
<dd>http://purl.org/uF/hCard/1.0/ &dagger;
<dd>http://www.w3.org/2006/03/hcard &dagger;
<dd>(Or use the combined profile.)
<dt>hResume
<dd>http://microformats.org/wiki/hresume-profile
<dt>rel-license
<dd>http://purl.org/uF/rel-license/1.0/ &dagger;
<dd>(Or use the combined profile.)
<dt>rel-nofollow
<dd>http://purl.org/uF/rel-nofollow/1.0/
<dd>(Or use the combined profile.)
<dt>rel-tag
<dd>http://purl.org/uF/rel-tag/1.0/
<dd>(Or use the combined profile.)
<dt>VoteLinks
<dd>http://purl.org/uF/VoteLinks/1.0/ &dagger;
<dd>http://tommorris.org/profiles/votelinks ¶&dagger;
<dd>(Or use the combined profile.)
<dt>XFN
<dd>http://gmpg.org/xfn/11
<dd>http://gmpg.org/xfn/1 (older version)
<dd>(Or use the combined profile.)
<dt>xFolk
<dd>http://microformats.org/wiki/xfolk-profile
<dt>XOXO
<dd>(Use the combined profile.)
</dl>

&dagger; = GRDDL-enabled.<br/>
¶ = non-XMDP profile.

=== Other Interesting Profile URIs ===

* [http://purl.org/uF/pattern-data-class/1 Experimental data-* class pattern]
* [http://purl.org/stuff/hdoap/profile hDOAP (posh format)] ¶&dagger;

== How to link to a profile URI ==

=== <code><nowiki><head profile></nowiki></code> ===

This is the original method of linking to profile URIs and is currently supported by the greatest number of tools. This is valid in HTML 4 and XHTML 1.x, but is not valid in Atom (as Atom has no <code><nowiki><head></nowiki></code> element) or current drafts of HTML 5 and XHTML 2.

Example:
<pre><nowiki><html>
<head profile="http://example.com/profile1 http://example.net/profile2">
...</nowiki></pre>

=== <code>rel="profile"</code> ===

An alternative method is provided for people using markup languages which do not support <code><nowiki><head profile></nowiki></code>. Add <code>rel="profile"</code> to either a visible link (<code><nowiki><a></nowiki></code>) or hidden link (<code><nowiki><link></nowiki></code>).

Example:
<pre><nowiki><p>This page uses
<a rel="profile" href="http://gmpg.org/xfn/11">XFN 1.1</a>!</p></nowiki></pre>

==Implementations==

=== GRDDL ===

Tools that support [http://www.w3.org/2001/sw/grddl-wg/ GRDDL] use profiles to parse microformats.

=== Cognition===

In "strict mode", [http://buzzword.org.uk/cognition/ Cognition] refuses to parse any microformats where the profile URI has not been explicitly declared on the page. (It will however, still parse microformats for which there exists no profile URI!)

== Issues ==

Some issues include:

* what domain to use? Candidates include:
** microformats.org
** www.w3.org
** xmdp.org
* what about versioning? How to keep in sync with the wiki and test materials?
* what profile URI to use for combinations, such as [[hcard]] and [[hcalendar]]?
** note [http://www.w3.org/TR/html401/struct/global.html#adef-profile HTML4.01] states "that one or more meta data profiles, [are] separated by white space"; though it's simpler for authors if they can just use one profile URI.
* More profiles are needed.

One proposal is: use www.w3.org, following [http://www.w3.org/1999/10/nsuri W3C namespace policy]. As to versioning, change the profile whenever the wiki changes (within some reasonable latency, say, a couple weeks or a month). For example: [http://www.w3.org/2006/03/hcard an hCard Profile at w3.org], and discussion: [http://microformats.org/discuss/mail/microformats-dev/2006-March/000068.html an hCard profile that seems to work with GRDDL].

=== Validator warning ===

Due to [http://sourceforge.net/tracker/index.php?func=detail&aid=1264455&group_id=27659&atid=390963 inconsistent wording of the HTML specs], HTMLTidy (and other tools?) give "[http://sourceforge.net/mailarchive/forum.php?thread_name=oytAFzxaKxiFFwpx%40pigsonthewing.org.uk&forum_name=htmlvalidator-help Warning: <head> escaping malformed URI reference]"
when more than one profile is used, e.g.

<code><head profile="http://www.ietf.org/rfc/rfc2731.txt http://www.w3.org/2006/03/hcard"></code>

W3C HTML validator has very poor validation of attributes and is technically unable to check this case. The HTML DTD however defines <code>profile</code> attribute as <code>%URI</code> (it's an alias for <code>CDATA</code>), same as <code><a href></code> attribute.

==See also==

* [[profile-uri-examples-in-wild|Profile URI examples, in the wild]]
* [[faqs-for-rdf]] for discussion of connecting microformats to URIs.
* [[hcard-profile]].

profile-uris

2008-11-17T16:53:36Z

91.84.42.38:

<entry-title>Profile URIs</entry-title>
{{TOC-right}}

== Introduction ==

In [[hcalendar-issues]], it is ACCEPTED that each microformat should have a profile URI, like [http://gmpg.org/xfn/11 the XFN profile].

==Known URIs==

This section lists known profile URIs for microformats. To promote cacheability and recognisability of profile URIs, authors {{should}} avoid minting new URIs for existing microformats, and {{should}} re-use existing well-known profile URIs.

=== Combined Profile ===

The following URL covers all non-draft Microformats as of March 2008, except XMDP. You can mix and match it with other XMDP profiles for new/draft microformats.

http://purl.org/uF/2008/03/

=== Individual Microformats ===

<dl>
<dt>adr</dt>
<dd>(Use an hCard profile.)</dd>
<dd>(Or use the combined profile.)</dd>
<dt>figure</dt>
<dd>http://purl.org/uF/figure/draft</dd>
<dt>geo</dt>
<dd>http://purl.org/uF/geo/0.9/</dd>
<dd>(Or use an hCard profile.)</dd>
<dd>(Or use the combined profile.)</dd>
<dt>hAtom</dt>
<dd>http://purl.org/uF/hAtom/0.1/</dd>
<dt>hAudio</dt>
<dd>http://purl.org/NET/haudio &dagger;</dd>
<dd>http://purl.org/uF/hAudio/0.9/ &dagger;</dd>
<dt>hCalendar</dt>
<dd>http://purl.org/uF/hCalendar/1.0/ &dagger;</dd>
<dd>http://www.w3.org/2002/12/cal/hcal ¶&dagger;</dd>
<dd>http://dannyayers.com/microformats/hcalendar-profile &dagger;</dd>
<dd>(Or use the combined profile.)</dd>
<dt>hCard</dt>
<dd>http://purl.org/uF/hCard/1.0/ &dagger;</dd>
<dd>http://www.w3.org/2006/03/hcard &dagger;</dd>
<dd>(Or use the combined profile.)</dd>
<dt>hResume</dt>
<dd>http://microformats.org/wiki/hresume-profile</dd>
<dt>rel-license</dt>
<dd>http://purl.org/uF/rel-license/1.0/ &dagger;</dd>
<dd>(Or use the combined profile.)</dd>
<dt>rel-nofollow</dt>
<dd>http://purl.org/uF/rel-nofollow/1.0/</dd>
<dd>(Or use the combined profile.)</dd>
<dt>rel-tag</dt>
<dd>http://purl.org/uF/rel-tag/1.0/</dd>
<dd>(Or use the combined profile.)</dd>
<dt>VoteLinks</dt>
<dd>http://purl.org/uF/VoteLinks/1.0/ &dagger;</dd>
<dd>http://tommorris.org/profiles/votelinks ¶&dagger;</dd>
<dd>(Or use the combined profile.)</dd>
<dt>XFN</dt>
<dd>http://gmpg.org/xfn/11</dd>
<dd>http://gmpg.org/xfn/1 (older version)</dd>
<dd>(Or use the combined profile.)</dd>
<dt>xFolk</dt>
<dd>http://microformats.org/wiki/xfolk-profile</dd>
<dt>XOXO</dt>
<dd>(Use the combined profile.)</dd>
</dl>

&dagger; = GRDDL-enabled.<br/>
¶ = non-XMDP profile.

=== Other Interesting Profile URIs ===

* [http://purl.org/uF/pattern-data-class/1 Experimental data-* class pattern]
* [http://purl.org/stuff/hdoap/profile hDOAP (posh format)] ¶&dagger;

== How to link to a profile URI ==

=== <code><nowiki><head profile></nowiki></code> ===

This is the original method of linking to profile URIs and is currently supported by the greatest number of tools. This is valid in HTML 4 and XHTML 1.x, but is not valid in Atom (as Atom has no <code><nowiki><head></nowiki></code> element) or current drafts of HTML 5 and XHTML 2.

Example:
<pre><nowiki><html>
<head profile="http://example.com/profile1 http://example.net/profile2">
...</nowiki></pre>

=== <code>rel="profile"</code> ===

An alternative method is provided for people using markup languages which do not support <code><nowiki><head profile></nowiki></code>. Add <code>rel="profile"</code> to either a visible link (<code><nowiki><a></nowiki></code>) or hidden link (<code><nowiki><link></nowiki></code>).

Example:
<pre><nowiki><p>This page uses
<a rel="profile" href="http://gmpg.org/xfn/11">XFN 1.1</a>!</p></nowiki></pre>

==Implementations==

=== GRDDL ===

Tools that support [http://www.w3.org/2001/sw/grddl-wg/ GRDDL] use profiles to parse microformats.

=== Cognition===

In "strict mode", [http://buzzword.org.uk/cognition/ Cognition] refuses to parse any microformats where the profile URI has not been explicitly declared on the page. (It will however, still parse microformats for which there exists no profile URI!)

== Issues ==

Some issues include:

* what domain to use? Candidates include:
** microformats.org
** www.w3.org
** xmdp.org
* what about versioning? How to keep in sync with the wiki and test materials?
* what profile URI to use for combinations, such as [[hcard]] and [[hcalendar]]?
** note [http://www.w3.org/TR/html401/struct/global.html#adef-profile HTML4.01] states "that one or more meta data profiles, [are] separated by white space"; though it's simpler for authors if they can just use one profile URI.
* More profiles are needed.

One proposal is: use www.w3.org, following [http://www.w3.org/1999/10/nsuri W3C namespace policy]. As to versioning, change the profile whenever the wiki changes (within some reasonable latency, say, a couple weeks or a month). For example: [http://www.w3.org/2006/03/hcard an hCard Profile at w3.org], and discussion: [http://microformats.org/discuss/mail/microformats-dev/2006-March/000068.html an hCard profile that seems to work with GRDDL].

=== Validator warning ===

Due to [http://sourceforge.net/tracker/index.php?func=detail&aid=1264455&group_id=27659&atid=390963 inconsistent wording of the HTML specs], HTMLTidy (and other tools?) give "[http://sourceforge.net/mailarchive/forum.php?thread_name=oytAFzxaKxiFFwpx%40pigsonthewing.org.uk&forum_name=htmlvalidator-help Warning: <head> escaping malformed URI reference]"
when more than one profile is used, e.g.

<code><head profile="http://www.ietf.org/rfc/rfc2731.txt http://www.w3.org/2006/03/hcard"></code>

W3C HTML validator has very poor validation of attributes and is technically unable to check this case. The HTML DTD however defines <code>profile</code> attribute as <code>%URI</code> (it's an alias for <code>CDATA</code>), same as <code><a href></code> attribute.

==See also==

* [[profile-uri-examples-in-wild|Profile URI examples, in the wild]]
* [[faqs-for-rdf]] for discussion of connecting microformats to URIs.
* [[hcard-profile]].

figure

2008-11-17T16:23:38Z

91.84.42.38: add Template:DraftSpecification

<entry-title>figure 0.3</entry-title>
{{Template:DraftSpecification}}

{{TOC-right}}

== Specification ==

'''This is a DRAFT specification.'''

<div class="vcard">
; <span class="role">Editor</span>
: <span class="fn">[[User:TobyInk|Toby Inkster]]</span> (<span class="url">http://tobyinkster.co.uk/</span>)
</div>
; Authors
: Toby Inkster (affiliations above)
: <div class="vcard"><span class="fn">[[User:Csarven|Sarven Capadisli]]</span> (<span class="url">http://www.csarven.ca</span>)</div>

; Acknowledgements: See [[figure#Inspiration_and_Acknowledgements|acknowledgements]].

[[figure#Copyright|Copyright]] and [[figure#Patents|patents]] statements apply.

== Introduction ==

Many HTML documents include supporting images, such as photographs, flow charts, graphs, blueprints or screen captures. These are usually incorporated using the HTML <img> element, however this offers no way of differentiating between such supplementary content and mere decorative images.

Authors often wish to annotate these images with captions or attributions. Currently there is no markup to explicitly associate such text with an image and readers must rely on the proximity of the image and text on the finished rendered page. This specification aims to allow authors to mark up captions and credits, explicitly associating them with an image.

This specification ''is not'' intended as a method for marking up ''all'' images on web pages — the HTML <code><nowiki><img/></nowiki></code> element is adequate for decorative and many other images. This specification is intended to be used for images that add or clarify information to the article's text.

{{rfc-2119-intro}}

== Format ==

=== Properties ===

<div style="float:right;width:50%;font-size:85%;margin:0 0 1em 1em">
====Key====
Based on Perl's [http://www.perl.com/doc/manual/html/pod/perlre.html standard quantifiers]:
{| border="1" cellpadding="2"
| '''bold''' {1} || {{must}} be present exactly once
|-
| ''italic''<nowiki>*</nowiki> || {{optional}}, and {{may}} occur more than once
|-
| + || {{must}} be present, and {{may}} occur more than once
|-
| ? || {{optional}}, but {{must-not}} occur more than once
|-
| [square brackets] || list of common values
|-
| (parentheses) || data format
|-
| # || comment
|-
| ! || awaiting documentation
|}
</div>

* '''figure''' {1}
** '''image''' {1}
** '''legend''' +
** ''credit'' (text | [[hcard|hCard]])*
** ''subject'' (text | [[hcard|hCard]] | [[geo]] | [[adr]] | [[hcalendar|hcalendar event]])*

Additionally, an figure {{may}} contain zero or more links marked up with [[rel-tag]].

Please note that the "legend" element should contain what would normally be called a "[http://en.wiktionary.org/wiki/Caption caption]". The term "legend" is used in this specification instead of "caption" in order to maintain parity with the element names used in HTML5. (In turn HTML 5 uses <legend> instead of <caption> to avoid triggering table layouts in legacy browsers.)

The subject, credit and tags may be children of the legend, in which case the text within them forms part of the legend as well as part of the child elements.

====Embedded Microformats====

If an element with class "credit" also has class "vcard" then the element {{should}} be considered to be the [[hcard]] for a credited person or organisation. Otherwise it {{must}} be considered as a plain text credit.

If an element with class "subject" also has a class "vcard" then the element {{should}} be considered to be the [[hcard]] for the subject of the image - for example the person depicted by a photograph or sketch. If an element with class "subject" also has a class "adr" or "geo" then the element should be considered to be the [[adr|address]] or [[geo|geographic location]] of the subject of the picture - for example the location of a landscape in a photo or the address of a the building shown in blueprints. If an element with class "subject" also has a class "vevent" then the element should be considered to be the [[hcalendar|vevent]] for the subject of a figure - for example a photograph of a sporting event, or a diagram of a military operation.

====Design Patterns Used====

The [[include-pattern|include pattern]] {{may}} be used within figures.

As the figure microformat does not specify any properties that are not human-readable, the [[abbr-design-pattern|abbr design pattern]] {{should-not}} be used directly within a figure, though it {{may}} be used within children formatted in accordance to another microformat - e.g. as [[hcalendar|vevents]] often use the abbr design pattern to specify their start time, a figure subject formatted as a vevent {{may}} use the abbr design pattern in accordance with the [[hcalendar]] specification.

=== Minimisation ===

To simplify markup, a number of shortcuts are explicitly allowed by this specification.

# When no "image" class is found within the figure, the first <img> element {{must}} be taken to be the image.
# The longdesc attribute {{may}} be used to point to a legend elsewhere on the page in a manner similar to the [[include-pattern|include pattern]]. As with the inclusion, parsers should ignore the pattern if the fragment linked to is an off-page resource.
# If the "legend" class is found on the same element as the "image" class (or the image inferred by the previous rule), then the title attribute {{must}} be used as the legend.
#* Rationale: some people have questioned the use of the title attribute rather than the alt attribute. The purpose of the figure's legend is to display explanatory text alongside the image. The purpose of the alt attribute is "to serve as content when the element cannot be rendered normally" [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-alt] — i.e. when the image cannot be displayed. Thus the alt and legend fulfil different purposes. Authors are encouraged to consider accessibility carefully when building their page, and supply appropriate alt text in addition to the image's legend.
# If no legend can be found using the legend class or longdesc attribute, then the alt attribute {{must}} be used in its place.
# The "image" and/or "legend" classes may be attached to the same element as the element with the "figure" class.

=== XHTML Meta Data Profile ===

Authors using the figure microformat {{should}} add a profile link to the XMDP profile. The preferred URL is <tt><nowiki>http://purl.org/uF/figure/draft</nowiki></tt>. For more information on how to link to the profile, see [[profile-uris|Profile URIs]].

<dl class="profile">
<dt id="class">class
<dd>[http://www.w3.org/TR/REC-html40/struct/global.html#adef-class HTML 4 definition of "class".] This profile defines the following class names:
<dl>
<dt id="figure">figure
<dd>A section containing a graphical element which provides information relevant to the document. A figure will include one image and at least one legend. The legend may be implied from the image's <code>longdesc</code> attribute.
<dt id="image">image
<dd>The primary graphical element contained within a section with <code>class="figure"</code>.
<dt id="legend">legend
<dd>A description or explanation for a graphic, intended to be displayed alongside it.
<dt id="subject">subject
<dd>A person, place, event or other thing or concept depicted by a graphic.
<dt id="credit">credit
<dd>A person, organisation or other agent that created, contributed to or supplied a graphic.
</dl>
</dl>

== Examples ==

<pre>
<div class="figure">
<img class="image" src="photo.jpeg" alt="">
<p class="legend">
<a rel="tag" href="http://en.wikipedia.org/wiki/Photography">Photo</a>
of <span class="subject">Albert Einstein</span> by
<span class="vcard credit">
<span class="fn">Paul Ehrenfest</span>
(<span class="role">photographer</span>)
</span>
</p>
</div>
</pre>

Parsed as:

* '''Image''': photo.jpeg
* '''Legend''': Photo of Albert Einstein by Paul Ehrenfest (photographer)
* '''Credit''': Paul Ehrenfest (hCard)
* '''Subject''': Albert Einstein
* '''Categories''': Photography

<pre>
<p class="figure">
<label style="display:block" class="legend">January sales data</label>
<img class="image" src="salesdata.png"
alt="Widget sales have fallen slightly, but widget repair kits have sold well.">
</p>
</pre>

Parsed as:

* '''Image''': salesdata.png
* '''Legend''': January sales data

=== Examples Using Minimisation ===

The following examples {{must}} all be considered equivalent:

<pre>

<div class="figure">
<img class="image" src="foo.jpeg" alt="">
<span class="legend">Foo</span>
</div>
</pre>

<pre>

<div class="figure">
<img src="foo.jpeg" alt="">
<span class="legend">Foo</span>
</div>
</pre>

<pre>


<div class="figure">
<img class="legend" src="foo.jpeg" alt="" title="Foo">
</div>
</pre>

<pre>



<img class="figure legend" src="foo.jpeg" alt="" title="Foo">
</pre>

<pre><nowiki>
<div class="figure">
<img class="image" src="foo.jpeg" longdesc="#the-legend" alt="" />
</div>

<p class="legend" id="the-legend">Foo</p></nowiki></pre>

== HTML 5 Considerations ==

When used in [http://www.w3.org/html/wg/html5/ HTML 5], any <figure> element has an implied class "figure"; any <legend> element has an implied class "legend". For example, the following HTML 5:

<pre>
<figure>
<img src="foo.jpeg" alt="">
<legend>Foo</legend>
</figure>
</pre>

is interpreted as if it were:

<pre>
<figure class="figure">
<img src="foo.jpeg" alt="">
<legend class="legend">Foo</legend>
</figure>
</pre>

== Inspiration and Acknowledgments ==

This microformat is largely intended to be a simple [http://en.wikipedia.org/wiki/Porting "port"] of HTML 5's <code><figure></code> construct to other versions of HTML and XHTML.

The three required properties (figure, image and caption) are derived from that. The additional properties (credit, subject) are included because this information seems to be commonly supplied in figures "in the wild" in prose even if it is not marked up with wrapper elements.

* [http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded0.html#figure HTML 5 Draft Specification: <code style="text-decoration:underline"><figure></code> element]
* [http://edward.oconnor.cx/2007/08/figure-markup-redux Edward O'Connor: Figure markup redux]
* [http://www.contentwithstyle.co.uk/Articles/161/figure-microformats/ Matthias Willerich: Figure Microformats]
* [[figure-examples]] (various authors)

Other references which were considered:

* [http://www.w3.org/MarkUp/html3/figures HTML 3 Specification: Figures] — never caught on, not implemented in browsers.
* [http://www.w3.org/Style/Examples/007/figures.html Bert Bos: figures & captions]
* [http://rjohara.net/server/css-figures-captions/ Robert J O'Hara: Scalable figures and captions with CSS and HTML]
* [http://www.cs.tut.fi/~jkorpela/www/captions.html Jukka Korpela: Image captions on Web pages]

== Copyright ==
This specification is released into the public domain.

{{MicroFormatPublicDomainContributionStatement}}

== Patents ==
{{MicroFormatPatentStatement}}

==See also==
*[[figure-examples]]
*[[figure-formats]]
*[[figure-brainstorming]]
*[[figure-issues]]

figure

2008-11-17T16:22:34Z

91.84.42.38: Ben: very nice job on the wiki upgrade!!

<entry-title>figure 0.3</entry-title>

{{TOC-right}}

== Specification ==

'''This is a DRAFT specification.'''

<div class="vcard">
; <span class="role">Editor</span>
: <span class="fn">[[User:TobyInk|Toby Inkster]]</span> (<span class="url">http://tobyinkster.co.uk/</span>)
</div>
; Authors
: Toby Inkster (affiliations above)
: <div class="vcard"><span class="fn">[[User:Csarven|Sarven Capadisli]]</span> (<span class="url">http://www.csarven.ca</span>)</div>

; Acknowledgements: See [[figure#Inspiration_and_Acknowledgements|acknowledgements]].

[[figure#Copyright|Copyright]] and [[figure#Patents|patents]] statements apply.

== Introduction ==

Many HTML documents include supporting images, such as photographs, flow charts, graphs, blueprints or screen captures. These are usually incorporated using the HTML <img> element, however this offers no way of differentiating between such supplementary content and mere decorative images.

Authors often wish to annotate these images with captions or attributions. Currently there is no markup to explicitly associate such text with an image and readers must rely on the proximity of the image and text on the finished rendered page. This specification aims to allow authors to mark up captions and credits, explicitly associating them with an image.

This specification ''is not'' intended as a method for marking up ''all'' images on web pages — the HTML <code><nowiki><img/></nowiki></code> element is adequate for decorative and many other images. This specification is intended to be used for images that add or clarify information to the article's text.

{{rfc-2119-intro}}

== Format ==

=== Properties ===

<div style="float:right;width:50%;font-size:85%;margin:0 0 1em 1em">
====Key====
Based on Perl's [http://www.perl.com/doc/manual/html/pod/perlre.html standard quantifiers]:
{| border="1" cellpadding="2"
| '''bold''' {1} || {{must}} be present exactly once
|-
| ''italic''<nowiki>*</nowiki> || {{optional}}, and {{may}} occur more than once
|-
| + || {{must}} be present, and {{may}} occur more than once
|-
| ? || {{optional}}, but {{must-not}} occur more than once
|-
| [square brackets] || list of common values
|-
| (parentheses) || data format
|-
| # || comment
|-
| ! || awaiting documentation
|}
</div>

* '''figure''' {1}
** '''image''' {1}
** '''legend''' +
** ''credit'' (text | [[hcard|hCard]])*
** ''subject'' (text | [[hcard|hCard]] | [[geo]] | [[adr]] | [[hcalendar|hcalendar event]])*

Additionally, an figure {{may}} contain zero or more links marked up with [[rel-tag]].

Please note that the "legend" element should contain what would normally be called a "[http://en.wiktionary.org/wiki/Caption caption]". The term "legend" is used in this specification instead of "caption" in order to maintain parity with the element names used in HTML5. (In turn HTML 5 uses <legend> instead of <caption> to avoid triggering table layouts in legacy browsers.)

The subject, credit and tags may be children of the legend, in which case the text within them forms part of the legend as well as part of the child elements.

====Embedded Microformats====

If an element with class "credit" also has class "vcard" then the element {{should}} be considered to be the [[hcard]] for a credited person or organisation. Otherwise it {{must}} be considered as a plain text credit.

If an element with class "subject" also has a class "vcard" then the element {{should}} be considered to be the [[hcard]] for the subject of the image - for example the person depicted by a photograph or sketch. If an element with class "subject" also has a class "adr" or "geo" then the element should be considered to be the [[adr|address]] or [[geo|geographic location]] of the subject of the picture - for example the location of a landscape in a photo or the address of a the building shown in blueprints. If an element with class "subject" also has a class "vevent" then the element should be considered to be the [[hcalendar|vevent]] for the subject of a figure - for example a photograph of a sporting event, or a diagram of a military operation.

====Design Patterns Used====

The [[include-pattern|include pattern]] {{may}} be used within figures.

As the figure microformat does not specify any properties that are not human-readable, the [[abbr-design-pattern|abbr design pattern]] {{should-not}} be used directly within a figure, though it {{may}} be used within children formatted in accordance to another microformat - e.g. as [[hcalendar|vevents]] often use the abbr design pattern to specify their start time, a figure subject formatted as a vevent {{may}} use the abbr design pattern in accordance with the [[hcalendar]] specification.

=== Minimisation ===

To simplify markup, a number of shortcuts are explicitly allowed by this specification.

# When no "image" class is found within the figure, the first <img> element {{must}} be taken to be the image.
# The longdesc attribute {{may}} be used to point to a legend elsewhere on the page in a manner similar to the [[include-pattern|include pattern]]. As with the inclusion, parsers should ignore the pattern if the fragment linked to is an off-page resource.
# If the "legend" class is found on the same element as the "image" class (or the image inferred by the previous rule), then the title attribute {{must}} be used as the legend.
#* Rationale: some people have questioned the use of the title attribute rather than the alt attribute. The purpose of the figure's legend is to display explanatory text alongside the image. The purpose of the alt attribute is "to serve as content when the element cannot be rendered normally" [http://www.w3.org/TR/REC-html40/struct/objects.html#adef-alt] — i.e. when the image cannot be displayed. Thus the alt and legend fulfil different purposes. Authors are encouraged to consider accessibility carefully when building their page, and supply appropriate alt text in addition to the image's legend.
# If no legend can be found using the legend class or longdesc attribute, then the alt attribute {{must}} be used in its place.
# The "image" and/or "legend" classes may be attached to the same element as the element with the "figure" class.

=== XHTML Meta Data Profile ===

Authors using the figure microformat {{should}} add a profile link to the XMDP profile. The preferred URL is <tt><nowiki>http://purl.org/uF/figure/draft</nowiki></tt>. For more information on how to link to the profile, see [[profile-uris|Profile URIs]].

<dl class="profile">
<dt id="class">class
<dd>[http://www.w3.org/TR/REC-html40/struct/global.html#adef-class HTML 4 definition of "class".] This profile defines the following class names:
<dl>
<dt id="figure">figure
<dd>A section containing a graphical element which provides information relevant to the document. A figure will include one image and at least one legend. The legend may be implied from the image's <code>longdesc</code> attribute.
<dt id="image">image
<dd>The primary graphical element contained within a section with <code>class="figure"</code>.
<dt id="legend">legend
<dd>A description or explanation for a graphic, intended to be displayed alongside it.
<dt id="subject">subject
<dd>A person, place, event or other thing or concept depicted by a graphic.
<dt id="credit">credit
<dd>A person, organisation or other agent that created, contributed to or supplied a graphic.
</dl>
</dl>

== Examples ==

<pre>
<div class="figure">
<img class="image" src="photo.jpeg" alt="">
<p class="legend">
<a rel="tag" href="http://en.wikipedia.org/wiki/Photography">Photo</a>
of <span class="subject">Albert Einstein</span> by
<span class="vcard credit">
<span class="fn">Paul Ehrenfest</span>
(<span class="role">photographer</span>)
</span>
</p>
</div>
</pre>

Parsed as:

* '''Image''': photo.jpeg
* '''Legend''': Photo of Albert Einstein by Paul Ehrenfest (photographer)
* '''Credit''': Paul Ehrenfest (hCard)
* '''Subject''': Albert Einstein
* '''Categories''': Photography

<pre>
<p class="figure">
<label style="display:block" class="legend">January sales data</label>
<img class="image" src="salesdata.png"
alt="Widget sales have fallen slightly, but widget repair kits have sold well.">
</p>
</pre>

Parsed as:

* '''Image''': salesdata.png
* '''Legend''': January sales data

=== Examples Using Minimisation ===

The following examples {{must}} all be considered equivalent:

<pre>

<div class="figure">
<img class="image" src="foo.jpeg" alt="">
<span class="legend">Foo</span>
</div>
</pre>

<pre>

<div class="figure">
<img src="foo.jpeg" alt="">
<span class="legend">Foo</span>
</div>
</pre>

<pre>


<div class="figure">
<img class="legend" src="foo.jpeg" alt="" title="Foo">
</div>
</pre>

<pre>



<img class="figure legend" src="foo.jpeg" alt="" title="Foo">
</pre>

<pre><nowiki>
<div class="figure">
<img class="image" src="foo.jpeg" longdesc="#the-legend" alt="" />
</div>

<p class="legend" id="the-legend">Foo</p></nowiki></pre>

== HTML 5 Considerations ==

When used in [http://www.w3.org/html/wg/html5/ HTML 5], any <figure> element has an implied class "figure"; any <legend> element has an implied class "legend". For example, the following HTML 5:

<pre>
<figure>
<img src="foo.jpeg" alt="">
<legend>Foo</legend>
</figure>
</pre>

is interpreted as if it were:

<pre>
<figure class="figure">
<img src="foo.jpeg" alt="">
<legend class="legend">Foo</legend>
</figure>
</pre>

== Inspiration and Acknowledgments ==

This microformat is largely intended to be a simple [http://en.wikipedia.org/wiki/Porting "port"] of HTML 5's <code><figure></code> construct to other versions of HTML and XHTML.

The three required properties (figure, image and caption) are derived from that. The additional properties (credit, subject) are included because this information seems to be commonly supplied in figures "in the wild" in prose even if it is not marked up with wrapper elements.

* [http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded0.html#figure HTML 5 Draft Specification: <code style="text-decoration:underline"><figure></code> element]
* [http://edward.oconnor.cx/2007/08/figure-markup-redux Edward O'Connor: Figure markup redux]
* [http://www.contentwithstyle.co.uk/Articles/161/figure-microformats/ Matthias Willerich: Figure Microformats]
* [[figure-examples]] (various authors)

Other references which were considered:

* [http://www.w3.org/MarkUp/html3/figures HTML 3 Specification: Figures] — never caught on, not implemented in browsers.
* [http://www.w3.org/Style/Examples/007/figures.html Bert Bos: figures & captions]
* [http://rjohara.net/server/css-figures-captions/ Robert J O'Hara: Scalable figures and captions with CSS and HTML]
* [http://www.cs.tut.fi/~jkorpela/www/captions.html Jukka Korpela: Image captions on Web pages]

== Copyright ==
This specification is released into the public domain.

{{MicroFormatPublicDomainContributionStatement}}

== Patents ==
{{MicroFormatPatentStatement}}

==See also==
*[[figure-examples]]
*[[figure-formats]]
*[[figure-brainstorming]]
*[[figure-issues]]