Verifying Requirements and Dependencies
18-6 Oracle Fusion Middleware Developers Guide for Oracle Help
Follow these steps to set up your OHW-RC help system:
1.
Set up the directory structure as following: OHW-RC_HOME
| — OHW-RC_deployment_name
| — helppages
— helpsets |
— custom_helpset_directory — META-INF
— WEB-INF |
— lib — META-INF
For example: my_module
| — my_module_help
| — helppages
— helpsets |
— my_ModuleHelpset — META-INF
— WEB-INF |
— lib — META-INF
2.
Create your own helpset directory. Place all your help files in or under OHW-RC_ HOME\OHW-RC_deployment_name\helpsets\custom_helpset_
directory directory, including the helpset file, topic files, and the other control files index, table of contents, etc.. Also, place any JAR files here, if you are using
JAR files for your helpset. You can use JARred and unJARred helpsets together in the same deployment.
3.
Create the configuration file. In an editor, create an XML file and save it as ohwconfig.xml, in the OHW-RC_HOME\OHW-RC_deployment_
name\helpsets directory. You may also copy the ohwconfig.xml from demo EAR file and edit it to your requirement. The file is available in
ohw-rc-thick-demo\ohw-rc-thick-demo\helpsets directory.
If you are creating a new ohwconfig.xml file, see Chapter 9, Oracle Help for the
Web Configuration File for more information about behaviors you can configure.
If you are editing the demo EAR file’s ohwconfig.xml, follow these instructions:
a.
Modify the booksbooks section to direct it to your helpset. For example:
books helpSet id=myModule location=my_ModuleHelpsetmy_ModuleHelpset.hs
books
b.
Remove the helpsets which you do not wish to provide from the booksbooks section. If removed, the helpsets would not appear in the
helpset switcher dropdown list of the OHW-RC user interface. If you have
Understanding OHW-RC Deployment 18-7
only one helpSet element in the booksbooks section, the helpset switcher is not available.
c.
Update the brandingsbrandings section to display your own brand. For example:
brandings branding text=My Module
brandings
4.
Download the ohw-rc-5_0.zip from OTN. Extract the contents of the zip file in a temporary directory, and then extract the contents of ohw-rcf-webapp.zip to
OHW-RC_HOME\OHW-RC_deployment_name\helppages directory.
You may also copy the helppages directory from the demo EAR file. The files are available in ohw-rc-thick-demo\ohw-rc-thick-demo\helppages
directory.
5.
Copy the following library files to OHW-RC_HOME\OHW-RC_deployment_ name\WEB-INF\lib directory.