TB: Keyboard Shortcuts documentation: Major Revision #5614 (based on revision #5594): content and markup cleanup

RESOLVED FIXED

Status

RESOLVED FIXED
7 years ago
5 years ago

People

(Reporter: bugzilla2007, Assigned: bugzilla2007)

Tracking

(Depends on: 4 bugs, Blocks: 2 bugs)

Firefox Tracking Flags

(Not tracked)

Details

(URL)

+++ This bug was initially created as a clone of Bug #718962 +++

This bug is intended for details and discussion of a major revision of the Keyboard Shortcuts documentation article which I am about to land (and I want to try linking here from that revision's comment, so I need this bug first).
Please find the URL of that revision in the URL field or subsequent comments.

I created this major revision based on sreepriya's great foundational work in revision 5594 (2) which conflated the markup by 32% (from 14682 down to 9912 characters) in spite of adding content. That revision makes the markup just so much more readable and easier to maintain:

- correct markup for keyboard shortcuts:
e.g. nifty {key Ctrl+Shift+Tab}
instead of wrong and bulky {button Ctrl} + {button Shift} + {button Tab}

- correct markup for identical cross-OS shortcuts:
e.g. slim {for win,linux}{key...}{/for}{for mac}{key...}{/for}
instead of redundant and confusing {for win}{key...}{/for}{for mac}{key...}{/for}{for linux}{key...}{/for}

I'll approve sreepriya's revision 5594 (2) to acknowledge and preserve this revolutionary improvement. It comes with a number of minor glitches which I will fix with my upcoming revision documented here.

In addition, I have once again fixed a whole lot of previously existing issues:
- fix/improve wrong/misleading/insufficient command captions
- fix/remove wrong/outdated keyboard shortcuts (wip)
- add product version selectors for some shortcuts that changed (what's the point of having the version selector if we don't maintain it?)
- minor changes to the sequence of shortcuts in the list (wip)
- add OS-sensitive markup in the introduction
- cross the t's and dot the i's in the markup, removing extra spaces etc.

I might add the bugs which I have touched with this revision as dependants of this bug (unless specified otherwise in subsequent comments). In some cases, fixes and improvements might be preliminary or incomplete because I can't verify shortcuts on Linux and MAC. I have filed respective bugs which are awaiting verification.

The revision documented here is an incremental update but it's not the end of the road. A lot more needs to be done, pls refer to tbkbd-doc-tracker Bug 714031 and tbkbd-docnew-tracker Bug 714044 for details.

Any hints or comments regarding this revision are welcome here.

(1) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts
(2) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts/revision/5594
(3) https://support.mozilla.org/en-US/kb/Markup-chart
(Assignee)

Comment 1

7 years ago
(In reply to Thomas D. from comment #0)
> This bug is intended for details and discussion of a major revision of the
> Keyboard Shortcuts documentation article which I am about to land...
> Please find the URL of that revision in the URL field or subsequent comments.

This bug is about:
https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts/revision/5614

Landed as Major Change (MT), ready for translation so that localizers can benefit from the major markup and content cleanup, now current (1).

> Any hints or comments regarding this revision are welcome here.

dito.
 
(1) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts
Summary: TB: Keyboard Shortcuts documentation: Major Revision #.... (based on revision #5594) → TB: Keyboard Shortcuts documentation: Major Revision #5614 (based on revision #5594): content and markup cleanup
(Assignee)

Updated

7 years ago
No longer blocks: 686436
Depends on: 686436
(Assignee)

Comment 2

7 years ago
A lot of bugs were fixed or otherwise improved by this revision (see dependants).
(Assignee)

Updated

7 years ago
Assignee: nobody → bugzilla2007
Status: NEW → RESOLVED
Last Resolved: 7 years ago
Resolution: --- → FIXED
(Assignee)

Updated

7 years ago
Blocks: 721666
(Assignee)

Updated

5 years ago
Depends on: 886699
You need to log in before you can comment on or make changes to this bug.