Difference between revisions of "Main Page"

From Microformats Wiki
Main Page
Jump to navigation Jump to search
m (Reverted edit of Aspendos@msn.com, changed back to last version by Tantek)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(963 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
__NOTOC__
+
{{DISPLAYTITLE:Welcome to the microformats wiki!}}
__NOTOC__
 
= Microformats Wiki =
 
  
'''Please read [[how-to-play]] before making any edits.'''
+
'''<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 [[process]] before proposing any new microformats.'''
+
* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.
  
== Introduction ==
+
==Introduction==
 +
{{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.
  
What are microformats? See the [http://microformats.org/about/ about page] for an overview, and the [[introduction]] page for more info.  Recent [[press]] and [[presentations]] are also a good place for some background reading as well. Frequently asked questions are answered in the [[faq]].  Want something or want to contribute?  Help with things [[to-do]].
+
== Get Started==
 +
{{main|get-started}}
 +
Get started with microformats:
  
One popular definition from our [http://microformats.org/discuss/ mailing list] is "simple conventions for embedding semantics in HTML to enable decentralized development." More precisely, microformats can be defined as:
+
* 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>.
:simple conventions
+
* Mark-up your contact info with [[h-card]], link to other profiles with [[rel-me]]
:for embedding semantic markup
+
* Mark-up your blog with [[h-entry]]. See https://indieweb.org/ for more
::for a specific problem domain
+
* Questions? Read the [[faq|frequently asked questions]], ask on [[IRC]]
:in human-readable (X)HTML/XML documents, Atom/RSS feeds, and "plain" XML
+
* Want to learn more in person? Check out microformats [[events]]
::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
 
  
"Or do you just use your browser to browse?  That's so 20th century." -- [http://diveintomark.org Mark Pilgrim]
+
== 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 ==
 
== Specifications ==
[[microformats|Microformats]] open standards specifications (see also: [[implementations]])
+
'''[[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]]
 
* [[hcard|hCard]]
 
* [[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 ==
+
Current, stable microformats open standard specifications:
* [[adr|adr]]
+
* [[h-adr]]
* [[geo|geo]]
+
* [[h-card]]
* [[hatom|hAtom]] {{NewMarker}}
+
* [[h-entry]]
* [[hresume|hResume]] {{NewMarker}}
+
* [[h-event]]
* [[hreview|hReview]]
+
* [[h-feed]]
* [[rel-directory]]
+
* [[h-geo]]
* [[rel-enclosure]]
+
* [[h-item]]
* [[relpayment-research | rel-payment]]
+
* [[h-listing]]
* [[robots-exclusion|Robots Exclusion]]
+
* [[h-product]]
* [[xfolk|xFolk]]
+
* [[h-recipe]]
* [[rel-home]] {{NewMarker}}
+
* [[h-resume]]
 +
* [[h-review]]
 +
* [[h-review-aggregate]]
  
== Design Patterns ==
+
=== 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
  
Design patterns give microformat authors a vocabulary for expressing their ideas consistently with what has already been done. ''If you're tempted to try your hand at writing a microformat '''[[process|read this first]]'''!''
+
=== Classic Microformats ===
 +
In addition use well established classic microformats for the primary subject of a page for legacy [[search engines]] support.
  
* [[abbr-design-pattern]]
+
* [[hatom|hAtom]] - blog posts and other date-stamped content
* [[class-design-pattern]]
+
* [[hcalendar|hCalendar]] - events
* [[datetime-design-pattern]]
+
* [[hcard|hCard]] - people, organizations, contacts
* [[existing-classes|class names defined across all microformats]]
+
* [[hlisting|hListing]] - listings for products or services
* [[include-pattern]] {{NewMarker}}
+
* [[hmedia|hMedia]] - media info about images, video, audio
* [[rel-design-pattern]]
+
* [[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
  
== Exploratory discussions ==
+
* [[adr|adr]] - address location information
Research and analysis of real-world [[examples]], existing formats, and brainstorming to motivate the microformat.
+
* [[geo|geo]] - latitude &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)
*[[attention]]
 
*[[blog-description-examples]]
 
*[[blog-info-examples]]
 
*[[blog-post-examples]], [[blog-post-formats]], [[blog-post-brainstorming]] (yields [[hatom|hAtom]])
 
*[[book-examples]], [[book-formats]], [[book-brainstorming]]
 
*[[chat-examples]], [[chat-formats]]
 
*[[citation|citation microformat overview]], [[citation-examples]], [[citation-formats]], [[citation-brainstorming]]
 
*[[comment-problem]], [[comment-examples]], (need to extract from [[comments-formats]])
 
*[[directory-inclusion-examples]], [[directory-inclusion-formats]]. (see also [[rel-directory]])
 
*[[distributed-conversation]], [[distributed-conversation-brainstorming]], [[distributed-conversation-examples]], [[distributed-conversation-formats]]
 
*[[forms-examples]]
 
*[[genealogy-formats]]
 
*[[hash-examples]]
 
*[[last-modified-examples]], [[last-modified-formats]], [[last-modified-brainstorming]]
 
*[[hlisting-proposal]], [[hlisting-feedback]] {{NewMarker}}
 
**[[listing-examples]], [[listing-formats]], [[listing-brainstorming]]
 
*[[location-formats]]. (see also [[adr]] and [[geo]])
 
*[[media-info-examples]]
 
*[[mfo-examples]]
 
*[[other-formats]]
 
*[[photo-note-examples]]
 
*[[recipe-examples]]
 
*[[requirements-testing]], [[requirements-testing-examples]]
 
*[[rest-examples]]
 
*[[resume-brainstorming]], [[resume-formats]]
 
*[[review-examples]], [[review-formats]] (yielded the [[hreview|hReview]] draft)
 
*[[search-results-example]]
 
*[[show-brainstorming]]
 
*[[showroll-brainstorming]]
 
*[[table-examples]]
 
*[[tagspeak-examples]]
 
*[[transit-table-examples]]
 
*[[widget-examples]], [[widget-brainstorming]]
 
*[[wiki-formats]]
 
*[[xmdp-brainstorming]] (see also [[xmdp-faq]])
 
  
== Examples ==
+
=== Drafts ===
* [[examples]]
+
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.
* [[zen-garden]] {{NewMarker}}
 
  
 +
* [[hnews|hNews]] - news articles, extension of hAtom
  
== Tools & Test Cases & Additional Research ==
+
* [[rel-home]] - link to the homepage of a site
 +
* [[rel-payment]] - link to a payment mechanism
  
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.
+
* [[XMDP]] - define a microformat vocabulary / profile
 +
* [[xoxo|XOXO]] - outlines
  
*[[parsing-microformats]]
+
''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]].
*[[selected-test-cases-from-the-web]]
 
*[[vcard-implementations]], [[vcard-errata]]
 
*[[icalendar-implementations]]
 
*[[faqs-for-rdf]]
 
*[[why-are-content-standards-hard]]
 
  
== shared work areas ==
+
== Design Patterns ==
* [[buttons]] {{NewMarker}}
+
{{design_patterns}} <!-- this can be edited in /wiki/Template:design_patterns -->
* [[demo]] - a page with links for quickly demonstrating microformats working in practice.
 
* [[events]] {{NewMarker}}
 
* [[to-do]]
 
* [[marked-for-deletion]]
 
  
== microformats wiki in other languages ==
+
== 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
  
You may read and edit microformats articles in <del>many different</del> other languages
+
* [[rel-directory]] - link to web directories
 +
* [[vote-links|VoteLinks]]
  
=== microformats wiki languages with over 2 articles ===
+
== Examples ==
 +
* [[examples-in-the-wild]]
 +
* [[implementations]]
 +
* [[zen-garden]]
  
* [[Main_Page-fr|Français (French)]]
+
== Resources ==
* [[Main_Page-jp|日本語 (Japanese)]] {{NewMarker}}
+
See [[resources]].
  
=== Start a microformats wiki in another language ===
+
== User centric development ==
 +
*[[user-interface]]
 +
*[[data-portability]]
 +
*[[social-network-portability]]
 +
*[http://indiewebcamp.com/ indieweb]
  
Don't see the language you want?  Help translate the microformats wiki into another language!
+
== Shared work areas ==
 
+
* [[to-do]]
We're still figuring this out. 
+
* [[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]]
  
For now, see the [http://en.wikipedia.org/wiki/Wikipedia:Multilingual_coordination Wikipedia page on Multilingual coordination], and [http://meta.wikimedia.org/wiki/How_to_start_a_new_Wikipedia How to start a new Wikipedia] for some good general tips, advice, and community conventions.
+
== 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 want to start with the list of [[stable-pages]], which are pages that are relatively stable, and have only minimal/editorial changes, which makes them much easier to keep in sync with the English versions, by using the [[Special:Watchlist|my watchlist]] feature (use it to watch the pages you've translated for changes).
+
<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:
  
Page naming: for the translated version of a page, use the same name for the page, and simply add the RFC 3066 language identifier code as a dash suffix. E.g. for the French version, [[Main_Page]] becomes [[Main_Page-fr]], and [[how-to-play]] becomes [[how-to-play-fr]].
+
* 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.
  
==== more languages folks want to see ====
+
See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].
  
* Chinese: 微支付 (Microformats) (see [http://msittig.blogspot.com/2005/11/since-i-translated-schedule-of.html source of 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.