Themes API Reference


This is the reference for the Themes API. Themes are implemented in XML files that contain key-value pairs for metadata and design elements.

Contents


Metadata Attributes


The top section of a themes specification lists the metadata attributes for the theme, such as the title and author:

<?xml version="1.0" encoding="UTF-8"?>
<ConfigMaps>
 <ConfigMap type="Skin">
   <Meta name="title">Android</Meta>
   <Meta name="description"> </Meta>
   <Meta name="author">iGoogle</Meta>
   <Meta name="author_email">igooglehdthemes+android@example.com</Meta>
   <Meta name="full_page_thumbnail.url">
    http://www.igoogleportal.com/docs/images/android_1920x1200_thumb.png
   </Meta>
 </ConfigMap>
 <ConfigMap type="Skin">
   <Attribute name="full_page.background_image.url">
    http://www.igoogleportal.com/docs/images/android_1920x1200_fullpage.png
   </Attribute>
 </ConfigMap>
</ConfigMaps>

A ConfigMap represents one fully-qualified skin. That is, it represents a skin with all attributes that apply to a single visual state. But the concept is actually more general than that. Each ConfigMap really just describes all Skin attributes that apply to an arbitrary set of Attributes. The "actual" skin is computed from all applicable ConfigMaps. A theme specification must minimally have two <ConfigMap> sections: one to wrap the metadata, and one to wrap the design attributes for at least one skin.

This table lists the attributes that can be included in the metadata section. You must include all metadata attributes in your theme to submit it to the iGoogle Portal Themes directory, though you can test the theme without them. If you plan to submit a theme to the iGoogle Portal Themes directory, it must be a polished, complete design that conforms to the guidelines in the program policy.

Attribute Description Type Values

title

Title displayed in the Themes directory String 0-30 characters

description

Description of the theme and what it does String 0-300 characters

author

Author’s name shown in the Themes directory String 0-50 characters

author_email

Author’s email address, used to so that Google and users can contact you. String 0-100 characters, must contain “@”

author_location

The author's geographical location, such as "Mountain View , CA, USA ". String 0-100 characters

full_page_thumbnail.url

Thumbnails are used in the themes directory to give users a preview of a theme. URL to a JPG (preferred), PNG acceptable Well-formed URL, not relative. 680(w) x 425(h).

Design Attributes


The following table lists the attributes used to define the design details for a particular skin. Strictly speaking, none of these elements is required--there is no run-time checking, in other words. However, if you plan to submit a theme to the iGoogle Portal Themes directory, it must be a polished, complete design that conforms to the guidelines in the program policy.

Within the attributes section, you can use the <Trait name="TimeOfDay">xx-xx</Trait> element to specify the time of day that a particular skin is displayed. For details, see creating a dynamic theme.

Attribute Description Type Values

full_page.background_image.url

Background image for full page theme. URL to a JPG (preferred), PNG acceptable Well-formed absolute URL, not relative. Suggested resolution: 1920x1200. Minimum resolution: 1024x768

Back to top