登录/创建账户

欢迎使用小工具 API!

该开发人员指南基于小工具 JavaScript API 的 gadgets.* 版本。小工具 API 已被“重新定义名称空间”到 gadgets.* JavaScript 名称空间中,以为反对和支持的程序提供较为简洁的 API。要了解有关 gadgets.* API 的详细信息,请参阅此处的参考文档。当 gadgets.* API 与旧的小工具 API 明显重叠时,还会有重要的不同之处。

目前,只有某些容器(容器是运行小工具的站点或应用程序)支持 gadgets.* API。要获取支持 gadgets.* API 的容器列表,请参阅 OpenSocial 容器列表。某些旧容器仅支持旧的小工具 API,所以请确保查看特定容器的文档以确定所支持的 API。要了解关于小工具的不同类型及其运行环境的详细信息,请参阅小工具 API 概述。

该开发人员指南适用于想使用小工具 API 编写小工具的人们。小工具非常容易创建,因此如果您刚接触网络编程,编写小工具是个不错的开始。

目录

“Hello, World” 小工具中包含什么? 小工具中包含什么?


“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> 标识内容部分的结束。

</Module> 标识小工具定义的结束。

小工具中包含什么?

小工具 API 包含一些简单的构建快:XML、HTML 和 JavaScript。您仅需基本了解 HTML 便可开始使用。我们将教给您编写小工具所需了解的关于 XML 的所有内容。然后,当您编写更复杂的小工具时,如果您还不熟悉 JavaScript,您可能还想了解一些 JavaScript。

XML 是常用的标记语言。它以人和计算机都能读写的方式介绍了结构化数据。

XML 是用于编写小工具规范的语言。小工具仅是一个 XML 文件(放置在互联网上 Goolge 能找到的某个位置)。指定小工具的 XML 文件包含有关如何处理和提交小工具的说明。XML 文件可包含小工具的所有数据和代码,也可以包含找到元素其他内容的位置的引用(网址)。

HTML 是用于格式化互联网上的页面的标记语言。小工具的静态内容通常是用 HTML 编写的。HTML 看起来与 XML 类似,但它用于格式化网络文档而非介绍结构化数据。

JavaScript 是可用于向小工具添加动态行为的脚本语言。 从此处去向何处 运行社交小工具的每个容器的特征都略有不同。以下是可获取一些开发社交小工具的实际经验的几处地方:

OpenSocial教程

iGoogle Sandbox 开发人员指南,包含有关为 iGoogle sandbox 开发小工具的信息。

Orkut Sandbox 开发人员指南,包含有关为 Orkut sandbox 开发小工具的信息。

有关常规小工具编程的详细信息,请转至“编写您自己的小工具”。 从那里,您可以转至“开发基础”或返回至文档主页,以获取部分和主题的概述。