get-started: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
No edit summary
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(87 intermediate revisions by 37 users not shown)
Line 1: Line 1:
<div style="float:right;margin-left:1em">__TOC__</div>
{{DISPLAYTITLE:Get Started}}
<div style="text-indent:2em;font-weight:bold;padding:1em;background:yellow">
Latest: [http://microformats.org/2014/03/05/getting-started-with-microformats2 Get Started with microformats2]
</div>


<h1>С чего начать</h1>
Get started by adding support for microformats to your website, services, and products.


Начните своё знакомство с микроформатами, добавив их к своему Web-сайту, сервисам или продуктам
== 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.
Микроформаты основаны на соглашениях о простой разметке, которая позволяет добавить смысловую структуру к содержимому вашего сайта.


Один из ключевых [[principles-ru|принципов]] микроформатов  — это предоставление [[humans-first-ru|удобного для чтения человеком]] контента. Это значит, что вы должны думать о том, чтобы ваш контент был удобочитаем. Используя [[semantic-xhtml-ru|наиболее подходящие HTML-элементы]] и применяя структурированные [[semantic-class-names-ru|имена классов]] для вашей разметки, вы производите контент, который может понять и человек, и программные средства. Всё дело в том, что для такой дружбы машины и человека вам не нужно изучать новые языки программирования или обучаться новым техническим приёмам. Всё что используется в микроформатах — всё это лежит прямо на поверхности и базируется на известных всем форматах.
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:


Большое количество данных может быть размечено микроформатами. Они созданы, чтобы быть похожими на текущие стили разметки. Есть даже немалая вероятность того, что у вас на странице уже есть некоторые зачатки микроформаты. Начните именно с них. Например, очень простой и быстрый старт можно получить, используя [[hcard-ru|hCard]] — микроформат для отображения персональной информации и информации об организациях. Вы можете подумать, что внедрение на странциу [[hcard-ru|hCard]] является внедрением визитной карточки, но вы можете посмотреть некоторые [[hcard-examples-ru|примеры], чтобы убедиться, что это нечто большее.
== 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|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].


=== На своём Web-сайте ===
===== history =====
Если у вас есть свой собственный Web-сайт, прочитайте [[hcard-authoring-ru|инструкцию по внедрению hCard]], чтобы подробнее ознакомиться с этим процессом.  
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.


* Добавьте [[hcard-ru|hCard]] на страницу информации о связи с вами
=== products ===
* Внедрите hCard вместе с [[xfn-ru|XFN]] к списку друзей (или блогроллу)
Does your company make any products that generate HTML?
* Добавьте ваш сайт на нашу страницу [[hcard-examples-in-wild-ru|показательных внедрений]].


Вы можете использовать [http://microformats.org/code/hcard/creator генератор hCard], если захотите.  
* Make sure such products generate [[posh|POSH]] and whenever possible, the appropriate microformats.
* Then add those products to the [[implementations]] page.


 
=== enterprise ===
=== На своём блоге ===
Если у вас есть блог, вы также можете разметить его с помощью микроформатов.
 
* Добавьте [[hatom-ru|hAtom]] для разметки статей
* Добавьте ваш блог на страницу [[hatom-examples-in-wild-ru|живых примеров]].
 
 
== Организация ==
 
=== Web-сайт ===
 
==== Информация для связи ====
 
* ''Информация для связи''. У каждой компании или организации есть странице для связи, где вы можете добавить [[hcard-ru|hCard]], например, используя [[hcard-authoring-ru|инструкцию по внедрению hCard]].
* ''Каталог сотрудников'' вы также можете разметить микроформатами, добавив hCard к спискам или результатам поиска.
* Добавьте эти страницы в нашу [[hcard-examples-in-wild-ru|коллекцию].
 
 
==== События ====
Используйте микроформат hCalendar везде, где вы размещаете информацию о проводимых событиях. Начните с [http://microformats.org/code/hcalendar/creator генератора hCalendar].
 
 
===== История =====
Если ваша организация публикует собственную историю, вы также можете разметить данные записи с помощью hCalendar, что позволит любому построить на основе этих данных временную характеристику происходивших событий.
 
 
=== Продукты ===
Ваша компания производит программы, генерирующие каким-либо образом HTML (CMS, Блог-платформа, например)?
 
* Убедитесь, что она генерирует [[posh-ru|верную разметку]] и, где это возможно, внедрите микроформаты.
* Добавьте такие продукты на страницу [[implementations-ru|реализаций]].
 
<!--=== enterprise ===
Wondering how to use microformats in an enterprise scenario?
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 hCard, hCalendar, and hReview respectively.-->
Any publication of information about people, events, reviews etc. could benefit from being marked up with h-card, hCalendar, and hReview respectively.


== Другое содержимое ==
== other content ==
* Вы применяете лицензию к тому, что вы создаёте? Разметьте путь к вашей лицензии микроформатом [[rel-license-ru|rel-license]]
* Do you have an explicit copyright license on your content? Then markup the link to your license with [[rel-license]].
* Вы создаёте социальную суть, средство для управления социальными взаимоотношениями? Используйте [[XFN-ru|XFN]].
* Do you publish social network / relationship info? Then mark that up with [http://gmpg.org/xfn/ XFN].  
* Вы используете теги для статей? Тогда вам следует применить к ним [[rel-tag-ru|rel-tag]] (для собственных произведений) или [[xFolk-ru|xFolk]] (для любых произведений, URI).
* Are you tagging things? Then use [[rel-tag]] (for your own stuff) or [[xFolk]] (for tagging any URL).
* Вы публикуете списки, информацию о содержимом? Попробуйте использовать [[XOXO-ru|XOXO]].
* Are you publishing lists or outlines? Then use [[XOXO]].  
* Размещаете обзоры? Тогда вам следует оформить их как [[hreview-ru|hReview]]. Можете использовать для этого [http://microformats.org/code/hreview/creator генератор hReview]  
* Do you publish reviews? Then use [[hReview]].
* Публикуете пресс-релизы или ведёте блог? Разметьте его с помощью [[hatom-ru|hAtom]].
** Start with the [http://microformats.org/code/hreview/creator hReview creator].
* Do you publish press releases? Then use [[hatom|hAtom]].


== Что делать дальше ==
== what next ==
Когда вы считаете, что разметили микроформатами все возможные блоки на вашем сайте, можете попробовать [[advocacy-ru|убедить]] других в пользе использования микроформатов.
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:


Попробуйте верстать чисто, [[semantic-xhtml-ru|семантично]], чтобы код был как можно более красивее. Не пренебрегайте [[posh-ru|POSH]]. Если вы не нашли [[microformats-ru|микроформата]] для вашего случая, попробуйте поэкспериментировать с [[poshformats-ru|POSH-форматами]].
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://tantek.com/log/2004/07.html#classmeaningnotshow Class for meaning not for show]
Line 86: Line 73:
* [http://tantek.com/presentations/2005/03/elementsofxhtml Meaningful XHTML]
* [http://tantek.com/presentations/2005/03/elementsofxhtml Meaningful XHTML]
* [http://www.tantek.com/presentations/2004etech/realworldsemanticspres.html Real World Semantics]
* [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-ru|Защищайте микроформаты]]
* [[advocacy]]
* [[spread-microformats-ru|Продвигайте микроформаты]]
* [[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

your blog

If you have a blog:

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

translations

Read about how to get-started in additional languages:

see also