257007 - Bad link text ("click here") in Firefox help

Status: VERIFIED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[PikeUK]

There are a couple of uses of "click here" in Firefox help, the phrase is
specifically forbidden in the style guide:

http://www.mozilla.org/projects/help-viewer/documentation_language-style.php#links

"Link texts should make sense out of context. [...] In particular, the phrase
"click here" must never be used."

http://lxr.mozilla.org/aviarybranch/source/browser/components/help/locale/en-US/menu_reference.xhtml#268
http://lxr.mozilla.org/aviarybranch/source/browser/components/help/locale/en-US/menu_reference.xhtml#273

Comment 1

[R.J. Keller]

Moving to new Firefox Help owner.

Comment 2

[Sean Umphlet (nosebleed)]

Taking.

I think it would be a good idea to change

<a href="customization.xhtml#themes[extensions]">Click here</a> for more
information on themes[extensions].

to

See <a href="customization.xhtml#themes[extensions]">Themes[Extensions]</a> for
more information on themes[extensions].

I can make a patch really quick, but I'm waiting for another patch on the same
file to get checked in.

Comment 3

[Jeff Walden (gone starting June 8)]

(In reply to comment #2)
> See <a href="customization.xhtml#themes[extensions]">Themes[Extensions]</a>
> for more information on themes[extensions].

Think about how that would look:

See _Themes_ for more information on themes.

It's redundant.  It's also why I haven't touched this bug yet: I couldn't come
up with something that wasn't redundant.  Looking at this again jogged my brain
some, so I think I have a solution:

For more information, see the _Themes_ help topic.

If you agree that this works, make a patch with this wording and I'll r+ it.

Comment 4

[Sean Umphlet (nosebleed)]

Attachment: First Patch

Jeff, that looks like a satisfactory sentence to me... I hope the attached
patch is sufficient enough.

Comment 5

[Jeff Walden (gone starting June 8)]

Comment on attachment 159243 [details] [diff] [review]
First Patch

r=[e-mail]

I'll check this in sometime later today.

Comment 6

[Jeff Walden (gone starting June 8)]

Well, maybe not "today", per se...fixed branch & trunk.