This repository was archived by the owner on Jan 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathlimitations.html
More file actions
206 lines (197 loc) · 9.93 KB
/
limitations.html
File metadata and controls
206 lines (197 loc) · 9.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--
* Copyright © 2003 Sun Microsystems, Inc
* All rights reserved.
* Notice of copyright on this source code
* product does not indicate publication.
*
* 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).
* Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A.
*
-->
<html>
<head>
<title>Limitations and Bugs</title>
<link rel="stylesheet" type="text/css" href="../jhug.css" title="Style">
</head>
<body bgcolor="#ffffff">
<h2>Limitations and Bugs</h2>
<p>This release of JavaHelp has the following limitations and bugs.</p>
<h3><a name="htmlviewer">HTML Viewer</a></h3>
<p> 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.
<h4>Images Distorted</h4>
<p>
Occasionally, images are distorted (stretched).
Redisplaying the page corrects the problem.
<p> You can sometimes avoid this problem by explicitly specifying "height" and
"width" attributes with the <code><img></code> tag. For example,
<p><code> <img src="../../images/hg_note.gif" width="18"
height="13"></code>
<h4><a name="classpathlimitations">Classpath Limitations</a></h4>
<p> Due to Java security protocols, it is not possible to reference images and
files from your topics that are outside the <code>CLASSPATH</code> of your application
(or <code>hsviewer</code>). </p>
<p>For example, you start <code>hsviewer</code> with the following command: </p>
<p><code> java -jar c:\JavaHelp\demos\bin\hsviewer.jar -helpset
C:\my_app\help\myhelpset.hs </code></p>
<p> The <code>hsviewer</code> application sets the <code>CLASSPATH</code> to be:</p>
<p><code> C:\my_app\help </code></p>
<p>You cannot reference files above the <code>C:\my_app\help</code> folder. For example,
in the following code an image in <code>C:\my_app\images</code> referenced as follows
cannot be displayed:
<p>
<code>
<IMG SRC="../../images/foo.gif">
</code></p>
<p> You can work around this problem by using the <code>-classpath</code> parameter
of <code>hsviewer.jar</code>. The parameter allows you to specify a <code>CLASSPATH</code>
separately from the helpset file, enabling you to set the <code>CLASSPATH</code>
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:</p>
<pre> java -jar c:\JavaHelp\demos\bin\hsviewer.jar -helpset C:\my_app\help\myhelpset.hs
-classpath C:\my_app</pre>
<h4>Duplicate Lines Displayed (J2SE 1.2.2) </h4>
<p> 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.
<h4>Anchor Targets</h4>
<p>There are two problems with anchors:</p>
<ul type="circle">
<li>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. </li>
<li> Named anchors cause a space to be added at the beginning of the object
that follows them.
</ul>
<p> The best way to work around this problem is to nest the text of the target
within the anchor tag. For example: </p>
<p><code> <H2><a name="widgets">Working With Widgets</a></H2>
</code></p>
<h4>Cascading Style Sheets</h4>
<p> Tag names in styles and style sheets <i>must</i> be specified with lowercase
letters or they will be ignored.
<h4><tt><sup></tt> and <tt><sub></tt> Tags (J2SE 1.2.2) </h4>
<p> The <code><sup></code> <code><sub></code> tags are ignored on J2SE 1.2.2
systems.
<h4>The Width Attribute of the <tt><td></tt> Tag</h4>
<p> 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.
<p> 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.
<h4>Named Anchors in Ordered and Unordered Lists</h4>
<p> If the first item after a list tag (<code><ul></code>, <code><ol></code>,
or <code><dl></code>) is a named anchor (<code><a name></code>), the list
shown in the following example is rendered incorrectly:
<pre><ul>
<a name="17539"> </a>
<li>Transmitter reports
<a name="17540"> </a>
<li>Channel reports
</ul></pre>
The following list is rendered correctly:
<pre><ul>
<li><a name="17539">Transmitter reports</a></li>
<li><a name="17540">Channel reports</a></li>
</ul></pre>
<h4>TABS in <tt><pre></tt> Tag not Recognized</h4>
<p> TABS used in text enclosed in <code><pre></code> tags are not recognized.
Space characters are recognized correctly.
<h4>Viewer Cannot Load Image Files Directly</h4>
<p> 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 <code><img></code>
tag.
<h4>Page Setup Settings not Preserved (Printing)</h4>
<p>
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.
<h3>Full-text Search</h3>
<p>The text search feature, implemented by running <code>jhindexer</code> on your helpset, has the following limitations and bugs.</p>
<h4>Parsing of Asian Languages</h4>
<p>
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.
<p> 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:
<ol>
<li>Double-click a word in the content pane.
<li>Copy and paste the word into the search navigator Find field.
<li>Press Return.
</ol>
<h4>Match Limit</h4>
<p>
To enhance full-text search performance, the
search navigator reports the 100 most relevant matches.
For example, in the <code>idedemo</code> program, if you search for the
word "build", you see that different forms of the
word (builder, built, builds) are not highlighted because
the 100 match limit was met with the exact match "build".
This limit should not be a problem with more complex, multi-word, natural
language queries.
<h4>jhindexer Does Not Parse <tt>"."</tt> Correctly</h4>
<p> The <code>jhindexer</code> does not treat the <code>"."</code> character correctly.
As as result, a search for <code>"javax.help"</code> in the <code>apiviewer</code>
returns no matches.</p>
<h3>Context Sensitive Help</h3>
<!--
<h4>Field-Level Help Button</h4>
<p>
In the idedemo, if the field-level help button is clicked before the help
viewer has been accessed (for example, Help > Demo JDE Help), a
NullPointerException occurs. -->
<h4>F1 Help (Solaris OpenWindows) </h4>
<p>
On Solaris OpenWindows manager the F1 key does not get help
on the the component with focus.
</p>
<h3>Other Bugs</h3>
<h4>Copy/Paste on Solaris</h4>
<p>
On Solaris systems, follow these steps to copy and paste text from the help viewer:
<ol>
<li>Highlight text in the viewer.
<li>Type Control-C to copy the text.
<li>With focus in the target Solaris window, press the Paste key.
</ol>
<h4><tt>jar:</tt> Protocol</h4>
<p> Due to a bug, the Java<sup><font size="1">TM</font></sup> 2 SDK <code>jar:</code>
protocol does not permit relative references to JAR files. Instead, they must
be fully qualified. For example, the following code works correctly:
<p><code> jar:file://c:/my_app/help.jar!map.jhm</code>
<p>There is no way to make that reference relative from the location of a helpset
file. For that reason, you must include the helpset and map files in the JAR
file with the rest of the helpset.
<h4>Index Navigator</h4>
<p>
If an index entry contains more that two hierarchical levels,
a "turner" mechanism (like the one used in the TOC) is
added to the second +<i>n</i> levels.
<h4>Popup Window Accessibility</h4>
<p> JavaHelp popup windows are not as accessible as they should be due to a bug
in the underlying AWT classes that prevents the popups from obtaining focus.
Popup windows can be dismissed by pressing the F10 key - the Esc key does not
work because the window cannot obtain focus. In addition, this same bug prevents
scrollbars in popup windows from being accessible from the keyboard; therefore,
it is important to set the size of popups to enable all the information to be
displayed in a single scroll zone.
<h4>Fonts and Localization</h4>
<p> There are limitations in this release on the ability to display fonts in the
help viewer content pane. Due to a bug in the J2SE, the only character encoding
that can be displayed in the HTML content pane is the system default. Different
locales that use that encoding are rendered correctly. `
</body>
</html>