get-started: Difference between revisions
No edit summary |
m (Replace <entry-title> with {{DISPLAYTITLE:}}) |
||
| (21 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Get Started}} | |||
<div style="text-indent:2em;font-weight:bold;padding:1em;background:yellow"> | <div style="text-indent:2em;font-weight:bold;padding:1em;background:yellow"> | ||
Latest: [http://microformats.org/2014/03/05/ | Latest: [http://microformats.org/2014/03/05/getting-started-with-microformats2 Get Started with microformats2] | ||
</div> | </div> | ||
Get started by adding support for microformats to your website, services, and products. | |||
== introduction == | == introduction == | ||
Microformats are based on simple markup conventions that enable you to add meaningful structure to your web content. | |||
One of the key [[principles]] of microformats, is to privilege [[humans-first|human readable]] content. This means that you should think first and foremost of your content design being readable and accessible to web viewers. Using the [[semantic-xhtml|most appropriate HTML elements]] and applying structured [[semantic-class-names|class names]] to your markup enables you to produce content that can be clearly understood by a human audience and also used in a structured way by automated programs and other online tools. But the point is that you shouldn't have to go out of your way to produce such machine friendly markup - microformats make it easy to integrate this greater degree of structure into your websites, without the overhead of having to learn complicated new languages or formats. | |||
The best way to understand microformats is to start using them straight away. Since they're embedded in ordinary HTML, you can take existing pages and add these structured class names to the markup, but it's recommended that when doing this, you also take a close look at the overall tag structure that you're using - maybe there is a better way to say what you mean using basic HTML tags. | |||
Many common kinds of content can be marked up in microformats. Microformats are designed to be similar to current markup styles. Chances are, you already have some of them on your site. Start with the obvious ones. For example a simple, and very popular place to start is with [[h-card]] - a microformat for displaying personal and organizational contact details. You can think of [[h-card]] as a way to embed mini business cards in web pages, but glancing over the [[h-card-examples|examples]] shows a lot more possibilities than just that. Here are some specific places to start using microformats today: | |||
== yourself == | == yourself == | ||
=== your website === | === your website === | ||
[http:// | If you have your own website, read [[h-card-authoring]] for tips and guidelines on how to best markup existing content with h-card and take a look at the [[h-card-examples]], then | ||
* add [[h-card]] to your contact info page | |||
* add h-card+[[xfn|XFN]] to your friends list or blog roll | |||
* add your website and contact page to the [[h-card#Examples_in_the_wild|list of examples in the wild]] | |||
=== your blog === | |||
If you have a blog: | |||
* add [[hatom|hAtom]] to your blog pages | |||
* add your blog to the [[hatom-examples-in-wild]] page. | |||
== your organization == | |||
=== website === | |||
==== contact info ==== | |||
* '''Contact info.''' Every company or organization has a contact or about page of some sort on their website. Read [[h-card-authoring]] and add [[h-card]] to the contact/about pages along with "Add to address book" links for each h-card. | |||
* '''Employee directory.''' If your company has a page listing employees or others that belong to the organization, add [[h-card]] to the listings or search results. | |||
* add those pages with h-cards to the [[h-card#Examples_in_the_wild|list of examples in the wild]] | |||
==== events ==== | |||
Use hCalendar anywhere on the website that publishes event information. Start with the [http://microformats.org/code/hcalendar/creator hCalendar creator]. | |||
===== history ===== | |||
If your organization publishes its history, mark up the events noted with hCalendar, thus allowing anybody to build a dynamic timeline application with your history. | |||
=== products === | |||
Does your company make any products that generate HTML? | |||
* Make sure such products generate [[posh|POSH]] and whenever possible, the appropriate microformats. | |||
* Then add those products to the [[implementations]] page. | |||
=== enterprise === | |||
Wondering how to use microformats in an enterprise scenario? | |||
Any publication of information about people, events, reviews etc. could benefit from being marked up with h-card, hCalendar, and hReview respectively. | |||
== other content == | |||
* Do you have an explicit copyright license on your content? Then markup the link to your license with [[rel-license]]. | |||
* Do you publish social network / relationship info? Then mark that up with [http://gmpg.org/xfn/ XFN]. | |||
* Are you tagging things? Then use [[rel-tag]] (for your own stuff) or [[xFolk]] (for tagging any URL). | |||
* Are you publishing lists or outlines? Then use [[XOXO]]. | |||
* Do you publish reviews? Then use [[hReview]]. | |||
** Start with the [http://microformats.org/code/hreview/creator hReview creator]. | |||
* Do you publish press releases? Then use [[hatom|hAtom]]. | |||
== what next == | |||
Once you have added microformats support to your website and helped your company and organization do so as well: | |||
* [[advocacy|Advocate]] the use and support of microformats on other sites as well. | |||
And here are a few more tips: | |||
Try to produce clean, [[semantic xhtml]], AKA [[POSH]]. Where there aren't [[microformats]] for specific types of content, feel free to experiment with your own [[poshformats]]. | |||
* [http://tantek.com/log/2004/07.html#classmeaningnotshow Class for meaning not for show] | |||
* http://microformats.org/wiki/SemanticXHTMLDesignPrinciples | |||
* [http://tantek.com/presentations/20040928sdforumws/semantic-xhtml.html Semantic XHTML] | |||
* [http://tantek.com/presentations/2005/03/elementsofxhtml Meaningful XHTML] | |||
* [http://www.tantek.com/presentations/2004etech/realworldsemanticspres.html Real World Semantics] | |||
* ... | |||
== translations == | |||
Read about how to [[get-started]] in additional <span id="languages">languages</span>: | |||
* [[get-started-fr|français]] | |||
* [[get-started-ru|Русский]] | |||
== see also == | |||
* [[advocacy]] | |||
* [[spread-microformats]] | |||
Latest revision as of 16:22, 18 July 2020
Latest: Get Started with microformats2
Get started by adding support for microformats to your website, services, and products.
introduction
Microformats are based on simple markup conventions that enable you to add meaningful structure to your web content.
One of the key principles of microformats, is to privilege human readable content. This means that you should think first and foremost of your content design being readable and accessible to web viewers. Using the most appropriate HTML elements and applying structured class names to your markup enables you to produce content that can be clearly understood by a human audience and also used in a structured way by automated programs and other online tools. But the point is that you shouldn't have to go out of your way to produce such machine friendly markup - microformats make it easy to integrate this greater degree of structure into your websites, without the overhead of having to learn complicated new languages or formats.
The best way to understand microformats is to start using them straight away. Since they're embedded in ordinary HTML, you can take existing pages and add these structured class names to the markup, but it's recommended that when doing this, you also take a close look at the overall tag structure that you're using - maybe there is a better way to say what you mean using basic HTML tags.
Many common kinds of content can be marked up in microformats. Microformats are designed to be similar to current markup styles. Chances are, you already have some of them on your site. Start with the obvious ones. For example a simple, and very popular place to start is with h-card - a microformat for displaying personal and organizational contact details. You can think of h-card as a way to embed mini business cards in web pages, but glancing over the examples shows a lot more possibilities than just that. Here are some specific places to start using microformats today:
yourself
your website
If you have your own website, read h-card-authoring for tips and guidelines on how to best markup existing content with h-card and take a look at the h-card-examples, then
- add h-card to your contact info page
- add h-card+XFN to your friends list or blog roll
- add your website and contact page to the list of examples in the wild
your blog
If you have a blog:
- add hAtom to your blog pages
- add your blog to the hatom-examples-in-wild page.
your organization
website
contact info
- Contact info. Every company or organization has a contact or about page of some sort on their website. Read h-card-authoring and add h-card to the contact/about pages along with "Add to address book" links for each h-card.
- Employee directory. If your company has a page listing employees or others that belong to the organization, add h-card to the listings or search results.
- add those pages with h-cards to the list of examples in the wild
events
Use hCalendar anywhere on the website that publishes event information. Start with the hCalendar creator.
history
If your organization publishes its history, mark up the events noted with hCalendar, thus allowing anybody to build a dynamic timeline application with your history.
products
Does your company make any products that generate HTML?
- Make sure such products generate POSH and whenever possible, the appropriate microformats.
- Then add those products to the implementations page.
enterprise
Wondering how to use microformats in an enterprise scenario?
Any publication of information about people, events, reviews etc. could benefit from being marked up with h-card, hCalendar, and hReview respectively.
other content
- Do you have an explicit copyright license on your content? Then markup the link to your license with rel-license.
- Do you publish social network / relationship info? Then mark that up with XFN.
- Are you tagging things? Then use rel-tag (for your own stuff) or xFolk (for tagging any URL).
- Are you publishing lists or outlines? Then use XOXO.
- Do you publish reviews? Then use hReview.
- Start with the hReview creator.
- Do you publish press releases? Then use hAtom.
what next
Once you have added microformats support to your website and helped your company and organization do so as well:
- Advocate the use and support of microformats on other sites as well.
And here are a few more tips:
Try to produce clean, semantic xhtml, AKA POSH. Where there aren't microformats for specific types of content, feel free to experiment with your own poshformats.
- Class for meaning not for show
- http://microformats.org/wiki/SemanticXHTMLDesignPrinciples
- Semantic XHTML
- Meaningful XHTML
- Real World Semantics
- ...
translations
Read about how to get-started in additional languages: