Справка:Микроформаты

Материал из Циклопедии
Перейти к навигации Перейти к поиску
Что такое Микроформат?

Микроформаты — специальная иерархия классов CSS, применяемых на страницах википроектов для улучшения определения поисковиками различных типов информации в содержимом викистатей. Являются частью микроразметки.[1] В Циклопедии микроформаты используются в шаблонах-карточках, где обычно указывается краткая информация о предмете статьи.

Общие правила[править]

  • Микроформат представляет собой иерархию вложенных HTML-тегов с соответствующими свойствами, каждое из которых указывается в качестве CSS класса конкретного тега:

    <тег class="свойство">Содержимое тега</тег>

    Предпочитаемыми тегами являются <div> и <span>.
  • Для ряда свойств, используемых более одного раза, могут быть указаны разные типы этих свойств и соответствующие этим типам значения с помощью подсвойств type и value:
<тег class="свойство">
<тег class="type">Тип</тег>
<тег class="value">Значение</тег>
</тег>
  • Для каждого свойства, имеющего вложенные типы type и значения value, если тип type не указан, то непосредственное содержимое свойства определяется как его значение value.
  • Если указан только type, без value, в качестве значения используется содержимое тега самого свойства:
<тег class="свойство">
<тег class="type">Тип</тег>
Содержимое тега
</тег>
  • При указании свойства микроформата через тег <abbr> или через вложенный тег с классом class="value-title" значением является указанный в нём атрибут title=, при этом содержимое самого тега <abbr> или родительского тега используется лишь в качестве отображаемого текста и может быть вообще не указано.
  • Свойства микроформата делятся на два вида:
    1. Принимающие в качестве значения URL. Такие свойства из (вложенного) тега <a> извлекают значение атрибута href=, из тега <img> — значение атрибута src=.
    2. Принимающие в качестве значения текст содержимого. Такие свойства из тега <a> и остальных тегов извлекают вложенный текст, из тега <img> — значение атрибута alt=.
    в одном теге можно сочетать свойства разных видов, при этом одни извлекают ссылку, а другие — текстовое значение.

Note Примечание: Во всех свойствах, определяющих дату, в том числе в датах события в hCalendar, дате рождения в hCard, используется формат даты по стандарту ISO 8601 / RFC 3339 вида YYYY-MM-DDThh:mm:ss, не предназначенный для непосредственного чтения. Поэтому значения свойств дат рекомендовано выводить не в качестве непосредственно отображаемого текста, читаемого людьми, а через HTML-атрибут title= тега <abbr> или вложенного тега с классом value-title, скрытого с помощью display:none;.

Микроформаты[править]

 Легенда 
  Подчёркиванием выделены обязательные свойства.
Зелёным цветом отмечены свойства, указываемые внутри своего родителя только один раз.
Красным цветом обозначены нестандартные свойства и расширения, введённые отдельными платформами и работающие не во всех поисковиках.
Даты, значение которых указывается по стандарту ISO, выделены жёлтым фоном.
 

hCard[править]

