Main Page: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(DATA1)
(add see blog / feed at the top since domain home page redirects here now, float TOC to right)
 
(649 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
__NOTOC__
{{DISPLAYTITLE:Welcome to the microformats wiki!}}
<h1>Microformats Wiki</h1>


'''Hello!''' Welcome to the microformats wiki. If you haven't already done so, please see the [[introduction]] page.
'''<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 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.


Please read [[process]] before proposing any new microformats.
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.


__TOC__
== Get Started==
{{main|get-started|Getting Started}}
Get started with microformats:


==Getting Started==
* 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]]


[[what-are-microformats|What are microformats]]? [[what-can-you-do-with-microformats|What can you do with them]]?
== 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.


The [http://microformats.org/about/ about page], [http://microformats.org/ latest news], plus recent [[press]], [[presentations]], [[books]], [[podcasts]], and [[screencasts]] are also good places for some background information. Our [[cheatsheets]] are handy if you need a quick reminder about a particular microformat. We even have a [[spellcheck|spell-check dictionary]] of microformat-related terms.
Current, stable microformats open standard specifications.


Frequently asked questions about this wiki and microformats in general are answered in the [[faq|FAQ]], and there is a [[glossary]].
=== Parsing ===
If you are implementing a microformats2 parser, see:
* [[microformats2-parsing]]


Want to learn more in person? Check out [[events|microformats events]].
=== 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]]


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


One popular definition from our [http://microformats.org/discuss/ mailing list] (see also: [[mailing-lists]]) is "simple conventions for embedding semantics in HTML to enable decentralized development." More precisely, microformats can be defined as:
=== Classic Microformats ===
:simple conventions
In addition use well established classic microformats for the primary subject of a page for legacy [[search engines]] support.
:for embedding semantic markup
::for a specific problem domain
:in human-readable (X)HTML/XML documents, Atom/RSS feeds, and "plain" XML
::that normalize existing content usage patterns
::using brief, descriptive class names
::often based on existing interoperable standards
:to enable decentralized development
::of resources, tools, and services


Simply put: "Microformats are a codification of convention." -- [http://easy-reader.net Aaron Gustafson]
* [[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


"Or do you just use your browser to browse? That's so 20th century." -- [http://diveintomark.org Mark Pilgrim]
* [[adr|adr]] - address location information
* [[geo|geo]] - latitude &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)


== How to contribute ==
==== 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.


Do you want to help take microformats to the next level?  You can:
* [[hnews|hNews]] - news articles, extension of hAtom


*Check out our open [[to-do|to do list]] for things to help get done.
* [[rel-home]] - link to the homepage of a site
*Join the [http://microformats.org/discuss mailing lists] and [[irc|IRC Channel]] to learn and help answer questions about microformats.
* [[rel-payment]] - link to a payment mechanism
*[[advocacy|Advocate]] the use of microformats.
*help to [[Main_Page#microformats_wiki_in_other_languages|translate this microformats wiki into other languages]] to make microformats globally accessible.
*Find [[orphans|orphaned]] pages, and add links to them.


== Specifications ==
* [[XMDP]] - define a microformat vocabulary / profile
[[microformats|Microformats]] open standards specifications (see also: [[implementations]], [[examples-in-the-wild]])
* [[xoxo|XOXO]] - outlines
* [[hcalendar|hCalendar]] - [http://microformats.org/code/hcalendar/creator hcalendar creator]
* [[hcard|hCard]] - [http://microformats.org/code/hcard/creator hcard creator]
* [[rel-license]]
* [[rel-nofollow]]
* [[rel-tag]]
* [[vote-links|VoteLinks]]
* [http://gmpg.org/xfn/ XFN] (see also: [[xfn-implementations]])
* [http://gmpg.org/xmdp/ XMDP]
* [[xoxo|XOXO]]


== 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]]
* [[geo|geo]]
* [[hatom|hAtom]]
* [[hresume|hResume]]
* [[hreview|hReview]] - [http://microformats.org/code/hreview/creator hreview creator]
* [[rel-directory]]
* [[rel-enclosure]]
* [[rel-home]]
* [[rel-payment]]
* [[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]]) - Marking up information and metadata related to audio (speech, music, and sound in general). {{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)
* popular definition from our [http://www.weblocal.com.br HOSPEDAGEM] popular definition from our [[workofart-examples|work of art examples]],
* 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-brainstorming|code brainstorming]] {{NewMarker}}
* 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]] {{NewMarker}}
* [[course-catalog]]; [[course-catalog-examples]] {{NewMarker}}
* [[currency]]; [[currency-examples]]; [[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-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]]. (see also [[rel-directory]])
* distributed conversation [[distributed-conversation|distributed conversation overview]], [[distributed-conversation-brainstorming|distributed conversation brainstorming]], [[distributed-conversation-examples|distributed conversation examples]], and [[distributed-conversation-formats|distributed conversation formats]]
* forms [[forms-examples|forms examples]]
* file-format ([[file-format-examples|examples]], formats, brainstorming) - for the mark-up of file format information (size, type, codecs, bitrate, etc.) {{NewMarker}}
* genealogy [[genealogy-formats|genealogy examples]]
* geo extensions
** [[geo-extension-strawman]] - extend geo for moons, other planets, etc.
** [[geo-elevation-examples]] - extend geo for representing altitude {{NewMarker}}
** [[geo-waypoint-examples]] - extend geo for representing routes and boundaries, using waypoints {{NewMarker}}
* group [[group-brainstorming|group brainstorming]] and [[group-examples|group examples]]
* items [[items-brainstorming|items brainstorming]] and [[items-examples|items examples]]
* hash [[hash-examples|hash examples]]
* job listing [[job-listing-examples|job listing examples]] and [[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]]
* hListing [[hlisting-proposal|hListing proposal]], and [[hlisting-feedback|hListing feedback]]
** Also, listing [[listing-examples|examples]], [[listing-formats|formats]], and [[listing-brainstorming|brainstorming]]
* [[product|hProduct]] - [[product-brainstorming|hProduct brainstorming]] | [[product-examples|hProduct examples]]
* [[htodo|hToDo]]
* location [[location-formats|location formats]]. (see also [[adr]] and [[geo]])
* measures and measurement units [[measure]]
* [[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}}
* microsummary [[microsummary-brainstorming|microsummary brainstorming]]
* [[mfo-examples|MFO examples]]
* music [[music-examples|music examples]] {{UpdateMarker}}
* [[operating-hours]]: [[operating-hours-examples]] ..of stores, restaurants, etc. {{UpdateMarker}}
* [[payment]]
* photo note [[photo-note-examples|photo note examples]]
*[[question-answer]], [[question-answer-brainstorming]]; [[question-answer-examples]] {{NewMarker}}
* recipe [[recipe-examples|recipe examples]], [[recipe-brainstorming]] {{UpdateMarker}}
* rel-product [[rel-product-brainstorming|rel-product brainstorming]]
* requirements testing [[requirements-testing|requirements testing overview]], and [[requirements-testing-examples|requirements testing examples]]
* [[rest-examples|REST examples]]
* [[wiki-formats|wiki formats]] [http://www.weblocal.com.br hospedagem de sites] alternates-brainstorming [[mercurial-quick-start|HowTo: Download code from the repository]]
* resume [[resume-brainstorming|resume brainstorming]], and [[resume-formats|resume formats]]
* 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-brainstorming|show brainstorming]]
* showroll [[showroll-brainstorming|brainstorming]]
* [[species]] - for the marking up of the scientific names of living things: [[species-examples]]; [[species-brainstorming]] {{UpdateMarker}}
* table [[table-examples|examples]]
* tagspeak [[tagspeak-examples|tagspeak examples]]
* tagcloud [[tagcloud-examples|tagcloud examples]], and [[tagcloud-brainstorming|tagcloud  brainstorming]].
* transit table [[transit-table-examples|transit table examples]]
* [[uid]]
* widget [[widget-examples|widget examples]], and [[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 153: Line 115:
* [[zen-garden]]
* [[zen-garden]]


== Tools, Test Cases and 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 ==
*[[user-interface]]
*[[data-portability]]
*[[social-network-portability]]
*[http://indiewebcamp.com/ indieweb]


*[[accessibility]]
== Shared work areas ==
*[[faqs-for-rdf]]
*[[icalendar-implementations]]
*[[internationalization]]
*[[parsing-microformats]]
*[[selected-test-cases-from-the-web]]
*[http://hg.microformats.org/ Source code repository] -- [[mercurial-quick-start|HowTo: Download code from the repository]]
*[[vcard-implementations]], [[vcard-errata]], [[vcard-suggestions]]
*[[why-are-content-standards-hard]]
* [[profile-examples-in-wild|Profile examples, in the wild]]
 
== shared work areas ==
* [[buttons]]
* [[icons]] {{NewMarker}}
* [[spread-microformats]] {{NewMarker}}
* [[demo]] - a page with links for quickly demonstrating microformats working in practice.
* [[events]]
* [[to-do]]
* [[to-do]]
* [[microformats-issues]] {{NewMarker}} - issues related to more than one microformat.
* [[templates]]
* [[user-interface]]
* [http://microformats.org/wiki/delete pages for deletion] <!-- keep as external link; removes from "what links here" -->
* [[shortcuts]] to wiki pages with long names
* [[Special:Specialpages|"Special" wiki pages]]
* [[marked-for-deletion]]
* [[year-in-review]]


== microformats wiki translations in other languages ==
== 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.


<span id="microformats_wiki_translations"><span id="microformats_wiki_translations_in_other_languages">&nbsp;</span></span>
== Microformats wiki translations ==
You may read and edit microformats articles in many other languages:
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-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]].
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:

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.

Parsing

If you are implementing a microformats2 parser, see:

Vocabularies

microformats2 vocabularies:

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.

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

Retrieved from "http://microformats.org/wiki/index.php?title=Main_Page&oldid=70705"