JavaHelp TM 2.0系统用户指南

需积分: 10 49 浏览量更新于2024-07-30 收藏 590KB PDF 举报

"JavaHelp TM 2.0 System User's Guide 是 Sun Microsystems 出版的一份关于 JavaHelp 的用户指南，主要针对的是 Java 平台上的帮助系统开发。这份文档详细介绍了如何使用 JavaHelp 系统来创建、管理和呈现应用程序的帮助内容。JavaHelp 是 Java 应用程序的标准帮助系统，提供了一种组织和显示丰富内容的方法，包括上下文敏感的帮助、索引、搜索功能等。" 在 JavaHelp 系统中，开发者可以利用其丰富的特性和组件来构建高效且用户友好的帮助系统。例如，JavaHelp 提供了以下关键组成部分： 1. **框架**：JavaHelp 框架是整个系统的中心，它负责管理帮助内容、处理用户的请求，并将请求转发到相应的帮助组件。 2. **帮助集（HelpSet）**：这是一个定义了帮助内容结构的文件，它包含了帮助主题、索引、搜索配置等信息。开发者可以通过 HelpSet 来组织和分类帮助内容。 3. **主题（Topic）**：主题是帮助系统的基本单元，包含具体的帮助信息。它们可以是 HTML 文件或其他支持的格式。 4. **索引**：JavaHelp 支持创建和使用索引来快速定位帮助内容，用户可以通过关键词进行查找。 5. **搜索**：系统提供了全文本搜索功能，允许用户输入关键词来搜索整个帮助集。 6. **上下文敏感帮助**：JavaHelp 可以与应用程序集成，当用户在应用中遇到问题时，可以即时触发相关的帮助内容。 7. **书签和收藏**：用户可以保存感兴趣的主题以便日后查看。 8. **跳转链接**：帮助内容中可以包含内部和外部链接，方便用户在帮助系统内导航或跳转到其他资源。 JavaHelp 2.0 版本可能包含了一些新特性、改进和对旧版本的兼容性修复。这份文档会详细阐述如何设置和配置这些组件，以及如何将 JavaHelp 集成到 Java 应用程序中。此外，它还可能涵盖了错误处理、自定义外观和国际化支持等内容。对于开发人员来说，理解并掌握 JavaHelp 系统的使用方法，可以帮助他们为自己的应用程序提供高质量的帮助文档，提升用户体验。通过阅读这份指南，读者可以学习如何创建定制化的帮助系统，满足特定项目的需求。同时，文档中提到的法律条款和限制也应引起注意，特别是对于政府机构使用的情况，可能需要遵循特定的法规和许可证要求。

demos/browser/demo_instructions.

2.4.7 Search Example

The file demos/src/sunw/demo/searchdemo/ClientSearch.java shows how to extend the

HelpSearch class to implement an alternate search engine.

2.4.8 Localized Helpsets

Localized demonstration helpsets (English, German, Japanese) for the IDE demo are included in the

demos/hsjar folder. Be sure to choose the appropriate font in the JavaHelp viewer's Set Fonts dialog box

(choose Options > Set Font).

You must have installed the appropriate Unicode fonts to be able to view the Japanese helpset.

Also, you use a different command to run helpsets. The command is:

java −jar hsviewer.jar [−helpset hs_name]

For example (on a Windows system):

C:\> java −jar c:\JavaHelp\demos\bin\hsviewer.jar

−helpset c:\JavaHelp\demos\hs\newmerge\MergeHelp.hs

2.5 Sample Helpsets

This release includes a variety of helpsets packaged in different ways. Many of these helpsets are used by the

demonstration programs, but you can also use the hsviewer executable jar file to view them.

Helpsets are described in detail in Authoring Help Information.

You can view these helpsets to familiarize yourself with the capabilities of the JavaHelp system. You can also

use these helpsets as templates for creating your own help systems. The helpsets are described below.

2.5.1 JavaHelp System User's Guide

The JavaHelp System User's Guide (this document) is also available as a JavaHelp helpset. It is located in

doc\jhug.

2.5.2 History of the Holidays

This helpset is interesting because it shows how a help system can be set up with two different TOCs. This

helpset can be found in the following location:

JavaHelp_Home/demos/hsjar/holidays.jar

To view this helpset on a UNIX system, use the following command:

java −jar JavaHelp_Home/demos/bin/hsviewer.jar \

−helpset JavaHelp_Home/demos/hsjar/holidays.jar

