255131 - Nits in Keyboard Shortcuts docs

Status: RESOLVED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[Jeff Walden (gone starting June 8)]

The Keyboard Shortcuts docs have some quirks.  The biggest issue is that the
capitalization of minor words like "in" and "the" is somewhat inconsistent.  The
other issue is that the wording for "Delete Individual Form Auto-Complete Entry"
is a little odd (too long, too specific because it ignores the location bar, for
example).  The forthcoming patch will change it to "Delete Selected Autocomplete
Entry", which is in my opinion better because it's shorter, more informative,
covers more use cases, and doesn't hyphenate autocomplete (I've never seen it
hyphenated except in this one location).

Comment 1

[Jeff Walden (gone starting June 8)]

Attachment: Patch for autocomplete deletion & lowercases little words consistently

Comment 2

[Jeff Walden (gone starting June 8)]

We might also have to alter the Downloads shortcut per a thought started in bug
228699 comment 40.  I'm keeping an eye on it through the CC list.

Comment 3

[R.J. Keller]

Comment on attachment 155768 [details] [diff] [review]
Patch for autocomplete deletion & lowercases little words consistently

>        <td><kbd>Shift</kbd>+<kbd>F3</kbd></td>
>      </tr>
>      <tr>
> -      <td>Find on this page</td>
> +      <td>Find in This Page</td>
>        <td><kbd>Ctrl</kbd>+<kbd>F</kbd></td>
>        <td><kbd>Ctrl</kbd>+<kbd>F</kbd></td>
>        <td><kbd>Ctrl</kbd>+<kbd>F</kbd></td>

This looks a bit weird having the "in" lowercased but the "page" uppercased. I
usually just follow Tenser's style ->
http://texturizer.net/firefox/keyboard.html

Comment 4

[Jeff Walden [:Waldo]]

Edit->Find _in_ This Page?

Comment 5

[R.J. Keller]

Comment on attachment 155768 [details] [diff] [review]
Patch for autocomplete deletion & lowercases little words consistently

(In reply to comment #4)
> Edit->Find _in_ This Page?

oh that's where you got it from. Interesting. I wonder why they used this case.

r=[e-mail] from me. Thanks Jeff! I really appreciate these optimizations
you've made to the help docs.

Comment 6

[Jeff Walden (gone starting June 8)]

Attachment: A few more just-noticed issues

This patch is the previous patch plus a few new fixes I hadn't noticed before:

-Select All is Alt+A on Linux (I think Ctrl+A is a vi keybinding, maybe)
-fix seemingly innocent whitespace issues with Web Search & Page Info which
 could result in "Ctrl+ J", for example, on some platforms
-remove spurious 'win' class on F5 for Reload - F5 is Reload everywhere
-Bookmarks is Ctrl+I only on win

I got most of this info via LXR.  As for where to look for errors, that was
mostly intuition, my memory for Windows shortcuts, and the current Linux build
I'm using now.	LXR searches provided the values for entities when I needed to
know them.

In the future is it possible to require keyboard shortcut changes to be
recorded in Help docs when done?  Another possibility might be to CC the QA
contact for docs changes to all relevant bugs, with an explanatory comment (tho
that'd miss arbitrary changes by head devs like Ben if they don't file a bug). 
Either way would be much better than what happens now -- witness the results if
no one had noticed the errors (of which there are probably more).

Because the previous patch hasn't been committed, this patch contains
everything from it.  I don't know of a way to split off the changes in this
patch from the changes in that one.

Comment 7

[R.J. Keller]

Comment on attachment 155898 [details] [diff] [review]
A few more just-noticed issues

Looks good! It's great to have you back Jeff! r=[e-mail]

Comment 8

[Jeff Walden (gone starting June 8)]

Comment on attachment 155898 [details] [diff] [review]
A few more just-noticed issues

Anyone feel like checking this in for me?  :-)

Comment 9

[R.J. Keller]

Steffen, can you check this in for me? I'm having problems getting SSH working
on my system, and they just locked pserver.

Comment 10

[Steffen Wilberg]

I'll check this in once the tree is reopened.

We're not the only ones being surprised by the disabling of pserver :)
http://weblogs.mozillazine.org/pinkerton/archives/006190.html
But I got ssh working with the help of http://www.mozilla.org/cvs-ssh-faq.html

Comment 11

[Steffen Wilberg]

Checked in.