Sun ONE logo     Previous     Contents     Index     Next     
Sun ONE Portal Server 6.0 Desktop Customization Guide



Appendix A       Desktop Template and Tag Reference


This appendix describes the Desktop template files and serves as a reference to the tags found in these templates.

This appendix contains the following sections:

Overview of Desktop Templates and Tags

Sun™ ONE Portal Server uses two types of files for displaying Desktop channels and pages: JavaServer Pages™ (JSP™) and template files. JavaServer Pages are the preferred way of displaying the Desktop. The Desktop templates were used in iPlanet™ Portal Server 3.0 and are included for backward compatibility only. This appendix describes only the Desktop templates. See Appendix C "JavaServer Pages Reference" for information about JavaServer Pages.

If you choose to install the sample portal, the installer locates the JSP and template files in the /etc/opt/SUNWps/desktop/default directory.

The Desktop Type attribute in the Desktop attributes page of the iPlanet™ Directory Server Access Management Edition administration console specifies from what subdirectory to retrieve either the JSP or template files for the Desktop. The default for this attribute is default, meaning the default subdirectory.

How the Desktop Template Tags Work

A template produces a channel, page, or table. The tags that are embedded in a template at run-time are swapped out for real values. For example, the [tag:netmailSettings] tag swaps in a partial HTML template that has mail server information. The [tag:fontFace] tag swaps in the value of the font that the user has chosen on the Theme page. The [tag:switchColumns] tag swaps in the switchColumns.js template, a JavaScript™ template that lets users change how the columns are displayed on their Desktops.

A tag that swaps in a template gets that template from the same directory if the template exists in that directory. If the template does not exist in that directory, the template is gotten from the next higher directory. The top-level directory contains tags that are used by different channels.

Desktop Templates and Tag Reference

The templates described in this appendix are in the following directories, beneath the /etc/opt/SUNWps/desktop/default subdirectory:

Each table has two columns. The first column gives the name of the template with a brief description; the second column lists all the tags found in that template; each tag also has a brief description.



Note The names of the Desktop templates and tags have changed. The static URL tags like [surl:/desktop/images/nothing.gif] or [surl:/desktop/tabs/images/tabNotch.gif] refer to .gif files found in the default directory /opt/SUNWps/web-apps/https-servername/portal/desktop, where servername is the full server name. If during installation you defined the static installation location differently, look in that directory for these .gif files.




Table A-1    App Template Subdirectory

App Template and Description

Tag Name and Description

display.template - Contains the JavaScript code that launches the windows that the HTML applications show up in.

 

[tag:apps] - Replaced with the application content

 


Table A-2    Bookmark Template Subdirectory 

Bookmark Template and Description

Tag Name and Description

display.template - Contains JavaScript code for the Bookmark provider to open new windows with the URLs typed in and do the correct URL http:// prepending. Also contains a small bit of formatting for the URL entry box.

 

[tag:windowOption] - JavaScript variable default for launching Bookmark windows (taken from prefs)

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:bookmarks] - List of bookmark links

 

edit.template - Contains the formatting for the Edit page for the Bookmark provider.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:resourceCount] - Number of bookmarks

[tag:resourceName] - Name of the bookmark

[tag:resourceURL] - URL of the bookmark

[tag:resourceList] - Checkable list of bookmarks for Edit page in table format

[tag:windowOptions] - Default for checkboxes of how the bookmark should be opened (new window, existing window, and so on)

 


Table A-3    Error Template Subdirectory  

Bookmark Template and Description

Tag Name and Description

banner.template - The banner across the top of the Desktop pages.

 

[surl:/images/spacer.gif] - Used to space gifs or channels

[surl:/images/productName.gif] - Logo gif of the product name

[surl:/images/blueBullet.gif] - Blue button to denote Home, Help, Logout, and so on

[tag:staticContent] - Directory you defined for the deployment URI during installation.

[tag:localeString] - Directory designation for chosen locale

[surl:/desktop/images/nothing.gif] - Used to space gifs or channels

 

banner-nocontext.template

 

[surl:/images/spacer.gif] - Used to space gifs or channels

[surl:/images/productName.gif] - Logo gif of the product name

[surl:/docs/en/desktop/usedesk.htm] - Help link for Desktop

