How to Use This JavaHelp Document

The document is displayed in a window that includes the following panes:

 

 

Following are explanations of JavaHelp features:

Using the Menu Pane

The menu pane displays the following items:

Item

Description

File

Open Page—Displays the Open Page dialog box, which allows you to enter a URL of a WWW (World Wide Web) location.

Exit—Closes the help project.

Options

Set Font—Displays the Set Font dialog box, which allows you to specify the font size and style.

Using the Toolbar Pane

The toolbar pane displays the following buttons:

Buttons

Description

Enables you to redisplay pages that you have previously viewed.

  • The Back button returns to the last page you viewed before opening the current page. If you use the Back button repeatedly, it takes you in reverse order through the sequence of pages you have already viewed.

  • The Forward button takes you forward through a sequence of pages that you previously viewed.

Contrast these buttons with the Previous and Next buttons.

Prints the topic you are viewing.

See Printing from This Document for additional information.

Brings up the Page Setup dialog box, which allows you to specify page and printer values.

Using the Navigation Pane

The navigation pane contains the following tabs:

Tab Name

Description

Contents Tab

Presents a hierarchical, expandable/collapsible table of contents. Initially, the contents is displayed in expanded form. You can display each subject area in as much or little detail as you want. The following symbols are used in the table of contents:

A "book" with subtopics. Click to expand/collapse.

A single topic. It can be part of a "book" or can be separate. Click to display the topic.

Index Tab

A list of index entries.  To find a term, do one of the following:

  • Type a term in the box labeled Find, then press Enter. The list scrolls to the first occurrence of the term, if any, and the topic appears in the topic window.

  • Scroll through the list of index entries until you find a term that interests you, then click on it.

Search Tab

To do a search:

  • Type the word or phrase in the box labeled Find.

  • Press Enter.

A list of topics appears in the navigation pane, with the first topic displayed in the topic pane. The search words are highlighted in the topic. When you select another topic title, its contents appear in the topic pane.

A solid red circle (preceding the topic title) indicates the matching criteria is a close one—the results match the search string in form and order of words.

the more filled the circle, the closer the match. The number indicates how many times the search string or an approximation of the search string occurs in the topic.

A half-filled red circle (preceding the topic title) indicates the matching criteria was not as close as those preceded by a solid red circle.

<number preceding the topic title>

A number (preceding the topic title) indicates how many times the search string or an approximation of the search string occurs in the topic.

Note:  Topic titles are listed in order first by the scores attached to the filled circles, then by the number of occurrences.

Search behavior:

  • Searches are not case-sensitive.

  • Searches ignore all punctuation marks, such as periods, commas, and hyphens.

  • When the search or index feature cannot locate the requested words or character strings, you do not receive a message to that effect.

  • The highlighting of a found string is sometimes misaligned by several characters.

  • The search feature does not always find all occurrences of a word.

Using Hide/Show Feature

Buttons

Description

These buttons, located between the navigation pane and the topic pane, enable you to hide the navigation pane and then redisplay it. When you move the mouse over the button, a horizontal line with an arrow at each end appears. Click to hide/show the navigation pane.

Using the Topic Pane

The topic pane displays the following buttons:

Buttons

Description

These buttons enable you to display pages in the order that they appear in the table of contents. It is a browse sequence.

  • The Previous button jumps to the previous page in the browse sequence.

  • The Next button jumps to the next page in the browse sequence.

Contrast these buttons with the Back and Forward buttons in the Toolbar pane.

The topic frame displays the text of the current help topic. The following are some symbols and icons that you might see in JavaHelp topics:

Symbols and Icons

Description

Software Caution

Hardware Caution

Indicates information about preventing possible damage to equipment or loss of data.

WARNING

Indicates information about preventing injuries or fatalities.

Changing the Size of Panes

You can change the relative size of the panes by clicking on a border between the panes and then dragging the border to resize it. For example, if you want the navigation pane to be wider, click the border between the navigation pane and the topic pane and drag the border to the right.

Selecting Objects in JavaHelp Documentation

You can use either a mouse or keyboard actions to select objects on the menu, toolbar, and navigation panes. Selected objects are highlighted on the menu pane and outlined on the toolbar and navigation panes.

Mouse ActionsClicking the left mouse button selects the object.

KeyboardThe following keyboard actions select objects:

Display Appearance

Copying Text

The cursor does not change when you point to text in a topic. To copy text to the Windows clipboard, select the text with the arrow cursor (the selected text will change color) and press Ctrl-C on your keyboard.