Appendix A Desktop Template Files

This appendix describes the Desktop template files. It contains the following sections:

Overview of Desktop Templates

Sun Java System 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. This appendix describes only the Desktop templates. See Appendix C, "JavaServer Pages Reference" for information about JavaServer Pages.

The desktop default JSP and template files are installed in the /etc/opt/SUNWps/desktop/default directory and if you choose to install sample portal, the sample portal part of the JSP and template files are installed the /etc/opt/SUNWps/desktop/sampleportal directory. For more information on these two directories, see Chapter 1, "Introduction to Customizing the Desktop."

The Desktop Type attribute in the Desktop attributes page of the Sun Java System Identity Server software administration console specifies from what subdirectory to retrieve either the JSP or template files for the Desktop. The default for this attribute is sampleportal, meaning the sampleportal subdirectory.

Desktop Templates in the default Directory

The templates described in this appendix are in the following provider subdirectories, beneath the /etc/opt/SUNWps/desktop/default directory:

AddressBookProvider

Table A-1 lists the templates in the html subdirectory of the AddressBookProvider and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-1 AddressBookProvider Template Files
display-clientURL.template	Used for displaying the “Launch Address Book” link
display-entries.template	Used for formatting the table headers
display-entry.template	Used for formatting the display of the address book entry
display-error.template	Used for displaying error messages
display-summary.template	Used for formatting number of total and unread messages
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
edit.template
ma-edit-link.template
ma-edit.template

AppProvider

Table A-2 lists the templates in the AppProvider subdirectory and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

BookmarkProvider

Table A-2 AppProvider Template Files
display.template	Contains the JavaScript code that launches the windows that the HTML applications show up in.

Table A-3 lists the templates in the html subdirectory of BookmarkProvider and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

CalendarProvider

Table A-3 BookmarkProvider Template Files
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.
edit.template	Contains the formatting for the Edit page for the Bookmark provider.
editUrlWrapper.template	Used by the edit page of Bookmark Provider to draw the part where the bookmarks are removed.
editWindowOption.template	Contains the markup for the radio buttons used to select the window option.
urlWrappter.template	Contains markup for each URL shown in display.template.

Table A-4 lists the templates in the html subdirectory of the CalendarProvider and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-4 CalendarProvider Template Files
display-clientURL.template	Used for displaying the Launch Calendar link.
display-dayView-emptyEventLis t.template	Used for displaying the message “No events scheduled for today.”
display-dayView-emptyTaskList .template	Used for displaying the message “No tasks are pending for today.”
display-dayView-event.templat e	Used for formatting events
display-dayView-eventAllDay.t emplate	Used for formatting an all day event
display-dayView-otherTasks.te mplate	Used for formatting other tasks
display-dayView-overdueTasks. template	Used for formatting overdue tasks
display-dayView-task.template	Used for formatting a “normal” task
display-dayView.template	Used for formatting the layout of all tasks and events
display-error.template	Used for displaying error messages
display-monthView-dayOfWeek.t emplate	Used for creating week layout within the month
display-monthView-emptyEventL ist.template	Used for formatting when there are no events
display-monthView-emptyTaskLi st.template	Used for formatting when there are no tasks
display-monthView-event.templ ate	Used for formatting an event
display-monthView-eventAllDay .template	Used for formatting an all day event
display-monthView-task.templa te	Used for formatting a task
display-monthView-weekView.te mplate	Used for formatting the week view with a month
display-monthView.template	Used for generating the entire month layout
display-summary-events.templa te	Used to show number of events
display-summary-tasks.templat e	Used to show number of tasks
display-summary.template	Used for formatting number of total and unread messages
display-weekView-currentDayHe ader.template	Used for formatting header for week view
display-weekView-emptyEventLi st.template	Used for formatting an empty event list
display-weekView-emptyTaskLis t.template	Used for formatting an empty task list
display-weekView-event.templa te	Used for formatting an event
display-weekView-eventAllDay. template	Used for formatting an all day event
display-weekView-task.templat e	Used for formatting a task
display-weekView.template	Used for the overall week view
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-config-options.template
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-separate.template
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
edit.template
url.template	Used for creating hyperlinks

