Instructions for Integrating the WebWorks Help into Your Web Application
The following procedure applies to using WebWorks ePublisher 9.2.
Step 1: Place the online help project files provided by the documentation team into your project.
1. Your online help project files will be staged in the L:\Technical Writing directory in the Output folder of your specific project. Be sure to verify the location with your technical writer.
Example L:\Technical Writing\{P roject Name}\Online Help\ {Help_P roject_Name}\Output\WebWorks Help 5.0\{Help_Project_Name}\index.html...
2.
Copy the contents of the Output folder to the root of your web application. This should be at the same level as your WEB-INF folder.
Example If your CVS structure includes a web folder that is packaged as your web application’s root directory once your application is deploy ed, your new CVS project package might look like this: C:\devt ools\eclipse\workspace\ {Your Project}\web\WebWorks Help 5.0\{Help_Project_Name}
3.
Rename or move the folders referenced above as needed, but keep the names and hierarchy of files and folders nested beneath the entry- level file, index.html, the same.
Example Rename C:\devt ools\eclipse\workspace\sporespracip-release10\web\WebWorks Help 5.0\SPORE_Portal_Online_Help to C:\devt ools\eclipse\workspace\sporespracip-release10\web\webHelp\SPORE_1.0
Last updated on 3/13/09
1
Step 2: Insert the help links.
Understanding topic aliases
Each context-sensitive topic in the help project you receive from the technical writing team has a corresponding topic alias. The topic alias links the content of a topic to a page in an application. You must work with the technical writer early in product development to create these topic aliases; either you or the technical writer can create them. The technical writer summarizes them in a mapping or topic alias table and provides that to you. According to WebWorks ePublisher, the tool used to compile the help content, topic alias names must follow these guidelines: Must be unique Must begin with an alphabetical character May contain alphanumeric characters May not contain special characters or spaces, with the exception of underscores ( _ )
Note: The information in the mapping table should match that located in topics.j s in the online help output folder provided by the documentation team. Once in that folder, the path is …\Output\WebWorks Help 5.0\CGEMS Online Help\wwhdata\common. After you integrate the help with the application, if the correct topic does not open from the correct page of the application, your or the doc ument ation team can troubleshoot by comparing the content of topics.j s with the mapping table. The technical writ er can also verify through a report in ePublisher that the topic aliases have resolved correctly to the appropriate OH topics.
Putting in Javascript Help Calls
You can call the Webworks API through Javascript using the method detailed below. The two topics in the attached help file can be called from the Search Protocols page (using the query_protocols topic alias) and the Welcome page (using the welcome topic alias).
Last updated on 3/13/09
2
Method: WWHAPI_DisplayHelpWithNavigation(ParamContext, ParamTopic); Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping). ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).
Description: Loads with most recently called tab opened ("contents" if not previously called), the correct helpset volume (context) and topic as specified by the parameters without re- loading the browser window, except if this is the first call. Calls to specific pages: On the welcome page, insert the following code to call welcome page help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "Welcome"); On the User Registration page, insert the following code to call help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "User_Register"); On the Please Login or Register page, insert the following code to call help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "User_Login"); On the User Edit page, insert the following code to call help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "User_Edit"); On the Change Password page, insert the following code to call help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "Change_Password"); On the Search Protocols page, insert the following code to call Search Protocols page help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "Query_Protocol"); On the Protocol Details page, insert the following code to call help:
Last updated on 3/13/09
3
MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "View_Protocol_Detail"); On the Edit Protocol page, insert the following code to call help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "Edit_Protocol"); On the Add a Protocol page, insert the following code to call help: MyHelpset.WWHAPI_DisplayHelpWithNavigation("caCTUS_Help", "Submit_Protocol");
Last updated on 3/13/09
4