To add the JHelp classes to your project, simply add the included jar file to your classpath. Some IDEs refer to this as libraries on the Java build path of your project. You can then build your project and include the JHelp classes with your application distributables.

• jhelp.jar is an executable jar that can be used to develop the help contents independent of the application. It assumes a content hierarchy file name of help.txt located in the same directory.

• Each line in the file represents a different help content topic.
• The title of the topic begins the line and the location of the content topic is specified by a "?=" followed by the path to the html file for this topic.
• A unique ID can be specified for each help content topic by using "uid=" followed by a unique ID. This ID can then be used to set the JHelpFrame to go to the target ID using the displayContentUID(String uid) method.
• A space before the topic title indicates a subtopic in the hierarchy.
• Example file:

  Getting Started  ?=help/start.html uid=start
  Content Hierarchy  ?=help/hierchy.html
  Topic  ?=help/topic.html
   Subtopic 1  ?=help/stopic1.html
   Subtopic 2  ?=help/stopic2.html
    Sub-Subtopic  ?=help/sstopic.html
  Graphics  ?=help/graphics.html
  Links  ?=help/links.html
  Search Tab  ?=help/search.html
  

• The tip content file is similarly structured to the help content file but there is no hierarchy or UIDs.
• The tips are indexed from 0 and can be displayed by using the showIndex(int index) method.
• The tip title is only used as an identification of the tip and never actually displayed in the JTipsDialog.
• Example file:

  Tip #1  ?=tips/tip1.html
  Tip #2  ?=tips/tip2.html
  Tip #3  ?=tips/tip3.html
  

Copyright 2001-2008 VersaEdge Software, LLC. All rights reserved.
Privacy Policy