[BRLTTY] Improving the key table help.

[Lars Bjørndal]

Hello, Dave!

Are you also planning to group the key bindings into expandable groups
in the help system? That way, if the group names are intuitive, it
would be more convenient to find key bindings, e.g. you don't need to
scroll through a long list to find an element.

Regards,
Lars

On ma., jan. 12, 2015 at 11:08:58 -0500, Dave Mielke wrote:
> Volker: I'm hoping you'll see this message as you began this subject so I'm 
> particularly looking for your feedback. Feedback from others is, of course, 
> welcome as well.
> 
> The file Focus14.txt is attached to this message as an example of my first 
> crack at improving the key table help. I've tried to take into account all of 
> the suggestions that've been made. This includes:
> 
> * grouping the bindings into meaningful groups
> * adding a descriptive header to each of these groups
> * listing all possible bindings for the same function together
> * listing the help and learn bindings at the top
> * making major headers stand out more
> * improving some of the vague terminology
> 
> As always, I'd like all of you to give me feedback regarding how to further 
> improve the appearance, understandability, etc of this text.
> 
> -- 
> Dave Mielke           | 2213 Fox Crescent | The Bible is the very Word of God.
> Phone: 1-613-726-0014 | Ottawa, Ontario   | http://Mielke.cc/bible/
> EMail: dave at mielke.cc | Canada  K2A 1H7   | http://FamilyRadio.com/

