yandex widgets dg

21
Яндекс.Виджеты Руководство разработчика 25.06.2009

Upload: mikhail-lomonosov

Post on 16-Jun-2015

752 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Yandex Widgets Dg

Яндекс.ВиджетыРуководство разработчика

25.06.2009

Page 2: Yandex Widgets Dg

Яндекс.Виджеты. Руководство разработчика. Версия 1.0 Дата сборки документа: 25.06.2009.Этот документ является составной частью технической документации Яндекса.Сайт справки к сервисам Яндекса: http://help.yandex.ru© 2008—2009 ООО «ЯНДЕКС». Все права защищены.

Предупреждение об исключительных правахЯндексу (а также указанному им правообладателю) принадлежат исключительные права на все результаты интеллектуальной деятельности и приравненные к нимсредства индивидуализации, используемые при разработке, поддержке и эксплуатации сервиса Яндекс.Виджеты. К таким результатам могут относиться, но неограничиваясь указанными, программы для ЭВМ, базы данных, изображения, тексты, другие произведения, а также изобретения, полезные модели, товарные знаки,знаки обслуживания, коммерческие обозначения и фирменные наименования. Эти права охраняются в соответствии с Гражданским кодексом РФ и международнымправом.Вы можете использовать сервис Яндекс.Виджеты или его составные части только в рамках полномочий, предоставленных вам Пользовательским соглашениемсервиса Яндекс.Виджеты или специального соглашения.Нарушение требований по защите исключительных прав правообладателя влечет за собой дисциплинарную, гражданско-правовую, административнуюили уголовную ответственность в соответствии с российским законодательством.

Контактная информацияООО «ЯНДЕКС»http://www.yandex.ruТел.: +7 495 739 7000Email: [email protected]Главный офис: 111033, г. Москва, ул. Самокатная, д. 1, стр. 21

Page 3: Yandex Widgets Dg

СодержаниеО руководстве ..................................................................................................................................................................................... 4

Концепции .......................................................................................................................................................................................... 5Что такое виджеты? ................................................................................................................................................................... 5Виджеты от Яндекса .................................................................................................................................................................. 5Устройство виджета ................................................................................................................................................................... 6Автономные и серверные виджеты .......................................................................................................................................... 8

Процедуры ........................................................................................................................................................................................ 12Как создать виджет с нуля? ..................................................................................................................................................... 12Как создать виджет при помощи конструктора? .................................................................................................................. 12Как добавить свой виджет в каталог виджетов? ................................................................................................................... 14Как добавить свой виджет в региональную программу? ..................................................................................................... 14

Справочная информация ............................................................................................................................................................... 15Свойства виджета ..................................................................................................................................................................... 15Настройки виджета .................................................................................................................................................................. 16

Виджетная заготовка ....................................................................................................................................................................... 19

Предметный указатель .................................................................................................................................................................... 20

Яндекс.Виджеты Руководство разработчика

Page 4: Yandex Widgets Dg

Руководство разработчика

О руководствеДанное руководство является описанием приемов создания Яндекс.Виджетов и предназначено как дляопытных разработчиков, так и для тех, кто впервые хочет попробовать свои силы в создании веб-при-ложения с нуля. Веб-виджеты являются сравнительно простыми программами, что делает их хорошейотправной точкой для тех, кто только начинает интересоваться веб-программированием.

Руководство содержит практическую информацию по созданию Яндекс.Виджетов. Новички найдутв нем много полезной информации о принципах создания виджетов. Людям с опытом будет интересноузнать об отличительных особенностях Яндекс.Виджетов, включая подробную информацию об ихсвойствах и настройках.

Структура документаДанный документ состоит из следующих разделов:

1. Концепции: объяснение основных понятий, ответы на вопросы "что это?".

2. Процедуры: пошаговые описания решений поставленных задач, ответы на вопросы "как сделать?".

3. Справочная информация: список свойств и настроек виджетов.

4. Виджетная заготовка: шаблон для создания собственного виджета.

