Начало работы: API gadgets.*.

Добро пожаловать в API гаджетов!

Это руководство разработчика основано на версии gadgets.* API JavaScript гаджетов. API гаджетов был "перемещен" в пространство имен JavaScript gadgets.*. Это делает API удобнее для программирования и поддержки. Узнать больше об API gadgets.* можно в справочной информации здесь. API gadgets.* значительно перекрывается с устаревшим API гаджетов, но есть и важные отличия.

На сегодня только несколько контейнеров (контейнер – это сайт или приложение, выполняющее гаджет) поддерживает gadgets.* API. Список контейнеров, поддерживающих gadgets.* APIСписок контейнеров OpenSocial. Некоторые старые контейнеры поддерживают только устаревший API гаджетов, поэтому обязательно проверьте в документации контейнера, какие API поддерживаются. Узнать больше о различных типах гаджетов и о том, где они работают можно в Обзоре API гаджетов.

Все контейнеры поддерживают старый API независимо от поддержки API gadgets.*. Но API gadgets.* предлагает много новых функций, недоступных в старом API, поэтому при возможности следует использовать его.

Это руководство разработчика предназначено для тех, кто хочет использовать API гаджетов для создания гаджетов. Гаджеты настолько легко создавать, что с них вполне можно начинать изучение веб-программирования.

Содержание

  1. "Hello, World"
  2. Как устроен гаджет?
  3. Дальнейшие действия

"Hello, World"

Простейший гаджет – это всего пара строк кода. В следующем гаджете появляется надпись "Hello, world!":

<?xml version="1.0" encoding="UTF-8" ?> 
<Module>
<ModulePrefs title="hello world example" />
<Content type="html">
<![CDATA[ Hello, world! ]]> </Content>
</Module>

В примере "Hello, World" следует обратить внимание на следующее.

  • Спецификация гаджетов написана на языке XML. XML-файл обычно начинается с первой строки. Она должна идти первой в файле.
  • Тег <Module> означает, что этот файл XML содержит гаджет.
  • Тег <ModulePrefs> содержит сведения о гаджете, например его заголовок, описание, автора и другие дополнительные сведения.
  • Строка <Content type="html"> означает, что содержание гаджета – HTML.
  • <![CDATA[ ...insert HTML here... ]]>используется для заключения HTML, если тип содержания гаджета – html. Он сообщает анализатору гаджета о том, что текст в разделе CDATA не должен восприниматься как XML. В разделе CDATA обычно содержится HTML и JavaScript.
  • </Content> означает конец раздела Content.
  • </Module> означает конец раздела определения гаджета.

Как устроен гаджет?

API гаджетов состоит из нескольких простых блоков: XML, HTML и JavaScript. Для начала необходимо получить базовое представление о HTML. Мы научим вас всему, что нужно знать об XML, чтобы создавать гаджеты. Затем, по мере того, как вы начнете создавать более сложные гаджеты, вам, возможно, захочется изучить JavaScript, если вы все еще с ним не знакомы.

XML – это язык разметки общего назначения. Он описывает структурированные данные так, чтобы этот формат могли прочесть и освоить как люди, так и компьютеры.

XML – язык, применяемый при составлении спецификаций к гаджетам. Гаджет – это просто XML-файл, размещенный где-либо в Интернете, где Google может его обнаружить. Файл XML, определяющий гаджет, содержит инструкции о том, как обрабатывать и выводить гаджет. Файл XML может содержать все данные и код гаджета. Кроме того, он может иметь ссылки (URL), позволяющие найти остальные элементы.

HTML – это язык разметки для форматирования страниц в Интернете. Статическое содержание гаджета обычно пишется на HTML. HTML похож на XML, но он используется для форматирования веб-документов, а не для описания структурированных данных.

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

Дальнейшие действия

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

Более общие сведения о программировании гаджетов можно найти в разделе Создание собственных гаджетов. Оттуда можно отправиться в Основные принципы разработки или обратно на главную страницу документации, где есть обзор разделов и тем.

В начало