8-2 Oracle Fusion Middleware Extending the Administration Console for Oracle WebLogic Server
console extension is jolt.hs. The Jolt console extension is a standard extension the Administration Console. For localized helpsets, append the locale information to
the end of the name of the extension, for example, jolt_en_US.hs.
■
Mapping file .jhm This XML file maps context help IDs to help topics.
■
Table of contents file .xml This XML file defines the table of contents for the help.
The following files are optional:
■
Index file .xml This XML file defines the index for the help.
■
Full text search database These database files are generated using the Javahelp software or a Help authoring
tool that creates Javahelp: There are further considerations for merging helpsets and for providing localized
helpsets. See Section 8.3.1, Directory Structure for Merging Extension Help
and Section 8.4, Localizing Helpsets.
8.3 Merging Helpsets
The table of contents and the search database for a console extensions helpset are automatically merged into the main Administration Console help, provided that the
extensions helpset is organized and named properly. Extension helpsets are merged only when the help is deployed on the same server instance as the Administration
Console.
The Administration Consoles helpset file sets the merge type to the Javahelp AppendMerge
type. That type defines how console extension helpsets are merged into the main console help.
See Merging Helpsets at http:docs.sun.comsource819-0913authormerge.html
for more information about Javahelp merging. See also
Section 8.5, How Helpsets Are Merged for more information about how helpsets are merged in WebLogic Server.
8.3.1 Directory Structure for Merging Extension Help
For an extensions help to be merged with the main console help, the help files must be organized as follows. The name of the directory containing the helpset files must be
bea-helpsets .
...\console_extension\bea_helpsets\extension_name_locale.hs ...\console_extension\bea_helpsets\locale\extension_name-map.jhm
...\console_extension\bea_helpsets\locale\extension_name-toc.xml ...\console_extension\bea_helpsets\locale\extension_name-search\search database files
...\console_extension\bea_helpsets\locale\topics_dir\HTML topic files... ...\console_extension\bea-helpsets\locale\topics_dir\images\Graphic files...
...\console_extension\PortalConfig\... ...\console_extension\WEB-INF\...
...\console_extension\Other extension source directories...
Adding Online Help for Console Extensions 8-3
For example: ...\my_ext\webapp\bea_helpsets\my_ext_en_US.hs
...\my_ext\webapp\bea_helpsets\en_US\my_ext_map.jhm ...\my_ext\webapp\bea_helpsets\en_US\my_ext_toc.xml
...\my_ext\webapp\bea_helpsets\en_US\my_ext-search\search database files... ...\my_ext\webapp\bea_helpsets\en_US\pagehelp\HTML topic files...
...\my_ext\webapp\bea_helpsets\en_US\taskhelp\HTML topic files... ...\my_ext\webapp\bea-helpsets\en_US\taskhelp\images\Graphic files...
...\my_ext\webapp\jsp\... ...\my_ext\webapp\PortalConfig\...
...\my_ext\webapp\WEB-INF\...
8.4 Localizing Helpsets
Multiple localized helpsets can be simultaneously included in help. The help viewer uses the same strategy used by java.util.ResourceBundle for locating
locale-specific help files. The help viewer expects the following directory structure under the bea-helpsets directory for your extension:
...\extension_name_locale_1.hs ...\extension_name_locale_2.hs
...\extension_name_locale_3.hs ...\locale_1\map.jhm
...\locale_1\toc.xml ...\locale_1\search\Search db files...
...\locale_1\topics\HTML topic files... ...\locale_1\topics\images\Graphic files... optional
...\locale_2\map.jhm ...\locale_2\toc.xml
...\locale_2\my_search\Search db files... ...\locale_2
\topics\HTML topic files... ...\locale_1\topics\images\Graphic files... optional
...\locale_3\map.jhm ...\locale_3\toc.xml
...\locale_3\search\Search db files... ...\locale_3\topics\HTML topic files
...\locale_3 \topics\images\Graphic files... optional
For example, see Figure 8–1
.
Note: The HTML topic files and graphic files may be located in
multiple directories and subdirectories, but they all must be under ...\console_extension\bea_helpsets\locale
\.
8-4 Oracle Fusion Middleware Extending the Administration Console for Oracle WebLogic Server
Figure 8–1 Directory Structure for Localized Help
If the help content for the locale specified in the browser is not found, the help viewer displays the content from the default folder.
8.5 How Helpsets Are Merged