Яндекс.Виджеты Руководство разработчика

4

Page 5: Yandex Widgets Dg

Концепции

Концепции

Что такое виджеты?Виджет (англ. widget – приспособление, безделушка) – это небольшое приложение, которое показываетнекоторую информацию или выполняет несложное действие, а то и просто украшает экран пользователя.

К наиболее широко распространенным виджетам относятся новостные ленты, часы, индикаторы погоды,настольные игры.

Веб-виджет — это виджет, встраиваемый в веб-страницу сайта.

Веб-виджеты могут выступать в роли "окон" к другим сервисам: в область каждого виджета может бытьзагружена отдельная веб-страница, что дает возможность получить на одной странице функциональ-ность, предоставляемую сразу несколькими сервисами или сайтами.

См. также"Web widget" в ВикипедииВиджеты от Яндекса

Виджеты от ЯндексаЯндекс разработал собственную виджетную платформу: Яндекс.Виджеты.

Яндекс.Виджеты можно устанавливать на главную страницу Яндекса, которую каждый пользовательможет настроить по своему усмотрению.

Яндекс.Виджеты можно выбрать из обширного каталога виджетов, который постоянно пополняется.

Примечание:Для доступа к каталогу нужно выбрать ссылку "Настроить" на главной странице Яндекса, а затем нажатьна кнопку "Добавить новый блок".

Яндекс.Виджеты Руководство разработчика

5

Page 6: Yandex Widgets Dg

Концепции

Отличительные особенности Яндекс.Виджетов:

• Яндекс.Виджеты легко создавать: для этого почти не требуется специальных навыков в областипрограммирования.

• Опытные разработчики смогут использовать при разработке Яндекс.Виджетов практически любыесовременные технологии, среди которых JavaScript, CSS, Flash и AJAX. HTML-код виджета можетбыть результатом работы любого серверного языка программирования.

• Яндекс.Виджеты совместимы со всеми современными браузерами. На сегодняшний день Яндексофициально поддерживает следующие браузеры:

• Microsoft Internet Explorer 8.xx

• Microsoft Internet Explorer 7.xx

• Microsoft Internet Explorer 6.xx

• Firefox 3.x

• Firefox 2.x

• Opera 9.6

• Opera 9.5

• Opera 9.2x

• Safari 3

Примечание:Далее, когда мы будем говорить о виджетах, мы будем иметь в виду именно веб-виджеты от Яндекса.

Что нужно для создания собственного виджета?• Базовое представление о веб-технологиях (знания HTML уже достаточно для создания простых

виджетов).

• Текстовый редактор.

• Немного времени, чтобы ознакомиться с базовыми приемами создания Яндекс.Виджетов.

См. такжеИнформация о каталоге виджетовУстройство виджетаКак создать виджет с нуля?Как создать виджет при помощи конструктора?Как добавить свой виджет в каталог виджетов?

Устройство виджетаВиджет представляет собой XHTML-файл, загружаемый в отдельный элемент <iframe>, которому мож-но задать нужный размер и разместить в произвольном месте. Это позволяет "установить" на одну

Яндекс.Виджеты Руководство разработчика

6

Page 7: Yandex Widgets Dg

Концепции

страницу большое количество виджетов. При этом внешне данная страница выглядит совершенно обы-чно.

Примечание:Содержимое файла виджета должно быть в кодировке UTF-8.

Виджеты в режиме редактирования (слева) и в обычном режиме (справа)

XHTML-файл виджета выглядит следующим образом:

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xmlns:widget="http://wdgt.yandex.ru/ns/" > <head>

<!-- Описание виджета -->

<!-- Свойства виджета --> <meta name="description" content="Подробное и емкое описание" /> <meta name="..." content="..." /> <meta ... /> ... <!-- Cсылка для загрузки тела серверного виджета (см. ниже) --> <meta name="src" content="..." />

<!-- Пользовательские настройки --> <widget:preferences> <preference name="..." type="..." ... /> <preference ... /> ... </widget:preferences>