[surl:/images/blueBullet.gif] - Blue button to denote Home, Help, Logout, and so on

[surl:/desktop/images/nothing.gif] - Used to space gifs or channels

 

error.template

 

[tag:noCache] - Inserts noCache.template template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template [tag:banner] - Inserts banner.template into this template

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:lastChannelName] - Name of last channel

[tag:staticContent] - Directory you defined for the deployment URI during installation.

[tag:localeString] - Directory designation for chosen locale

[tag:stackTrace] - Produces a stack trace

[tag:productName] - Product name

 

error-nocontext.template

 

[tag:noCache] - Inserts noCache.template template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template into this template

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[surl:/docs/en/desktop/usedesk.htm] - Help link for Desktop

[surl:/docs/en/desktop/fdesktop.htm] - Help link for frames on the Desktop

[tag:stackTrace] - Produces a stack trace

[tag:productName] - Product name

 


Table A-4    Login Template Subdirectory 

Login Template and Description

Tag Name and Description

display.html - Contains the JavaScript code that launches the login window.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:persistentCookie] - Inserts the persistent cookie template

[tag:loginHelpUrl] - Help link for login

 

display_AuthLDAP.html - Contains the JavaScript code that launches the LDAP login window.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:persistentCookie] - Inserts the persistent cookie template

[tag:loginHelpUrl] - Help link for login

 

display_AuthUnix.html - Contains the JavaScript code that launches the UNIX login window.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:persistentCookie] - Inserts the persistent cookie template

[tag:loginHelpUrl] - Help link for login

 

persistentCookie.html - Partial HTML template for remembering the user's name and password.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

 


Table A-5    MailCheck Template Subdirectory  

Mailcheck Template and Description

Tag Name and Description

display.template - Contains MailCheck provider layout content.

 

[tag:mailCheckErrorMessages] - Contains error messages if the user has not filled in correct values for the IMAP Server Name, IMAP User and IMAP Password.

[tag:mailCheckContents] - Displays the result of connecting to the given server with the user ID and password. The message could be "Mail Server is alive, 0 unread message(s)."

 

edit.template - Contains the formatting for the Edit page for the MailCheck provider.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:IMAPServerName] - Name of the IMAP mail server

[tag:IMAPUserId] - user ID

[tag:IMAPPassword] - Password for the mail server

 


Table A-6    TemplateTabContainer Template Subdirectory  

TemplateTableContainer Template and Description

Tag Name and Description

banner.template - The banner across the top of the Desktop pages, including the Edit, Layout, and Content pages.

 

[surl:/images/spacer.gif] - Used to space gifs or channels

[surl:/images/productName.gif] - Logo gif of the product name

[surl:/images/blueBullet.gif] - Blue button to denote Home, Help, Logout, and so on

[tag:frontContainerName] - Name of the front container

[tag:tabContainerName] - Name of the tab container

[tag:theme_channel] - Link to Theme decision page

[tag:help_link] - Help link for Desktop

[surl:/desktop/images/nothing.gif] - Used to space gifs or channels

 

display.template

 

[tag:noCache] - Inserts noCache.template

[tag:productName] - Product name

[surl:/desktop/css/style.css] - Inserts style template

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner]- Inserts banner.template into this template

[tag:inlineError] - Replaced with inlinError.template if error has occured

[tag:content] - Inserts content

[tag:menubar] - Inserts menubar.template into this template

 

editForm.template - Edit page template for creating and removing tabs.

 

[tag:noCache] - Inserts noCache.template

[tag:productName] - Product name

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template into this template

[tag:inlineError] - Replaced with inlinError.template if error has occured

[tag:TemplateTabContainer.editPage] - Edit tabs page

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template into this template

 

inlineError.template - HTML to show an error message.

 

[tag:errMessage] - The error message

 

makeNewTab.template - HTML used in editForm.template for creating a new tab.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:TemplateTabContainer.tabTopics] - HTML for selecting a tab topic

 

menubar.template - HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages, and containing Home, Help and Log Out links.

 

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:productName] - Product name

[tag:tabContainerName] - Name of the tab container

[tag:frontContainerName] - Name of the front container

[tag:theme_channel] - Link to Theme decision page

[tag:help_link] - Link to help from Desktop

 

noCache.template - HTML META headers to prevent browser caching of the pages.

 