> Key Table: FreedomScientific Focus Blue
> =======================================
> 
> There are two Nav controls - one at each side of the top.
> * Each has three actions: Up, Down, and Press.
> * On some models, a Nav control is a wheel which can be both rolled and pressed.
> * On others, it's an up/down rocker along with a separate pressable button.
> The Selector keys are at either end of the front edge.
> * On older models, they're known as GDF (General Display Function) keys.
> The Advance keys are just inside the rockers and outside the shift keys.
> 
> Default Bindings
> ----------------
> 
> Special Modes
> * enter/leave help display: Space+Dot1+Dot2+Dot5
> * enter/leave command learn mode: Space+Dot1+Dot2+Dot3
> * enter/leave preferences menu: Space+Dot1+Dot2+Dot3+Dot4
> * enter/leave status display: Space+Dot2+Dot3+Dot4
> * set screen image frozen/unfrozen: Space+Dot1+Dot2+Dot4
> * set screen image frozen: Space+Dot1+Dot2+Dot4+Dot8
> * set screen image unfrozen: Space+Dot1+Dot2+Dot4+Dot7
> * set display mode attributes/text: Space+Dot1+Dot4+Dot5
> * set display mode attributes: Space+Dot1+Dot4+Dot5+Dot8
> * set display mode text: Space+Dot1+Dot4+Dot5+Dot7
> 
> Cursor Functions
> * go to screen cursor: RightSelector
> * go back after cursor tracking: LeftSelector
> * bring screen cursor to character: RoutingKey
> * bring screen cursor to current line: Space+Dot1+Dot2+Dot3+Dot6
> 
> Vertical Navigation
> * go up one line: LeftNavUp
> * go up one line: RightRockerUp
> * go down one line: LeftNavDown
> * go down one line: RightRockerDown
> * go to top line: RightSelector+LeftAdvance
> * go to bottom line: RightSelector+RightAdvance
> * go to beginning of top line: LeftSelector+LeftAdvance
> * go to beginning of bottom line: LeftSelector+RightAdvance
> * go up to nearest line with different content: LeftNavPress+LeftNavUp
> * go down to nearest line with different content: LeftNavPress+LeftNavDown
> * go up to nearest line with different highlighting: LeftSelector+LeftNavUp
> * go down to nearest line with different highlighting: LeftSelector+LeftNavDown
> * go up to last line of previous paragraph: RightAdvance+LeftNavUp
> * go down to first line of next paragraph: RightAdvance+LeftNavDown
> * go up to previous command prompt: LeftAdvance+LeftNavUp
> * go down to next command prompt: LeftAdvance+LeftNavDown
> * go up to nearest line with less indent than character: LeftAdvance+NavrowKey
> * go down to nearest line with less indent than character: RightAdvance+NavrowKey
> 
> Horizontal Navigation
> * go left one braille window: LeftAdvance
> * go left one braille window: RightNavUp
> * go right one braille window: RightAdvance
> * go right one braille window: RightNavDown
> * go to beginning of line: LeftNavPress
> * go to end of line: RightNavPress
> * go left one character: RightNavPress+RightNavUp
> * go right one character: RightNavPress+RightNavDown
> * place left end of braille window at character: LeftNavPress+RoutingKey
> * place left end of braille window at character: LeftSelector+NavrowKey
> 
> Clipboard Functions
> * start new clipboard at character: LeftAdvance+RoutingKey
> * append to clipboard from character: LeftSelector+RoutingKey
> * linear copy to character: RightSelector+RoutingKey
> * rectangular copy to character: RightAdvance+RoutingKey
> * copy characters to clipboard: RoutingKey+RoutingKey
> * insert clipboard text after screen cursor: LeftSelector+RightSelector
> * insert clipboard text after screen cursor: Space+Dot1+Dot3+Dot4+Dot6
> * search backward for clipboard text: RightSelector+LeftNavUp
> * search forward for clipboard text: RightSelector+LeftNavDown
> * save clipboard to disk: Space+Dot1+Dot3+Dot4+Dot6+Dot8
> * restore clipboard from disk: Space+Dot1+Dot3+Dot4+Dot6+Dot7
> 
> Configuration Functions
> * set autorepeat on/off: Space+Dot1+Dot2+Dot3+Dot5
> * set autorepeat on: Space+Dot1+Dot2+Dot3+Dot5+Dot8
> * set autorepeat off: Space+Dot1+Dot2+Dot3+Dot5+Dot7
> * set text style 6-dot: Space+Dot2+Dot3+Dot5
> * set text style 8-dot: Space+Dot2+Dot3+Dot6
> * set skipping of lines with identical content on/off: Space+Dot2+Dot4
> * set skipping of lines with identical content on: Space+Dot2+Dot4+Dot8
> * set skipping of lines with identical content off: Space+Dot2+Dot4+Dot7
> * set skipping of blank braille windows on/off: Space+Dot1+Dot2
> * set skipping of blank braille windows on: Space+Dot1+Dot2+Dot8
> * set skipping of blank braille windows off: Space+Dot1+Dot2+Dot7
> * set sliding braille window on/off: Space+Dot2+Dot4+Dot5+Dot6
> * set sliding braille window on: Space+Dot2+Dot4+Dot5+Dot6+Dot8
> * set sliding braille window off: Space+Dot2+Dot4+Dot5+Dot6+Dot7
> * set track screen cursor on/off: Space+Dot2+Dot3+Dot4+Dot5
> * set track screen cursor on: Space+Dot2+Dot3+Dot4+Dot5+Dot8
> * set track screen cursor off: Space+Dot2+Dot3+Dot4+Dot5+Dot7
> * set screen cursor visibility on/off: Space+Dot1+Dot4
> * set screen cursor visibility on: Space+Dot1+Dot4+Dot8
> * set screen cursor visibility off: Space+Dot1+Dot4+Dot7
> * set attribute underlining on/off: Space+Dot1+Dot3+Dot6
> * set attribute underlining on: Space+Dot1+Dot3+Dot6+Dot8
> * set attribute underlining off: Space+Dot1+Dot3+Dot6+Dot7
> 
> Menu Operations
> * restore preferences from disk: Space+Dot1+Dot2+Dot3+Dot4+Dot7
> * save preferences to disk: Space+Dot1+Dot2+Dot3+Dot4+Dot8
> 
> Speech Functions
> * describe character: RightNavPress+RoutingKey
> * describe character: NavrowKey
> 
> Input Operations
> * set braille keyboard enabled/disabled: Space+Dot1+Dot3
> * set braille keyboard enabled: Space+Dot1+Dot3+Dot8
> * set braille keyboard disabled: Space+Dot1+Dot3+Dot7
> * enter key: Space+Dot8
> * enter key: Space+RightShift
> * tab key: Space+Dot2+Dot3+Dot5+Dot6
> * backspace key: Space+Dot7
> * backspace key: Space+LeftShift
> * escape key: Space+Dot2+Dot6
> * cursor-left key: Space+Dot3
> * cursor-right key: Space+Dot6
> * cursor-up key: Space+Dot1
> * cursor-up key: LeftRockerUp
> * cursor-down key: Space+Dot4
> * cursor-down key: LeftRockerDown
> * page-up key: Space+Dot2+Dot3
> * page-down key: Space+Dot5+Dot6
> * home key: Space+Dot2
> * end key: Space+Dot5
> * insert key: Space+Dot3+Dot5
> * delete key: Space+Dot2+Dot5+Dot6
> * function key: Space+RoutingKey
> * switch to virtual terminal: RightShift+RoutingKey
> * switch to previous virtual terminal: Space+Dot1+Dot2+Dot3+Dot6+Dot7
> * switch to next virtual terminal: Space+Dot1+Dot2+Dot3+Dot6+Dot8
> 
> Braille Keyboard
> * braille keyboard dot1: Dot1
> * braille keyboard dot2: Dot2
> * braille keyboard dot3: Dot3
> * braille keyboard dot4: Dot4
> * braille keyboard dot5: Dot5
> * braille keyboard dot6: Dot6
> * braille keyboard dot7: Dot7
> * braille keyboard dot8: Dot8
> * braille keyboard space: Space
> * braille keyboard control: LeftShift
> * braille keyboard meta: RightShift
> 

> _______________________________________________
> This message was sent via the BRLTTY mailing list.
> To post a message, send an e-mail to: BRLTTY at mielke.cc
> For general information, go to: http://mielke.cc/mailman/listinfo/brltty