<!-- конец описания -->

<!-- Если планируется использование виджетного JS API, подключите соответствующую библиотеку (подробнее см. "Справочник по API") --> <script type="text/javascript" src="http://img.yandex.net/webwidgets/1/WidgetApi.js"> </script>

</head> <body> <!-- Тело автономного виджета (см. ниже) --> </body></html>

Из примера видно, что виджет состоит из описания и тела.

Описание виджетаВ описании виджета указываются некоторые обязательные свойства и пользовательские настройки (оп-ционально).

Яндекс.Виджеты Руководство разработчика

7

Page 8: Yandex Widgets Dg

Концепции

Свойства содержат описательную и служебную информацию о виджете, например:

<!-- Заглавие (title): название виджета --><meta name="title" content="Часы" /><!-- Описание (description): основная функция виджета --><meta name="description" content="Показывает время в разных часовых поясах" />

Для загрузки виджета на Яндекс должно быть указано название виджета (title). Для добавления в каталогвиджетов нужно указать основные функции виджета (description).

Примечание:Подробнее см. справочный раздел Свойства виджета.

Настройки позволяют сохранять параметры, специфические для каждого конкретного экземпляра вид-жета. Например, каждый пользователь виджета погоды может выбрать город, погода в котором отоб-ражается по умолчанию:

<widget:preferences> <preference name="city" type="list" label="Показывать погоду в городе: "> <option value="1">Москва</option> <option value="2">Санкт-Петербург</option> <option value="3">Мурманск</option> <option value="4">Норильск</option> <option value="5">Ярославль</option> ... </preference> </widget:preferences>

Примечание:Подробнее см. справочный раздел Настройки виджета.

Тело виджетаТело виджета представляет собой обычную HTML-страницу, которая может содержать скрипты, та-блицы стилей и пр. Тело может храниться в том же файле, что и описание, а может — на отдельномсервере. В зависимости от этого виджеты делятся на автономные и серверные. Тело серверного виджетаможет быть результатом работы любого серверного языка программирования, который на выходе ге-нерирует HTML.

См. такжеАвтономные и серверные виджетыКак создать виджет с нуля?Свойства виджетаНастройки виджета

Автономные и серверные виджетыXHTML-файл виджета всегда загружается на Яндекс. Если функциональная часть виждета расположенав блоке <body>, то виджет называется автономным. Если же она хранится на стороннем сервере (путьк телу виджета указан в свойстве src) — то серверным.

Яндекс.Виджеты Руководство разработчика

8

Page 9: Yandex Widgets Dg

Концепции

Автономные виджетыТело и описание автономного виджета содержатся в одном XHTML-файле, который загружается на Ян-декс. Тем не менее, автономные виджеты могут использовать внешние ресурсы во время своей работы,например, загружать скрипты, стили, картинки со сторонних серверов.

Любая информация, содержащаяся в теге body, должна быть валидным XHTML.

Пример:

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xmlns:widget="http://wdgt.yandex.ru/ns/" > <head> <meta name="title" content="Hello, world!" /> <meta name="description" content="Выводит строку Hello, world!" /> </head> <body> <p>Hello, world!</p> </body></html>

Схема взаимодействия автономных виджетов

Серверные виджетыТело серверных виджетов загружается со стороннего сайта. Блок <body> таких виджетов должен бытьпустым, а адрес источника загрузки — указан в свойстве src:

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xmlns:widget="http://wdgt.yandex.ru/ns/" > <head> <meta name="title" content="Hello, world!" /> <meta name="description" content="Выводит строку Hello, world!" /> <meta name="src" content="http://example.com/helloworld.html" /> </head> <body> </body></html>

Примечание:Любое содержимое тега <body> серверного виджета будет проигнорировано.

Яндекс.Виджеты Руководство разработчика

9

Page 10: Yandex Widgets Dg

Концепции

Для того чтобы достичь такой же функциональности, как у только что описанного автономного виджета,указанный файл http://example.com/helloworld.html должен содержать следующее:

<html> <head> </head> <body> <p>Hello, world!</p> </body></html>

Используя данный подход, можно сделать свою страницу виджетом, затратив минимум усилий. Для это-го лишь необходимо подставить нужный параметр в свойство src.

Код тела виджета может быть написан на любом серверном языке программирования, результатом ра-боты которого является HTML. Чтобы переписать приведенный пример на PHP, нужно:

1. Указать в свойстве src ссылку на php-файл:

<meta name="src" content="http://example.com/helloworld.php" />

2. По указанному адресу разместить файл с кодом на PHP:

<html> <head> </head> <body> <?php echo '<p>Здравствуй, мир!</p>'; ?> </body></html>

Схема взаимодействия серверных виджетов

Яндекс.Виджеты Руководство разработчика

10

Page 11: Yandex Widgets Dg

Концепции

Разработчикам, имеющим свой хостинг, следует иметь в виду, что попадание виджета в каталогЯндекса существенно увеличит трафик и нагрузку на сервер хостинга.

См. такжеКак создать виджет с нуля?Свойства виджетаНастройки виджета

Яндекс.Виджеты Руководство разработчика

11

Page 12: Yandex Widgets Dg

Процедуры

Процедуры

Как создать виджет с нуля?При выполнении описанных ниже шагов можно пользоваться виджетной заготовкой.

1. Выберите тип виджета: автономный или серверный.

Совет:Если вы не являетесь профессиональным разработчиком или не имеете собственного хостинга,вам лучше работать с автономными виджетами.

2. Создайте валидную XHTML-страницу. Добавьте в блок <head> этой страницы свойства и, при не-обходимости, настройки виджета.

Для загрузки виджета на Яндекс XHTML-файл должен содержать как минимум свойство title(название виджета). Для добавления в каталог виджетов нужно добавить свойство description(краткий обзор функций виджета), а также загрузить картинку превью из кабинета разработчикаво время добавления виджета.

Примечание:Содержание файла виджета должно быть в кодировке UTF-8.

3. Добавьте тело виджета.

• Для автономного виджета: поместите тело виджета в созданный XHTML-файл (основнуюразметку в тег <body>, вложенные скрипты и стили — в блок <head>).

• Для серверного виджета: добавьте в блок <head> свойство src, указав в нем путь к телувиджета:

<meta name="src" content="http://example.com/my-widget-page.xhtml" />

4. Загрузите полученную XHTML-страницу (виджет) на сервер Яндекса при помощи конструктораXHTML.

См. такжеПрактический пример: виджет "Hello, world!"Практический пример: виджет "Конвертор величин измерения расстояния"Как добавить свой виджет в каталог виджетов?Как создать виджет при помощи конструктора?Виджетная заготовкаАвтономные и серверные виджетыСвойства виджетаНастройки виджета

Как создать виджет при помощи конструктора?1. Зайдите в кабинет разработчика.

Яндекс.Виджеты Руководство разработчика

12

Page 13: Yandex Widgets Dg

Процедуры

Чтобы воспользоваться кабинетом разработчика, нужно авторизоваться при помощи логина на Ян-дексе.

2. Перейдите по ссылке "Загрузить виджет".

3. Выберите один из доступных конструкторов:

• Быстрый старт: создание виджета из кода заранее подготовленной HTML-страницы. Свойствавиджета указываются отдельно при помощи формы.

• RSS-виджет: создание виджета из RSS-ленты.

• iFrame-виджет: создание виджета из обычной интернет-страницы, которая уже размещена в ин-тернете.

• XHTML: загрузка виджета из заранее подготовленного XHTML-файла. Свойства и настройкивиджета должны быть указаны в файле.

4. Примите условия пользовательского соглашения.

5. Укажите в форме ввода данные виджета:

Для конструктора "Быстрый старт"Поле ЗначениеЗаголовок виджета Заголовок виджета.

Описание виджета Описание функций виджета.