To view this helpset on a Windows system, use the following command in a Command window:

java −jar JavaHelp_Home\demos\bin\hsviewer.jar −helpset JavaHelp_Home\demos\hsjar\holidays.jar

JavaHelp System User's Guide

10 2.4.7 Search Example

2.5.3 IDE Demo

This helpset is used in the IDE Demo demonstration program. It is located in

demos/hsjar/idehelp.jar

To view this helpset on a UNIX system, enter the following command at the command line:

java −jar JavaHelp_Home/demos/bin/hsviewer.jar \

−helpset JavaHelp_Home/demos/hsjar/idehelp.jar

To view this helpset on a Windows system, use the following command in a Command window:

java −jar JavaHelp_Home\demos\bin\hsviewer.jar −helpset JavaHelp_Home\demos\hsjar\idehelp.jar

2.5.4

2.5.5 Localized Helpsets

Two localized helpsets, one in German and another in Japanese, are included in the release. For more

information about localizing helpsets, see Localizing Help Information.

To view these helpsets, you must have installed the correct fonts on your system.

2.5.5.1 German

This helpset is a portion of the IDE demo helpset that has been localized in German. It is located in

JavaHelp_Home/demos/hsjar/idehelp_de.jar

To view this helpset on a UNIX system, enter the following command at the command line:

java −jar JavaHelp_Home/demos/bin/hsviewer.jar \

−helpset JavaHelp_Home/demos/hsjar/idehelp_de.jar

To view this helpset on a Windows system, use the following command in a Command window:

java −jar JavaHelp_Home\demos\bin\hsviewer.jar −helpset JavaHelp_Home\demos\hsjar\idehelp_de.jar

2.5.6

2.5.6.1 Japanese

This helpset is a portion of the IDE demo helpset that has been localized in Japanese. To view the Japanese

helpset, you must have installed the correct Unicode fonts. This helpset is located in

JavaHelp_Home/demos/hsjar/idehelp_ja.jar

To view this helpset, enter the following command at the UNIX command line:

java −jar JavaHelp_Home/demos/bin/hsviewer.jar \

−helpset JavaHelp_Home/demos/hsjar/idehelp_ja.jar

To view this helpset on a Windows system, use the following command in a Command window:

java −jar JavaHelp_Home\demos\bin\hsviewer.jar −helpset JavaHelp_Home\demos\hsjar\idehelp_ja.jar

JavaHelp System User's Guide

2.5.3 IDE Demo 11

2.5.7

2.6 The JavaHelp Libraries and Tools

The JavaHelp libraries and tools are located in the javahelp folder of the release. All classes work with the

Java 2 Platform, Standard Edition (J2SE) and use Swing 1.2 or later (included in the J2SE).

2.6.1 Libraries

The JavaHelp classes are distributed in the following four JAR files located in the javahelp\lib folder:

jh.jar The standard library, which includes everything needed to use the standard

navigator types (TOC, index, full−text search).

jhbasic.jar A subset of jh.jar that does not include support for the full−text search engine.

This subset might be useful for very simple help systems that do not require a

full−text search database or for help systems in which size is critical.

jhall.jar Contains all the JavaHelp system classes, including the tools required to create a

search database.

jsearch.jar Contains the default full−text search engine used in the JavaHelp system.

2.6.2 Tools

The JavaHelp tools are used to view helpsets and to build and query the full−text search database. These

tools are located in the javahelp\bin folder.

jhindexer Command−line program that creates the full−text search database used by the JavaHelp

system full−text search navigator to locate matches.

jhsearch Command−line program that queries the JavaHelp system full−text search database that is

created with the jhindexer command. You can use jhsearch to test a search database

without invoking the help viewer.

2.7 Limitations and Bugs

This release of JavaHelp has the following limitations and bugs.

2.7.1 HTML Viewer

The JavaHelp HTML viewer is based on the Swing JEditorPane component. HTML rendering can differ

depending on which version of Swing your application uses. Differences between versions are noted below.

2.7.1.1 Images Distorted

Occasionally, images are distorted (stretched). Redisplaying the page corrects the problem.

You can sometimes avoid this problem by explicitly specifying "height" and "width" attributes with the <img>

tag. For example,

JavaHelp System User's Guide

12 2.5.7

2.7.1.2 Classpath Limitations

Due to Java security protocols, it is not possible to reference images and files from your topics that are

outside the CLASSPATH of your application (or hsviewer).

