Section 32. Online Help

FacilitatePro puts full documentation at the facilitator's fingertips through the online help feature. Facilitator screens are accented throughout with new online help icons that link directly to the relevant section of this Facilitator's Guide. Table of Contents and Index pages provide easy access with hyperlinks to other parts of the online manual.

The online Facilitator's Guide is stored locally on the FacilitatePro web server. It does not require separate Internet access and remains behind a network firewall. The guide can be augmented locally with additional sections and links as appropriate to each implementation.

Help Icons on Facilitator Screens Link to Contextual Online Help

Help File Structure on Web Server

The directory for online help files should be named "Help" and placed directly within the WEB directory. The Help directory contains an "Images" directory that in turn contains all images and screen shots displayed within the online help. The Help directory also contains a "Scripts" directory used to help create the online help layout. These files should not be touched.

The Help directory lists each individual section of the online help as a separate HTML page. Additional custom HTML pages could be added here with the appropriate additions to the Table of Contents and Index pages (TOC.html and IX.html respectively).

The destination of each link is defined within a file in the CodeLibrary directory named: HelpFile_Translation.txt. A sample of the format of this file is shown below.

Help_DefaultPage=Index.shtml

Help Enable Link=True

Help Window Link Path=help/

Help Window Link Format= - <a href='javascript:void window.open("XURLX", "Window001", "height=600 width=600 resizable=yes, toolbar=yes, menubar=yes, scrollbars=yes"); '> <img border=0 src="/images/buttons/Help_02_Book_a.gif"> </a>

********** Facilitator Main Screen

Help_FCP0100=FCHelp-1-27.html

Help_FCP0200=FCHelp-1-32.html

********** List / Edit of User Profiles

` List of User Profiles Heading

Help_LUP0100=FCHelp-1-54.html

` Search Options

Help_LUP0200=FCHelp-1-54.html#wp9004141