299974 - adjust Help docs to the new Help Viewer

Status: VERIFIED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[Steffen Wilberg]

We're mentioning the Index and Glossary in "Mozilla Firefox Help"
(firefox_welcome.xhtml) and How to Use Help (welcome.xhtml).

We also need to explain the search bar and how to switch back to Contents.

Comment 1

[Steffen Wilberg]

Attachment: patch

Something like this.

Comment 2

[Jeff Walden (gone starting June 8)]

Comment on attachment 188570 [details] [diff] [review]
patch

>+  Jeff Walden <[e-mail]>

This happens twice in this patch.  In both places change the email address to
<[e-mail]>, as that's what I use in code that is likely to be
publicly accessible and might be displayed in an unobfuscated form.

>+<p>To display information about &brandFullName; in this window, click topics in
>+  the <em>Contents</em> sidebar. Double-click or click the plus icon to see its
>+  subtopics.</p>

Single-click and double-click may both work.  However, single-click is a far
more familiar concept to new users (they may even have trouble
double-clicking).  Remove "Double-click or " here, please.

>+<p>To display help information in this window, click a topic in the
>+  <em>Contents</em> sidebar. Double-click or click the plus icon to see its
>+  subtopics.</p>

Once again, mention only double-click here.

>+  to see related topics. Then click the topic you want to read about. If your

Change that sentence to, "Click on a topic to read about it.".

Anyway, there's just one little problem remaining: the "plus icon" is not
always a plus icon (it's a triangle on Macs, at least), and I don't think
there's a good way to describe it in a cross-platform way.  I suppose we could
change the sentence to:

Click the <span class="noMac">plus icon</span><span class="mac">spinner
triangle</span> next to a topic to see its subtopics.

I haven't heard from Mano whether "spinner triangle" is both newbie-friendly
and non-insane, but before we check in anything we need to figure out what to
use there.  (Note also that I added "next to a topic" to clarify that the
twisty widget doesn't have subtopics.)	Whenever we figure out what to do, you
can fix that on checkin after approval.

Comment 3

[Jeff Walden (gone starting June 8)]

(In reply to comment #2)
> I haven't heard from Mano whether "spinner triangle" is both newbie-friendly
> and non-insane

He says it's "ok".  We could go with it if we had to, but I'd really like to do
whatever everyone else does, and Mano didn't know what that was.

Comment 4

[Steffen Wilberg]

The Apple HIG calls it "disclosure triangle":
http://developer.apple.com/documentation/UserExperience/Conceptual/OSXHIGuidelines/XHIGControls/chapter_18_section_7.html#//apple_ref/doc/uid/20000957-TP30000359-CHDFEEGH

Comment 5

[Jeff Walden (gone starting June 8)]

(In reply to comment #4)
> The Apple HIG calls it "disclosure triangle":

But do the Apple end-user help docs call it that?  End users aren't likely to
know HIG terminology.  HIGs are for software developers and designers, not end
users.

Comment 6

[Stefan [:stefanh]]

Looking at Apple's own support pages it looks like they're using "Disclosure
triangle" a lot (search for "disclosure triangle"). However, they also seem to
use "triangle". At least at
http://docs.info.apple.com/article.html?path=Mac/10.4/en/mh355.html. Doing some
Google searches gives me the impression that "Triangle" is most widely used.

I would use "triangle". You just need to know how that thing you should click on
looks like. Not what it actually is (if it's something else than a triangle...). 

Comment 7

[Steffen Wilberg]

Checked in with just "triangle".

Checking in mozilla/browser/locales/en-US/chrome/help/firebird-toc.rdf;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/firebird-toc.rdf,v  <-- 
firebird-toc.rdf
new revision: 1.30; previous revision: 1.29
done
Checking in mozilla/browser/locales/en-US/chrome/help/firefox_welcome.xhtml;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/firefox_welcome.xhtml,v  <--
 firefox_welcome.xhtml
new revision: 1.16; previous revision: 1.15
done
Checking in mozilla/toolkit/locales/en-US/chrome/mozapps/help/help-toc.rdf;
/cvsroot/mozilla/toolkit/locales/en-US/chrome/mozapps/help/help-toc.rdf,v  <-- 
help-toc.rdf
new revision: 1.4; previous revision: 1.3
done
Checking in mozilla/toolkit/locales/en-US/chrome/mozapps/help/welcome.xhtml;
/cvsroot/mozilla/toolkit/locales/en-US/chrome/mozapps/help/welcome.xhtml,v  <--
 welcome.xhtml
new revision: 1.4; previous revision: 1.3
done

Comment 8

[Jeff Walden (gone starting June 8)]

(In reply to comment #6)
> I would use "triangle". You just need to know how that thing you should click on
> looks like. Not what it actually is (if it's something else than a triangle...). 

Yeah, that makes far more sense than what I'd suggested; thanks for looking into
this.  Now, on to the next bug...