The JavaHelp viewer is a tri-pane window designed by Sun Microsystems. It is intended to display compiled (.JAR file) or uncompiled (set of source files) JavaHelp systems.

Main features of the JavaHelp viewer include:

image33.gif Example of JavaHelp

Output files for Oracle Help Systems

Output File

Description

Translate with

*.HS file

Helpset file. The Helpset file points to a set of map files and defines an associated set of navigational views such as the table of contents, index, and search. The Helpset file is in XML format and consists of tags separating the file into sections - title, topic ID maps, navigational views, etc.

 

  • Use Alchemy CATALYST and XML Editor.

  • Use JavaHelp-HS ezParse rule when inserting these files into a project TTK.

*.JAR

Compressed Oracle Help file. When you generate Oracle Help files you are given the option to create a compressed output file. If you select this option, all of the output files in your project are compressed into a file with the extension .JAR.

 

  • Use Alchemy CATALYST and JAR Editor.

default.css

Cascading style sheet file. Default.css is the default cascading style sheet applied to all topics in your project. Cascading style sheet is the term for HTML styles developed by the World Wide Web Consortium (W3C). "Cascading" refers to the hierarchy of the three styles (external style sheets, embedded, inline) when they are used in combination.

 

  • Use Alchemy CATALYST and CSS Editor.

fts.idx

Full-text search file. This file contains the full-text search database. If you add full-text search functionality to your project this database is searched when your users enter words and phrases.

 

  • Rebuild using JAVA Help SDK toolkit.

index.xml

Index file. The index file describes content and layout to the index navigator. This file uses XML and follows the index file format described in the Oracle Help for Java 3.2/4.1 specification.

 

  • Use Alchemy CATALYST and XML Editor.

  •  Use JavaHelp-NDX ezParse rule when inserting these files into a project TTK.

link.xml

Link file for associative links, also known as See Also controls. The link file is used by Oracle Help to generate the list of topics associated with a particular See Also keyword. This file is in XML format.

 

  • Use Alchemy CATALYST and XML Editor.

  • Use JavaHelp-LNK ezParse rule when inserting these files into a project TTK.

map.xml

Map file. A map file is used to associate Help topic IDs with the HTML files containing the Help content and with Window Types defined in the HelpSet. These IDs and the map file are used in the API for context-sensitive calls, in the table of contents files, and in index files. The format of the map file for Oracle Help is similar to the file format outlined in the JavaHelp 1.0 specification.

 

  • Use Alchemy CATALYST and XML Editor.

  • Use JavaHelp-MAP ezParse rule when inserting these files into a Project TTK.

toc.xml

Table of contents file. The table of contents file describes content and layout to the TOC view so the user sees the table of contents exactly the way you designed it. The file is in XML format and follows the table of contents file format described in the Oracle Help for Java 3.2/4.1 specification.

 

  • Use Alchemy CATALYST and XML Editor.

  • Use JavaHelp-TOC ezParse rule when inserting these files into a Project TTK.

Each Topic is an individual HTML file that has to be localised using the HTML Visual Editor.

note.bmp

The file  JavaHelp.ezp contains all the ezParse rules required to localization Oracle Help Systems. This can be located in the \samples folder.

For more information on Oracle Help Systems, please refer to JavaHelp Developers Guide.