IMF Developer's Guide

Theme Configuration Reference

IMF Developer's Guide » Theme Configuration

A theme configuration XML file is used to specify a set of configuration files used by IMF to change data views from within the application. Themes are given names that can be chosen by a user to see a preset set of data, usually at the same extent as the current view.

The <theme-config> element is the topmost tag of a theme configuration XML file. The elements of the theme configuration file must be enclosed in a <theme-config> element tag:

<?xml version="1.0" encoding="UTF-8"?>
<theme-config>
<!-- all your configuration stuff goes here -->
</theme-config>

For best results, and to avoid making errors when working with the configuration files, use an XML editing tool like XMLSPY to create, edit, and validate your XML against the schema for this file format. The Home Edition works well, and is free. When using a validation tool, note the the elements must appear in the sequence below.

The schema for the theme configuration XML is located at:

http://www.moximedia.com/docs/imf-aims-5.0/theme-config.xsd

Your XML documents can be validated against the schema on Moxi Media's server, or a copy of the file installed on yours. To specify that the file be validated when working with an XML editor, use the following format:

<?xml version="1.0" encoding="UTF-8"?>
<theme-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:noNamespaceSchemaLocation="http://www.moximedia.com/imf-docs-5.0/theme-config.xsd">
<!-- all your configuration stuff goes here -->
</theme-config>

Note that you can use a file location for the schema reference instead of a URL. If your configurations are in a sub-folder of the $IMF/sites directory, you could use:

<?xml version="1.0" encoding="UTF-8"?>
<theme-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:noNamespaceSchemaLocation="../../config/theme-config.xsd">
<!-- all your configuration stuff goes here -->
</theme-config>

Frequency	Elements
R+	<theme>

Frequency	Description
R1	Top level root element. Required once in all theme configuration files.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<theme-config>
  <theme name="Theme One" description="Description of theme one." site-config-xml="site-config-one.xml" same-extent="true"/>
  <theme name="Theme Two" description="Description of theme two." site-config-xml="site-config-two.xml" same-extent="true"/>
</theme-config>