[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [platform-help-dev] Tooltip text in Contents view?
|
There was a similar discussion regarding the label and the tooltip of
search results:
http://dev.eclipse.org/mhonarc/lists/platform-help-dev/msg00038.html.
Yes, performance is the major concern here, although, as a help user, I
don't see much value in hovering over topics and see some abstract of the
topic. Given that tooltips pop up with some delay, I'd say that is probably
better to just click on the topic and read it. If some topics have it, they
may create the false expectation that tooltips may contain important info,
but if not all the topics have it, then it's a bit confusing. If all the
topics have tooltips, I'd see a major performance problems when dealing
with large books.
On the other hand, tooltips on books (primary TOC's) may be useful when
books are large and downloading one would take a while. The tooltip would
help get some basic info first, before deciding to load the entire book.
I like your suggestion to get the abstract when the TOC's are built, as
this would only parse files once.
-Dorian
|---------+----------------------------------->
| | Steve |
| | Woolley/UK/IBM@IBMGB |
| | Sent by: |
| | platform-help-dev-admin@|
| | eclipse.org |
| | |
| | |
| | 04/24/2003 05:24 AM |
| | Please respond to |
| | platform-help-dev |
| | |
|---------+----------------------------------->
>-------------------------------------------------------------------------------------------------------------|
| |
| To: platform-help-dev@xxxxxxxxxxx |
| cc: |
| Subject: [platform-help-dev] Tooltip text in Contents view? |
| |
| |
>-------------------------------------------------------------------------------------------------------------|
Hi folks,
The feature that displays the search results context in hover help/tooltip
text (when you hover the pointer over search results) is a useful addition
to the V2.1 Help system. Currently, when you hover the pointer over a
topic in the navigation tree (Contents view), you only get a duplication of
the topic label attribute in the hover help. Whilst this is useful when
the length of the topic label exceeds the width of the contents/navigation
frame, it offers little more value (although it may have accessibility
implications that I have overlooked?). Is it possible to display an
abstract for each topic in the hover help in addition to the toc label
attribute?
The proposal for achieving this is as follows:
Topic abstracts or descriptions could be embedded as metadata within the
HTML:
<head>
.
.
.
<meta name="abstract" content="Learn the basics of caring for your new pet
bat." />
.
.
.
</head>
When the ToC is built, the help system parses the <meta name="abstract"
content="blah blah blah" /> string from the HTML file and populates the
tooltip text with this string instead of the toc label attribute string.
I would expect the see this tooltip rendered as:
+----------------------------------------------------------------------+
| Learn how to care for your new pet bat | <-------- derived
from <topic label="Learn how to care for your new pet bat" href
="batcare.html" />
| Learn the basics of caring for your new pet bat. | <--------
derived from <meta name="abstract" content="Learn the basics of caring for
your new pet bat." />
+----------------------------------------------------------------------+
Topics not containing <meta name="abstract" /> will only display the toc
label attribute string in the hover help/tooltip text as implemented in
V2.1.
I suspect there will be a degradation in performance associated with
parsing the abstract from every topic in the ToC, but variations on this
approach may be possible.
Any thoughts?
Steve
________________________________________________________________________________
Stephen Woolley - User Assistance Architect
WebSphere MQ Integrator User Technologies
Mail Point 095, IBM United Kingdom Laboratories, Hursley Park,
Winchester, Hampshire, SO21 2JN, United Kingdom
Steve Woolley/UK/IBM@IBMGB swoolley@xxxxxxxxxx
Tel/Fax: +44 (0)1962 818428 Internal: 248428
Home Office: (01962) 774812 / +44 1962 774812
_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev
