Guide changes

[Jean-Philippe MENGUAL <mengualjeanphi@free.fr>]

[-- Attachment #1: Type: text/plain, Size: 692 bytes --]

Hi,

In this patch, I do the following suggestions:
- Deleting the copy of speakupmap.map from the User Guide;
- Replace it with the contents of DefaultKeyAssignments;
- Delete the DefaultKeyAssignments file from the tree;
- Extend the contents of DefaultKeysAssignment (now pasted in the main
Guide), completion is based on speakupmap.map information.

I wait for your agreement before translating this change. Here's what
looks the guide if you accept the change. If you do, you additionally
should delete file I quoted above.

If you accept, I'll translate this and fix some errors in the
translation of the guide.

Waiting for suggestions or agreement,

Regards,


Jean-Philippe MENGUAL


[-- Attachment #2: fixguide.txt --]
[-- Type: text/x-patch, Size: 9869 bytes --]

--- /home/jp/a/spkguide.txt	2010-10-22 00:26:56.000000000 +0200
+++ spkguide.txt	2010-10-22 00:30:25.000000000 +0200
@@ -116,9 +116,10 @@
 few exceptions, but we'll come to those later.
 
 Note:  In this guide I will refer to the numeric keypad as the keypad. 
-This is done because the speakupmap.map file referred to later in this
-manual uses the term keypad instead of numeric keypad.  Also I'm lazy
-and would rather only type one word.  So keypad it is.  Got it?  Good.
+This is done because the files describing the assignments of the keys with the 
+functions use the term keypad instead of 
+numeric keypad.  Also I'm lazy and would rather only type one word.  So keypad 
+it is.  Got it?  Good.
 
 Most of the Speakup review keys are located on the keypad at the far
 right of the keyboard.  The numlock key should be off, in order for these
@@ -247,103 +248,122 @@
 commands.  You can also get a list of commands and assigned keys from
 the help system.
 
-The following list was taken from the speakupmap.map file.  Key
-assignments are on the left of the equal sign, and the associated
-Speakup commands are on the right.  The designation "spk" means to press
-and hold the speakup key, a.k.a. keypad insert, a.k.a. caps lock, while
-pressing the other specified key.
-
-spk key_f9 = punc_level_dec
-spk key_f10 = punc_level_inc
-spk key_f11 = reading_punc_dec
-spk key_f12 = reading_punc_inc
-spk key_1 = vol_dec
-spk key_2 =  vol_inc
-spk key_3 = pitch_dec
-spk key_4 = pitch_inc
-spk key_5 = rate_dec
-spk key_6 = rate_inc
-key_kpasterisk = toggle_cursoring
-spk key_kpasterisk = speakup_goto
-spk key_f1 = speakup_help
-spk key_f2 = set_win
-spk key_f3 = clear_win
-spk key_f4 = enable_win
-spk key_f5 = edit_some
-spk key_f6 = edit_most
-spk key_f7 = edit_delim
-spk key_f8 = edit_repeat
-shift spk key_f9 = edit_exnum
- key_kp7 = say_prev_line
-spk key_kp7 = left_edge
- key_kp8 = say_line
-double  key_kp8 = say_line_indent
-spk key_kp8 = say_from_top
- key_kp9 = say_next_line
-spk  key_kp9 = top_edge
- key_kpminus = speakup_parked
-spk key_kpminus = say_char_num
- key_kp4 = say_prev_word
-spk key_kp4 = say_from_left
- key_kp5 = say_word
-double key_kp5 = spell_word
-spk key_kp5 = spell_phonetic
- key_kp6 = say_next_word
-spk key_kp6 = say_to_right
- key_kpplus = say_screen
-spk key_kpplus = say_win
- key_kp1 = say_prev_char 
-spk key_kp1 = right_edge
- key_kp2 = say_char
-spk key_kp2 = say_to_bottom
-double key_kp2 = say_phonetic_char
- key_kp3 = say_next_char  
-spk  key_kp3 = bottom_edge
- key_kp0 = spk_key
- key_kpdot = say_position
-spk key_kpdot = say_attributes
-key_kpenter = speakup_quiet
-spk key_kpenter = speakup_off
-key_sysrq = speech_kill
- key_kpslash = speakup_cut
-spk key_kpslash = speakup_paste
-spk key_pageup = say_first_char
-spk key_pagedown = say_last_char
-key_capslock = spk_key
- spk key_z = spk_lock
-key_leftmeta = spk_key
-ctrl spk key_0 = speakup_goto
-spk key_u = say_prev_line
-spk key_i = say_line
-double spk key_i = say_line_indent
-spk key_o = say_next_line
-spk key_minus = speakup_parked
-shift spk key_minus = say_char_num
-spk key_j = say_prev_word
-spk key_k = say_word
-double spk key_k = spell_word
-spk key_l = say_next_word
-spk key_m = say_prev_char
-spk key_comma = say_char
-double spk key_comma = say_phonetic_char
-spk key_dot = say_next_char
-spk key_n = say_position
- ctrl spk key_m = left_edge
- ctrl spk key_y = top_edge
- ctrl spk key_dot = right_edge
-ctrl spk key_p = bottom_edge
-spk key_apostrophe = say_screen
-spk key_h = say_from_left
-spk key_y = say_from_top
-spk key_semicolon = say_to_right
-spk key_p = say_to_bottom
-spk key_slash = say_attributes
- spk key_enter = speakup_quiet
- ctrl  spk key_enter = speakup_off
- spk key_9 = speakup_cut
-spk key_8 = speakup_paste
-shift spk key_m = say_first_char
- ctrl spk key_semicolon = say_last_char
+You may change the assignments to be anything you want but that will take some 
+familiarity with key mapping.
+
+We have remapped the insert or zero key on the keypad to act as a
+shift key.  Well, actually as an altgr key.  So in the following list
+InsKeyPad-period means hold down the insert key like a shift key and
+hit the keypad period.
+
+4.1. If your Speakup Key is Insert keypad
+
+4.1.1. Bindings with keys on the keypad:
+
+KeyPad-1		Say Previous Character (left one letter)
+InsKeyPad-1		Move reading cursor to right edge of screen (insert end)
+ControlKeyPad-1		Move reading cursor to last character on current line.
+KeyPad-2		Say Current Letter
+Double KeyPad-2		Say Current Character Phonetically
+InsKeyPad-2		say current letter phonetically
+KeyPad-3		Say Next Character (right one letter)
+InsKeyPad-3		Move reading cursor to bottom of screen (insert pgdn)
+KeyPad-4		Say Previous Word (left one word)
+InsKeyPad-4		say from left edge of line to reading cursor.
+KeyPad-5		Say Current Word
+Double KeyPad-5		Spell Current Word
+InsKeyPad-5		Spell Current Word
+KeyPad-6		Say Next Word (right one word)
+InsKeyPad-6		Say from reading cursor to right edge of line.
+KeyPad-7		Say Previous Line (UP one line)
+InsKeyPad-7		Move reading cursor to left edge of screen (insert home)
+KeyPad-8		Say current Line
+Double KeyPad-8		Say current Line indentation
+InsKeyPad-8		say from top of screen to reading cursor.
+KeyPad-9		Say Next Line (down one line)
+InsKeyPad-9		Move reading cursor to top of screen (insert pgup)
+KeyPad-period		Say Position (current line, position and console)
+InsKeyPad-period	say colour attributes of current position.
+KeyPad-Enter		Shut Up (until another key is hit) and sync reading cursor
+InsKeyPad-Enter		Shut Up (until toggled back on).
+		allowed value for the row or column for your current screen.
+
+KeyPad-/		Mark and Cut screen region.
+InsKeyPad-/		Paste screen region into any console.
+KeyPad-star		Toogle cursoring modes
+InsKeyPad-star n<x|y>	go to line (y) or column (x). Where 'n' is any
+KeyPad-Minus		Park reading cursor (toggle)
+InsKeyPad-minus		Say character hex and decimal value.
+KeyPad-plus		Say Entire Screen
+InsKeyPad-plus		Say from reading cursor line to bottom of screen.
+
+4.1.2. Bindings with functions keys:
+
+InsKeyPad-F1		Speakup Help System
+InsKeyPad-F2		Set a window
+InsKeyPad-F3		Clear the window
+InsKeyPad-F4		Enable a window
+InsKeyPad-F5		Edit some
+InsKeyPad-F6		Edit most
+InsKeyPad-F7		Edit delimitations
+InsKeyPad-F8		Edit repeats
+InsKeyPad-F9		Decrease the punctuation level
+Shift-InsKeyPad-F9		Edit exadecimal numeric
+InsKeyPad-F10		Increase the punctuation level
+InsKeyPad-F11		Decrease the reading punctuation level
+InsKeyPad-F12		Increase the reading punctuation level
+
+4.1.3. Bindings with keys on the first line of the keyboard under functions keys:
+
+InsKeyPad-1		decrease the volume
+InsKeyPad-2		Increase the volume
+InsKeyPad-3		Decrease the pitch
+InsKeyPad-4		Increase the pitch
+InsKeyPad-5		Decrease the rate
+InsKeyPad-6		Increase the rate
+InsKeyPad-pageup		Says the first character
+InsKeyPad-pagedown		Says the last character
+
+4.2. If CapsLock or meta-left key are the Speakup Key:
+
+SpeakupKey-z		Lock Speakup
+ctrl-SpeakupKey-0 n<x|y>	go to line (y) or column (x). Where 'n' is any
+SpeakupKey-u		Say the previous line
+SpeakupKey-i		Say the current line
+double SpeakupKey-i		Say the current line indentation
+SpeakupKey-o		Say the next line
+SpeakupKey-minus		Park reading cursor (toggle)
+shift-SpeakupKey-minus		Say character hex and decimal value.
+SpeakupKey-j		Say the previous word
+SpeakupKey-k		Say the current word
+Double SpeakupKey-k		Spell the current word
+SpeakupKey-l		Say the next word
+SpeakupKey-m		Say the previous character
+ctrl-SpeakupKey-m		say from left edge of line to reading cursor.
+SpeakupKey-comma		Say the current character
+Double SpeakupKey-comma		Say the current character phonetically
+SpeakupKey-dot		Say the next character
+SpeakupKey-n		Say Position (current line, position and console)
+ctrl-SpeakupKey-y		Move reading cursor to top of screen (insert pgup)
+ctrl-SpeakupKey-Dot		Say from reading cursor to right edge of line.
+ctrl-SpeakupKey-p		Move reading cursor to bottom of screen (insert pgdn)
+SpeakupKey-apostrophe		Say Entire Screen
+SpeakupKey-h		Say from left edge of screen to the reading cursor
+SpeakupKey-y		Say from the top of screen to the reading cursor
+SpeakupKey-semicolon		Say from the reading cursor to the right edge
+ctrl-SpeakupKey-semicolon		Say the last character
+SpeakupKey-p		Say from the reading cursor to the bottom of screen
+SpeakupKey-slash		say colour attributes of current position.
+SpeakupKey-enter		Shut Up (until another key is hit) and sync reading cursor
+ctrl-SpeakupKey-enter		Shut Up (until toggled back on).
+SpeakupKey-9		Mark and Cut screen region.
+SpeakupKey-8		Paste screen region into any console.
+shift-SpeakupKey-m		Say the first character
+SpeakupKey-r		Say Entire Screen
+
+Hitting any key while speakup is outputting speech will quiet the
+synth until it has caught up with what is being printed on the
+console.
 
 5.  The Speakup Sys System
 
@@ -1060,7 +1080,7 @@
 as shown in the following example.
 
 The Spanish name for the color blue is azul.
-Looking at the colors file, we see that the name "blue" is at position 1
+Looking at the colors file, we see that the adjective "blue" is at position 1
 within the colors group.  Let's change blue to azul:
 echo '1 azul' > /speakup/i18n/colors
 The next time that Speakup says message 1 from the colors group, it will
@@ -1072,8 +1092,6 @@
 and most users will just load the files necessary for their language. So far,
 only French language is available beyond native Canadian English language.
 
-French is only available after you are logged in. 
-
 Canadian English is the default language. To toogle another language,
 download the source of Speakup and untar it in your home directory. The
 following command should let you do this: