Microformats Wiki

Welcome to the microformats wiki!

(Difference between revisions)

Jump to: navigation, search
(Georgian translation started! (sort languages in each section by English transliteration of non-roman characters))
Current revision (19:28, 10 April 2017) (view source)
(Get Started: indieweb.org!)
 
(11 intermediate revisions not shown.)
Line 1: Line 1:
<entry-title>Welcome to the microformats wiki!</entry-title>
<entry-title>Welcome to the microformats wiki!</entry-title>
-
'''<dfn>microformats</dfn>''' are extensions to HTML for marking up [[hCard|people, organizations]], [[hCalendar|events]], [[adr|locations]], [[hAtom|blog posts]], [[hProduct|products]], [[hReview|reviews]], [[hResume|resumes]], [[hRecipe|recipes]] etc. Sites use microformats to publish a standard API that is consumed and used by [[search engines]], [[browsers]], and other tools. See [[what-are-microformats]] for more.
+
'''<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.
 +
 
 +
* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.
==Introduction==
==Introduction==
Line 11: Line 13:
Get started with microformats:
Get started with microformats:
-
* First, make sure your pages and web apps use semantically rich, descriptive, ‘[[posh|<abbr title="Plain Old Semantic HTML">POSH</abbr>]]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
+
* 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 [[hCard]] ([[hcard-authoring|see authoring tips]], [[hcard-examples|examples]]) and link from your personal site to other profiles with [[rel-me]].
+
* Mark-up your contact info with [[h-card]], link to other profiles with [[rel-me]]
-
* Questions? Read the [[faq|frequently asked questions]], ask on the [[IRC]] channel.
+
* Mark-up your blog with [[h-entry]]. See https://indieweb.org/ for more
-
* Want to learn more in person? Check out microformats [[events]].
+
* 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 ==
Line 20: Line 23:
* [[get-started|Get started]] by adding microformats to your website, services, and products
* [[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
+
* Join the [[irc|IRC Channel]] to learn and help answer questions.
-
* Read [[how-to-play]] before editing this wiki
+
-
* Join the [[irc|IRC Channel]] and [[mail|mailing lists]] to learn and help answer questions (read [[mailing-lists#General_guidelines|general guidelines]] before posting).
+
* Write a [[testimonial]]
* Write a [[testimonial]]
-
* Write a blog post on: '''[[recently-in-microformats]]'''
 
* Do something on the [[to-do|to do list]].
* Do something on the [[to-do|to do list]].
* [[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.
Line 32: Line 32:
== Specifications ==
== Specifications ==
-
Current, stable microformats open standard specifications.
+
'''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.
-
* {{NewMarker}} '''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. start using it on public web pages and developing more parsers and applications.
+
Current, stable microformats open standard specifications:
-
In addition use well established microformats:
+
* [[h-adr]]
-
* [[hcalendar|hCalendar]] - events
+
* [[h-card]]
-
* [[hcard|hCard]] - people, organizations, contacts
+
* [[h-entry]]
 +
* [[h-event]]
 +
* [[h-feed]]
 +
* [[h-geo]]
 +
* [[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-license]] - licensed content
* [[rel-nofollow]] - links in untrusted 3rd party content
* [[rel-nofollow]] - links in untrusted 3rd party content
* [[rel-tag]] - tag posts and pages by subject
* [[rel-tag]] - tag posts and pages by subject
* [[XFN]] - social relationships and [[rel-me]] links among profiles for the same person
* [[XFN]] - social relationships and [[rel-me]] links among profiles for the same person
-
* [[XMDP]] - define a microformat vocabulary / profile
 
-
* [[xoxo|XOXO]] - outlines
 
-
== Drafts ==
+
=== Classic Microformats ===
-
Drafts are newer microformats, which are still making their way through the [[process]] to become specifications. Implementers should be prepared to keep abreast of future developments and changes. Please watch the wiki pages for updates.
+
In addition use well established classic microformats for the primary subject of a page for legacy [[search engines]] support.
-
* [[adr|adr]] - address location information
 
-
* [[geo|geo]] - latitude &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)
 
* [[hatom|hAtom]] - blog posts and other date-stamped content
* [[hatom|hAtom]] - blog posts and other date-stamped content
 +
* [[hcalendar|hCalendar]] - events
 +
* [[hcard|hCard]] - people, organizations, contacts
* [[hlisting|hListing]] - listings for products or services
* [[hlisting|hListing]] - listings for products or services
* [[hmedia|hMedia]] - media info about images, video, audio
* [[hmedia|hMedia]] - media info about images, video, audio
-
* [[hnews|hNews]] - news articles, extension of hAtom
 
* [[hproduct|hProduct]] - products
* [[hproduct|hProduct]] - products
* [[hrecipe|hRecipe]] - cooking+baking recipes
* [[hrecipe|hRecipe]] - cooking+baking recipes
Line 59: Line 71:
* [[hreview|hReview]] - individual reviews and ratings
* [[hreview|hReview]] - individual reviews and ratings
* [[hreview-aggregate|hReview-aggregate]] - aggregate reviews and ratings
* [[hreview-aggregate|hReview-aggregate]] - aggregate reviews and ratings
-
* [[rel-author]] - link to the author's home page (from an article)
+
 
 +
* [[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-home]] - link to the homepage of a site
* [[rel-payment]] - link to a payment mechanism
* [[rel-payment]] - link to a payment mechanism
-
''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!''
+
* [[XMDP]] - define a microformat vocabulary / profile
-
 
+
* [[xoxo|XOXO]] - outlines
-
== Exploratory Discussions ==
+
-
{{main|exploratory-discussions}}
+
-
See: [[exploratory-discussions]] for details of research and analysis of real-world [[examples]], existing formats, and brainstorming of possible new microformats, per the microformats [[process]].
+
''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]].
== Design Patterns ==
== Design Patterns ==
Line 74: Line 92:
== Archived ==
== 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 [[process#related_issues_questions_regarding_document_stages: process|when does it make sense to demote a microformat spec]]). These may eventually be retired, deprecated, or reincorporated into other exploratory discussions.
+
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]]
* [[haudio|hAudio]]
-
* [[rel-directory]] - link to web directories
 
-
* [[rel-enclosure]] - link to attachments (e.g. files) to download and cache
 
* [[robots-exclusion|robots exclusion]]
* [[robots-exclusion|robots exclusion]]
-
* [[vote-links|VoteLinks]]
 
* [[xfolk|xFolk]] - tagged links
* [[xfolk|xFolk]] - tagged links
 +
 +
* [[rel-directory]] - link to web directories
 +
* [[vote-links|VoteLinks]]
== Examples ==
== Examples ==
Line 94: Line 112:
*[[data-portability]]
*[[data-portability]]
*[[social-network-portability]]
*[[social-network-portability]]
 +
*[http://indiewebcamp.com/ indieweb]
== Shared work areas ==
== Shared work areas ==
Line 116: Line 135:
** [[Main_Page-ru|<span lang="ru">Русский</span> (Russian)]]
** [[Main_Page-ru|<span lang="ru">Русский</span> (Russian)]]
* languages with over 2 articles
* languages with over 2 articles
-
** [[Main_Page-cs|<span lang="cs">Česky</span> (Czech)]] {{NewMarker}}
+
** [[Main_Page-cs|<span lang="cs">Česky</span> (Czech)]]
** [[Main_Page-zh|<span lang="zh">汉语</span> (Chinese)]]
** [[Main_Page-zh|<span lang="zh">汉语</span> (Chinese)]]
** [[Main_Page-de|<span lang="de">Deutsch</span> (German)]]
** [[Main_Page-de|<span lang="de">Deutsch</span> (German)]]
** [[Main_Page-es|<span lang="es">Español</span> (Spanish)]]
** [[Main_Page-es|<span lang="es">Español</span> (Spanish)]]
-
** [[Main_Page-gl|<span lang="gl">Galego</span> (Galician)]] {{NewMarker}}
+
** [[Main_Page-gl|<span lang="gl">Galego</span> (Galician)]]  
-
** [[Main_Page-id|<span lang="id">Indonesia</span> (Bahasa Indonesia)]] {{NewMarker}}
+
** [[Main_Page-id|<span lang="id">Indonesia</span> (Bahasa Indonesia)]]  
** [[Main_Page-pl|<span lang="pl">Polski</span> (Polish)]]
** [[Main_Page-pl|<span lang="pl">Polski</span> (Polish)]]
-
** [[Main_Page-ro|<span lang="ro">Română</span> (Romanian)]] {{NewMarker}}
+
** [[Main_Page-ro|<span lang="ro">Română</span> (Romanian)]]
* languages just started
* languages just started
** [[Main_Page-ar|<span lang="ar">العربية</span> (Arabic)]]
** [[Main_Page-ar|<span lang="ar">العربية</span> (Arabic)]]
-
** [[Main_Page-fa|<span lang="fa">پارسی</span> (Farsi)]] {{NewMarker}}
+
** [[Main_Page-fa|<span lang="fa">پارسی</span> (Farsi)]]
-
** [[Main_Page-ka|<span lang="ka">ქართული</span> (Georgian)]] {{NewMarker}}
+
** [[Main_Page-ka|<span lang="ka">ქართული</span> (Georgian)]] {{NewMarker}} <!-- 2013 -->
-
** [[Main_Page-it|<span lang="it">Italiano</span> (Italian)]] {{NewMarker}}
+
** [[Main_Page-it|<span lang="it">Italiano</span> (Italian)]]
-
** [[Main_Page-ko|<span lang="ko">한국어</span> (Korean)]] {{NewMarker}}
+
** [[Main_Page-ko|<span lang="ko">한국어</span> (Korean)]]
** [[Main_Page-th|<span lang="th">ภาษาไทย</span> (Thai)]]
** [[Main_Page-th|<span lang="th">ภาษาไทย</span> (Thai)]]
** [[Main_Page-tr|<span lang="tr">Türkçe</span> (Turkish)]] {{NewMarker}} <!-- 2012-328 -->
** [[Main_Page-tr|<span lang="tr">Türkçe</span> (Turkish)]] {{NewMarker}} <!-- 2012-328 -->
Line 136: Line 155:
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>

Current revision


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.

Contents

Introduction

Main article: introduction

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.

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.

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 examples, existing formats, and brainstorming of possible new microformats, per 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, parsers, 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 other-languages, and how-to-start-a-new-translation.

community

microformats.org is 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 (http://microformats.org/wiki/), discuss it in IRC (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.

Welcome to the microformats wiki! was last modified: Monday, April 10th, 2017

Views