(No Tags)

 

removeRenameTab.template - HTML used in editForm.template for removing and renaming existing tab(s).

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:TemplateTabContainer.tabList] - List of available tabs to remove.

 

selectedTab.template - HTML used to show the currently selected tab on the Desktop.

 

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[surl:/desktop/tabs/images/tabNotch.gif]- Used to place notch in tab

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:TemplateTabContainer.tabName] - Tab name

 

tab.template - HTML used to show the unselected tab(s) on the Desktop.

 

[tag:TemplateTabContainer.tabURL] -Tab URL (When Tab is clicked on)

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[surl:/desktop/tabs/images/tabNotch.gif]- Used to place notch in tab

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:TemplateTabContainer.tabName] - Tab name

 

tabs.template - Template of the tab provider on the Desktop with tabs on the left.

 

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[tag:tabs] - Inserts either tab.template or selectedTab.template depending on whether the current tab being drawn is selected or not

 

tabs_r.template - Template of the tab provider on the Desktop with tabs on the right.

 

[tag:tabs] - Inserts either tab.template or selectedTab.template depending on whether the current tab being drawn is selected or not

 


Table A-7    TemplateTableContainer Template Subdirectory  

TemplateTableContainer Template and Description

Tag Name and Description

arrangeProvider.js - JavaScript code used in the Desktop Layout page.

 

(No Tags)

 

banner.template - The banner across the top of the Desktop pages, including the Edit, Layout, and Content pages.

 

[surl:/images/spacer.gif] - Used to space gifs or channels

[surl:/images/productName.gif] - Logo gif of the product name

[surl:/images/blueBullet.gif] - Blue button to denote Home, Help, Logout, and so on

[tag:theme_channel] - Link to Theme decision page

[tag:frontContainerName] - Name of the front container

[tag:help_link] - Help link for Desktop

[surl:/desktop/images/nothing.gif] - Used to space gifs or channels

 

bareProviderWrapper.template - Template for each provider wrapper with no titlebar.

 

[tag:borderWidth] - Size of border (CELLPADDING) around provider HTML table

[tag:size] - Table width (WIDTH), fixed at 100%

[tag:borderColor] - Provider border color chosen by user on Theme page

[tag:bgColor] - Provider background color chosen

[tag:fontColor] - Color of font chosen

[tag:fontFace] - Font chosen

[tag:content] - Provider content

[surl:/desktop/images/nothing.gif] - Used to space gifs or channels

 

contentBarInContent.template - Content bar for template displayed when a user selects Content on any other page's Content bar.

 

[tag:toolbarRollover] - Inserts toolbarRollover.js into this template.

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[tag:frontContainerName] - Name of container

[tag:fontFace1] - Default font for the Desktop (sans-serif)

 

contentBarInLayout.template - Content bar for template displayed when user selects Layout on any other page's Content bar.

 

[tag:toolbarRollover] - Inserts toolbarRollover.js into this template.

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[tag:frontContainerName] - Name of container

[tag:fontFace1] - Default font for the Desktop (sans-serif)

 

contentLayout.template - Content bar for template displayed on the Desktop before the user selects Content or Layout.

 

[tag:toolbarRollover] - Inserts toolbarRollover.js into this template.

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[tag:frontContainerName] - Name of container

[tag:selectedName] - Name of selected tab

[tag:fontFace1] - Default font for the Desktop (sans-serif)

 

contentTemplate.template - The HTML template for the Content (Channels) page that displays when a user selects Content .

 

[tag:noCache] - Inserts noCache.template template

[tag:productName] - Product name

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:banner] - Inserts banner.template into this template

[tag:contentBarInContent] - Inserts contentBarInContent.template into this template

[tag:frontContainerName] - Name of container

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:thinProviders] - Checkbox list of available thin providers to add to desktop

[tag:wideProviders] - Checkbox list of available wide providers to add to desktop

[tag:fullProviders] - Checkbox list of available full width providers to add to desktop

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template into template

 

launchPopup.js - JavaScript code to launch a popup window.

 

(No Tags)

 

layout1Template.template - left/thin, right/wide.

 

[tag:noCache] - Inserts noCache.template into this template

[tag:productName] - Product name

[tag:arrangeProvider] - Inserts arrangeProvider.js template into this template

