Chapter 76
Desktop Templates in the default Directory
This chapter contains the following sections
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
|
|
ma-edit-link.template
|
|
ma-edit.template
|
|
AppProvider
The following table 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.
display.template
|
Contains the JavaScript code that launches the windows that the HTML applications show up in.
|
BookmarkProvider
The following table 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.
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 following table lists the templates in the html subdirectory of the CalendarProvider, LotusNotesCalendarProvider, and MSExchangeCalendarProvider 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 Calendar link.
|
display-dayView-emptyEventLi
st.template
|
Used for displaying the message “No events scheduled for today.”
|
display-dayView-emptyTaskLis
t.template
|
Used for displaying the message “No tasks are pending for today.”
|
display-dayView-event.templa
te
|
Used for formatting events
|
display-dayView-eventAllDay.
template
|
Used for formatting an all day event
|
display-dayView-otherTasks.t
emplate
|
Used for formatting other tasks
|
display-dayView-overdueTasks
.template
|
Used for formatting overdue tasks
|
display-dayView-task.templat
e
|
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-emptyEvent
List.template
|
Used for formatting when there are no events
|
display-monthView-emptyTaskL
ist.template
|
Used for formatting when there are no tasks
|
display-monthView-event.temp
late
|
Used for formatting an event
|
display-monthView-eventAllDa
y.template
|
Used for formatting an all day event
|
display-monthView-task.templ
ate
|
Used for formatting a task
|
display-monthView-weekView.t
emplate
|
Used for formatting the week view with a month
|
display-monthView.template
|
Used for generating the entire month layout
|
display-summary-events.templ
ate
|
Used to show number of events
|
display-summary-tasks.templa
te
|
Used to show number of tasks
|
display-summary.template
|
Used for formatting number of total and unread messages
|
display-weekView-currentDayH
eader.template
|
Used for formatting header for week view
|
display-weekView-emptyEventL
ist.template
|
Used for formatting an empty event list
|
display-weekView-emptyTaskLi
st.template
|
Used for formatting an empty task list
|
display-weekView-event.templ
ate
|
Used for formatting an event
|
display-weekView-eventAllDay
.template
|
Used for formatting an all day event
|
display-weekView-task.templa
te
|
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
The following table 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.
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
The following table 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.
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.
|
MailCheckProvider
The following table 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.
display.template
|
Contains MailCheck provider layout content.
|
edit.template
|
Contains the formatting for the Edit page for the MailCheck provider.
|
MailProvider
The following table lists the templates in the html subdirectory of the MailProvider, LotusNotesMailProvider, and 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.
display-clientURL.template
|
Used for displaying the Launch Mail link
|
display-error.template
|
Used for displaying error messages
|
display-headers-message.temp
late
|
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
The following table 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.
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
The following table 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.
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
The following table 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.
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.t
emplate
|
Partial template inserted into edit.template if Membership Authentication is used, to allow the user to change their password.
|
default
The following table 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.
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.
|