error

Table A-5 lists the templates in the error subdirectory and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-5 error Template Files
banner.template	The banner across the top of the Desktop pages.
banner_nocontext.template
error.template
error_nocontext.template	Displayed when no context is available.
noneditablechannel.template	Template that will be used when there is an error in desktop when an edit page for a channel which is not editable is accessed. Displayed only when the user attempts to edit a channel which cannot be edited.
noprivilege.template	Template that will be used when there is an error in desktop when a user with no privilege to access the desktop is trying to access the desktop. Displayed when a user who doesn’t have the privilege to see the desktop attempts to access the desktop.
unknownchannel.template	Template that will be used when there is an error in desktop when an undefined channel is being accessed. Displayed when the user is trying to access a channel which is not defined in the system.

LoginProvider

Table A-6 lists the templates in the LoginProvider subdirectory and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

LotusNotesAddressBookProvider

Table A-6 LoginProvider Template Files
display.template	Contains the JavaScript code that launches the login window.
display_AuthLDAP.template	Contains the JavaScript code that launches the LDAP login window.
display_AuthUnix.template	Contains the JavaScript code that launches the UNIX login window.
libertyLogin.template
persistentCookie.template	Partial HTML template for remembering the user’s name and password.

Table A-7 lists the templates in the LotusNotesAddressBookProvider subdirectory and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-7 LotusNotesAddressBookProvider Template Files
display-clientURL.template	Used for displaying the “Launch Address Book” link
display-entries.template	Used for formatting the table headers
display-entry.template	Used for formatting the display of the address book entry
display-error.template	Used for displaying error messages
display-summary.template	Used for formatting number of total and unread messages
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes

LotusNotesCalendarProvider

Table A-8 lists the templates in the html subdirectory of the LotusNotesCalendarProvider and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-8 LotusNotesCalendarProvider Template Files
display-clientURL.template	Used for displaying the Launch Calendar link.
display-dayView-emptyEventLis t.template	Used for displaying the message “No events scheduled for today.”
display-dayView-emptyTaskList .template	Used for displaying the message “No tasks are pending for today.”
display-dayView-event.templat e	Used for formatting events
display-dayView-eventAllDay.t emplate	Used for formatting an all day event
display-dayView-otherTasks.te mplate	Used for formatting other tasks
display-dayView-overdueTasks. template	Used for formatting overdue tasks
display-dayView-task.template	Used for formatting a “normal” task
display-dayView.template	Used for formatting the layout of all tasks and events
display-error.template	Used for displaying error messages
display-monthView-dayOfWeek.t emplate	Used for creating week layout within the month
display-monthView-emptyEventL ist.template	Used for formatting when there are no events
display-monthView-emptyTaskLi st.template	Used for formatting when there are no tasks
display-monthView-event.templ ate	Used for formatting an event
display-monthView-eventAllDay .template	Used for formatting an all day event
display-monthView-task.templa te	Used for formatting a task
display-monthView-weekView.te mplate	Used for formatting the week view with a month
display-monthView.template	Used for generating the entire month layout
display-summary-events.templa te	Used to show number of events
display-summary-tasks.templat e	Used to show number of tasks
display-summary.template	Used for formatting number of total and unread messages
display-weekView-currentDayHe ader.template	Used for formatting header for week view
display-weekView-emptyEventLi st.template	Used for formatting an empty event list
display-weekView-emptyTaskLis t.template	Used for formatting an empty task list
display-weekView-event.templa te	Used for formatting an event
display-weekView-eventAllDay. template	Used for formatting an all day event
display-weekView-task.templat e	Used for formatting a task
display-weekView.template	Used for the overall week view
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
url.template	Used for creating hyperlinks

LotusNotesMailProvider

