Main Page: Difference between revisions
Jump to navigation
Jump to search
(add see blog / feed at the top since domain home page redirects here now, float TOC to right) |
|||
| (836 intermediate revisions by more than 100 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: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. | ||
''' | * See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs. | ||
If you are looking for the '''microformats.org blog''', see: | |||
* https://microformats.org/blog ([https://microformats.org/feed RSS feed]) | |||
<span style="float:right">__TOC__</span> | |||
==Introduction== | |||
{{main|introduction|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|get-started|Getting Started}} | |||
Get started with microformats: | |||
* 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 == | ||
Want to join in and contribute? | |||
* [[get-started|Get started]] by adding microformats to your website, services, and products | |||
* Join the [[irc|IRC Channel]] to learn and help answer questions. | |||
* Write a [[testimonial]] | |||
* 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. | |||
* 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 == | |||
'''[[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. | |||
== | === Parsing === | ||
If you are implementing a microformats2 parser, see: | |||
* [[microformats2-parsing]] | |||
* [[ | |||
=== Vocabularies === | |||
microformats2 vocabularies: | |||
* [[h-adr]] | |||
* [[h-card]] | |||
* [[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-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 & longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates) | |||
==== Classic 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 | |||
''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}} <!-- this can be edited in /wiki/Template:design_patterns --> | |||
== 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|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 | |||
* [[rel-directory]] - link to web directories | |||
* [[vote-links|VoteLinks]] | |||
== Examples == | |||
* [[examples-in-the-wild]] | |||
* [[implementations]] | |||
* [[zen-garden]] | |||
== | == Resources == | ||
See [[resources]]. | |||
== User centric development == | |||
*[[user-interface]] | |||
*[[data-portability]] | |||
*[[social-network-portability]] | |||
*[http://indiewebcamp.com/ indieweb] | |||
== Shared work areas == | |||
* [[to-do]] | |||
* [[templates]] | |||
* [http://microformats.org/wiki/delete pages for deletion] <!-- keep as external link; removes from "what links here" --> | |||
* [[Special:Specialpages|"Special" wiki pages]] | |||
* [[year-in-review]] | |||
== 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|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. | |||
You may | <span id="microformats_wiki_translations"><span id="microformats_wiki_translations_in_other_languages"> </span></span> | ||
== Microformats wiki translations == | |||
You may read and edit microformats articles in many other languages: | |||
* languages with over 100 articles | |||
** [[Main_Page-fr|<span lang="fr">Français</span> (French)]] <span lang="fr">{{UpdateMarker-fr}}</span> | |||
* languages with over 10 articles | |||
** [[Main_Page-ja|<span lang="ja">日本語</span> (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 | |||
** [[Main_Page-cs|<span lang="cs">Česky</span> (Czech)]] | |||
** [[Main_Page-zh|<span lang="zh">汉语</span> (Chinese)]] | |||
** [[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 | |||
**[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]]. | |||
== 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 20:37, 12 September 2024
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.
If you are looking for the microformats.org blog, see:
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:
- Make sure your pages and web apps use proper ‘POSH’ HTML.
- 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 frequently asked questions, ask on IRC
- Want to learn more in person? Check out microformats events
How to contribute
Want to join in and contribute?
- Get started by adding microformats to your website, services, and products
- Join the IRC Channel to learn and help answer questions.
- Write a testimonial
- Do something on the to do list.
- 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, 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 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.
Parsing
If you are implementing a microformats2 parser, see:
Vocabularies
microformats2 vocabularies:
- h-adr
- h-card
- 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-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 - blog posts and other date-stamped content
- hCalendar - events
- hCard - people, organizations, contacts
- hListing - listings for products or services
- hMedia - media info about images, video, audio
- hProduct - products
- hRecipe - cooking+baking recipes
- hResume - individual resumes and CVs
- hReview - individual reviews and ratings
- hReview-aggregate - aggregate reviews and ratings
- adr - address location information
- geo - latitude & longitude location (WGS84 geographic coordinates)
Classic 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 - news articles, extension of hAtom
- rel-home - link to the homepage of a site
- rel-payment - link to a payment mechanism
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.
- abbr-design-pattern
- class-design-pattern
- date-design-pattern
- datetime-design-pattern
- include-pattern
- value-class-pattern
- rel-design-pattern
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.
- hAudio
- robots exclusion
- xFolk - tagged links
- rel-directory - link to web directories
- VoteLinks
Examples
Resources
See resources.
User centric development
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:
- languages with over 100 articles
- Français (French) mis à jour!
- languages with over 10 articles
- languages with over 2 articles
- languages just started
- elsewhere
- Wikipedia's article on microformats has been translated into a number of 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.