Chapter 3   Desktop Template Files


On the desktop and mobile device, content is displayed through a channel and the displayed content is specific to the channel and clientType. For each supported client, client specific template files describe the presentation and the layout of the channel.

This chapter discusses the HTML, cHTML, and WML template files used to display the pages that allow the user to configure the channel and the layout of the channel on their desktop page and mobile device home page.

These files are, by default, located in /etc/opt/SUNWips/desktop/MAP/iwtDesktop, /etc/opt/SUNWips/desktop/default/iwtDesktop/html, /etc/opt/SUNWips/desktop/default/iwtDesktop/wml/, /etc/opt/SUNWips/desktop/default/iwtDesktop/chtml directories.

The Mobile Access Pack Desktop providers use the file lookup mechanism to retrieve the client specific template files.

The Front Provider Template Files

The Front Provider presents the user's desktop page and navigation links to access the graphical user interface of the other desktop providers. The Front Provider invokes the content and application providers to display client specific content in the form of channels. On an HTML device, these channels appear as table cells. On a WML device, these channels appear as links to WML cards containing the contents of the channel. The following template files provide the front page for the user.

Desktop and Mobile Devices Home Page Template Files

This page typically contains the content of the user's selected channels. The following template files enable the presentation of these channels on the user's desktop and/or mobile device home page.`

HTML Template Files

The following template files are also used to display the desktop on a HTML client:

• menubar.html - Provides the black menubar used in the user's desktop. This file replaces the menubar.html file used in the iPlanet Portal Server desktop. It uses the [tag:iwtDesktop-fontFace1] and [tag:productName] tags.

• openClientsPage.js - Contains Javascript funtions to generate target URL for the Mobile Devices page. This is invoked to navigate to the Mobile Devices page.

WML Template Files

The following template files are used to display the user's home page on a wml client.

• frontProvider.template - Provides the markup for the home page on the mobile devices (WML clients) with links to configured providers. It uses the [tag:productName], [tag:links], and [tag:content] tags.

• providerWrapper.template - Wraps the content of each channel or provider. It uses the [tag:provider], [tag:title], [tag:content], and [tag:prov_help] tags.

• linkWrapper.template - Contains links to each channel. It uses the [tag:provider] and [tag:title] tags.

• provHelpLink.template - Contains links to the help file for the channel. It uses the [tag:help_link] tag.

• frontHelpLink.template - Contains links to the help file for the Home page. It uses the [tag:help_link] tag.

• changePage.template - Contains options to change the page. It uses the [tag:changePageURL] and [tag:textMsg] tags.

• redirect.template - Contains markup to redirect the user to another URL. It uses the [tag:URL] tag.

Nokia

The files discussed in this section are located in /etc/opt/SUNWips/desktop/default/iwtDesktop/wml/Nokia directory and are customized to support display of content on the Nokia 7110 phone.

• frontProvider.template - Displays the Nokia home page (similar to the desktop on a HTML client). It uses the [tag:productName] and [tag:content] tags.

• linkWrapper.template - Provides the template that wraps the channel into an option. It uses the [tag:provider] and [tag:title] tags.

• providerWrapper.template - Wraps the content of each channel or provider in the home page of Nokia. It uses the [tag:provider], [tag:title], [tag:content], and [tag:prov_help] tags.

cHTML Template Files

The following template files are used to display the user's home page on a cHTML client.

• frontProvider.template - Provides the markup for home page on mobile devices (cHTML clients) with links to configured providers. It uses the [tag:productName], [tag:links], and [tag:content] tags.

• providerWrapper.template - Wraps the content of each channel or provider. It uses the [tag:provider], [tag:title], [tag:content], and [tag:prov_help] tags.

• linkWrapper.template - Contains links to each channel. It uses the [tag:provider] and [tag:title] tags.

• provHelpLink.template - Contains links to the help file for the channel. It uses the [tag:help_link] tag.

• frontHelpLink.template - Contains links to the help file for the Home page. It uses the [tag:help_link] tag.

• changePage.template - Contains options to change the page. It uses the [tag:changePageURL] and [tag:textMsg] tags.

• redirect.template - Contains markup to redirect the user to another URL. It uses the [tag:URL] tag.

The Client Configuration Provider Template Files

The template files discussed in this section allow the user to configure the mobile devices that they will use to access the services. The user can not perform these tasks from the mobile device and must use their desktop to specify their mobile clientType. These template files provide support for configuring multiple clientTypes.

Select Mobile Devices

HTML Template Files

• devicemenubar.html - Provides the black menubar used in the Select Mobile Devices, Add or Remove Mobile Devices, Select Channels For Display, Organize Channel Layout on Devices, and Configure Character Set for Mobile Device pages. It uses the [tag:iwtDesktop-fontFace1] and [tag:productName] tags.

• clientConfiguration.template - Provides the page for the user to select the mobile clients to be configured. It uses the [tag:noCache], [tag:openFrontPage], [tag:productName], [tag:openContentPage], [tag:openLayoutPage], [tag:openClientsPage], [tag:openOptionsPage], [tag:style], [tag:banner], [tag:devicemenubar], [tag:iwtDesktop-fontFace1], and [tag:selectClients] tags.

• clientSelect.template - Provides a list of mobile devices that the user can configure. It uses the [tag:clientSize] and [tag:clientOptions] tags.

• clientOption.template - This file is used by the [tag:clientOptions] tag in the clientSelect.template file. It provides the markup for the OPTION tag for mobile clients within the SELECT tag in the clientSelect.template file. It uses the [tag:client] and [tag:clientType] tags.

• openConfigurationPage.js - Contains Javascript funtions to generate target URL for the Add/Remove Clients page. This is invoked to navigate to the Add/Remove Clients page.

• openContentPage.js - Contains Javascript funtions to generate target URL for the client specific channels page. This is invoked to navigate to the client specific channel selection page.

• openLayoutPage.js - Contains Javascript funtions to generate target URL for the Layout page. This is invoked to navigate to the client specific content Layout page.

• openOptionsPage.js - Contains Javascript funtions to generate target URL for the Options page. This is invoked to navigate to the client specific Options page.

Add or Remove Mobile Devices

HTML Template Files

• devicemenubar.html - Provides the black menubar used in the Select Mobile Devices, Add or Remove Mobile Devices, Select Channels For Display, Organize Channel Layout on Devices, and Configure Character Set for Mobile Device pages. It uses the [tag:iwtDesktop-fontFace1] and [tag:productName] tags.

• addRemoveClients.template - Provides the page for the user to add or remove mobile clients. It uses the [tag:noCache], [tag:openFrontPage], [tag:openConfigurationPage], [tag:style], [tag:banner], [tag:devicemenubar], [tag:iwtDesktop-fontFace1], and [tag:availableClients] tags.

• checked.template - Provides the input to check the checkbox. It provides the value for the [tag:checked] tag.

• clientInput.template: Provides the markup for checkbox input that provides the clientTypes. It uses the [tag:client], [tag:clientType], and [tag:checked] tags.

The Content Provider Template Files

The template files discussed in this section provides the page that allows the user to select the channels they wish to display on their desktop and on their mobile devices. These template files define the type of content to be displayed on all supported devices.

Select Channels For Display

HTML Template Files

• devicemenubar.html - Provides the black menubar used in the Select Mobile Devices, Add or Remove Mobile Devices, Select Channels For Display, Organize Channel Layout on Devices, and Configure Character Set for Mobile Device pages. It uses the [tag:iwtDesktop-fontFace1] and [tag:productName] tags.

• contentProvider.template - Provides the page that presents the available channels for the selected mobile device. It uses the [tag:noCache], [tag:productName], [tag:openConfigurationPage], [tag:openFrontPage], [tag:style], [tag:banner], [tag:devicemenubar], [tag:client], [tag:clientName], [tag:content], [tag:iwtDesktop-fontFace1] tags.

• selectWrapperTrue.template - Provides the template that wraps the channel select option for a channel that is selected. It uses the [tag:provider], [tag:title], and [tag:description] tags.

• selectWrapperFalse.template - Provides the template that wraps the channel select option for a channel that is not selected. It uses the [tag:provider], [tag:title], and [tag:description] tags.

• optionWrapper.template - Provides the template that wraps the channel into an option. It uses the [tag:provider] and [tag:title] tags.

• providerOption.template - Provides the list of selected channel names. It uses the [tag:providerName] and [tag:title] tags.

• providerInput.template - Provides the checkbox in the available channel list. This is used to select or deselect channels. It uses the [tag:provider], [tag:checked], [tag:title], and [tag:description] tags.

• providerSelect.template - Provides the markup for SELECT tag containing providerOption. It uses the [tag:providerSize] and [tag:providerOptions] tags.

• openConfigurationPage.js - Contains Javascript funtions to generate target URL for the Select Mobile Devices page. This is invoked to navigate to the Select Mobile Devices page when the user selects the cancel button.

WML Template Files

• contentProvider.template - Provides the page that displays the list of available channels for the user. It uses the [tag:semiColonSelectedList] and [tag:content].

• selectWrapperTrue.template - Provides the template that wraps the channel select option for a channel that is selected. It uses the [tag:provider], [tag:title], and [tag:description] tags.

• selectWrapperFalse.template - Provides the template that wraps the channel select option for a channel that is not selected. It uses the [tag:provider], [tag:title], and [tag:description] tags.

• optionWrapper.template - Provides the template that wraps the channel into an option. It uses the [tag:provider] and [tag:title] tags.

Nokia

The files discussed in this section are located in /etc/opt/SUNWips/desktop/default/iwtDesktop/wml/Nokia directory and are customized to support display of content on the Nokia 7110 phone.

• contentProvider.template - Provides the page that presents the available content for Nokia and provides a list of available channels for Nokia. It uses the [tag:semiColonSelectedList] and [tag:content] tags.

• optionWrapper.template - This file provides the template that wraps the channel into an option. It uses the [tag:provider] and [tag:title] tags.

cHTML Template Files

• contentProvider.template - Provides the page that displays the list of available channels for the user. It uses the [tag:semiColonSelectedList] and [tag:content].

• selectWrapperTrue.template - Provides the template that wraps the channel select option for a channel that is selected. It uses the [tag:provider], [tag:title], and [tag:description] tags.

• selectWrapperFalse.template - Provides the template that wraps the channel select option for a channel that is not selected. It uses the [tag:provider], [tag:title], and [tag:description] tags.

• optionWrapper.template - Provides the template that wraps the channel into an option. It uses the [tag:provider] and [tag:title] tags.

The Layout Provider Template Files

The template files discussed in this section provides the mobile devices edit content page for the user to configure and customize the layout order of the channels on the user's desktop and mobile devices. These template files define the display of content on all supported devices.

Organize Channel Layout on Devices

HTML Template Files

• devicemenubar.html - This file provides the black menubar used in the Select Mobile Devices, Add or Remove Mobile Devices, Select Channels For Display, Organize Channel Layout on Devices, and Configure Character Set for Mobile Device pages. It uses the [tag:iwtDesktop-fontFace1] and [tag:productName] tags.

• layoutProvider.template - Provides the page that allows users to organize their content on their mobile devices. It uses the [tag:productName], [tag:openConfigurationPage], [tag:openFrontPage], [tag:style], [tag:banner], [tag:devicemenubar], [tag:iwtDesktop-fontFace1], and [tag:provider] tags.

• anchorWrapper.template - Provides the markup for the anchor tag. It uses the [tag:provider] and [tag:title] tags.

• openConfigurationPage.js - Contains Javascript funtions to generate target URL for the Select Mobile Devices page. This is invoked to navigate to the Select Mobile Devices page when the user selects the cancel button.

WML Template Files

• layoutProvider.template - Provides the page that allows users to organize their content on their mobile devices. It uses the [tag:content] tag.

• anchorWrapper.template - Provides the markup for the anchor tag. It uses the [tag:provider] and [tag:title] tags.

Nokia

The files discussed in this section are located in /etc/opt/SUNWips/desktop/default/iwtDesktop/wml/Nokia directory and are customized to support display of content on the Nokia 7110 phone.

• layoutProvider.template - Provides the page on the Nokia mobile device to organize the layout of the content on Nokia. It uses the [tag:content] tag.

• anchorWrapper.template - This file is used by the Nokia layoutProvider and uses the [tag:title] tag.

cHTML Template Files

• accesskey.template - Provides the numeric entity for the numeric emoji characters used in cHTML. It uses the [tag:accesskey-no] tag.

• entity1.template - entity9.template - Provides the entity for emoji character image "1" through "9" respectively. Emoji are special characters which appear in i-mode pages as small icons. In cHTML, emoji are written as an ampersand, a pound sign followed by 5 digits

• layoutProvider.template - Provides the page that allows users to organize their content on their mobile devices. It uses the [tag:providerCount] and [tag:content] tags.

• anchorWrapper.template - Provides the markup for the anchor tag. It uses the [tag:provider] and [tag:title] tags.

The Options Provider Template Files

The template files discussed in this section provides the mobile device edit options page for the user to configure the character set for their mobile devices. This can be performed from the user's desktop only.

Configure Character Set for Mobile Device

HTML Template Files

• optionsProvider.template - Provides the page that allows users to select the character set to use with their mobile device. It uses the [tag:openConfigurationPage], [tag:openFrontPage], [tag:style], [tag:banner], [tag:devicemenubar], [tag:client], [tag:iwtDesktop-fontFace1], [tag:clientName], and [tag:charsetchoices] tags.

• charsetChoices.template - Provides the drop-down list of available character sets for the user in the Options page. It uses the [tag:charset] and [tag:selected] tags.

• selected.template - Provides the input for the [tag:selected] tag in the charsetChoices.template file.

• openConfigurationPage.js - Contains Javascript funtions to generate target URL for the Select Mobile Devices page. This is invoked to navigate to the Select Mobile Devices page when the user selects the cancel button.