[tag:performSubstitution] - Inserts performSubstitution.js template

[tag:performColumnSubstitution] - Inserts performColumnSubstitution.js template

[tag:selectAll] - Inserts selectAll.js template

[tag:switchColumns] - Inserts switchColumns.js template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template into this template

[tag:contentBarInLayout] - Inserts contentBarInLayout.template into this template

[tag:frontContainerName] - Name of container

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:layoutFullTop] - Inserts layoutFullTop.template into this template

[tag:leftUserProviderList] - List that shows left column channels

[surl:/desktop/images/b_up.gif] - Icon that shows up arrow

[surl:/desktop/images/b_down.gif] - Icon that shows down arrow

[tag:rightUserProviderList] - List that shows right column channels

[tag:layoutFullBottom] - Inserts layoutFullBottom.template into this template

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template into this template

 

layout2Template.template - left/wide, right/thin.

 

[tag:noCache] - Inserts noCache.template template

[tag:productName] - Product name

[tag:arrangeProvider] - Inserts arrangeProvider.js template

[tag:performSubstitution] - Inserts performSubstitution.js template

[tag:performColumnSubstitution] - Inserts performColumnSubstitution.js template

[tag:selectAll] - Inserts selectAll.js template

[tag:switchColumns] - Inserts switchColumns.js template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template into this template

[tag:contentBarInLayout] - Inserts contentBarInLayout.template into this template

[tag:frontContainerName] - Name of container

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:layoutFullTop] - Inserts layoutFullTop.template into this template

[tag:leftUserProviderList] - List that shows left column channels

[surl:/desktop/images/b_up.gif] - Icon that shows up arrow

[surl:/desktop/images/b_down.gif] - Icon that shows down arrow

[tag:rightUserProviderList] - List that shows right column channels

[tag:layoutFullBottom] - Inserts layoutFullBottom.template template

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template into this template

 

layout3Template.template - left/thin, center/wide, right/thin.

 

[tag:noCache] - Inserts noCache.template template

[tag:productName] - Product name

[tag:arrangeProvider] - Inserts arrangeProvider.js template

[tag:performSubstitution] - Inserts performSubstitution.js template

[tag:performColumnSubstitution] - Inserts performColumnSubstitution.js template

[tag:selectAll] - Inserts selectAll.js template

[tag:switchColumns] - Inserts switchColumns.js template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template into this template

[tag:contentBarInLayout] - Inserts contentBarInLayout.template into this template

[tag:frontContainerName] - Name of container

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:layoutFullTop] - Inserts layoutFullTop.template template

[tag:leftUserProviderList] - List that shows left column channels

[surl:/desktop/images/b_up.gif] - Icon that shows up arrow

[surl:/desktop/images/b_down.gif] - Icon that shows down arrow

[surl:/desktop/images/b_right.gif] - Icon that shows arrow pointing right

[tag:centerUserProviderList] - List that shows center column channels

[tag:rightUserProviderList] - List that shows right column channels

[surl:/desktop/images/b_left.gif] - Icon that shows arrow pointing left

 

 

[tag:layoutFullBottom] - Inserts layoutFullBottom.template template

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template into template

 

layout4Template.template - left/thin, center/thin, right/thin.

 

[tag:noCache] - Inserts noCache.template template

[tag:productName] - Product name

[tag:arrangeProvider] - Inserts arrangeProvider.js template

[tag:performSubstitution] - Inserts performSubstitution.js template

[tag:performColumnSubstitution] - Inserts performColumnSubstitution.js template

[tag:selectAll] - Inserts selectAll.js template

[tag:switchColumns] - Inserts switchColumns.js template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template template

[tag:contentBarInLayout] - Inserts contentBarInLayout.template into this template

[tag:frontContainerName] - Name of container

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:layoutFullTop] - Inserts layoutFullTop.template template

[tag:leftUserProviderList] - List that shows left column channels

[surl:/desktop/images/b_up.gif] - Icon that shows up arrow

[surl:/desktop/images/b_down.gif] - Icon that shows down arrow

[surl:/desktop/images/b_right.gif] - Icon that shows arrow pointing right

[tag:centerUserProviderList] - List that shows center column channels

[surl:/desktop/images/b_left.gif] - Icon that shows arrow pointing left

