Difference between revisions of "Main Page"

From Microformats Wiki
Main Page
Jump to navigation Jump to search
(→‎shared work areas: added spread microformats)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(821 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
__NOTOC__
+
{{DISPLAYTITLE:Welcome to the microformats wiki!}}
  
<h1> Microformats Wiki </h1>
+
'''<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.
  
'''Hello!''' Welcome to the microformats wiki. If this is your first visit, please see the [[introduction]] page.
+
* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.
  
Please read [[how-to-play]] before making any edits.
+
==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.
  
Please read [[process]] before proposing any new microformats.
+
== Get Started==
 +
{{main|get-started}}
 +
Get started with microformats:
  
__TOC__
+
* 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]]
  
== Background==
+
== How to contribute ==
 +
Want to join in and contribute?
  
[[what-are-microformats|What are microformats]]? [[what-can-you-do-with-microformats|What can you do with them]]?
+
* [[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]].
  
The [http://microformats.org/about/ about page], plus recent [[press]], [[presentations]], [[podcasts]], and [[screencasts]] are also good places for some background information. Frequently asked questions are answered in the [[faq|FAQ]]. Want to learn more in person? Check out [[events|microformats events]].
+
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.
  
==Definition==
+
== Specifications ==
 +
'''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.
  
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:
+
Current, stable microformats open standard specifications:
:simple conventions
+
* [[h-adr]]
:for embedding semantic markup
+
* [[h-card]]
::for a specific problem domain
+
* [[h-entry]]
:in human-readable (X)HTML/XML documents, Atom/RSS feeds, and "plain" XML
+
* [[h-event]]
::that normalize existing content usage patterns
+
* [[h-feed]]
::using brief, descriptive class names
+
* [[h-geo]]
::often based on existing interoperable standards
+
* [[h-item]]
:to enable decentralized development
+
* [[h-listing]]
::of resources, tools, and services
+
* [[h-product]]
 +
* [[h-recipe]]
 +
* [[h-resume]]
 +
* [[h-review]]
 +
* [[h-review-aggregate]]
  
"Or do you just use your browser to browse?  That's so 20th century." -- [http://diveintomark.org Mark Pilgrim]
+
=== 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
  
== How to contribute ==
+
=== 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 &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)
  
Want to help take microformats to the next level? 
+
=== 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.
  
Check out our open [[to-do|to do list]] for things to help get done. Join the [http://microformats.org/discuss mailing lists and irc channel] and learn and help answer questions about microformats.
+
* [[hnews|hNews]] - news articles, extension of hAtom
  
Take a look at the [[Main_Page#microformats_wiki_in_other_languages| microformats wiki in other languages]] and help translate the microformats wiki to make microformats globally accessible.
+
* [[rel-home]] - link to the homepage of a site
 +
* [[rel-payment]] - link to a payment mechanism
  
== Specifications ==
+
* [[XMDP]] - define a microformat vocabulary / profile
[[microformats|Microformats]] open standards specifications (see also: [[implementations]])
+
* [[xoxo|XOXO]] - outlines
* [[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 ==
+
''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]] {{NewMarker}}
 
* [[hresume|hResume]] {{NewMarker}}
 
* [[hreview|hReview]]
 
* [[rel-directory]]
 
* [[rel-enclosure]]
 
* [[rel-home]]
 
* [[relpayment-research | 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 -->
+
== 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
  
== Exploratory Discussions ==
+
* [[rel-directory]] - link to web directories
Research and analysis of real-world [[examples]], existing formats, and brainstorming to motivate the microformat.
+
* [[vote-links|VoteLinks]]
*alternates [[alternates-brainstorming|brainstorming]], [[alternates-examples|examples]]
 
*[[attention]]
 
* blog description [[blog-description-examples|examples]]
 
* blog info [[blog-info-examples|examples]]
 
* blog post [[blog-post-examples|examples]], [[blog-post-formats|formats]], and [[blog-post-brainstorming|brainstorming]] (yielded the [[hatom|hAtom]] draft)
 
* book [[book-examples|examples]], [[book-formats|formats]], and [[book-brainstorming|brainstorming]]
 
* chat [[chat-examples|examples]], [[chat-formats|formats]], and [[chat-brainstorming|brainstorming]]
 
* citation [[citation|effort]], [[citation-examples|examples]], [[citation-formats|formats]], [[citation-brainstorming|brainstorming]], and [[citation-faq|FAQ]]
 
* comment [[comment-problem|problem]], [[comment-examples|examples]], and [[comments-formats|formats]] (Some stuff needs to be extracted from [[comments-formats]])
 
* currency [[currency-examples|examples and brainstorming]] {{NewMarker}}
 
* directions [[directions-examples|examples]] {{NewMarker}}
 
* directory inclusion [[directory-inclusion-examples|examples]], [[directory-inclusion-formats|formats]]. (see also [[rel-directory]])
 
* distributed conversation [[distributed-conversation|overview]], [[distributed-conversation-brainstorming|brainstorming]], [[distributed-conversation-examples|examples]], and [[distributed-conversation-formats|formats]]
 
* forms [[forms-examples|examples]]
 
* genealogy [[genealogy-formats|examples]]
 
* group [[group-brainstorming|brainstorming]] and [[group-examples|examples]]
 
* hash [[hash-examples|examples]]
 
* job listing [[job-listing-examples|examples]] and [[job-listing-brainstorming|brainstorming]]
 
* last modified [[last-modified-examples|examples]], [[last-modified-formats|formats]], and [[last-modified-brainstorming|brainstorming]]
 
* hListing [[hlisting-proposal|proposal]], and [[hlisting-feedback|feedback]] {{NewMarker}}
 
** Also, listing [[listing-examples|examples]], [[listing-formats|formats]], and [[listing-brainstorming|brainstorming]]
 
* location [[location-formats|formats]]. (see also [[adr]] and [[geo]])
 
* [[luna]] ([[geo]]-like co-ordinates, for places on The Moon) {{NewMarker}}
 
* [[mars]] ([[geo]]-like co-ordinates, for places on the planet Mars) {{NewMarker}}
 
* measures and measurement units [[measure]]
 
* [[media-info]] ([[media-info-examples|examples]], [[media-info-formats|formats]], [[media-info-brainstorming|brainstorming]])
 
* meeting minutes [[meeting-minutes-examples|examples]], [[meeting-minutes-formats|formats]], and [[meeting-minutes-brainstorming|brainstorming]]
 
* metalink [[metalink-examples|examples]] {{NewMarker}}
 
* [[mfo-examples|MFO examples]]
 
* music [[music-examples|examples]]
 
* photo note [[photo-note-examples|examples]]
 
* recipe [[recipe-examples|examples]]
 
* rel-product [[rel-product-brainstorming|brainstorming]]
 
* requirements testing [[requirements-testing|overview]], and [[requirements-testing-examples|examples]]
 
* [[rest-examples|REST examples]]
 
* resume [[resume-brainstorming|brainstorming]], and [[resume-formats|formats]]
 
* review [[review-examples|examples]], and [[review-formats|formats]] (yielded the [[hreview|hReview]] draft)
 
* search results [[search-results-example|example]]
 
* show [[show-brainstorming|brainstorming]]
 
* showroll [[showroll-brainstorming|brainstorming]]
 
* [[species]] (or "''sci''"): for the marking up of the scientific names of living things. {{NewMarker}}
 
* table [[table-examples|examples]]
 
* tagspeak [[tagspeak-examples|examples]]
 
* tagcloud [[tagcloud-examples|examples]], and [[tagcloud-brainstorming | brainstorming]]. {{NewMarker}}
 
* transit table [[transit-table-examples|examples]]
 
* [[uid]]
 
* widget [[widget-examples|examples]], and [[widget-brainstorming|brainstorming]]
 
* [[wiki-formats|wiki formats]]
 
* work of art [[work-of-art|overview]], [[workofart-examples|examples]], [[workofart-formats|formats]], and [[workofart-brainstorming|brainstorming]] {{NewMarker}}
 
*[[xmdp-brainstorming|XMDP brainstorming]] (see also [[xmdp-faq]])
 
  
 
== Examples ==
 
== Examples ==
* [[examples]]
+
* [[examples-in-the-wild]]
 +
* [[implementations]]
 
* [[zen-garden]]
 
* [[zen-garden]]
  
 +
== Resources ==
 +
See [[resources]].
  
== Tools & Test Cases & Additional Research ==
+
== User centric development ==
 +
*[[user-interface]]
 +
*[[data-portability]]
 +
*[[social-network-portability]]
 +
*[http://indiewebcamp.com/ indieweb]
  
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.
+
== Shared work areas ==
 
 
*[[accessibility]]
 
*[[faqs-for-rdf]]
 
*[[icalendar-implementations]]
 
*[[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]]
 
*[[why-are-content-standards-hard]]
 
 
 
== shared work areas ==
 
* [[buttons]]
 
* [[spread-microformats]] {{NewMarker}}
 
* [[demo]] - a page with links for quickly demonstrating microformats working in practice.
 
* [[events]] {{NewMarker}}
 
 
* [[to-do]]
 
* [[to-do]]
* [[user-interface]]
+
* [[templates]]
* [[marked-for-deletion]]
+
* [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]]
  
== microformats wiki 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 50 articles
+
* languages with over 100 articles
** [[Main_Page-fr|Français (French)]] {{NewMarker-fr}}
+
** [[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
 
* languages with over 2 articles
** [[Main_Page-ja|日本語 (Japanese)]]
+
** [[Main_Page-cs|<span lang="cs">Česky</span> (Czech)]]
** [[Main_Page-es|Español (Spanish)]]
+
** [[Main_Page-zh|<span lang="zh">汉语</span> (Chinese)]]
* languages with 2 articles
+
** [[Main_Page-de|<span lang="de">Deutsch</span> (German)]]
** [[Main_Page-de|Deutsch (German)]]
+
** [[Main_Page-es|<span lang="es">Español</span> (Spanish)]]
 
+
** [[Main_Page-gl|<span lang="gl">Galego</span> (Galician)]]
==== microformats translations elsewhere ====
+
** [[Main_Page-id|<span lang="id">Indonesia</span> (Bahasa Indonesia)]]
These are offsite pages/sites with translations about microformats.  If you are working on one of these, please consider translating the main microformats website!
+
** [[Main_Page-pl|<span lang="pl">Polski</span> (Polish)]]
* [http://mikroformate.pbwiki.com/ Deutsch (German) mikroformate.pbwiki.com] {{NewMarker}}
+
** [[Main_Page-ro|<span lang="ro">Română</span> (Romanian)]]
 
+
* languages just started
=== Start a microformats wiki in another language ===
+
** [[Main_Page-ar|<span lang="ar">العربية</span> (Arabic)]]
 
+
** [[Main_Page-fa|<span lang="fa">پارسی</span> (Farsi)]]
Don't see the language you want?  Help translate the microformats wiki into another language!
+
** [[Main_Page-ka|<span lang="ka">ქართული</span> (Georgian)]] {{NewMarker}} <!-- 2013 -->
 
+
** [[Main_Page-it|<span lang="it">Italiano</span> (Italian)]]
We're still figuring this out. 
+
** [[Main_Page-ko|<span lang="ko">한국어</span> (Korean)]]
 
+
** [[Main_Page-th|<span lang="th">ภาษาไทย</span> (Thai)]]
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.
+
** [[Main_Page-tr|<span lang="tr">Türkçe</span> (Turkish)]] {{NewMarker}} <!-- 2012-328 -->
 
+
* elsewhere
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).
+
**[http://en.wikipedia.org/wiki/Microformat Wikipedia's article on microformats] has been translated into a number of 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]].
 
  
==== 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.