Chapter 7   Tag Swapper Tags


This chapter discusses the tag swapper tags used by the Mobile Access Pack server components. These tags are used in the template files to dynamically generate content. That is, the tags provide the method to insert dynamic data into static template files. The value of these tags are described in the following sections.

For detailed information on usage of these tags in template files, see Chapter 3 "Desktop Template Files" and Chapter 4 "Content Provider Template Files."

The Desktop Tags

The following tags are used in the iwtDesktop component template files (see Chapter 3 "Desktop Template Files" for more information).

Table 7-1    iwtDesktop Tags

Tag	Description
[tag:iwtDesktop-fontFace1]	This tag is substituted with the font face value used by the html <font> tag
[tag:productName]	This tag is substituted with the vlue of the iwtPlatform-productName attribute value
[tag:content]	This tag is substituted with the channel or provider content
[tag:style]	These tags are substituted with the contents of style.html, banner.html, devicemenubar.html, and menubar.html template files respectively
[tag:banner]
[tag:devicemenubar]
[tag:menubar]
[tag:title]	These tags are substituted with the channel title and description respectively
[tag:description]
[tag:links]	This contains the links to the providers on the home page for WML and cHTML clients
[tag:URL]	This tag is substituted with the URL
[tag:charset]	This tag is substituted with the list of available character sets
[tag:charsetchoices]	This tag is substituted with the list of character sets available for the specified clientType. It gets its value from the charsetChoices.template file
[tag:semiColonSelectedList]	This tag is used to display the user defined selections as checked when the user selects the Contens page. The list of selected options are delimited by a semicolon
[tag:noCache]	See Page 100 in the iPlanet Portal Server 3.0 Programmer's Reference Guide for a description of these tags. These tags are substituted with the content for noCache.html and openFrontPage.js template files respectively
[tag:openFrontPage]
[tag:openContentPage]	This tag displays the page to select channels for the mobile device. This uses the content in the openContentPage.js file in the /etc/opt/SUNWips/desktop/<locale>/iwtDesktop/html directory
[tag:openLayoutPage]	This tag displays the page to arrange the content layout on the mobile device. This uses thecontent in the openLayoutPage.js file in the /etc/opt/SUNWips/desktop/<locale>/iwtDesktop/html directory
[tag:openConfigurationPage]	This tag displays the page to add or remove mobile devices from the user's desktop. This uses the content in the openConfigurationPage.js file in the /etc/opt/SUNWips/desktop/<locale>/iwtDesktop/html directory
[tag:openClientsPage]	This tag displays the page to configure the mobile clients from the user's desktop. This uses the content in the openClientsPage.js file in the /etc/opt/SUNWips/desktop/<locale>/iwtDesktop/html directory
[tag:openOptionsPage]	This tag displays the page to configure the character sets for the user's mobile device. This uses the content in the openOptionsPage.js file in the /etc/opt/SUNWips/desktop/<locale>/iwtDesktop/html directory
[tag:provider]	This is substituted with the channel name. It is used in INPUT, CARD and OPTION tags when the name has to be used for the value or the name of the tag
[tag:providerCount]	This tag keeps a count of the number of channels selected for display by the user. This is used in the SELECT tag for organizing the providerList. This is used in the Layout page to set the table height
[tag:providerName]	This tag is substituted with the name of the channel and is used in the OPTION tag
[tag:providerSize]	This contains the number of providers and is used in a SELECT tag for providerList to size the selection box
[tag:providerOptions]	This tag gets its value from the providerOption.template file. This contains the list of OPTION tags for providers used in SELECT tag for providerList
[tag:client]	It is substituted with the clientType (in WML). It is used in INPUT and OPTION tags for the options, content, and layout providers
[tag:clientName]	This tag is substituted with the given name of the selected clientType (such as Nokia)
[tag:clientType]	This tag is substituted with the type of client (html, chtml, or wml). It is used in INPUT and OPTION tags
[tag:clientSize]	This sets the size of a SELECT tag (selection box) based on the number of clients
[tag:clientOptions]	This tag gets its value from clientOption.template file. It contains the list of OPTION tags for clients used in a SELECT tag
[tag:availableClients]	This tag is substituted with the list of available clients
[tag:selectClients]	This tag is substituted with the list of clients selected by the user
[tag:checked]	This tag is substituted with the value in the checked.template file
[tag:selected]	This tag gets its value from the selected.template file and indicates whether or not a selection has been made
[tag:accesskey-no]	This contains the numeric entity for the numeric emoji characters used in cHTML. It gets its value from the accesskey.template file
[tag:front_help]	This tag is substituted with the path to the help file for the home page
[tag:prov_help]	This tag is substituted with the provider specific help file. It gets its value from the provHelpLink.template file
[tag:help_link]	This is substituted with the path to the client specific help file
[tag:changePageURL]	This is substituted with the path to the file to go or change to
[tag:textMsg]	This is substituted with the text message
[tag:accesskey-no]	This is substituted with the numeric entity for the numeric emoji characters used for cHTML clients