[tag:rightUserProviderList] - List that shows right column channels

 

 

[tag:layoutFullBottom] - Inserts layoutFullBottom.template template

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template template

 

layoutFullBottom.template - Partial HTML template for Layout pages when the user has a full width channel available at the bottom of the layout.

 

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:fullbottomUserProviderList] - List of Full Width (Bottom) Channels to move

[surl:/desktop/images/b_up.gif] - Icon that shows up arrow

[surl:/desktop/images/b_down.gif] - Icon that shows down arrow

 

layoutFullTop.template - Partial HTML template for Layout pages when the user has a full width channel available at the top of the layout

 

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:fulltopUserProviderList] - List of Full Width (Top) Channels to move

[surl:/desktop/images/b_up.gif] - Icon that shows up arrow

[surl:/desktop/images/b_down.gif] - Icon that shows down arrow

 

menubar.template - HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages and containing Home, Help and Log Out links.

 

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:productName] - Product name

[tag:frontContainerName] - Name of container

[tag:theme_channel] - Link to Theme decision page

[tag:help_link] - Link to help from Desktop

 

minimized.template - Template of a provider when it's in its minimized state - just the title/button bar showing, no content area showing.

 

[tag:borderWidth] - Size of border (CELLPADDING) around channel (default 0)

[tag:size] - Table width (WIDTH), fixed at 100%

[tag:borderColor] - Color of border

[tag:titleBarColor] - Color of title bar

[tag:fontFace] - Default font for the Desktop (sans-serif)

[tag:title] - The title of the provider/channel

[tag:titleBarColor] - Title bar color

[tag:provider_cmds] - Inserts the channel command button links (maximize, detach, and so on)

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

 

optionsTemplate.template - Template for the Options page of the Desktop.

 

[tag:noCache] - Inserts noCache.template template

[tag:productName] - Product name

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:banner] - Inserts banner.template template

[tag:frontContainerName] - Name of container

[tag:inlineError] - Replaced with inlineError.template template if error has occured.

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:serviceTimeout] - Provider Timeout in seconds

[surl:/desktop/images/layout1.gif] - Icon for thin-wide layout

[tag:layoutOneChecked] - Makes Radio button for layout one the default.

[surl:/desktop/images/layout2.gif] - Icon for wide-thin layout

[tag:layoutTwoChecked] - Makes Radio button for layout two the default.

[surl:/desktop/images/layout3.gif] - Icon for thin-wide-thin layout

[tag:layoutThreeChecked] - Makes Radio button for layoutthree the default .

[surl:/desktop/images/layout4.gif] - Icon for thin-thin-thin layout

[tag:layoutFourChecked] - Makes Radio button for layout four the default.

[tag:desktop_url] - URL of Desktop to return to

[tag:menubar] - Inserts menubar.template template

 

performColumnSubstitution.js - JavaScript code used on the Layout page.

 

(No Tags)

 

performSubstitution.js - JavaScript code used on the Layout page.

 

(No Tags)

 

popupMenubar.template - Menubar to be used in popup windows.

 

[surl:/images/spacer.gif]- Used to space gifs or channels

[surl:/images/productName.gif]- Logo gif of Product name

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:frontContainerName] - Name of container

[tag:providerName] - Provider name

 

popupTemplate.template - Used to show provider/channel content in detatched windows. Similar use to providerWrapper.template, but not in a table structure.

 

[tag:noCache] - Inserts noCache.template template

[tag:productName] - Product name

[tag:providerTitle] - Provider/Channel title

[tag:openURLInParent] - Inserts openURLInParent.js template

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:popupMenubar] - Inserts popupMenubar.template template

[tag:providerContent] - Content of the provider

 

providerWrapper.template - Template that all providers and channels use for layout on Desktop. Defines the look of the border of the providers and channels on the screen.

 

[tag:borderWidth] - size of border (CELLPADDING) around provider HTML table

[tag:size] - Table width, fixed at 100%

[tag:borderColor] - Color of border

[tag:titleBarColor] - Color of title bar

[tag:fontFace] - Chosen font for the channels

[tag:title] - Provider title

[tag:provider_cmds] - Inserts the channel command button links (minimize, detach, and so on)

[tag:bgColor] - Background color

