IBM R1 manual Adding your own Help topic

Page 22

Note: You can replace a Help file with one in another directory by specifying the appropriate relative path and file name. For example, you might change the helpPage parameter in preferences.jsp to

<jsp:param name="helpPage" value="courseadmin/ch_mypreferences.html"/>

or, assuming that you had created and populated a myhelp directory at the same level as the student and course administrator Help directories, you might change the <helpPage> tag in the student home entry in Navigation.xml to

<helpPage>/myhelp/welcome.html</helpPage> or the like.

Adding your own Help topic

You can add your own Help topics to the system and create Index entries and links in the Table of Contents for them. The following procedure assumes that you want to add a topic to the Student Help system. The procedure for adding a topic to the Administrator Help system is essentially the same, the only significant differences being the prefix to the file namesch_ instead of sh_and the subdirectory in which you store the files.

1.Create a map file like the one described above in “Anatomy of a Help topic”

(sh_preferences.html). For example, you might create a file named sh_my_topic.html to which the corresponding content file will be named sh_my_topic_b.html:

<html>

<head>

<title>IBM Lotus Learning Management System Student Help</title> </head>

<frameset rows=33,* border=0 frameborder=no framespacing=0>

<frame name=header title="Help Header"

src="sh_help_header_h.html"scrolling=no framespacing=0 frameborder=no border=0 marginwidth=0 marginheight=0 noresize>

<frameset cols=150,* border=0 frameborder=no framespacing=0>

<frame name=navigation title="Help Navigation"

src="sh_help_navigation_l.html" scrolling="auto" framespacing="0" frameborder="No" border="0" marginwidth="0" marginheight="0" noresize>

<frame name=content title="Help Topic" src="sh_my_topic_b.html" scrolling=auto framespacing=0 frameborder=no border=0 marginwidth=0 marginheight=0 noresize>

</frameset>

</frameset>

</html>

2.Create the content file (sh_my_topic_b.html). Since you’ll need to enter Index entries by hand if you want the topic to be available through the Index, you don’t need to include <META> tags:

<HTML>

<HEAD>

Chapter 4: Customizing Help 17

Image 22
Contents Customization Guide Licensed Materials Property of IBM DisclaimerList of Trademarks Page Table of Contents Creating a tab Customization setsIndex 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 Replacing a context-sensitive Help topic Editing an existing 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 OverviewLMS JSP tag libraries Anatomy of a TLD fileServerNameWEB-INFtld String formName = request.getParameterformName Referencing the url tag in a JSPDefining the url tag in the TLD file Rtexprvaluetrue/rtexprvalue Attribute Tag ServerNameWEB-INFclassescomlotuselearntaglibAnatomy of a JSP Learning Management System serverDefining a page as a JSP Including tag library descriptor files Localizing page contentReferencing 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 textScript language=JavaScript src=js/delivery.js/script Displaying errors to the userPopulating 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 JSPChanging the functionality of an individual JSP Editing existing JSP tagsSpecifying the next page to display Submitting a form Canceling the submission of 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