Using the Subsystem Management Window Help System

The Subsystem Management Window online help is a JavaHelpTM system, featuring a window with a toolbar and two panes:

Tips on Using the Table of Contents

Tips on Using the Index

Tips on Performing a Full Text Search

To search for a natural language phrase, select the Search tab, type the phrase in the Find: text box, then press Enter.

Example: Typing in the phrase "storage partitions" produces the following results in the Full Text Search pane:

There are three columns returned in the results.

Column Description
Ranking The red circle indicates how well the topic ranked. The more complete the circle is filled in, the higher the ranking. The best match is shown at the top of the pane, followed by other matches in descending rank order.

See, "How are the Topics Ranked?", below.
Number of Matches The second columns contains a number that indicates how many times the query was matched in the listed topic.
Topic title The selected topic in the navigation pane displays in the topic pane with matched passages highlighted in the help text in an alternate color.

How are the Topics Ranked?

The JavaHelp search engine uses two techniques, described below, to score passages of text in the help topics as answers to your query.

Technique Description
Relaxation Ranking

Your query is compared with occurrences of the same or related terms in the help topics. The search engine attempts to find passages in the help topics in which as many as possible of the query terms occur in the same form and the same order.

The search engine relaxes the query constraints to identify the passages in which:

  • Not all of the terms occur
  • The terms occur in different forms
  • The terms occur in a different order
  • The terms occur with intervening words

The search engine assigns lower rankings to the passages depending on how they deviate from your query.

Tip: To improve the ranking process, include as much information in your query as possible.

Morphing The JavaHelp search engine finds words with common roots. For example, if you type the word "manage" in the Find: textbox, matches that contain "managed", "management", "manages", and "managing" are also returned.

Note: In version 1.0 of JavaHelp, morphing is used only when the help system language is English.

Opening the Help System

To open the help system from... Procedure
The Subsystem Management Window Press F1, or select either the Help >> Quick Help or the Help >> Contents menu option.

Result: The help system opens. The Quick Help option initially displays the topic "Using the Enterprise Management Window" in the content pane, and the Contents option initially displays the "Introduction to the Enterprise Management Software" in the content pane.
The Storage Partitions Definitions Window Press F1, or select either the Help >> Quick Help or the Help >> Contents menu option.

Result: The help system opens. The Quick Help option initially displays the topic "Using the Storage Partitions Definitions Window" in the content pane, and the Contents option initially displays the "Introduction to Storage Partitions" in the content pane.
A dialog with a help button Select the help button on the dialog or press F1.

Result: The help system opens and a context-sensitive help topic is displayed in the content pane.
Printing the Help System

Printing is not supported by JavaHelp at the time of the help system development and release. However, the AMW_help.pdf file on your installation CD contains a copy of the Subsystem Management Window help system that can be printed using Adobe Acrobat ReaderTM.

Troubleshooting

There are a few known problems in the standard underlying Java components on which the JavaHelp system is based. The following table discusses known problems that you may encounter when using the help system.

If... Then...
Images are rendered incorrectly in the Content Pane, as shown in the example below:

Display another help topic, then redisplay the topic with the incorrectly rendered graphic.

Result: The graphic is correctly rendered.
You receive a "Null Pointer Exception" Java error while using the help system. In most cases, you can ignore this error and re-attempt to access the particular topic. If the problem continues to occur, contact your Customer Support representative.
When following a hypertext link in a help topic to another header within the topic, the referenced information displays in the center of the content pane instead of at the top. This is a known problem, and there is no solution for the current release.
You receive a "Helpset File Error: Helpset is Corrupt or Not Found" error when accessing the help system. Follow the instructions on the dialog to recover from the problem. If the problem continues to occur, contact your Customer Support representative.