[tag:fontColor] - Color of chosen font for title

[tag:content] - Provider/channel content inserted here

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

 

removeProvider.js - JavaScript code used to remove a channel from the Desktop.

 

(No Tags)

 

selectAll.js - JavaScript code used on the Layout page.

 

(No Tags)

 

switchColumns.js - JavaScript code used on the Layout page.

 

(No Tags)

 

userTemplate.template - The base Desktop layout structure document. Very little in this file, as most of the content of the Desktop is swapped in during processing in the servlets.

 

[tag:noCache] - Inserts noCache.template template

[tag:launchPopup] - Inserts launchPopup.js template

[tag:detachedContent] - Provider content

[tag:productName] - Product name

[surl:/desktop/css/style.css] - Style sheet used by the Desktop for the banner and tabs templates

[tag:bulletColor] - Inserts bulletColor.js into this template

[tag:banner] - Inserts banner.template template

[tag:contentLayout] - Inserts contentLayout.template in this template

[tag:inlineError] - Replaced with inlineError.template if error has occured

[tag:fullTopContent] - Provider/channel content (HTML) inserted here

[tag:leftWidth] - Percentage of total width for left column

[tag:leftContent] - Channels for left column

[tag:centerWidth] - Percentage of total width for center column

[tag:centerContent] - Channels for center column

[tag:rightWidth] - Percentage of total width for right column

[tag:rightContent] - Channels for right column

[tag:fullBottomContent]

[tag:menubar] - Inserts menubar.template template

 


Table A-8    UserInfo Template Subdirectory  

UserInfo Template and Description

Tag Name and Description

content.template - Content page for the UserInfo provider.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:greeting] - User's greeting

[tag:cn] - User's common or full name

[tag:currentDate] - Date

[tag:timeLeft] - Time left in user's session

[tag:maxIdle] - Maximum idle time

 

edit.template - Edit page for the UserInfo provider.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:cn] - User's common or full name

[tag:greeting] - User's greeting

[tag:timezoneList] - List of timezones

[tag:localeList] - List of available locales

[tag:netmailSettings] - Inserts netmailSettings.template into this page to get the following information: IMAP server name, SMTP server name, IMAP user ID and IMAP password

[tag:passwordHandler] - Inserts passwordHandler-Membership.template (if available)to change membership password

 

netmailSettings.template - Partial template inserted into edit.template for Mail information.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

[tag:iplanet-ps-netmail-imap-server-name] - IMAP server name

[tag:iplanet-ps-netmail-smtp-server-name] - SMTP server name

[tag:iplanet-ps-netmail-imap-userid] - IMAP user ID

[tag:iplanet-ps-netmail-imap-password] - IMAP password

 

passwordHandler-Membership.template - Partial template inserted into edit.template if Membership Authentication is used, to allow the user to change their password.

 

[tag:fontFace1] - Default font for the Desktop (sans-serif)

 


Table A-9    default Template Subdirectory  

default Template and Description

Tag Name and Description

AtachCommand.template - Handles reattaching a detached channel.

 

[tag:detachAttachURL] - URL of the detached channel

desktop?action=process&provider=the container

name&the container name.channelAction=detach&the container

name.targetProvider=provider name

[tag:detachAttachIcon] - Inserts the reattach icon

[tag:detachAttachText] - Text for the alt tag for the reattach icon

[tag:providerName] - Provider name

 

banner.template - The banner across the top of the Desktop pages

 

[surl:/images/spacer.gif] - Used to space gifs or channels

[surl:/images/productName.gif] - Logo gif of the Product name

[surl:/images/blueBullet.gif] - Blue button to denote Home, Help, Logout, and so on

[tag:theme_channel] - Link to Theme decision page

[tag:frontContainerName] - Name of container

[tag:help_link] - Help link for Desktop

[surl:/desktop/images/nothing.gif] - Used to space gifs or channels

 

bulletColor.js - JavaScript code used to select and display bullet color.

 

[surl:/images/blueBullet.gif] - Blue button to denote home, help, logout,and so forth.

[surl:/images/redBullet.gif] - Red button to denote home, help, logout, or whatever has been chosen.

 

contentLayout.template - Content bar for template displayed on the Desktop before the user selects Content or Layout.

 

[tag:toolbarRollover] - Inserts toolbarRollover.js into this template.