Table A-9 lists the templates in the html subdirectory of the LotusNotesMailProvider and includes a brief description of the template file. In this two columned table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-9 LotusNotesMailProvider Template Files
display-clientURL.template	Used for displaying the Launch Mail link
display-error.template	Used for displaying error messages
display-headers-message.templ ate	Used for formatting individual message information
display-headers.template	Used for formatting message table headings
display-summary.template	Used for formatting number of total and unread messages
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
url.template	Used for creating hyperlinks

MailCheckProvider

Table A-10 lists the templates in the MailCheckProvider subdirectory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

MailProvider

Table A-10 MailCheckProvider Template Files
display.template	Contains MailCheck provider layout content.
edit.template	Contains the formatting for the Edit page for the MailCheck provider.

Table A-11 lists the templates in the html subdirectory of the MailProvider and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-11 MailProvider Template Files
display-clientURL.template	Used for displaying the Launch Mail link
display-error.template	Used for displaying error messages
display-headers-message.templ ate	Used for formatting individual message information
display-headers.template	Used for formatting message table headings
display-summary.template	Used for formatting number of total and unread messages
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
url.template	Used for creating hyperlinks

MSExchangeAddressBookProvider

Table A-12 lists the templates in the html subdirectory of MSExchangeAddressBookProvider and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-12 MSExchangeAddressBookProvider Template Files
display-clientURL.template	Used for displaying the “Launch Address Book” link
display-entries.template	Used for formatting the table headers
display-entry.template	Used for formatting the display of the address book entry
display-error.template	Used for displaying error messages
display-summary.template	Used for formatting number of total and unread messages
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes

MSExchangeCalendarProvider

Table A-13 lists the templates in the html subdirectory of the MSExchangeCalendarProvider and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-13 MSExchangeCalendarProvider Template Files
display-clientURL.template	Used for displaying the Launch Calendar link.
display-dayView-emptyEventLis t.template	Used for displaying the message “No events scheduled for today.”
display-dayView-emptyTaskList .template	Used for displaying the message “No tasks are pending for today.”
display-dayView-event.templat e	Used for formatting events
display-dayView-eventAllDay.t emplate	Used for formatting an all day event
display-dayView-otherTasks.te mplate	Used for formatting other tasks
display-dayView-overdueTasks. template	Used for formatting overdue tasks
display-dayView-task.template	Used for formatting a “normal” task
display-dayView.template	Used for formatting the layout of all tasks and events
display-error.template	Used for displaying error messages
display-monthView-dayOfWeek.t emplate	Used for creating week layout within the month
display-monthView-emptyEventL ist.template	Used for formatting when there are no events
display-monthView-emptyTaskLi st.template	Used for formatting when there are no tasks
display-monthView-event.templ ate	Used for formatting an event
display-monthView-eventAllDay .template	Used for formatting an all day event
display-monthView-task.templa te	Used for formatting a task
display-monthView-weekView.te mplate	Used for formatting the week view with a month
display-monthView.template	Used for generating the entire month layout
display-summary-events.templa te	Used to show number of events
display-summary-tasks.templat e	Used to show number of tasks
display-summary.template	Used for formatting number of total and unread messages
display-weekView-currentDayHe ader.template	Used for formatting header for week view
display-weekView-emptyEventLi st.template	Used for formatting an empty event list
display-weekView-emptyTaskLis t.template	Used for formatting an empty task list
display-weekView-event.templa te	Used for formatting an event
display-weekView-eventAllDay. template	Used for formatting an all day event
display-weekView-task.templat e	Used for formatting a task
display-weekView.template	Used for the overall week view
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
url.template	Used for creating hyperlinks

MSExchangeMailProvider