For example, you start hsviewer with the following command:

java −jar c:\JavaHelp\demos\bin\hsviewer.jar −helpset

C:\my_app\help\myhelpset.hs

The hsviewer application sets the CLASSPATH to be:

C:\my_app\help

You cannot reference files above the C:\my_app\help folder. For example, in the following code an image

in C:\my_app\images referenced as follows cannot be displayed:

You can work around this problem by using the −classpath parameter of hsviewer.jar. The parameter

allows you to specify a CLASSPATH separately from the helpset file, enabling you to set the CLASSPATH to

include the folder that contains the image and specify the helpset file relative to that folder. For example, you

could enter the following command (all on one line) at the command line:

java −jar c:\JavaHelp\demos\bin\hsviewer.jar −helpset C:\my_app\help\myhelpset.hs

−classpath C:\my_app

2.7.1.3 Duplicate Lines Displayed (J2SE 1.2.2)

If a TOC, or index entry points to an anchor target specified at or near the top of the page (in the first scroll

zone), the viewer can position the lines incorrectly, resulting in lines' being displayed twice.

2.7.1.4 Anchor Targets

There are two problems with anchors:

On J2SE 1.2.2 systems only, if the TOC or index is used to access a topic file that contains anchor

targets in the first scroll zone in the viewer, text will be duplicated in the display.

•

Named anchors cause a space to be added at the beginning of the object that follows them.•

The best way to work around this problem is to nest the text of the target within the anchor tag. For example:

<H2><a name="widgets">Working With Widgets</a></H2>

2.7.1.5 Cascading Style Sheets

Tag names in styles and style sheets must be specified with lowercase letters or they will be ignored.

2.7.1.6 <sup> and <sub> Tags (J2SE 1.2.2)

The <sup> <sub> tags are ignored on J2SE 1.2.2 systems.

JavaHelp System User's Guide

2.7.1 HTML Viewer 13

2.7.1.7 The Width Attribute of the <td> Tag

The width attribute of the <td> tag is ignored in J2SE 1.2. That version of the viewer assigns its own width to

table columns.

On J2SE 1.2.2, the width attribute works when specified in absolute pixels (px). The use of percentages (%) is

not supported in that version of J2SE.

2.7.1.8 Named Anchors in Ordered and Unordered Lists

If the first item after a list tag (<ul>, <ol>, or <dl>) is a named anchor (<a name>), the list shown in the

following example is rendered incorrectly:

<ul>

<li>Transmitter reports

<li>Channel reports

</ul>

The following list is rendered correctly:

<ul>

<li><a name="17539">Transmitter reports</a></li>

<li><a name="17540">Channel reports</a></li>

</ul>

2.7.1.9 TABS in <pre> Tag not Recognized

TABS used in text enclosed in <pre> tags are not recognized. Space characters are recognized correctly.

2.7.1.10 Viewer Cannot Load Image Files Directly

The help viewer aborts if you attempt to load a graphic file (*.gif, *.jpg) directly. You must include the images

in an HTML file by using the <img> tag.

2.7.1.11 Page Setup Settings not Preserved (Printing)

Changes made to the default settings in the Page Setup dialog box are not preserved between activations.

The default settings are always set upon activation.

2.7.2 Full−text Search

The text search feature, implemented by running jhindexer on your helpset, has the following limitations

and bugs.

2.7.2.1 Parsing of Asian Languages

The J2SE word−break iterator that the JavaHelp search indexer and search navigator use to parse Asian

(Japanese, Chinese, Korean, Thai) languages uses a heuristic that is not well suited to searching. As a result,

topic files are not parsed into words that users are likely to enter into the Find input field.

However, because the parser works on the same model used to highlight words when the user double−clicks

in the content pane, as a workaround (albeit an inconvenient one), the Asian language user can conduct a

full−text search as follows:

Double−click a word in the content pane.1.

Copy and paste the word into the search navigator Find field.2.

JavaHelp System User's Guide

14 2.7.1 HTML Viewer

剩余133页未读，继续阅读

ai945366631

粉丝: 0
资源: 1

JavaHelp TM 2.0系统用户指南

Java帮助文档.pdf

Java帮助文档.zip

java帮助文档中文版1

java 帮助文档

Java帮助文档

JAVA 帮助文档

JDK帮助文档 JAVA帮助文档

java 帮助文档java基础

Java帮助文档很好的Java中文帮助

《最全常用Linux命令集》.pdf

最新资源