[surl:/desktop/images/nothing.gif]- Used to space gifs or channels

[tag:frontContainerName] - Name of container

[selectedName] - Name of selected tab

[tag:fontFace1] - Default font for the Desktop (sans-serif)

 

detachCommand.template - Handles detaching a channel.

 

[tag:detachAttachURL] - URL of the channel to be detached

http://servername:port/ips/desktop?action=process&provider=the container name&the container name.channelAction=attach&the container name.targetProvider=provider name

[tag:detachAttachIcon] - Inserts the detach icon

[tag:detachAttachText] - Text for the alt tag for the detach icon

[tag:providerName] - Provider name

 

detachEditCommand.template - Handles link to the Edit page for the detached channel.

 

[tag:editURL] - URL of Edit page for this channel

[tag:editIcon] - Inserts edit icon

[tag:editTag] - Text for the alt tag for the edit icon

[tag:providerName] - Provider name

 

detachRemoveCommand.template - Handles closing or removing a detached channel.

 

[tag:removeURL] - URL of the detached channel to be removed

desktop?action=process&provider=the container name&the container name.channelAction=remove&the container name.targetProvider=provider name

[tag:removeIcon] - Inserts remove or close icon

[tag:removeText] - Text for the alt tag for the remove icon

[tag:providerName] - Provider name

 

editCommand.template - Handles link to the Edit page for this channel.

 

[tag:editURL] - URL of Edit page for this channel

http://servername:port?action=edit&provider=the edit container name&targetprovider=provider name&containerName=the container name

[tag:editIcon] - Inserts edit icon

[tag:editTag] - Text for the alt tag for the edit icon

[tag:providerName] - Provider name

 

helpHref.template - Generates the help URL for each of the channels. Displays the help contents in a new window.

 

[tag:help_link] - Help link for Desktop

[tag:help_icon] - Icon for help in channel title bar

[tag:help_tag] - Text for alt message

[tag:providerName] - Provider name

 

inlineError.template

 

[tag:errMessage] - The error message

 

menubar.template - HTML for the menubar across the bottom of the Desktop pages.

 

[tag:desktop-fontFace1] - Default font for the Desktop (sans-serif)

[tag:productName] - Product name

[tag:frontContainerName] - Name of container

[tag:theme_channel] - Link to theme page

[tag:help_link] - Help link

 

minMaximizeCommand.template - Handles minimizing and maximizing a channel.  

[tag:minMaximizeURL] - URL of channel to minimize or maximize

http://servername:port?action=process&provider=the container name&the container name.channelAction=maxmize&the container name.targetProvider=provider name

http://servername:port?action=process&provider=the container name&the container name.channelAction=minimize&the container name.targetProvider=provider name

[tag:minMaximizeIcon] - Inserts minimize /maximize icon

[tag:minMaximizeText] - Text for the alt tag for the minimize /maximize icon

[tag:providerName] - Provider Name

 

noCache.template - HTML META headers to prevent browser caching of the pages.

 

(No Tags)

 

openURLInParent.js - Javascript to open a URL in the parent window. Used in popup windows.

 

(No Tags)

 

providerCommands.template - Commands available in title bar.

 

[tag:minMaximizeCommand] - Inserts the minMaximizeCommand.template

[tag:helpCommand] - Inserts helpHref.template.

[tag:editCommand]- Inserts the editCommand.template

[tag:detachAtachCommand] - If the channel is detached, insert the detachCommand.template; if the channel is attached, then insert the attachCommand.template.

[tag:removeCommand] - Inserts the removeCommand.template

 

redirect.template

 

[tag:url] - URL of new location

 

removeCommand.template - Removes the channel.

 

[tag:removeURL] - URL of the channel to be removed

http://servername:port?action=process&provider=the container name&the container name.channelAction=remove&the container name.targetProvider=provider name

[tag:removeIcon] - Inserts the remove icon

[tag:removeText] - Text for the alt tag for the remove icon

[tag:providerName] - Provider Name

 

toolbarRollovers.js - JavaScript code use to display selection of Content or Layout by color change.

 

(No tags)

 


Previous     Contents     Index     Next     
Copyright 2002 Sun Microsystems, Inc. All rights reserved.

Last Updated August 29, 2002