186235 - Help Index should have an entry for "tooltips"

Status: VERIFIED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[R. Landfill]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.2.1) Gecko/20021130
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.2.1) Gecko/20021130

In the "Preferences|Appearance" there is a check box for "Show Tooltips".
However, I cannot find Tooltips in the Help. 



Reproducible: Always

Steps to Reproduce:
1. Open Help.  
2. Choose "Search"
3. Type in "Tooltips". 
4. Hit Enter. 

Actual Results:  
No information about Tooltips is displayed. 

Expected Results:  
Displayed some information about what a Tooltip is.

Comment 1

[Daniel Wang]

-> rudman

Comment 2

[R.J. Keller]

Nilson? Interested in taking this?

Comment 3

[Nilson Cain]

Yea, I will.  What do I need to do?  Explain what a tooltip is, and when it will
display?

Comment 4

[Nilson Cain]

Attachment: First proposal

See if it's the correct syntax, etc. and how it is.

Comment 5

[R.J. Keller]

hmm. Not sure about what help file to attach this to. I'll see tomorrow. If
anyone has any suggestions, feel free to post them.

Comment 6

[Nilson Cain]

If you'll notice, I took out the unneccesary <a NAME=""> tags and replaced them
with id="" in the h2s.  It serves the same purpose and is cleaner.

Hope that's OK.

Comment 7

[Daniel Wang]

-> Nilson

Comment 8

[Nilson Cain]

*NOTE*: Adding to cs_nav_prefs_apperance.html

Comment 9

[R.J. Keller]

--> me

I misinterpreted this bug. This is a request to add an entry to the index about
Tooltips.

This is in the wrong component. Moving this to Browser: Help

Comment 10

[[e-mail] (gone - use [e-mail] instead)]

I don't know if we want some mention of it or not, but there is also the
distinction for tooltip of them NOT being displayed for ALT attributes on HTML
elements, only for TITLE attributes.

See bug 25537 for more info.  I know it's controversial, but it may save someone
filing a DUP in the future.

Just a thought.

Comment 11

[R.J. Keller]

> I don't know if we want some mention of it or not, but there is also the
> distinction for tooltip of them NOT being displayed for ALT attributes on HTML
> elements, only for TITLE attributes.

This is end-user documentation. We don't want to have developer issues in the 
Help documentation.

I'll come up with a patch for this soon, since it looks like a quick fix.

Comment 12

[Worcester12345]

(In reply to comment #11)
> > I don't know if we want some mention of it or not, but there is also the
> > distinction for tooltip of them NOT being displayed for ALT attributes on HTML
> > elements, only for TITLE attributes.
> 
> This is end-user documentation. We don't want to have developer issues in the 
> Help documentation.
> 
> I'll come up with a patch for this soon, since it looks like a quick fix.

Looking forward to it! ;-)

Comment 13

[R.J. Keller]

Moving to new Help component owner.

Comment 14

[Giacomo Magnini]

Adding tooltip to index is easy: but where should it point to?
cs_nav_prefs_appearance.xhtml doesn't really explains what a tooltip is, and
there is no entry in the glossary for it. Should we add the item to glossay and
add the index entry pointing to it?

Comment 15

[Stefan [:stefanh]]

I think the Index entries just points to info in the help files, but not to the
glossary.

Comment 16

[Stefan [:stefanh]]

We don't want to put "tooltip" in the index, it's only mentioned in one
particular place. What we can do is to add an explanation to the glossary and
point to that in the appearance prefs text.

Comment 17

[Giacomo Magnini]

Attachment: As Stefan said (checked in)

Comment 18

[Stefan [:stefanh]]

Reassigning, also changing target milestone per discussion with Giacomo on irc.

Comment 19

[[e-mail]]

Comment on attachment 172810 [details] [diff] [review]
As Stefan said (checked in)

sr=me if you feel you need it ;-)

Comment 20

[Ian Neal]

Comment on attachment 172810 [details] [diff] [review]
As Stefan said (checked in)

Checking in cs_nav_prefs_appearance.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_appearance
.xhtml,v  <--  cs_nav_prefs_appearance.xhtml
new revision: 1.23; previous revision: 1.22
done
Checking in glossary.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/glossary.xhtml,v  <-- 
glossary.xhtml
new revision: 1.36; previous revision: 1.35
done

Comment 21

[Stefan [:stefanh]]

v