Table A-14 lists the templates in the html subdirectory of the MSExchangeMailProvider and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-14 MSExchangeMailProvider Template Files
display-clientURL.template	Used for displaying the Launch Mail link
display-error.template	Used for displaying error messages
display-headers-message.templ ate	Used for formatting individual message information
display-headers.template	Used for formatting message table headings
display-summary.template	Used for formatting number of total and unread messages
display.template	Used for overall channel formatting
edit-checkbox.template	Used for creating edit page checkboxes
edit-end.template	Used for creating end of the edit page
edit-link.template	Used for creating application helper edit link
edit-password.template	Used for creating edit page password boxes
edit-select.template	Used for creating edit page select boxes
edit-selectoption.template	Used for creating edit page select box options
edit-start.template	Used for creating the start of the edit page
edit-string.template	Used for creating edit page text boxes
url.template	Used for creating hyperlinks

TemplateTabContainerProvider

Table A-15 lists the templates in the TemplateTabContainerProvider subdirectory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-15 TemplateTabContainerProvider Template Files
banner.template	The banner across the top of the Desktop pages, including the Edit, Layout, and Content pages.
display.template
editForm.template	Edit page template for creating and removing tabs.
inlineError.template	HTML to show an error message.
makeNewTab.template	HTML used in editForm.template for creating a new tab.
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.
noCache.template	HTML META headers to prevent browser caching of the pages.
removeRenameTab.template	HTML used in editForm.template for removing and renaming existing tab(s).
selectedTab.template	HTML used to show the currently selected tab on the Desktop.
tab.template	HTML used to show the unselected tab(s) on the Desktop.
tabs.template	Template of the tab provider on the Desktop with tabs on the left.
tabs_r.template	Template of the tab provider on the Desktop with tabs on the right.

TemplateTableContainerProvider

Table A-16 lists the templates in the TemplateTableContainerProvider directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-16 TemplateTableContainer Template Files
arrangeProvider.js	JavaScript code used in the Desktop Layout page.
banner.template	The banner across the top of the Desktop pages, including the Edit, Layout, and Content pages.
bareProviderWrapper.template	Template for each provider wrapper with no titlebar.
contentBarInContent.template	Content bar for template displayed when a user selects Content on any other page’s Content bar.
contentBarInLayout.template	Content bar for template displayed when user selects Layout on any other page’s Content bar.
contentLayout.template	Content bar for template displayed on the Desktop before the user selects Content or Layout.
contentTemplate.template	The HTML template for the Content (Channels) page that displays when a user selects Content.
launchPopup.js	JavaScript code to launch a popup window.
layout1Template.template	left/thin, right/wide.
layout2Template.template	left/wide, right/thin.
layout3Template.template	left/thin, center/wide, right/thin.
layout4Template.template	left/thin, center/thin, right/thin.
layoutFullBottom.template	Partial HTML template for Layout pages when the user has a full width channel available at the bottom of the layout.
layoutFullTop.template	Partial HTML template for Layout pages when the user has a full width channel available at the top of the layout
maximizedTemplate.template	Template of a provider when it’s in its maximized state.
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.
minimized.template	Template of a provider when it’s in its minimized state - just the title/button bar showing, no content area showing.
optionsTemplate.template	Template for the Options page of the Desktop.
performColumnSubstitution.js	JavaScript code used on the Layout page.
performSubstitution.js	JavaScript code used on the Layout page.
popupMenubar.template	Menubar to be used in popup windows.
popupTemplate.template	Used to show provider/channel content in detached windows. Similar use to providerWrapper.template, but not in a table structure.
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.
removeProvider.js	JavaScript code used to remove a channel from the Desktop.
selectAll.js	JavaScript code used on the Layout page.
switchColumns.js	JavaScript code used on the Layout page.
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.

UserInfoProvider

Table A-17 lists the templates in the html subdirectory of UserInfoProvider and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

default

Table A-17 UserInfoProvider Template Files
content.template	Content page for the UserInfo provider.
edit.template	Edit page for the UserInfo provider.
netmailSettings.template	Partial template inserted into edit.template for Mail information.
passwordHandler-Membership.te mplate	Partial template inserted into edit.template if Membership Authentication is used, to allow the user to change their password.

