Sun Java System Portal Server 7.1 Technical Reference

Chapter 70 Desktop Templates in the default Directory

This chapter contains the following sections

AddressBookProvider, AppProvider, BookmarkProvider and CalendarProvider
error
LoginProvider
default directory template files

AddressBookProvider

The following table lists the templates in the html subdirectory of the AddressBookProvider, LotusNotesAddressBookProvider, and MSExchangeAddressBookProvider 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.

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: Used for creating edit the template
ma-edit-link.template: ma edit link template
ma-edit.template: ma edit template

AppProvider

The template available in the AppProvider subdirectory and its description is:

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

BookmarkProvider

The templates available in the html subdirectory of BookmarkProvider and their description are:

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.

CalendarProvider

The templates available in the html subdirectory of the CalendarProvider, LotusNotesCalendarProvider, and MSExchangeCalendarProvider and their description are:

display-clientURL.template: Used for displaying the Launch Calendar link.
display-dayView-emptyEventList.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.template: Used for formatting events
display-dayView-eventAllDay.template: Used for formatting an all day event
display-dayView-otherTasks.template: 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.template: Used for creating week layout within the month
display-monthView-emptyEventList.template: Used for formatting when there are no events
display-monthView-emptyTaskList.template: Used for formatting when there are no tasks
display-monthView-event.template: Used for formatting an event
display-monthView-eventAllDay.template: Used for formatting an all day event
display-monthView-task.template: Used for formatting a task
display-monthView-weekView.template: Used for formatting the week view with a month
display-monthView.template: Used for generating the entire month layout
display-summary-events.template: Used to show number of events
display-summary-tasks.template: Used to show number of tasks
display-summary.template: Used for formatting number of total and unread messages
display-weekView-currentDayHeader.template: Used for formatting header for week view
display-weekView-emptyEventList.template: Used for formatting an empty event list
display-weekView-emptyTaskList.template: Used for formatting an empty task list
display-weekView-event.template: Used for formatting an event
display-weekView-eventAllDay.template: Used for formatting an all day event
display-weekView-task.template: 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 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 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: Edit template
url.template: Used for creating hyperlinks

error

The templates available in the error subdirectory and their description are:

banner.template: The banner across the top of the Desktop pages.
banner_nocontext.template: Banner non context template
error.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

The templates available in the LoginProvider subdirectory and their description are:

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: Library login template.
persistentCookie.template: Partial HTML template for remembering the user’s name and password.

default

The templates available in the default directory and their description are:

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: Inline error 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: Redirect template.
removeCommand.template: Removes the channel.
bulletColor.js: JavaScript code used to select and display bullet color.
isPageCompletelyLoaded.js: Is page completely loaded.
openURLInParent.js: JavaScript to open a URL in the parent window. Used in popup windows.
pageLoaded.js: Page loaded.
toolbarRollovers.js: JavaScript code use to display selection of Content or Layout by color change.