Main Page: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
m (Reverted edits by Flaviooliveira (Talk) to last version by Tantek)
(auto-toc, shorten intro, add main article links to subsections, fast-track inline onramping, add microformats-2 to exploratory section)
Line 1: Line 1:
<entry-title>Welcome to the microformats wiki!</entry-title>
<entry-title>Welcome to the microformats wiki!</entry-title>
__TOC__
 
Please start with the [[introduction]] page and read [[how-to-play]] before making any edits.
'''<dfn>microformats</dfn>''' are extensions to HTML for marking up [[hCard|people]], [[hCalendar|events]], [[hAtom|blog posts]], [[hReview|reviews]], [[hRecipe|recipes]] etc.


==Introduction==
==Introduction==
This wiki is the central resource of the microformats community. You'll find current versions of published microformat specifications, specification drafts and publishing patterns. The wiki also hosts development resources, such as brainstorming pages for new formats and issue tracking pages for all current and in-development microformats.
{{main|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==
== Get Started==
To get started with microformats:
{{main|get-started}}
Get started with microformats:


* First, be familiar writing your pages and applications with semantically rich, descriptive, ‘[[posh|<abbr title="Plain Old Semantic HTML">POSH</abbr>]]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
* First, make sure your pages and applications use semantically rich, descriptive, ‘[[posh|<abbr title="Plain Old Semantic HTML">POSH</abbr>]]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
* Learn about microformats from the [http://microformats.org/about/ about page], [http://microformats.org/ blog], [[press]], [[presentations]], [[books]], [[podcasts]], & [[screencasts]] pages.
* Mark-up your contact information with [[hCard]] ([[hcard-authoring|authoring tips]], [[hcard-examples|examples]]) and link from your personal site to your other profiles with [[rel-me]].
* Take a look at established specifications such as [[hcard|hCard]] and [[hcalendar|hCalendar]], and follow the [[hcard-examples|examples]] to start publishing microformats.
* Have questions? Read the [[faq|frequently asked questions]], join the [[IRC]] channel and ask questions.
* Have questions? Read the [[faq|frequently asked questions]] and see the [[glossary]] for terms and definitions. You can also post to the {{MicroformatsMailingList}}.
* Want to learn more in person? Check out microformats [[events]].
* Want to learn more in person? Check out microformats [[events]].


==Definition==
==Definition==
{{main|what-are-microformats}}
Microformats are small patterns of HTML to represent commonly published things like [[hcard|people]], [[hcalendar|events]], [[hatom|blog posts]], [[hreview|reviews]] and [[rel-tag|tags]] in web pages.
Microformats are small patterns of HTML to represent commonly published things like [[hcard|people]], [[hcalendar|events]], [[hatom|blog posts]], [[hreview|reviews]] and [[rel-tag|tags]] in web pages.


Microformats enable the publishing of higher fidelity information on the Web; the fastest and simplest way to provide feeds and APIs for the information in your website.
Microformats are the fastest and simplest way to provide an API to the data and information in your website. See what else [[what-can-you-do-with-microformats|you can do with microformats]].
 
* Read more explanations of [[what-are-microformats|what microformats are]], and [[what-can-you-do-with-microformats|what you can do with them]].


== 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.
* [[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.
* [[advocacy|Advocate]] the use of microformats on other web sites, especially those you use
* Write a [[testimonial]].
* 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]]
* Do something on the [[to-do|to do list]].
* Do something on the [[to-do|to do list]].
* Join the [[irc|IRC Channel]] and [[mail|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.
* 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]].
Line 47: Line 48:
* [[XMDP]]
* [[XMDP]]
* [[xoxo|XOXO]]
* [[xoxo|XOXO]]
''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!''


== Drafts ==
== Drafts ==
Drafts are newer microformats, for which the specifications haven't been completed yet. Drafts are somewhat mature in the development [[process]] (see [[exploratory-discussions]] for additional efforts that are not as far along in the process). The stability of these documents cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Please watch the wiki pages for updates.
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.


* [[adr|adr]] - for marking up address information
* [[adr|adr]] - for marking up address information
Line 72: Line 71:
* [[xfolk|xFolk]]
* [[xfolk|xFolk]]


== Design Patterns ==
''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!''
{{design_patterns}} <!-- this can be edited in /wiki/Template:design_patterns -->


== Exploratory Discussions ==
== Exploratory Discussions ==
{{main|exploratory-discussions}}
'''New: [[microformats-2]]''' has sufficiently stabilized to start using on public web pages and developing parsers and applications.
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]].
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]].
== Design Patterns ==
{{design_patterns}} <!-- this can be edited in /wiki/Template:design_patterns -->


== Examples ==
== Examples ==

Revision as of 01:06, 3 April 2012

<entry-title>Welcome to the microformats wiki!</entry-title>

microformats are extensions to HTML for marking up people, events, blog posts, reviews, recipes etc.

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:

  • First, make sure your pages and applications use semantically rich, descriptive, ‘POSHHTML.
  • Mark-up your contact information with hCard (authoring tips, examples) and link from your personal site to your other profiles with rel-me.
  • Have questions? Read the frequently asked questions, join the IRC channel and ask questions.
  • Want to learn more in person? Check out microformats events.

Definition

Main article: what-are-microformats

Microformats are small patterns of HTML to represent commonly published things like people, events, blog posts, reviews and tags in web pages.

Microformats are the fastest and simplest way to provide an API to the data and information in your website. See what else you can do 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

The list of current, stable Microformats open standard specifications.

Drafts

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.

  • adr - for marking up address information
  • geo - for marking up WGS84 geographic coordinates (latitude; longitude)
  • hAtom - syndicating episodic content (e.g. weblog postings)
  • hAudio
  • hListing - open, distributed listings
  • hMedia - A single media publishing format that relates to Images, Video and Audio.
  • hNews
  • hProduct
  • hRecipe - for cooking+baking recipes
  • hResume - for publishing resumes and CVs
  • hReview - 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

If you're tempted to try your hand at writing a microformat please read the process page first!

Exploratory Discussions

Main article: exploratory-discussions

New: microformats-2 has sufficiently stabilized to start using on public web pages and developing parsers and applications.

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.

Design Patterns

Design patterns are common uses of markup across microformats.

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.