Table A-18 lists the templates in the default directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-18 Template Files in the default Directory
AtachCommand.template	Handles reattaching a detached channel.
banner.template	The banner across the top of the Desktop pages
contentLayout.template	Content bar for template displayed on the Desktop before the user selects Content or Layout.
detachCommand.template	Handles detaching a channel.
detachEditCommand.template	Handles link to the Edit page for the detached channel.
detachRemoveCommand.template	Handles closing or removing a detached channel.
editCommand.template	Handles link to the Edit page for this channel.
helpHref.template	Generates the help URL for each of the channels. Displays the help contents in a new window.
inlineError.template
MaximizeCommand.template	Allows the channel to be displayed in the maximize mode so that the channel occupies the entire Desktop.
menubar.template	HTML for the menubar across the bottom of the Desktop pages.
minimizeCommand.template	Allows the channel to be displayed in the minimize mode so that only the title bar of the channel is displayed and no content of the channel is displayed.
minMaximizeCommand.template	Handles minimizing and maximizing a channel.
normalizeCommand.template	Allows the channel to be displayed in the normal mode so that the channel is displayed in the Desktop, with all other channels in the same table container.
providerCommands.template	Commands available in title bar.
redirect.template
removeCommand.template	Removes the channel.
bulletColor.js	JavaScript code used to select and display bullet color.
isPageCompletelyLoaded.js
openURLInParent.js	Javascript to open a URL in the parent window. Used in popup windows.
pageLoaded.js
toolbarRollovers.js	JavaScript code use to display selection of Content or Layout by color change.

Desktop Templates in the sampleportal Directory

The templates described in this appendix are in the following provider subdirectories, beneath the /etc/opt/SUNWps/desktop/sampleportal directory:

MyFrontPageTemplatePanelContainer

Table A-19 lists the templates in the MyFrontPageTemplatePanelContainer directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

PredefinedFrontPageTemplatePanelContainerProvider

Table A-20 lists the templates in the PredefinedFrontPageTemplatePanelContainerProvider directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-20 PredefinedFrontPageTemplatePanelContainerProvider Template Files
banner.template	The banner across the top of the Desktop pages.
bareProviderWrapper.template	Template for each provider wrapper with no titlebar.
contentBarInContent.template	Content bar for template displayed when a user selects Content on any other page’s Content bar.
contentBarInLayout.template	Content bar for template displayed when user selects Layout on any other page’s Content bar.
contentLayout.template	Content bar for template displayed on the Desktop before the user selects Content or Layout.
contentTemplate.template	The HTML template for the Content (Channels) page that displays when a user selects Content.
layout1Template.template	left/thin, right/wide.
layout2Template.template	left/wide, right/thin.
layout3Template.template	left/thin, center/wide, right/thin.
layout4Template.template	left/thin, center/thin, right/thin.
layoutFullBottom.template	Partial HTML template for Layout pages when the user has a full width channel available at the bottom of the layout.
layoutFullTop.template	Partial HTML template for Layout pages when the user has a full width channel available at the top of the layout
maximizedTemplate.template	Template of a provider when it’s in its maximized state.
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.
minimized.template	Template of a provider when it’s in its minimized state - just the title/button bar showing, no content area showing.
optionsTemplate.template	Template for the Options page of the Desktop.
popupMenubar.template	Menubar to be used in popup windows.
popupTemplate.template	Used to show provider/channel content in detached windows. Similar use to providerWrapper.template, but not in a table structure.
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.
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.
arrangeProvider.js	JavaScript code used in the Desktop Layout page.
launchPopup.js	JavaScript code to launch a popup window.
performColumnSubstitution.js	JavaScript code used on the Layout page.
performSubstitution.js	JavaScript code used on the Layout page.
removeProvider.js	JavaScript code used to remove a channel from the Desktop.
selectAll.js	JavaScript code used on the Layout page.
switchColumns.js	JavaScript code used on the Layout page.

PredefinedSamplesTemplatePanelContainerProvider

