Themes Developer's Guide
Themes API lets you create custom designs for iGoogle Portal, giving millions of users tools to further personalize their homepage. Themes are dynamic designs-they can change throughout the day to reveal a visual storyline, message, or anything else.
- What is a theme?
- Creating and testing themes
- Creating a dynamic theme
- Submitting a theme
- Updating a theme
What is a theme?
A theme is a custom design for the iGoogle Portal page. You define a theme in a basic XML file that contains key-value pairs for iGoogle Portal page attributes, such as background images. A theme can be as simple as a simple background image, or it can include multiple images and dynamic behavior.
A theme has one or more skins. A skin specifies a look and feel for the attributes you want to include in your theme, creating a single design for the iGoogle Portal page. A theme with multiple skins is a dynamic theme, changing the iGoogle Portal page's design depending on the time of day.
Each skin is represented in the theme XML file by a different
ConfigMap (configuration map). A theme is essentially a collection of configuration maps.
Here is a simple example that illustrates the basic syntax of the theme XML file. Note that skins are defined within
<ConfigMap> tags. A theme can define multiple skins, and each skin is defined within a
<ConfigMap> section. A theme needs at least two
<ConfigMap> sections: one for the theme metadata (containing
<Meta> tags); another for the design attributes (containing
<Attribute> tags) for at least one skin.
Here is a simple example that illustrates the basic syntax of a theme XML file.
<?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">email@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>
Creating and testing themes
You can write a theme XML file using any text editor.
To test a theme, you must host the XML file and theme images on a public server. There are few options available :
- You can use github.com to host XML source and images of your theme and it's free.
- Other option available from Google which work for theme hosting is Google App Engine
Please make sure you use correct mime type for text files & images
Once your theme resources are hosted, you can verify images and xml url entering it into browser.
Creating a dynamic theme
Remember, the background image can all change throughout the day based on time of day or day of week. Feel free to create as many designs as you like (note that changes during hours at night are not seen often, and having too many images may cause users to miss a few if they don’t visit often).
When you have a dynamic theme, you create different skins for different time periods or day-of-week. Every skin must be fully qualified--that is, you must define all attributes for every skin. You use the
A Time-of-day Example
<ConfigMap type="Skin"> <Trait name="TimeOfDay">12am-1am</Trait> ...attributes... </ConfigMap> <ConfigMap type="Skin"> <Trait name="TimeOfDay">1am-2am</Trait> ...attributes... </ConfigMap> ...
Valid time ranges are from 12am - 12am. If the end time is before the start time, it will cause a submit-time error. For example, suppose that you want to specify a time span from 11pm-5am. This time span would be invalid. To make it work, you would have to split it up into two
Traits, one with
TimeOfDay from 11pm-12am, and another with
TimeOfDay from 12am-5am. You can also refer to the Ocean Theme as an example.
A Day-of-week Example
<ConfigMap type="Skin"> <Trait name="DayOfWeek">sun</Trait> ...attributes... </ConfigMap> <Trait name="DayOfWeek">mon</Trait> ...attributes... </ConfigMap> ...
DayOfWeek values are:
sun, mon, tue, wed, thu, fri, sat You can also refer to the Planets Theme as an example.
Submitting a Theme
You can use the Themes API to create simple designs for yourself and your friends. However, unless a theme is in the iGoogle Portal themes directory, no one can apply it. To share your theme with a wider audience and make it possible for users to persistently apply your theme to iGoogle Portal, you must submit it to the iGoogle Portal themes directory. For a theme to be included in the iGoogle Portal themes directory, it must be a compelling, polished, tested design that conforms to the guidelines given in the program policy. You must also include all of the metadata fields and ensure that all images used in the theme are publicly accessible.
Once your theme is ready, you can submit it here. When iGoogle Portal accepts your theme then includes it in the Themes directory.
If you have problems submitting your theme, make sure that all of the syntax is correct and that there are no blank lines in your themes XML file. If you have any questions or feedback, please contact us.
Updating a theme
If you want to make changes to a theme you've already submitted, just submit the theme again using the same url and it will be updated in about 1-2 weeks.
Back to top