Oracle Help

Latest revision as of 09:24, 18 December 2020

Oracle Help is a help "system" consisting of a common format, and software for two modes of playback: Oracle Java Help, a help viewer embedded in a Java program; and Oracle Web Help, a help viewer that serves pages over HTTP. Oracle Help's format appears to have been, from its early days^[2], based on that of JavaHelp, though curiously it was released long before Sun (the creator of JavaHelp) was bought by Oracle.

The formats a single "HelpSet" uses include:

• HelpSet file, extension ".hs", which provides metadata about the whole help set, and the names of other files;^[3]
• map files, XML files (with the extension .xml^[4]) that map topic IDs (strings identifying individual help topics) to HTML content files;
• table of contents files, extension .xml^[5], though and "old [relative to 2011] version" had extension .toc^[6], which give tables of contents;
• index files, extension .xml^[6], .tok for the "old version"^[6], which give (human-readable) indexes;
• search index files, in "a proprietary binary format"^[7] with extension ".idx"^[8] that stores a text search index, and is generated by a program distributed with Oracle Help^[9];
• link files, similar to map files, but which map link IDs (aliases used in the targets of links on content pages, in lieu of actual destination file names) to topic IDs (which are in turn mapped to content files)^[10]
• the "topic files", HTML files that hold the actual content of the help^[11].

[edit] Specifications

• Format specification in the v. 12.1.3 manual

[edit] Links

• Website (2010-2018)
  • Manual for v. 12.1.3
• Website (Current, as of 2020)

[edit] See Also

• JavaHelp
• CHM

[edit] References

1. ↑ https://web.archive.org/web/20010129073900/http://www.ehelp.com/RoboHelp/web/oraclehelp.shtm
2. ↑ https://web.archive.org/web/20010208114209/http://www.ehelp.com/RoboHELP/products/formatcomparison.shtm
3. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-metadata-files.htm#CACJACAB
4. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-metadata-files.htm, section 5.2.3, example
5. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-metadata-files.htm, section 5.2.6, following "If both of the labels were the same"
6. ↑ ^{6.0 6.1 6.2} https://web.archive.org/web/20110418143359/http://www.oracle.com/technetwork/topics/faq-099989.html, "How do I convert help files created in other authoring systems to Oracle Help format?"
7. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-helpinfo-files.htm, section 6.5
8. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-text-search-index.htm
9. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-text-search-index.htm
10. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-helpinfo-files.htm, section 6.6
11. ↑ https://docs.oracle.com/middleware/1213/jdev/develop-help/orahelp-topic-files.htm