Difference between revisions of "Main Page"

From Microformats Wiki
Main Page
Jump to navigation Jump to search
(Added figure links)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(579 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
<div style="float:right;margin-left:1em">__TOC__</div>
+
{{DISPLAYTITLE:Welcome to the microformats wiki!}}
  
Welcome to the microformats wiki!
+
'''<dfn>microformats</dfn>''' are HTML for marking up [[h-card|people, organizations]], [[h-event|events]], [[h-adr|locations]], [[h-entry|blog posts]], [[h-product|products]], [[h-review|reviews]], [[h-resume|resumes]], [[h-recipe|recipes]] etc. Sites use microformats to publish a standard API that is consumed and used by [[search engines]], [[browsers]], and other web sites. See [[what-are-microformats]] for more.
  
Please start with the [[introduction]] page and read [[how-to-play]] before making any edits.
+
* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.
  
 
==Introduction==
 
==Introduction==
* Learn what it means to be [http://microformats.org/wiki/posh <abbr title="Plain Old Semantic HTML">POSH</abbr>] {{NewMarker}}.
+
{{main|introduction}}
* See the [http://microformats.org/about/ about page], [http://microformats.org/ latest news], [[press]], [[presentations]], [[books]], [[podcasts]], & [[screencasts]].
+
This wiki is the central resource of the microformats community and provides microformats authoring guides, references, specifications, drafts, publishing patterns, research, brainstorming, and issue tracking.
* Have questions? Read the [[faq|frequently asked questions]] and see the [[glossary]] for new terms.
 
* Want to learn more in person? Check out microformats [[events]].
 
  
==Definition==
+
== Get Started==
Microformats are small bits of HTML that represent things like people, events, tags etc. in webpages. 
+
{{main|get-started}}
 +
Get started with microformats:
  
Microformats enable the publishing of higher fidelity information on the Web, providing the fastest & simplest way to support feeds and APIs for your website. See more explanations of [[what-are-microformats|what are microformats]], and [[what-can-you-do-with-microformats|what you can do with them]].
+
* Make sure your pages and web apps use proper ‘[[posh|<abbr title="Plain Old Semantic HTML">POSH</abbr>]]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
 +
* Mark-up your contact info with [[h-card]], link to other profiles with [[rel-me]]
 +
* Mark-up your blog with [[h-entry]]. See https://indieweb.org/ for more
 +
* Questions? Read the [[faq|frequently asked questions]], ask on [[IRC]]
 +
* Want to learn more in person? Check out microformats [[events]]
  
 
== How to contribute ==
 
== How to contribute ==
Do you want to help take microformats to the next level? You can:
+
Want to join in and contribute?
* [[get-started|Get started]] by adding microformats to your website, services, and products.
+
 
* [[advocacy|Advocate]] the use of microformats on other web sites, especially those you use.
+
* [[get-started|Get started]] by adding microformats to your website, services, and products
* Write a [[testimonial]].
+
* Join the [[irc|IRC Channel]] to learn and help answer questions.
 +
* Write a [[testimonial]]
 
* Do something on the [[to-do|to do list]].
 
* Do something on the [[to-do|to do list]].
* Join the [[irc|IRC Channel]] and [http://microformats.org/discuss mailing lists] to learn and help answer questions (read the [[mailing-lists#General_guidelines|general guidelines]] before posting).
 
 
* [[Main_Page#microformats_wiki_translations|Translate this microformats wiki into other languages]] to make microformats more accessible to readers of languages around the world.
 
* [[Main_Page#microformats_wiki_translations|Translate this microformats wiki into other languages]] to make microformats more accessible to readers of languages around the world.
* Find [[orphans|orphaned]] pages, and add links to them.
 
 
* Before proposing any new microformats, make sure your website is [[POSH]], [[get-started|uses existing microformats]], and then read the [[process]].
 
* Before proposing any new microformats, make sure your website is [[POSH]], [[get-started|uses existing microformats]], and then read the [[process]].
 +
 +
This wiki has a number of enhancements to assist development and contributions to microformats. Before you start editing, see the [[wiki-2|wiki introduction page]] for instructions.
  
 
== Specifications ==
 
== Specifications ==
[[microformats|Microformats]] open standards specifications (see also: [[implementations]], [[examples-in-the-wild]])
+
'''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.
* [[hcalendar|hCalendar]] - [http://microformats.org/code/hcalendar/creator hcalendar creator]
+
 
* [[hcard|hCard]] - [http://microformats.org/code/hcard/creator hcard creator]
+
Current, stable microformats open standard specifications:
* [[rel-license]]
+
* [[h-adr]]
* [[rel-nofollow]]
+
* [[h-card]]
* [[rel-tag]]
+
* [[h-entry]]
* [[vote-links|VoteLinks]]
+
* [[h-event]]
* [http://gmpg.org/xfn/ XFN] (see also: [[xfn-implementations]])
+
* [[h-feed]]
* [http://gmpg.org/xmdp/ XMDP]
+
* [[h-geo]]
* [[xoxo|XOXO]]
+
* [[h-item]]
 +
* [[h-listing]]
 +
* [[h-product]]
 +
* [[h-recipe]]
 +
* [[h-resume]]
 +
* [[h-review]]
 +
* [[h-review-aggregate]]
 +
 
 +
=== rel microformats ===
 +
Some microformats require only a rel attribute and are widely supported by consuming sites and software.
 +
* [[rel-author]] - link to the author's home page (from an article)
 +
* [[rel-enclosure]] - link to attachments (e.g. files) to download and cache
 +
* [[rel-license]] - licensed content
 +
* [[rel-nofollow]] - links in untrusted 3rd party content
 +
* [[rel-tag]] - tag posts and pages by subject
 +
* [[XFN]] - social relationships and [[rel-me]] links among profiles for the same person
 +
 
 +
=== Classic Microformats ===
 +
In addition use well established classic microformats for the primary subject of a page for legacy [[search engines]] support.
 +
 
 +
* [[hatom|hAtom]] - blog posts and other date-stamped content
 +
* [[hcalendar|hCalendar]] - events
 +
* [[hcard|hCard]] - people, organizations, contacts
 +
* [[hlisting|hListing]] - listings for products or services
 +
* [[hmedia|hMedia]] - media info about images, video, audio
 +
* [[hproduct|hProduct]] - products
 +
* [[hrecipe|hRecipe]] - cooking+baking recipes
 +
* [[hresume|hResume]] - individual resumes and CVs
 +
* [[hreview|hReview]] - individual reviews and ratings
 +
* [[hreview-aggregate|hReview-aggregate]] - aggregate reviews and ratings
 +
 
 +
* [[adr|adr]] - address location information
 +
* [[geo|geo]] - latitude &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)
 +
 
 +
=== Drafts ===
 +
Drafts are classic microformats which have varying degrees of support by consuming applications. They are stable and yet still open to change based on consuming application support, per the [[process]] to become specifications.
 +
 
 +
* [[hnews|hNews]] - news articles, extension of hAtom
 +
 
 +
* [[rel-home]] - link to the homepage of a site
 +
* [[rel-payment]] - link to a payment mechanism
 +
 
 +
* [[XMDP]] - define a microformat vocabulary / profile
 +
* [[xoxo|XOXO]] - outlines
  
== Drafts ==
+
''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!'' and then take a look at [[exploratory-discussions]] for details of prior research, analysis of real-world [[examples]], existing formats, and brainstorming of possible new microformats, per the microformats [[process]].
* [[adr|adr]] - for marking up address information
 
* [[geo|geo]] - for marking up [http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates (latitude; longitude)
 
* [[hatom|hAtom]] - syndicating episodic content (e.g. weblog postings)
 
* [[hresume|hResume]] - for publishing resumes and CVs
 
* [[hreview|hReview]] - [http://microformats.org/code/hreview/creator hreview creator]
 
* [[rel-directory]] - to indicate that the destination of a hyperlink is a directory listing containing an entry for the current page
 
* [[rel-enclosure]] - for indicating attachments (e.g. files) to download and cache
 
* [[rel-home]] - indicate a hyperlink to the homepage of the site
 
* [[rel-payment]] - indicate a payment mechanism
 
* [[robots-exclusion|Robots Exclusion]]
 
* [[xfolk|xFolk]]
 
  
 
== Design Patterns ==
 
== Design Patterns ==
 
 
{{design_patterns}} <!-- this can be edited in /wiki/Template:design_patterns -->
 
{{design_patterns}} <!-- this can be edited in /wiki/Template:design_patterns -->
  
== Exploratory Discussions ==
+
== Archived ==
Per the microformats [[process]]: research and analysis of real-world [[examples]], existing formats, and brainstorming to motivate the microformat. Please check [[rejected-formats]] before making additions.
+
Past specifications, drafts, and exploratory discussions which have either lacked (or lost) wide publishing support, implementation, or have been superceded by newer specs (see also [[process#related_issues_questions_regarding_document_stages|when does it make sense to demote a microformat spec]]). These may eventually be retired, deprecated, or reincorporated into other exploratory discussions.
 +
* [[haudio|hAudio]]
 +
* [[robots-exclusion|robots exclusion]]
 +
* [[xfolk|xFolk]] - tagged links
  
* alternates [[alternates-brainstorming|alternates brainstorming]], [[alternates-examples|alternates examples]]
+
* [[rel-directory]] - link to web directories
*[[attention]]
+
* [[vote-links|VoteLinks]]
* [[audio-info]] ([[audio-info-examples|examples]], [[audio-info-formats|formats]], [[audio-info-brainstorming|brainstorming]], [[audio-info-proposal|proposal]], [[audio-info-issues|issues]]) - Marking up information and metadata related to audio (speech, music, and sound in general).
 
* audio-album (see [[audio-info]] pages for examples, formats, brainstorming. [[audio-album-proposal]], [[audio-album-issues]]) - Marking up information and metadata related to audio albums/collections. {{NewMarker}}
 
* blog description [[blog-description-examples|blog description examples]]
 
* blog info [[blog-info-examples|blog info examples]]
 
* blog post [[blog-post-examples|examples]], [[blog-post-formats|blog post formats]], and [[blog-post-brainstorming|blog post brainstorming]] (yielded the [[hatom|hAtom]] draft)
 
* book [[book-examples|book examples]], [[book-formats|book formats]], and [[book-brainstorming|book brainstorming]]
 
* chat [[chat-examples|chat examples]], [[chat-formats|chat formats]], and [[chat-brainstorming|chat brainstorming]]
 
* citation [[citation|citation effort]], [[citation-examples|citation examples]], [[citation-formats|citation formats]], [[citation-brainstorming|citation brainstorming]], and [[citation-faq|citation FAQ]]
 
* code [[code-examples|code examples]], [[code-formats]], [[code-brainstorming|code brainstorming]]
 
* comment [[comment-problem|comment problem]], [[comment-examples|comment examples]], and [[comments-formats|comment formats]] (Some stuff needs to be extracted from [[comments-formats]])
 
* [[collection-description|collection description]] - for describing collections in libraries {{NewMarker}}
 
* [[course-catalog]]; [[course-catalog-examples]] {{NewMarker}}
 
* [[currency]]; [[currency-examples]]; [[currency-formats]]; [[currency-brainstorming]]; [[currency-proposal]]; [[currency-issues]]
 
* [[depend-examples]]: examples of dependency graphs, especially as they relate to software {{NewMarker}}
 
* [[digital-signatures]]: incorporation of digital signatures in Microformatted data; ([[digitalsignature-examples|digital-signature examples]], [[digitalsignature-formats]], [[digitalsignature-brainstorming|digital-signatures brainstorming]]) {{NewMarker}}
 
* directions [[directions-examples|directions examples]] {{NewMarker}}
 
* directory inclusion [[directory-inclusion-examples|directory inclusion examples]], [[directory-inclusion-formats|directory inclusion formats]]. (yielded the [[rel-directory]] microformat)
 
* distributed conversation [[distributed-conversation|distributed conversation overview]], [[distributed-conversation-examples|distributed conversation examples]], [[distributed-conversation-formats|distributed conversation formats]], [[distributed-conversation-brainstorming|distributed conversation brainstorming]]
 
* [[downloads]] [[downloads-examples|downloads examples]], [[downloads-formats|downloads formats]], [[downloads-brainstorming|downloads brainstorming]] {{NewMarker}}
 
* error messages [[error-message-examples|error message examples]], [[error-message-formats]], [[error-message-brainstorming|error message brainstorming]]
 
* figures [[figure-examples|figure examples]], [[figure-brainstorming|figure brainstorming]]
 
* file-format ([[file-format-examples|examples]], formats, brainstorming) - for the mark-up of file format information (size, type, codecs, bitrate, etc.) {{NewMarker}} - should this be merged with [[downloads]] ?
 
* forms [[forms-examples|forms examples]]
 
* genealogy [[genealogy-examples]], [[genealogy-formats|genealogy formats]]
 
* geo extensions
 
** [[geo-elevation-examples]], [[geo-elevation-formats]] - extend geo for representing altitude {{NewMarker}}
 
** [[geo-waypoint-examples]], [[geo-waypoint-formats]] - extend geo for representing routes and boundaries, using waypoints {{NewMarker}}
 
** [[geo-extension-examples]], [[geo-extension-formats]], [[geo-extension-brainstorming]], [[geo-extension-strawman]] - extend geo for moons, other planets, etc.
 
* group [[group-examples|group examples]], [[group-formats]], [[group-brainstorming|group brainstorming]]
 
* grouping ([[grouping-examples|examples]], [[grouping-formats|formats]], [[grouping-brainstorming|brainstorming]], [[grouping-proposal|proposal]]) - Metadata markup of items that should be grouped together. {{NewMarker}}
 
* hash [[hash-examples|hash examples]] (see also [[downloads]])
 
* items [[items-examples|items examples]], [[items-formats]], [[items-brainstorming|items brainstorming]]
 
* job listing [[job-listing-examples|job listing examples]], [[job-listing-formats]], [[job-listing-brainstorming|job listing brainstorming]]
 
* last modified [[last-modified-examples|last modified examples]], [[last-modified-formats|last modified formats]], and [[last-modified-brainstorming|last modified brainstorming]]
 
* listing / hListing [[hlisting-proposal|hListing proposal]], and [[hlisting-feedback|hListing feedback]]
 
** based on listing [[listing-examples|examples]], [[listing-formats|formats]], and [[listing-brainstorming|brainstorming]]
 
* location [[location-examples]], [[location-formats|location formats]]. (see also [[adr]], [[geo]], [[hcard|hCard]])
 
* measures and measurement units [[measure]], [[measure-examples]], [[measure-formats]]
 
* [[media-info]] ([[media-info-examples|media-info examples]], [[media-info-formats|media-info formats]], [[media-info-brainstorming|media-info brainstorming]]) {{UpdateMarker}}
 
* meeting minutes [[meeting-minutes-examples|meeting minutes examples]], [[meeting-minutes-formats|meeting minutes formats]], and [[meeting-minutes-brainstorming|meeting minutes brainstorming]]
 
* metalink [[metalink-examples|metalink examples]] {{NewMarker}}
 
* [[mfo-examples|MFO examples]]
 
* music [[music-examples|music examples]] {{UpdateMarker}} (see also [[audio-info]])
 
* news [[news-examples|news examples]] {{NewMarker}}
 
* [[operating-hours]]: [[operating-hours-examples]] ..of stores, restaurants, etc. {{UpdateMarker}}
 
* [[page-summary]] [[page-summary-examples]], [[page-summary-formats]]
 
* [[payment]]
 
* photo note [[photo-note-examples|photo note examples]]
 
* [[product]] -  [[product-examples]], [[product-formats]], [[product-brainstorming]]. The following needs to be cleaned up as part of product: rel-product [[rel-product-brainstorming|rel-product brainstorming]]
 
* [[question-answer]], [[question-answer-examples]], [[question-answer-formats]], [[question-answer-brainstorming]] {{NewMarker}}
 
* [[realestate-propertydetail]], [[realestate-propertydetail-examples]], [[realestate-propertydetail-formats]], [[realestate-propertydetail brainstorming]]
 
* receipt ([[receipt-examples|examples]], [[receipt-formats|formats]], [[receipt-brainstorming|brainstorming]], [[receipt-proposal|proposal]]) - Marking up information and metadata related to purchase receipts. {{NewMarker}}
 
* recipe [[recipe-examples|recipe examples]], [[recipe-formats]], [[recipe-brainstorming]] {{UpdateMarker}}
 
* requirements testing [[requirements-testing|requirements testing overview]], and [[requirements-testing-examples|requirements testing examples]]
 
* [[rest-examples|REST examples]] (see also [[rest]])
 
* resume [[resume-examples]], [[resume-formats|resume formats]], [[resume-brainstorming|resume brainstorming]] yielded the [[hresume|hResume]] draft.
 
* review [[review-examples|review examples]], and [[review-formats|review formats]] yielded the [[hreview|hReview]] draft
 
* search results [[search-results-example|search results example]]
 
* show [[show-examples]], [[show-formats]], [[show-brainstorming|show brainstorming]] (see also [[media-info]])
 
* showroll [[showroll-examples]], [[showroll-formats]], [[showroll-brainstorming]]
 
* [[species]] - for the marking up of the scientific names of living things: [[species-examples]], [[species-formats]], [[species-brainstorming]] {{UpdateMarker}}
 
* table [[table-examples|examples]]
 
* tagspeak [[tagspeak-examples|tagspeak examples]]
 
* tagcloud [[tagcloud-examples|tagcloud examples]], [[tagcloud-formats]], and [[tagcloud-brainstorming|tagcloud  brainstorming]].
 
* [[to-do-examples]], [[to-do-formats]], [[to-do-brainstorming]], to perhaps yield [[htodo|hToDo]]
 
* transit table [[transit-table-examples|transit table examples]]
 
* [[uid]]
 
* [[widget]], [[widget-examples|widget examples]], [[widget-formats]], [[widget-brainstorming|widget brainstorming]]
 
* [[wiki-formats|wiki formats]]
 
* work of art [[work-of-art|work of art overview]], [[workofart-examples|work of art examples]], [[workofart-formats|work of art formats]], and [[workofart-brainstorming|work of art brainstorming]]
 
* [[xmdp-brainstorming|XMDP brainstorming]] (see also [[xmdp-faq]])
 
  
 
== Examples ==
 
== Examples ==
Line 138: Line 105:
 
* [[zen-garden]]
 
* [[zen-garden]]
  
== tools, test cases, additional research ==
+
== Resources ==
 +
See [[resources]].
  
The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting tools and services that need to process more than one microformat. This section is intended for editors, parsers, validators, test cases, and other information relevant across multiple microformats.
+
== User centric development ==
 
 
*[[accessibility]]
 
*[[faqs-for-rdf]]
 
*[[icalendar-implementations]]
 
*[[internationalization]]
 
*[[parsing-microformats]]
 
*[[profile-uri-examples-in-wild|Profile URI examples, in the wild]] (Profile URIs for <code>head</code> elements)
 
*[[selected-test-cases-from-the-web]]
 
*[http://hg.microformats.org/ Source code repository] -- [[mercurial-quick-start|how to download code from the repository]]
 
 
*[[user-interface]]
 
*[[user-interface]]
*[[user-profile-examples-in-wild|User profile examples, in the wild]] (User profiles, for social websites)
+
*[[data-portability]]
*[[vcard-implementations]], [[vcard-errata]], [[vcard-suggestions]]
+
*[[social-network-portability]]
*[[why-are-content-standards-hard]]
+
*[http://indiewebcamp.com/ indieweb]
  
== resources ==
+
== Shared work areas ==
* [[events]]
+
* [[to-do]]
* [[cheatsheets]] are handy if you need a quick reminder about a particular microformat.
+
* [[templates]]
* [[spread-microformats]]
+
* [http://microformats.org/wiki/delete pages for deletion] <!-- keep as external link; removes from "what links here" -->
* [[buttons]]
+
* [[Special:Specialpages|"Special" wiki pages]]
* [[icons]]
+
* [[year-in-review]]
* [[demo]] - a page with links for quickly demonstrating microformats working in practice.
 
* [[semacode|Semacode]]
 
* [[jobs]]
 
* [[user-interface]]
 
* [[shortcuts]] to wiki pages with long names
 
* [[marked-for-deletion]]
 
* [[spellcheck|spell-check dictionary]]
 
  
== shared work areas ==
+
== Tools, test cases, additional research ==
* [[to-do]]
+
The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting [[tools|tools and services]] that need to process more than one microformat. That section is intended for editors, [[parsers]], [[validators]], test cases, and other information relevant across multiple microformats.
* [[microformats-issues]] - issues related to more than one microformat.
 
* [[external-issues]]
 
  
== microformats wiki translations ==
+
<span id="microformats_wiki_translations"><span id="microformats_wiki_translations_in_other_languages">&nbsp;</span></span>
<span id="microformats_wiki_translations_in_other_languages">You may read and edit microformats articles in many other languages:</span>
+
== Microformats wiki translations ==
 +
You may read and edit microformats articles in many other languages:
  
 
* languages with over 100 articles
 
* languages with over 100 articles
** [[Main_Page-fr|Français (French)]] {{UpdateMarker-fr}}
+
** [[Main_Page-fr|<span lang="fr">Français</span> (French)]] <span lang="fr">{{UpdateMarker-fr}}</span>
 
* languages with over 10 articles
 
* languages with over 10 articles
** [[Main_Page-pt-br| Português (Brazilian Portuguese)]]
+
** [[Main_Page-ja|<span lang="ja">日本語</span> (Japanese)]]
** [[Main_Page-ja|日本語 (Japanese)]]
+
** [[Main_Page-pt-br|<span lang="pt-br">Português</span> (Brazilian Portuguese)]]
 +
** [[Main_Page-ru|<span lang="ru">Русский</span> (Russian)]]
 
* languages with over 2 articles
 
* languages with over 2 articles
** [[Main_Page-es|Español (Spanish)]]
+
** [[Main_Page-cs|<span lang="cs">Česky</span> (Czech)]]
** [[Main_Page-de|Deutsch (German)]]
+
** [[Main_Page-zh|<span lang="zh">汉语</span> (Chinese)]]
** [[Main_Page-ro|Romanian]]
+
** [[Main_Page-de|<span lang="de">Deutsch</span> (German)]]
 +
** [[Main_Page-es|<span lang="es">Español</span> (Spanish)]]
 +
** [[Main_Page-gl|<span lang="gl">Galego</span> (Galician)]]
 +
** [[Main_Page-id|<span lang="id">Indonesia</span> (Bahasa Indonesia)]]
 +
** [[Main_Page-pl|<span lang="pl">Polski</span> (Polish)]]
 +
** [[Main_Page-ro|<span lang="ro">Română</span> (Romanian)]]
 +
* languages just started
 +
** [[Main_Page-ar|<span lang="ar">العربية</span> (Arabic)]]
 +
** [[Main_Page-fa|<span lang="fa">پارسی</span> (Farsi)]]
 +
** [[Main_Page-ka|<span lang="ka">ქართული</span> (Georgian)]] {{NewMarker}} <!-- 2013 -->
 +
** [[Main_Page-it|<span lang="it">Italiano</span> (Italian)]]
 +
** [[Main_Page-ko|<span lang="ko">한국어</span> (Korean)]]
 +
** [[Main_Page-th|<span lang="th">ภาษาไทย</span> (Thai)]]
 +
** [[Main_Page-tr|<span lang="tr">Türkçe</span> (Turkish)]] {{NewMarker}} <!-- 2012-328 -->
 
* elsewhere
 
* elsewhere
 
**[http://en.wikipedia.org/wiki/Microformat Wikipedia's article on microformats] has been translated into a number of languages.
 
**[http://en.wikipedia.org/wiki/Microformat Wikipedia's article on microformats] has been translated into a number of languages.
  
 
See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].
 
See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].
 +
 +
== community ==
 +
<span class="h-card"><strong class="p-name p-org">microformats.org</strong> is <span class="p-note">a community focused on using an empirical (rather than aspirational) [[process]] to research web data & information human publishing behaviors, openly document it on our wiki (<span class="p-url p-uid">http://microformats.org/wiki/</span>), discuss it in [[IRC]] (<span class="p-url">irc://irc.freenode.net/microformats</span>), then brainstorm ideas & proposals based on that research for simple formats based on HTML to interoperably represent that information on the web, incrementally implement, and iterate.</span></span>

Latest revision as of 16:01, 18 July 2020


microformats are HTML for marking up people, organizations, events, locations, blog posts, products, reviews, resumes, recipes etc. Sites use microformats to publish a standard API that is consumed and used by search engines, browsers, and other web sites. See What are microformats? for more.

  • See microformats2 for a technical overview and summary of how to use microformats on public web pages and for APIs.

Introduction

Main article: Introduction to Microformats

This wiki is the central resource of the microformats community and provides microformats authoring guides, references, specifications, drafts, publishing patterns, research, brainstorming, and issue tracking.

Get Started

Main article: Get Started

Get started with microformats:

How to contribute

Want to join in and contribute?

This wiki has a number of enhancements to assist development and contributions to microformats. Before you start editing, see the wiki introduction page for instructions.

Specifications

microformats2 is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.

Current, stable microformats open standard specifications:

rel microformats

Some microformats require only a rel attribute and are widely supported by consuming sites and software.

Classic Microformats

In addition use well established classic microformats for the primary subject of a page for legacy search engines support.

  • adr - address location information
  • Geo - latitude & longitude location (WGS84 geographic coordinates)

Drafts

Drafts are classic microformats which have varying degrees of support by consuming applications. They are stable and yet still open to change based on consuming application support, per the The microformats process to become specifications.

  • hNews - news articles, extension of hAtom
  • XMDP - define a microformat vocabulary / profile
  • XOXO - outlines

If you're tempted to try your hand at writing a microformat please read the process page first! and then take a look at Exploratory Discussions for details of prior research, analysis of real-world Best Practices for Examples Pages, existing formats, and brainstorming of possible new microformats, per the microformats The microformats process.

Design Patterns

Design patterns are common uses of markup across microformats.

Archived

Past specifications, drafts, and exploratory discussions which have either lacked (or lost) wide publishing support, implementation, or have been superceded by newer specs (see also when does it make sense to demote a microformat spec). These may eventually be retired, deprecated, or reincorporated into other exploratory discussions.

Examples

Resources

See resources.

User centric development

Shared work areas

Tools, test cases, additional research

The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting tools and services that need to process more than one microformat. That section is intended for editors, Microformats Parsers, microformats validators, test cases, and other information relevant across multiple microformats.

 

Microformats wiki translations

You may read and edit microformats articles in many other languages:

See also List of microformats wiki translations, and how-to-start-a-new-translation.

community

microformats.org is a community focused on using an empirical (rather than aspirational) The microformats process to research web data & information human publishing behaviors, openly document it on our wiki (http://microformats.org/wiki/), discuss it in #microformats on freenode (irc://irc.freenode.net/microformats), then brainstorm ideas & proposals based on that research for simple formats based on HTML to interoperably represent that information on the web, incrementally implement, and iterate.