From 4be5c016738aa307be2d19f9402fc97cf00ca895 Mon Sep 17 00:00:00 2001
From: William Kendrick
Date: Mon, 7 Apr 2014 06:22:23 +0000
Subject: [PATCH] Improved documentation on new keyboard-controlled mouse
feature.
---
docs/CHANGES.txt | 26 ++------------------------
docs/OPTIONS.txt | 38 +++++++++++++++++++++++++++++++++-----
docs/html/OPTIONS.html | 42 ++++++++++++++++++++++++++++++++++++------
3 files changed, 71 insertions(+), 35 deletions(-)
diff --git a/docs/CHANGES.txt b/docs/CHANGES.txt
index f974a38ae..649239af8 100644
--- a/docs/CHANGES.txt
+++ b/docs/CHANGES.txt
@@ -114,32 +114,10 @@ $Id$
Special thanks to Richard Verhoeven
Public domain.
- * Keyboard can be used to move and click mouse ("keyboard" option).
+ * Keyboard can be used to move and click mouse ("--keyboard" option).
[Experimental!]
by Ankit Choudary (GSOC 2010)
-
- * Keys to move:
- * [Up] / [Down] / [Left] / [Right]
- * [A] / [S] / [D] / [W]
- * Numpad 1/2/3/4/6/7/8/9
-
- * Keys to click:
- * [\] (backslash)
- * Numpad 5
-
- * [Tab] can be used to jump between Tools (toolbox on the left),
- Colors (color palette at the bottom) and drawing canvas.
-
- Note: disabled when using Text or Label tool to type, so that you
- can type text, and use [Tab] to end a string (without moving text
- cursor).
-
- * FIXME:
- * Difficult to actually draw, unless mouse-accessibility is also on.
- * Option is on by default; should be disabled by default, and enabled
- via config.
- * ASDW is QWERTY-centric; drop it, or add ways to support other
- keyboard layouts.
+ * See documentation in OPTIONS for how to use it.
* Joystick can be used to drive Tux Paint
by Ankit Choudary (GSOC 2010)
diff --git a/docs/OPTIONS.txt b/docs/OPTIONS.txt
index c9b33d53a..ae196185b 100644
--- a/docs/OPTIONS.txt
+++ b/docs/OPTIONS.txt
@@ -3,13 +3,13 @@
Options Documentation
- Copyright 2002-2012 by Bill Kendrick and others
+ Copyright 2002-2014 by Bill Kendrick and others
New Breed Software
bill@newbreedsoftware.com
http://www.tuxpaint.org/
- March 30, 2013
+ April 6, 2014
----------------------------------------------------------------------
@@ -505,10 +505,38 @@ Windows Users
keyboard=yes
This allows the keyboard arrow keys to be used to control the
- mouse pointer. (e.g., for mouseless environments.)
+ mouse pointer. (e.g., for mouseless environments, or
+ handicapped/accessibility purposes)
- The [Arrow] keys move the mouse pointer. [Space] acts as the
- mouse button.
+ Features:
+ * Fine movement within canvas, or coarse movement if
+ [Shift] is held.
+ * Coarse movement within tool button areas.
+ * Key controls:
+ * [Left]/[Right]/[Up]/[Down], numpad [1] thru [9]:
+ Move mouse
+ * [Space]/[5]: Click mouse (except when using "Text"
+ or "Label" tools)
+ * [Insert]: Click mouse (always)
+ * [F4] jump mouse between "Tools", "Colors" and canvas
+ areas
+ * If mouse is within "Tools" section on the left, or
+ "Colors" secton at the bottom:
+ * [F7], [F8]: Move down/up between buttons,
+ respectively (Tools section, only)
+ * [F11], [F12]: Move to previous/next button,
+ respectively
+ * To click-and-drag, hold one of the 'click' keys (e.g.,
+ [Insert]), and use the movement keys (e.g., [Left]).
+ * Note: The "mouse accessibility" feature works with
+ the keyboard mouse controls. With both options
+ enabled, painting tools can be used to draw by
+ pressing a 'click' key to start clicking, movement
+ keys to move around (which will draw), and another
+ 'click' key to end the click (stop drawing).
+ * A regular mouse and/or joystick may still be used (so you
+ can, e.g., move with the mouse, and click with the
+ keyboard, or vice-versa)
savedir=DIRECTORY
diff --git a/docs/html/OPTIONS.html b/docs/html/OPTIONS.html
index 1289e83a2..e2d6653d6 100644
--- a/docs/html/OPTIONS.html
+++ b/docs/html/OPTIONS.html
@@ -16,14 +16,14 @@ version
Options Documentation
-Copyright 2002-2012 by Bill Kendrick and others
+
Copyright 2002-2014 by Bill Kendrick and others
New Breed Software
bill@newbreedsoftware.com
http://www.tuxpaint.org/
-March 30, 2013
+April 6, 2014
@@ -629,10 +629,40 @@ New Breed Software
keyboard=yes
This allows the keyboard arrow keys to be used
- to control the mouse pointer. (e.g., for mouseless environments.)
-
- The [Arrow] keys move the mouse pointer.
- [Space] acts as the mouse button.
+ to control the mouse pointer. (e.g., for mouseless environments, or
+ handicapped/accessibility purposes)
+
+ Features:
+
+ - Fine movement within canvas, or coarse movement if [Shift] is held.
+
- Coarse movement within tool button areas.
+
- Key controls:
+
+ - [Left]/[Right]/[Up]/[Down], numpad [1] thru [9]: Move mouse
+
- [Space]/[5]: Click mouse (except when using "Text" or "Label" tools)
+
- [Insert]: Click mouse (always)
+
- [F4] jump mouse between "Tools", "Colors" and canvas areas
+
- If mouse is within "Tools" section on the left, or
+ "Colors" secton at the bottom:
+
+ - [F7], [F8]: Move down/up between buttons, respectively
+ (Tools section, only)
+
- [F11], [F12]: Move to previous/next button, respectively
+
+
+ - To click-and-drag, hold one of the 'click' keys (e.g., [Insert]),
+ and use the movement keys (e.g., [Left]).
+
+ - Note: The "mouse accessibility" feature works with the keyboard
+ mouse controls. With both options enabled, painting tools
+ can be used to draw by pressing a 'click' key to start clicking,
+ movement keys to move around (which will draw), and another
+ 'click' key to end the click (stop drawing).
+
+ - A regular mouse and/or joystick may still be used
+ (so you can, e.g., move with the mouse, and click with the keyboard,
+ or vice-versa)
+
savedir=DIRECTORY