Table A-21 lists the templates in the PredefinedFrontPageTemplatePanelContainerProvider directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-21 PredefinedSamplesTemplatePanelContainerProvider Template Files
banner.template	The banner across the top of the Desktop pages.
bareProviderWrapper.template	Template for each provider wrapper with no titlebar.
contentBarInContent.template	Content bar for template displayed when a user selects Content on any other page’s Content bar.
contentBarInLayout.template	Content bar for template displayed when user selects Layout on any other page’s Content bar.
contentLayout.template	Content bar for template displayed on the Desktop before the user selects Content or Layout.
contentTemplate.template	The HTML template for the Content (Channels) page that displays when a user selects Content.
layout1Template.template	left/thin, right/wide.
layout2Template.template	left/wide, right/thin.
layout3Template.template	left/thin, center/wide, right/thin.
layout4Template.template	left/thin, center/thin, right/thin.
layoutFullBottom.template	Partial HTML template for Layout pages when the user has a full width channel available at the bottom of the layout.
layoutFullTop.template	Partial HTML template for Layout pages when the user has a full width channel available at the top of the layout
maximizedTemplate.template	Template of a provider when it’s in its maximized state.
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.
minimized.template	Template of a provider when it’s in its minimized state - just the title/button bar are displayed and no content area is displayed.
optionsTemplate.template	Template for the Options page of the Desktop.
popupMenubar.template	Menubar to be used in popup windows.
popupTemplate.template	Used to show provider/channel content in detached windows. Similar use to providerWrapper.template, but not in a table structure.
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.
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.
launchPopup.js	JavaScript code to launch a popup window.
performColumnSubstitution.js	JavaScript code used on the Layout page.
performSubstitution.js	JavaScript code used on the Layout page.
removeProvider.js	JavaScript code used to remove a channel from the Desktop.
selectAll.js	JavaScript code used on the Layout page.
switchColumns.js	JavaScript code used on the Layout page.

SamplesTemplatePanelContainer

Table A-22 lists the templates in the SamplesTemplatePanelContainer directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

TemplateTabContainerProvider

Table A-23 lists the templates in the TemplateTabContainerProvider directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

TemplateTabCustomTableContainerProvider

Table A-24 lists the templates in the TemplateTabCustomTableContainerProvider directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

TemplateTableContainer

Table A-25 lists the templates in the TemplateTableContainer directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

ToolsTemplatePanelContainer

Table A-26 lists the templates in the ToolsTemplatePanelContainer directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

sampleportal

Table A-27 lists the templates in the sampleportal directory and includes a brief description of the template file. In this two column table, the left column contains the template file name and the right column includes a brief description of the corresponding template file.

Table A-27 Template Files in the sampleportal Directory
AtachCommand.template	Handles reattaching a detached channel.
MaximizeCommand.template	Allows the channel to be displayed in the maximize mode so that the channel occupies the entire Desktop.
detachEditCommand.template	Handles link to the Edit page for the detached channel.
detachCommand.template	Handles detaching a channel.
detachRemoveCommand.template	Handles closing or removing a detached channel.
editCommand.template	Handles link to the Edit page for the detached channel.
helpHref.template	Generates the help URL for each of the channels. Displays the help contents in a new window.
minimizeCommand.template	Allows the channel to be displayed in the minimize mode so that only the title bar of the channel is displayed and no content of the channel is displayed.
normalizeCommand.template	Allows the channel to be displayed in the normal mode so that the channel is displayed in the Desktop, with all other channels in the same table container.
removeCommand.template	Removes the channel.

Miscellaneous Template Information

This section contains miscellaneous information on using templates when customizing the Desktop.

Dynamic Template Reloading

If you make changes to the Desktop templates, note that these templates are dynamically reloaded. The reload interval is by default set to thirty seconds. You can change the reload interval in the desktopconfig.properties file at /etc/opt/SUNWps/desktop directory.

Previous Contents Index Next
Sun Java System Portal Server 6 2004Q2 Desktop Customization Guide