TM JavaHelp 2.0 System User's Guide Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A. 650−960−1300 Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Sun, Sun Microsystems, the Sun Logo, Solaris, Java, the Java Coffee Cup Logo, J2SE, Java Foundation Classes (J.F.C.), Java Plug−in and JavaHelp are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON−INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software Clause at DFARS 252.227−7013 (Oct. 1988) and FAR 52.227−19 (c) (June 1987). JavaHelp System User's Guide i Table of Contents 1 JavaHelpTM System User's Guide JavaHelp 2.0 − February 2004.............................................................1 1.1 Keeping in Touch..............................................................................................................................1 1.1.1 Feedback...............................................................................................................................1 1.1.2 Mailing List.............................................................................................................................2 1.1.3 Discussion group (JAVAHELP−INTEREST)..........................................................................2 2 The JavaHelp 2.0 Release..............................................................................................................................3 2.1 Contents of the Release...................................................................................................................3 2.2 Requirements...................................................................................................................................4 2.3 New Features and Changes in JavaHelp 2.0...................................................................................4 2.3.1 Installation Packages..............................................................................................................4 2.3.2 Running the JavaHelp Viewer.................................................................................................4 2.3.3 JDK 1.1 is no longer supported...............................................................................................4 2.3.4 Change to API for Accessing Frames.....................................................................................4 2.3.5 Multi−Topic Printing.................................................................................................................5 2.3.6 Comprehensive Merging Options............................................................................................5 2.3.7 New Views in Help Viewer......................................................................................................5 2.3.8 Specifying View (Navigator) Icons or Text..............................................................................5 2.3.9 Presentation Controls..............................................................................................................5 2.3.10 Customizable Toolbar Support in Helpset File......................................................................5 2.3.11 Server−Based JavaHelp.......................................................................................................6 2.3.12 Helpset File has an Implementation Section.........................................................................6 2.3.13 Dynamic Context−Sensitive Help for Components...............................................................6 2.4 Demonstration Programs..................................................................................................................6 2.4.1 IDE Demo................................................................................................................................7 2.4.2 Object Demo...........................................................................................................................8 2.4.3 API Viewer..............................................................................................................................8 2.4.4 Merge Demo...........................................................................................................................9 2.4.5 Newmerge Demo....................................................................................................................9 2.4.6 Browser Demo........................................................................................................................9 2.4.7 Search Example......................................................................................................................9 2.4.8 Localized Helpsets..................................................................................................................9 2.5 Sample Helpsets.............................................................................................................................10 2.5.1 JavaHelp System User's Guide.............................................................................................10 2.5.2 History of the Holidays..........................................................................................................10 2.5.3 IDE Demo..............................................................................................................................10 2.5.4 ..............................................................................................................................................10 2.5.5 Localized Helpsets................................................................................................................11 2.5.6 ..............................................................................................................................................11 2.5.7 ..............................................................................................................................................11 2.6 The JavaHelp Libraries and Tools..................................................................................................11 2.6.1 Libraries................................................................................................................................11 2.6.2 Tools.....................................................................................................................................12 2.7 Limitations and Bugs......................................................................................................................12 2.7.1 HTML Viewer........................................................................................................................12 2.7.2 Full−text Search....................................................................................................................14 2.7.3 Context Sensitive Help..........................................................................................................14 2.7.4 Other Bugs............................................................................................................................15 2.8 List of Files in the JavaHelp 2.0 Release........................................................................................15 3 JavaHelp System Overview.........................................................................................................................19 3.1 Introduction.....................................................................................................................................19 3.2 JavaHelp System Features.............................................................................................................20 3.2.1 Help Viewers.........................................................................................................................20 JavaHelp System User's Guide i ii JavaHelp System User's Guide Table of Contents 3 JavaHelp System Overview 3.2.2 Table of Contents..................................................................................................................21 3.2.3 Index.....................................................................................................................................21 3.2.4 Full−Text Search...................................................................................................................21 3.2.5 Compression and Encapsulation..........................................................................................21 3.2.6 Embeddable Help Windows..................................................................................................21 3.2.7 Context−Sensitive Help.........................................................................................................21 3.2.8 Flexible Packaging................................................................................................................21 3.2.9 Customization.......................................................................................................................22 3.2.10 Merging...............................................................................................................................22