Высота виджета Высота <iframe>, в котором отображается виджет (в пикселах). Значениепо умолчанию: 300

Содержимое виджета Тело виджета: интернет-страница, выполняющая функцию виджета.Страница может содержать HTML, CSS и JavaScript.

Картинка Картинка превью виджета (будет отображаться в каталоге виджетов).

Для конструктора "RSS виджет"Поле ЗначениеЗаголовок виджета Заголовок виджета.

Адрес сайта Адрес сайта, с которого взята RSS-лента (в начале адреса нужно обяза-тельно указать http://).

Описание виджета Описание RSS-ленты.

Путь к RSS Путь к RSS-ленте (в начале адреса нужно обязательно указать http://).

Картинка Картинка превью виджета (будет отображаться в каталоге виджетов).

Для конструктора "iFrame-виджет"Поле ЗначениеЗаголовок виджета Заголовок виджета.

Адрес сайта Адрес сайта, связанного с содержимым виджета. Например, сайт разра-ботчика или сайт сервиса, доступ к которому предоставляет виджет(в начале адреса нужно обязательно указать http://).

Описание виджета Описание функций виджета.

Путь к виджету Адрес страницы, на основе которой будет создан виджет (в начале адресанужно обязательно указать http://).

Яндекс.Виджеты Руководство разработчика

13

Page 14: Yandex Widgets Dg

Процедуры

Поле ЗначениеВысота виджета Высота <iframe>, в котором отображается виджет (в пикселах). Значение

по умолчанию: 300.

Картинка Картинка превью виджета (будет отображаться в каталоге виджетов).

Для конструктора "XHTML"Поле ЗначениеXHTML Готовый XHTML-файл виджета.

Картинка Картинка превью виджета (будет отображаться в каталоге виджетов).

После указания данных о виджете, вы будете автоматически перенаправлены на страницуредактирования виджета.

См. такжеКак создать виджет с нуля?Как добавить свой виджет в каталог виджетов?

Как добавить свой виджет в каталог виджетов?Для попадания в каталог виджет должен удовлетворять правилам и критериям размещения в каталоге.Предложить свой виджет для добавления в каталог можно перейдя по ссылке Предложить виджетына странице каталога в кабинете разработчика.Для входа в кабинет разработчика нужно авторизоваться при помощи логина на Яндексе.

См. такжеИнформация о каталоге виджетовКак создать виджет с нуля?Как создать виджет при помощи конструктора?

Как добавить свой виджет в региональную программу?Для участия виджета в региональной программе он должен удовлетворять критериям и техническимтребованиям, указанным на странице региональной программы. Предложить свой виджет для участияв региональной программе можно на этой же странице — перейдя по ссылке Предложить виджеты.Для входа в кабинет разработчика нужно авторизоваться при помощи логина на Яндексе.

См. такжеИнформация о региональной программеКак создать виджет с нуля?Как создать виджет при помощи конструктора?

Яндекс.Виджеты Руководство разработчика

14

Page 15: Yandex Widgets Dg

Справочная информация

Справочная информация

Свойства виджетаСвойства виджета содержат информацию:

• о названии и функциях виджета;

• об источниках внешних данных, необходимых для корректной работы виджета;

• о правилах отображения виджета, например, таких, как его высота.

Конечный пользователь не может влиять на свойства виджета, так как в них содержится информация,специфичная для класса виджета в целом, а не для его отдельного экземпляра.

Свойства необходимо помещать в блок <head> XHTML-файла виджета. Каждое свойство описываетсяотдельно внутри собственного тега meta. Например:

<head> <meta name="title" content="Hello, world!" /> <meta name="..." content="..." /> ...</head>

Атрибуты тега metaАтрибут Значениеname Название свойства виджета. Значение атрибута name должно совпадать

с названием одного из типов, перечисленных в секции "Типы свойств".

content Значение свойства, указанного в атрибуте name. Допустимые значения зависятот типа свойства.

Примечание:Оба атрибута являются обязательными.

Яндекс.Виджеты Руководство разработчика

15

Page 16: Yandex Widgets Dg

Справочная информация

Свойства виджетаОбязательные: необходимы для загрузки виджета на Яндекс

Свойство Значениеtitle Заголовок виджета.

Рекомендуемые: необходимы для добавления виджета в каталогСвойство Значениеdescription Описание функций виджета.

titleURL Адрес сайта, связанного с содержимым виджета. Например, сайтразработчика или сайт сервиса, доступ к которому предоставляет виджет.

НеобязательныеСвойство Значениеsrc Адрес тела серверного виджета. Подробнее см. Автономные и серверные

виджеты.

height Высота <iframe>, в котором отображается виджет (в пикселах). Значениепо умолчанию: 300.

Свойства виджета "Часы"<head> <meta name="title" content="Настенные часы" /> <meta name="description" content="Отображает время. Формат отображения: настенные часы со стрелками." /> <meta name="titleURL" content="http://example.com" /> <meta name="height" content="400" /></head>

См. такжеНастройки виджета

Настройки виджетаНастройки виджета можно сравнить с переменными, значения которых могут различаться для каждогоотдельно взятого пользователя экземпляра виджета.

Для использования настроек нужно объявить пространство имен Яндекс.Виджетов:

xmlns:widget="http://wdgt.yandex.ru/ns/"

Пользовательские настройки содержатся в теге-контейнере <widget:preferences>, который необходимопомещать в блок <head> XHTML-файла виджета. Каждой настройке соответствует вложенныйтег <preference>. Например:

<head> <widget:preferences> <preference name="color" type="text" defaultValue="green"/> <preference name="..." type="..." ... /> ... </widget:preferences></head>

Настройки передаются в адресной строке как GET-параметры в парах "имя настройки"-"значение":

?preferenceName1=value1&preferenceName2=value2...&preferenceNameN=valueN

Общий размер информации, которая может храниться в настройках, не должен превышать 1 Kb.

Яндекс.Виджеты Руководство разработчика

16

Page 17: Yandex Widgets Dg

Справочная информация

Пользователь может менять свои настройки через форму настроек, которая автоматически генерируетсяна основе информации, содержащейся в теге <widget:preferences>. Форма генерируется и передаетсянепосредственно в момент запроса пользователем настроек виджета.

Примечание:Если виджет не содержит пользовательских настроек, тег widget:preferences указывать не нужно.

Атрибуты тега preferenceОбязательные

Атрибут Значениеname Название пользовательской настройки. Используется для программной

идентификации настройки (сравните с именем переменной). Пользовательне видит значение данного атрибута.

type Тип пользовательской настройки. Допустимые значения: text, boolean,list,hidden. Подробнее см. Типы настроек.

НеобязательныеАтрибут Значениеlabel Текстовое описание пользовательской настройки, которое отображается

на форме настроек. Значение данного атрибута может содержать любыезнаки, доступные в кодировке UTF-8. Ограничение по длине — 256 знаков.Если параметр превышает это значение, остаток строки отбрасывается.

defaultValue Значение пользовательской настройки по умолчанию. Допустимые значениязависят от типа атрибута. Подробнее см. Типы настроек.

Типы настроек

Примечание:Типы настроек задаются в атрибуте type тега preference.

textТекстовое поле ввода. Соответствующий HTML-код на форме настроек:

<input type="text" />

Значение по умолчанию: пустая строка (если не задано иное значение по умолчанию в атрибутеdefaultValue).

booleanБинарный флаг. Соответствующий HTML-код на форме настроек:

<input type="checkbox" />

Допустимые значения:

• false (по умолчанию, если не задано иное значение по умолчанию в атрибуте defaultValue);

• true.

Яндекс.Виджеты Руководство разработчика

17

Page 18: Yandex Widgets Dg

Справочная информация

hiddenПеременная, которая явно НЕ отображается на форме настроек. Соответствующий HTML-код на форменастроек:

<input type="hidden" />

Может быть использована для хранения константных значений, который будут обрабатываться, напри-мер, при помощи JS API.

listВыпадающий список. Элементы списка указываются во вложенных тегах option:

<preference name="months" type="list"> <option value="1">Январь</option> <option value="2">Февраль</option> <option value="3">Март</option> ...</preference>

Тег option имеет единственный атрибут value, в котором указывается значение соответствующего пунк-та списка (для программной обработки).

Соответствующий HTML-код на форме настроек:

<select name="months"> <option value="1">Январь</option> <option value="2">Февраль</option> <option value="3">Март</option> ...</select>

Настройки виджета "Часы"<widget:preferences> <!-- Формат отображения времени --> <preference name="timeFormat" type="list" label="Формат отображения времени" defaultValue="1"> <option value=1>24 часа (hh:mm)</option> <option value=2>12 часов (am/pm)</option> <option value=3>Часы/минуты/секунды (hh:mm:ss)</option> ... </preference> <!-- Флаг "Отображать дату" --> <preference name="showDate" type="boolean" label="Отображать дату" defaultValue="false" /> </widget:preferences>

См. такжеСвойства виджета

Яндекс.Виджеты Руководство разработчика

18

Page 19: Yandex Widgets Dg

Руководство разработчика

Виджетная заготовкаРаботу над собственным виджетом можно начать со следующей заготовки:

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xmlns:widget="http://wdgt.yandex.ru/ns/" > <head>

<!-- Сделайте описание виджета: -->

<!-- Добавьте свойства виджета. --> <!-- Для загрузки виджета необходимо указать название: --> <meta name="title" content="Название виджета" /> <!-- Для добавления в каталог виджетов необходимо добавить описание: --> <meta name="description" content="Виджет предназначен для..." /> <meta name="" content="" /> <meta name="" content="" />

<!-- Если виджет является серверным, укажите адрес, с которого будет загружаться тело виджета, в свойстве src --> <meta name="src" content="http://example.com/mywidget.html" />

<!-- Добавьте пользовательские настройки. Если виджет в них не нуждается, просто пропустите эту секцию --> <widget:preferences> <preference name="" type="" /> <preference name="" type="" /> </widget:preferences>

<!-- Если планируется использование виджетного JS API, подключите соответствующую библиотеку (подробнее см. "Справочник по API")--> <script type="text/javascript" src="http://img.yandex.net/webwidgets/1/WidgetApi.js"> </script>

<!-- Подключите таблицы стилей и скрипты (если необходимо) --> <link rel="" type="" href="" /> <script type="" src="" />

</head> <body> <!-- Если виджет является автономным, поместите тело виджета в этот же файл. --> </body></html>

См. такжеКак создать виджет с нуля?Свойства виджетаНастройки виджетаАвтономные и серверные виджеты

Яндекс.Виджеты Руководство разработчика

19

Page 20: Yandex Widgets Dg

Предметный указатель

#<head> 12, 15, 16<preference> 16<widget:preferences> 16, 17

AAJAX 6

Bbody 9

Ccontent 15CSS 6

DdefaultValue 17description 8, 12, 16

FFlash 6

Hheight 16HTML 6

JJavaScript 6

Llabel 17

Mmeta 15

Nname 15, 17

Ooption 18

Ppreference 17

Ssrc 8–10, 12, 16

Ttask 12, 14title 12, 16titleURL 16

type 17

Vvalue 18

Wwidget 5widget:preferences 17

Аавтономные 8автономным 8

Ввиджет 4, 5виджетах 6виджеты 8

Мметаданные 15

Ппараметры 16

Ссерверные 8серверным 8

Шшаблон 6, 19

ЯЯндекс 5Яндекс.Виджетов 4, 6Яндекс.Виджеты 4–6Яндекса 11

Яндекс.Виджеты Руководство разработчика

Page 21: Yandex Widgets Dg

Яндекс.ВиджетыРуководство разработчика

25.06.2009