Микроформат hCard — описание
hCard — микроформат, используемый для выделения элементов данных о людях, местах и организациях. Является распространённым и поддерживается многими поисковыми платформами, в т. ч. Яндексом, Google. Иерархия классов микроформата hCard:
  • vcard — Корневой класс для hCard. Указывает, что данный элемент и все производные (вложенные в него элементы) содержат в себе микроформат hCard. Для каждого объекта или субъекта используется свой отдельный экземпляр vcard, допускается вкладывать их один в другой.
    • fn — Имя объекта (формальное имя, formal name). Если свойство n не указано, используется вместо него по следующим правилам:
      • если значение содержит два слова, они интерпретируются как given-name и family-name (Имя Фамилия, с запятой Фамилия, Имя)
      • если значение содержит одно слово, оно определяется как nickname
      Если fn указывается вместе с org при пустом n, объект считается организацией.
    • n — Имя объекта. Используется для подробного представления имени субъектов (людей, животных, персонажей).
      • honorific-prefix — Обращение (сэр, г-н, Его Величество, товарищ и т. п.)
      • given-name — Имя
      • family-name — Фамилия
      • additional-name — Отчество
      • honorific-suffix
      • nickname — Псевдоним
    • logo — Логотип, изображение, ассоциированное с объектом
    • photo — Фотография объекта. Извлекает значение URL из атрибута src= вложенного тега <img> или из атрибута href= вложенного тега <a>.
    • bday — День рождения объекта.
    • geo — Географические координаты объекта. Данное свойство встроено в шаблон {{Coord}} и вставляется вместе с ним.
      • latitude — Широта как часть географических координат
      • longitude — Долгота как часть географических координат объекта
    • adr — Адрес объекта (подробный)
      • type — Тип родительского элемента. Распространённые значения: WORK (рабочий адрес, оффис), home (домашний адрес) и др.
      • value — Актуальное значение конкретно-указанного типа.
        • postal-code — Почтовый индекс
        • country-name — Имя страны. Допускается вывод через <abbr>.
        • region — Регион. Допускается вывод через <abbr>
        • locality — Населённый пункт
        • street-address — Улица, дом
        • extended-address — Расширенный адрес (корпус, номер подъезда, этаж ...)
        • post-office-box — Адрес почтового ящика
    • label — Адрес объекта (обобщённый). Допускает указание полного адреса — содержимого одновременно всех вложенных элементов adr — в качестве единого значения без разделения на элементы.
      • type — Тип родительского элемента.
      • value — Актуальное значение конкретно-указанного типа.
    • org — Организация или компания объекта. Если объект является организацией или компанией, указывается вместе с fn class="fn org", при этом n не используется и должно быть пустым. Если organization-name не указано, то org считается равным organization-name. Данное свойство может быть вложенным внутрь adr.
      • organization-name — Имя организации или компании объекта
      • organization-unit — Департамент, отдел, в котором числится объект
    • title — Название занимаемой субъектом должности или положения
    • role — Информация о роли субъекта
    • agent — Представитель субъекта (агент, секретарь и т. д.)
    • tel — Телефонный номер объекта
      • type — Тип родительского элемента. Распространённые значения: home (домашний), msg (с автоответчиком), work (рабочий), fax (факс), cell (мобильный/сотовый), video (видеофон), pager (пэйджер), modem (модем), car (в автомобиле) и др.
      • value — Актуальное значение конкретно-указанного типа.
    • email — Эл. почта объекта
      • type — Тип родительского элемента. Распространённые значения: INTERNET, x400 и др.
      • value — Актуальное значение конкретно-указанного типа.
    • mailer — Приложение, которое используется в качетстве почтового клиента объектом
    • tz — Временна́я зона объекта
    • url — Ссылка на веб-страницу объекта hCard или какого-либо его свойства. Значение ссылки извлекается из атрибута href= вложенного тега <a>. Может использоваться в сочетании со всеми другими свойствами hCard, имеющими текстовое значение, например class="fn url". При этом url извлекает ссылку, а fn — текст.
    • workhours — Время работы организации.[2]
    • note — Дополнительная информация об объекте
    • key — Публичный ключ объекта
      • type — Тип родительского элемента.
      • value — Актуальное значение конкретно-указанного типа.
    • category — Категория объекта. Специализация деятельности организации.
    • class — Классификатор уровня доступа к объекту (public — публичный, confidentional — скрытый)
    • sort-string — Имя одного из свойств микроформата, которое будет использовано для сортировки по алфавиту. По умолчанию это часть имени.
    • uid — Глобально уникальный идентификатор, привязанный к объекту или одному из свойств объекта.
    • rev — Указывает ревизию hCard
    • sound — Какой элемент будет озвучен аудио-средствами. По умолчанию, это «fn»

hCalendar[править]

Микроформат hCalendar — описание
hCalendar — микроформат разметки событий. Поддерживается Google, не поддерживается Яндексом. Иерархия классов микроформата hCalendar:
  • vcalendar — Корневой класс для hCalendar. Указывает, что данный элемент и все производные (вложенные в него элементы) содержат в себе микроформат hCalendar
  • vevent — Корневой класс для событий. Равнозначен vcalendar, может использоваться вместо vcalendar как корневой класс hCalendar (если vcalendar не указан), или как вложенное свойство корневого класса vcalendar. Внутрь может быть вложен микроформат hCard.
    • dtstart — Дата начала события.
    • dtend — Дата окончания события.
    • duration — Период или длительность события.
    • dtstamp — Дата записи / последнего обновления hCalendar
    • summary — Краткое описание события.
    • description — Подробное описание события
    • location — Место проведения события. Внутрь может быть вложен микроформат hCard с описанием адреса.
    • geo — Географические координаты объекта. Данное свойство встроено в шаблон {{Coord}} и вставляется вместе с ним.
      • latitude — Широта как часть географических координат
      • longitude — Долгота как часть географических координат объекта
    • url — Ссылка на веб-страницу события hCalendar или какого-либо его свойства. Значение ссылки извлекается из атрибута href= вложенного тега <a>. Может использоваться в сочетании со всеми другими свойствами hCard, имеющими текстовое значение, например class="location url". При этом url извлекает ссылку, а location — текст.
    • rrule — повтор события относительно dtstart
      • freq — частота повтора. Возможные значения: DAILY (ежедневно), WEEKLY (еженедельно), MONTHLY (ежемесячно), YEARLY (ежегодно)
      • count — число повторов (целое число)
      • interval — интервал (целое число), пропуск между повторами единицах времени (днях, месяцах, годах), определённых через freq
      • until — дата окончания повторов
    • rdate — даты повтора события после dtstart.
    • category
    • uid

