IBM R1 manual Customizing the user interface

Page 6

Chapter 1

Customizing the IBM Lotus Learning Management System User interface

There are several ways you can tailor the IBM® Lotus® Learning Management System (LMS) interface to control the product's look and feel and the user's access to its features. Depending on the nature of the changes you want to make, customization can involve one or more of the following:

Changing default settings that affect what the user can see and do. You can do this either through the Administrator interface or by editing XML files.

Editing properties, template, graphics, and style sheet files.

Editing the HTML files that constitute the Help system.

Editing the application’s JavaServer Pages™ (JSPs)changing the HTML content, adding or removing custom tags or overriding the default settings of their attributes, adding or changing functionality by including Java™ code or JavaScript™, adding or removing include statements, inserting or changing forward statementsor writing your own.

Copying and renaming portions of the directory tree on the Learning Management Module server (LMMS) and Delivery server (DS) and editing the copied files to create a new interface. (The aggregation of such copied and edited files, together with the information necessary to locate the files and identify the set of users to whom they apply, is known as a customization set.)

Creating custom reports. (This process is described in the Administrator’s Guide.)

Writing directly to the LMS database.

This document describes the aspects of the Student interface that you can customize without having to write directly to the LMS database or program in Java. The LMS database schema is described in the Administrator's Guide.

Note: If you are upgrading to the LMS from a version of LearningSpace® that you have customized, changes that you made to the LearningSpace interface will be lost because the implementations of the two applications are radically different. Changes that you make in the LMS interface may be lost when you upgrade to subsequent versions of the product or reinstall the current version. It is therefore advisable to save backup copies of all files that you customize.

The user interface consists of a number of JSPs whose visual attributes you can modify. These visual attributes include the following:

static text

colors and fonts

graphical images

background colors

frame dimensions

Chapter 1: Customizing the user interface 1

Image 6
Contents Customization Guide Disclaimer Licensed Materials Property of IBMList of Trademarks Page Table of Contents Customization sets Creating a tabIndex Customizing the user interface Disclaimer and a word about conventions Acronyms and abbreviationsAcronym or What it stands for Abbreviation Page Chapter Changing settings through the user interface or XML Changing settingsPage Chapter Controlling access to features through permissions To add a role to the systemTo automatically assign a role to a user To modify permissions settings for an existing roleTo assign a role to a user To explicitly assign a role to a userControlling access to features Page Chapter Customizing Help Anatomy of a Help topicScript Mosaic-bg Background-repeat repeat-xScript Head Editing an existing Help topic Replacing a context-sensitive Help topicLmsform action=/prefSubmit.do % Adding your own Help topic HREF=shnotifications.html target=topNotifications/Abr HREF=shenrolled.html target=topEnrolled courses/AbrChapter Customizing JavaServer Pages OverviewAnatomy of a TLD file LMS JSP tag librariesServerNameWEB-INFtld Referencing the url tag in a JSP String formName = request.getParameterformNameDefining the url tag in the TLD file Rtexprvaluetrue/rtexprvalue Attribute Tag ServerNameWEB-INFclassescomlotuselearntaglibLearning Management System server Anatomy of a JSPDefining a page as a JSP Localizing page content Including tag library descriptor filesReferencing Struts tags Including JavaScript source code Including the JSPs that comprise the main templateDiv class=formBoxPositionInner Td class=formBoxTitleBg colspan=3 valign=middle nowrapLogicnotPresent LogicnotMatch DivLogicnotPresent logicpresent name=invalidForm LogicpresentDelivery server Localizing page textDisplaying errors to the user Script language=JavaScript src=js/delivery.js/scriptPopulating a frameset in a JSP Defining resizable frames Making global changes Frameset HtmlApplying customization sets Changing the application styleLanguage-version Editing existing CSS filesServerNamecsslanguageCodebrowserType Browser-versionChanging the font size or font style of the application Adding your own CSS filesReplacing CSS files @import urlmyStyles.cssUpdating page text ServerNameWEB-INFclassesresourcesserverNamepropertiesAdding and replacing graphics Titlelmsmessage key=application.title //titleApplication.title = IBM Lotus Learning Management System Lmslinklmsimg src=images/name.gif… //lmslinkImage.alt.logo = IBM Lotus Learning Management System Replacing the application logoLearning Management System server Delivery serverDeliverylogoURL resource=images/myCompanyLogo.gif Changing individual JSPsReplacing a reference to a CSS style Changing the style of an individual JSPEditing existing JSP tags Changing the functionality of an individual JSPSpecifying the next page to display Canceling the submission of a form Submitting a formEditing form Bean values with the lmshidden tag Lmshidden property=userEvent Removing JSP tagsLmshidden name=%=formName% property=unmodifiedKeywords Custom fieldsIt then checks to see if its a text box type field LogicnotPresent Logicequal Page Adding Ldap attributes to User Search pages Chapter Customizing SearchCustomizing user searches Attribute name=HealthPlanChoice type=java.lang.StringHealthPlanChoice = Employees Health Plan Removing fields from User Search pagesAdding custom fields to the Offerings Catalog Customizing Offerings Catalog searchesCustomizing course management and resource searches Removing fields from Offerings Search pagesRemoving fields from the Search pages Chapter Customization sets Creating a customization setLMM De en etc. SalesCS De en EtcPage Attribute Name Type Modified Size Path Customization sets Page Chapter Creating a tab UsersUsers.jsp @ taglib uri=/WEB-INF/tld/lms.tld prefix=lms %Td width=1 valign=top Page Users.rosterUsers.subtitle = Roster Users Navigation.xml Users.rosterUsers.search Users.rosterUsers.search.confirmTrail TrailManageProfiles TrailTrail TrailManageRoles Trail TrailManageUsersTarget tag struts action-mapping Content tag JSP file namesName tag page names and resourced text Label tag breadcrumbsUsers.rosterUsers.search.confirm Permissions tag permission to display Adding custom permissionsTitle tag title bar text HelpPage tag context-sensitive HelpName UpdatetimeOid Permid0000000000000000PERM 0000000000003000PERM 0000000000009300PERM Example Copy the JSPsPage Creating a tab END Index Content Area Creating a tab Div Second linked page customGoodbye.jsp looks like this Page Customtab.html Create Help filesCustomtabb.html Add permissions to the LMS database Select Maxpermid from PermissionEdit ApplicationResources.properties Edit navigation.xml NavigationNamestudenthome/name Assign permissionsCreating a tab Page Index