Main Page: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(→‎Get Started: simplify wording)
(add see blog / feed at the top since domain home page redirects here now, float TOC to right)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<entry-title>Welcome to the microformats wiki!</entry-title>
{{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.
'''<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.
Line 5: Line 5:
* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.
* 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==
==Introduction==
{{main|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.
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==
{{main|get-started}}
{{main|get-started|Getting Started}}
Get started with microformats:
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>.
* 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 contact info with [[h-card]], link to other profiles with [[rel-me]]
* Mark-up your blog with [[h-entry]]. See https://indiewebcamp.com/ for more
* Mark-up your blog with [[h-entry]]. See https://indieweb.org/ for more
* Questions? Read the [[faq|frequently asked questions]], ask on [[IRC]]
* Questions? Read the [[faq|frequently asked questions]], ask on [[IRC]]
* Want to learn more in person? Check out microformats [[events]]
* Want to learn more in person? Check out microformats [[events]]
Line 34: Line 37:
'''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.
'''[[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:
Current, stable microformats open standard specifications.
 
=== Parsing ===
If you are implementing a microformats2 parser, see:
* [[microformats2-parsing]]
 
=== Vocabularies ===
microformats2 vocabularies:
* [[h-adr]]
* [[h-adr]]
* [[h-card]]
* [[h-card]]
Line 59: Line 69:


=== Classic Microformats ===
=== Classic Microformats ===
In addition use well established microformats for the primary subject of a page for legacy [[search engines]] support.
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
* [[hatom|hAtom]] - blog posts and other date-stamped content
Line 75: Line 85:
* [[geo|geo]] - latitude &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)
* [[geo|geo]] - latitude &amp; longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)


 
==== Classic Drafts ====
=== 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.
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.


Line 156: Line 165:


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.