hRecipe[править]

Микроформат hRecipe — описание
hRecipe — микроформат для описания кулинарных рецептов. Поддерживается Яндексом, Google. Иерархия свойств hRecipe:
  • hrecipe — корневой класс hRecipe
    • fn — Название рецепта или блюда.
    • author — Автор рецепта. В качестве вложенного содержимого допускается совместное использование микроформата hCard путём добавления class="author vcard".
    • ingredient — Ингредиент
      • type — Единица измерения продукта
      • value — Количество единиц продукта
      • name — Название продукта.[2]
      • amount — Единица и/или количество продукта. Используется вместо type и value.[2]
    • instructions — Инструкция по приготовлению блюда.
      • photo — Фотография процесса приготовления блюда
      • instruction — Отдельный пункт инструкции.[2]
    • duration — Длительность приготовления
    • yield — Количество порций приготовленного блюда
    • photo — Фотография процесса приготовления блюда
    • nutrition — Пищевая и/или энергетическая ценность блюда
      • calories — Калорийность[2]
      • fat — Содержание жиров[2]
      • saturatedFat — Содержание насыщенных жиров[2]
      • unsaturatedFat — Содержание ненасыщенных жиров[2]
      • carbohydrates — Содержание углеводов[2]
      • sugar — Содержание сахаров[2]
      • fiber — Содержание клетчатки[2]
      • protein — Содержание белков[2]
      • cholesterol — Содержание холестерина[2]
      • servingSize — Размер порции[2]
    • result-photo — Фотография готового блюда. Нестандартное свойство, дополнительно добавляемое вместе с одним из свойств photo.[2]
    • cuisine-type — Национальная кухня, к которой относится блюдо.[2]
    • weight — Вес готового блюда.[2]

hReview[править]

Микроформат hReview — описание
hReview — микроформат разметки отзывов (о продукции, услугах, произведениях и мероприятиях в сфере культуры и искусства). Поддерживается Яндексом, Google.

Поддержка микроформатов в википроекте[править]

Шаблоны со встроенным микроформатом[править]

Ряд популярных викишаблонов с своём составе имеют встроенную поддержку микроформата:

  • Шаблон {{ДатаРождения}} поддерживает свойство микроформата bday и может использоваться для добавления данных о дате рождения в составе hCard.
  • Шаблон отображения географических координат {{Coord}} по умолчанию поддерживает свойство микроформата geo. С заполненными параметрами он кроме видимого содержимого формирует и выводит скрытые теги с уже готовыми заполненными свойствами geo (latitude, longitude). Данный шаблон можно вставлять внутрь элементов hCard, hCalendar для добавления координат объекта или события.

В Циклопедии в шаблонах-карточках используется шаблон {{СрокЖизни}}, автоматически добавляющий свойство bday микроформата hCard. Шаблоны {{Форматирование изображения}}, {{Форматирование сайта}} свойство микроформата не добавляют, но автоматически подставляют готовое корректное значение value-title.

Шаблоны для добавления микроформата[править]

В Циклопедии для вставки микроформатов предназначен специально созданный для этих целей шаблон {{Микроформат}}, который позволяет более удобно вставлять свойства и значения микроформата в другие шаблоны.

Ссылки[править]

Источники[править]

  1. Микроразметка — Seo-wiki
  2. 2,00 2,01 2,02 2,03 2,04 2,05 2,06 2,07 2,08 2,09 2,10 2,11 2,12 2,13 2,14 2,15 2,16 Нестандартное свойство, внедрено и поддерживается Яндексом.