The Calendar Provider Tags

The following tags are used in the iwtCalendarProvider template files (see "The Calendar Provider Template Files" for more information).

Table 7-2    iwtCalendarProvider Tags

Tag	Description
[tag:calendar-display-client-uri]	This tag is substituted with the Single Sign On URL to the user's calendar client
[tag:calendar-display-client-sessionid]	This tag is substituted with the user's session id
[tag:dayView]	This tag is substituted with the checkbox for choosing day view in the edit calendar page
[tag:calendar-display-dayView-event-startHourOfDay0]	This tag is used for displaying calendar events or appointment data
[tag:calendar-display-dayView-event-startHourOfDay1]	This tag is used for displaying calendar events or appointment data
[tag:calendar-display-dayView-event-startHour0]	This tag is used for displaying calendar events or appointment data
[tag:calendar-display-dayView-event-endHourOfDay0]	This tag is used for displaying calendar events or appointment data
[tag:calendar-display-dayView-event-endHourOfDay1]	This tag is used for displaying calendar events or appointment data
[tag:calendar-display-dayView-event-endHour0]	This tag is used for displaying calendar events or appointment data
[tag:calendar-display-dayView-event-startHour1]	This tag is substituted with the event start hour
[tag:calendar-display-dayView-event-startMinute]	This tag is substituted with the event start minute
[tag:calendar-display-dayView-event-startAmPm]	This tag is substituted with the event start time as `am' or `pm'
[tag:calendar-display-dayView-event-endHour1]	This tag is substituted with the event end hour
[tag:calendar-display-dayView-event-endMinute]	This tag is substituted with the event end minute
[tag:calendar-display-dayView-event-endAmPm]	This tag is substituted with the event end time as `am' or `pm'
[tag:calendar-display-dayView-event-location]	This tag is substituted with the location of the event
[tag:calendar-display-dayView-event-summary]	This tag is substituted with the summary text of the event
[tag:calendar-display-dayView-event-description]	This tag is substituted with the description text of the event
[tag:calendar-display-dayView-event-allDay]	This tag is substituted with the event marked as an all day event
[tag:calendar-display-dayView-dayOfWeek]	This tag is substituted with the day of the week
[tag:calendar-display-dayView-month]	This tag is substituted with the month
[tag:calendar-display-dayView-day]	This tag is substituted with the day
[tag:calendar-display-dayView-year]	This tag is substituted with the year
[tag:calendar-display-dayView-eventList]	This tag is substituted with the events with all of their information retrieved from display-dayView-event.template file
[tag:calendar-display-error]	This tag is substituted with the error message
[tag:calendar-display-summary-events]	This tag is substituted with the summary of the events
[tag:weekView]	This tag is substituted with the checkbox for choosing week view in the edit calendar page
[tag:calendar-display-weekView-event-allDay]	This tag is substituted with the event marked as an all day event
[tag:calendar-display-weekView-event-startHourOfDay0]	This tag is substituted with the 0 based 24-hour clock
[tag:calendar-display-weekView-event-startHourOfDay1]	This tag is substituted with the 1 based 24-hour clock
[tag:calendar-display-weekView-event-startHour0]	This tag is substituted with the 0 based 12-hour clock
[tag:calendar-display-weekView-event-endHourOfDay0]	This tag is substituted with the 0 based 24-hour clock
[tag:calendar-display-weekView-event-endHourOfDay1]	This tag is substituted with the 1 based 24-hour clock
[tag:calendar-display-weekView-event-endHour0]	This tag is substituted with the 0 based 12-hour clock
[tag:calendar-display-weekView-event-startHour1]	This tag is substituted with the event start hour
[tag:calendar-display-weekView-event-startMinute]	This tag is substituted with the event's start minute
[tag:calendar-display-weekView-event-endHour1]	This tag is substituted with the event's end hour
[tag:calendar-display-weekView-event-endMinute]	This tag is substituted with the event's end minute
[tag:calendar-display-weekView-event-startAmPm]	This tag is substituted with the event's start time as am or pm
[tag:calendar-display-weekView-event-endAmPm]	This tag is substituted with the event's end time as am or pm
[tag:calendar-display-weekView-event-summary]	This tag is substituted with the summary text of the event
[tag:calendar-display-weekView-dayOfWeek0] - [tag:calendar-display-weekView-dayOfWeek6]	This tag is substituted with the day of the week where 0 refers to Monday and so forth
[tag:calendar-display-weekView-day0] - [tag:calendar-display-weekView-day6]	This tag is substituted with the date in the week where day0 refers to 1 and so forth
[tag:calendar-display-weekView-eventList0] - [tag:calendar-display-weekView-eventList5]	This tag is substituted with the events scheduled for the corresponding date (see [tag:calendar-display-weekView-dayOfWeek0] - [tag:calendar-display-weekView-dayOfWeek6]. It gets its value from display-weekView-event.template file
[tag:calendar-display-summary]	This tag is a wrapper for summary view
[tag:calendar-display-dayView]	This tag is a wrapper for day view
[tag:calendar-display-weekView]	This tag is a wrapper for week view
[tag:calendar-display-clientURL]	This tag is substituted with the actual calendar client url
[tag:calendarServerName]	This tag is substituted with the input box to enter port number for calendar server in the edit calendar page (see )
[tag:calendarServerPort]	This tag is substituted with the input box to enter port number for calendar server in the edit calendar page (see )
[tag:calendarUserName]	This tag is substituted with the input box in the edit calendar page to enter user name required for calendar server (see )
[tag:calendarUserPassword]	This tag is substituted with the input box in the edit calendar page to enter user password required for calendar server (see )

The Mail Provider Tags

The tags discussed in Table 7-3 are used in the iwtMailProvider template files (see "The Mail Provider Template Files" for more information).

Table 7-3    iwtMailProvider Tags

Tag	Description
[tag:clientURL]	This tag is substituted with the URL of the mail client
[tag:clientPort]	This tag is substituted with the mail client port number
[tag:mail-display-clientURL-uri]	This tag is substituted with the Single Sign On URL to the mail client
[tag:mail-display-clientURL]	This tag is substituted with the content from the display-clientURL.template file
[tag:mail-display-error]	This tag is substituted with the error message specific to the exception received
[tag:mail-display-headers-message-clientURL]	This tag is substituted with the Single Sign on url to the mail client
[tag:mail-display-headers-message-subject]	This tag is substituted with the subject of the message header
[tag:mail-display-headers-message-mailto]	This tag is substituted with the email address of the message sender
[tag:mail-display-headers-message-name]	This tag is substituted with the name of the mail sender
[tag:mail-display-headers-message-cbgc]	This tag is substituted with the background color
[tag:mail-display-headers-message-date]	This tag is substituted with the date the message was sent
[tag:mail-display-headers-message-status]	This tag is substituted with the status of the message as read or unread
[tag:mail-display-headers-subject]	This tag is substituted with the localized string for the heading (subject)
[tag:mail-display-headers-from]	This tag is substituted with the localized string for the heading (from)
[tag:mail-display-headers-date]	This tag is substituted with the localized string for the heading (date)
[tag:mail-display-headers-status]	This tag is substituted with the localized string for the heading (status)
[tag:mail-display-headers-messageList]	This tag is substituted with the content from the display-headers-message.template file
[tag:mail-display-summary-unread]	This tag is substituted with the number of unread messages
[tag:mail-display-summary-total]	This tag is substituted with the total number of messages
[tag:mail-display-summary]	This tag is substituted with the content from the display-summary.template file
[tag:mail-display-headers]	This tag is substituted with the content from the display-headers.template file
[tag:displayHeadersChecked]	This tag indicates whether displayHeaders checkbox is checked (see )
[tag:numberHeaders]	This tag is substituted with the number of message headers to be displayed on the user's desktop (see )
[tag:topSelected]	This tag is substituted with the user's message sort order preference if most recent is to be at the top of the inbox (see )
[tag:topString]	This tag is substituted with the localized string for "most recent at top"(see )
[tag:bottomSelected]	This tag is substituted with the user's message sort order preference if most recent is to be at the bottom of the inbox (see )
[tag:bottomString]	This tag is substituted with the localized string for "most recent at bottom" (see )
[tag:IMAPServerName]	This tag is substituted with the IMAP server name (see )
[tag:IMAPUserId]	This tag is substituted with the user's user id (see )
[tag:IMAPPassword]	This tag is substituted with the user's password see )
[tag:changeUserInfoChecked]	This tag indicates whether or not to update the user's mail server information in the user's info channel settings
[tag:msgCopyInSentChecked]	This tag indicates whether or not to place a copy of the message in sent mail (see )
[tag:signature]	This tag is substituted with the user's signature file (see )
[tag:preset1] to [tag:preset9]	These tags are substituted with the appropriate predefined messages (see )

The Address Book Provider Tags

The tags discussed in Table 7-4 are used in the iwtAddressBookProvider template files (see "The Address Book Provider Template Files" for more information).

Table 7-4    iwtAddressBookProvider Tags

Tag	Description
[tag:ab-display-clientURL-appURL]	This tag is substitued with the actual URL to the address book client
[tag:ab-display-entry-list]	This tag gets all the address book entries for the user in the format specified in display-entry.template file
[tag:ab-display-entry-cbgc]	This tag contains the background color of the channel
[tag:ab-display-entry-firstname]	This tag is substitued with the first name of the user
[tag:ab-display-entry-lastname]	This tag is substitued with the last name of the user
[tag:ab-display-entry-email]	This tag is substitued with the email address of the user
[tag:ab-display-entry-email-link]	This tag is substitued with the email address of the user as a link. If an email address is not specified, then the message 'Email not specified' is displayed
[tag:ab-display-error]	This tag is substitued with the error message
[tag:ab-display-summary-entries]	This tag is substitued with the number of address book entries for the user
[tag:ab-display-summary]	This tag is substitued with the address book summary for the user. The content for this is retrieved from display-summary.template file (see page 50).
[tag:ab-display-entries]	This tag is substitued with the address book entries for the user. The content for this is retrieved from display-entries.template file (see page 51)
[tag:ab-display-clientURL]	This tag is substitued with the URL to the address book application on the mobile device. The contents for this come from display-clientURL.template file (see page 50)
[tag:iwtAddressBookProvider-displayEntries]	This tag indicates whether to display address book entries in the address book channel, or to just display the summary. Its value is retrieved from the 'Display entries' checkbox in the edit address book page (see )
[tag:iwtAddressBookProvider-numEntries]	This tag indicates the number of address book entries the user has selected to be displayed on the address book channel. Its value comes from the 'Number of entries' input box in the edit address book page (see )
[tag:iwtAddressBookProvider-isLnSelected]	This tag indicates whether sorting is to be done on the last name for the address book entries to be displayed. Its value comes from the 'Sort By' list in the edit address book page (see )
[tag:iwtAddressBookProvider-isFnSelected]	This tag indicates whether sorting is to be done on the first name for the address book entries to be displayed. Its value comes from the 'Sort By' list in the edit address book page (see )
[tag:iwtAddressBookProvider-isNoSorting]	This tag indicates that no specific choice is made for sorting the address book entries by
[tag:iwtAddressBookProvider-isUpSelected]	This tag indicates whether ascending sorting order has been selected for the display of address book entries. Its value comes from the 'Sort Order' list in the edit address book page (see )
[tag:iwtAddressBookProvider-isDownSelected]	This tag indicates whether the decending sorting order has been selected for the display of address book entries. Its value comes from the 'Sort Order' list in the edit address book page (see )
[tag:iwtAddressBookProvider-IMAPUserId]	This tag is substituted with the user id of the user whose address book is to be retrieved. This is used to authenticate the user against the IMAP server before the address book for the user can be retrieved
[tag:iwtAddressBookProvider-IMAPPassword]	This tag is substituted with the password corresponding to the IMAP user id. It is used to authenticate the user against the IMAP server before the address book for the user can be retrieved

The Wireless Personal Note Provider Tags

The tags discussed in Table 7-5 are used only in the iwtPersonalNoteProvider template files (see "The Wireless Personal Notes Provider Template Files" for more information).

Table 7-5    iwtPersonalNoteProvider Tags

Tag	Description
[tag:noteCount]	This tag contains an attribute that tracks the number of personal notes that are editable. This value is used by the WirelessPersonalNoteProvider.processEdit() method.
[tag:noteList]	This tag is substituted with the editable personal note textboxes.
[tag:nameId]	This tag tracks which personal note to edit.
[tag:removeId]	This tag tracks which personal note to remove.
[tag:tableData]	This tag is substituted with all the evaluated content from the table data wrapper logic (see page 54). This includes the personal note content which typically contains rows of data.
[tag:pnote]	This tag is substituted with the personal note content.
[tag:bgColor]	This tag is substituted with the background color. This value is retrieved from both the darkColor.template and lightColor.template files and this value alternates between the darkColor and the lightColor beginning with the lightColor.
[tag:textColor]	This tag is substituted with the text color retrieved from the textColor.template file.

The PostIt Note Provider Tags

The tags discussed in Table 7-6 are used in the iwtPostItProvider template files (see "The PostIt Provider Template Files" for more information).

Table 7-6    PostIt Note Provider Tags

Tag	Description
[tag:note]	This tag is substituted with the provider or channel content.

The Wireless URLScraper Provider Tags

The tags discussed in Table 7-7 are used in the iwtwirelssURLScraperProvider template files for WML clients (see "The Wireless URL Scraper Provider Template Files" for more information).

Table 7-7    iwtWirelessURL Scraper Tags

Tag	Description
[tag:wirelessurlscraper-linkurl]	This tag is substituted with the link to the URL.

The User Information Provider Tags

The tags discussed in Table 3-8 are used only in the iwtUserInfoProvider template files (see "The UserInfo Provider Template Files" for more information).

Table 7-8    iwtUserInfoProvider Tags

Tag	Description
[tag:iwtUserInfoProvider-firstName]	This tag is substituted with the first name of the user for the user information channel.
[tag:iwtUserInfoProvider-lastName]	This tag is substituted with the last name of the user for the user information channel.
[tag:iwtUserInfoProvider-greeting]	This tag is substituted with the greeting for the user.
[tag:timezoneList]	This tag is substituted with the user's timezone.
[tag:currentDate]	This tag is substituted with the current date.
[tag:timeLeft]	This tag is substituted with the amount of time left in the user's session before the session expires.
[tag:maxIdle]	This tag is substituted with the configured maximum amount of time that the user's session is allowed to be idle before the session expires.
[tag:iwtUser-IMAPServerName]	This tag is substituted with the IMAP server name of the user.
[tag:iwtUser-SMTPServerName]	This tag is substituted with the SMTP server name of the user.
[tag:iwtUser-IMAPUserId]	This tag is substituted with the IMAP server user id of the user.
[tag:iwtUser-IMAPPassword]	This tag is substituted with the IMAP server password of the user.
[tag:localeList]	This tag is substituted with the list of available locales for the user.
[tag:passwordHandler]	This tag encrypts the user's password.

The Bookmark Provider Tags

The tag swapper tags discussed in Table 7-9 are used in the iwtBookmarkProvider template files (see "The Wireless Bookmarks Provider Template Files" for more information).

Table 7-9    iwtBookmarkProvider tags

Tag	Description
[tag:bookmarks]	This tag is substituted with the bookmark provider content which typically includes bookmarks to URL's.
[tag:resourceCount]	This attribute tracks the number of resources or bookmarks that are editable. This value is used by the BookMarkProvider.processEdit() method.
[tag:resourceList]	This tag is substituted with the editable resources or bookmarks textboxes. One textbox is populated with the resource name and the other textbox is populated with the resource location.
[tag:link]	This tag is substituted with the URL location.
[tag:name]	This tag is substituted with the name of the resource or the value of the html <title> tag.