ONESTROKE
---------

Changes
-------

NOTE: This project has been succeeded by CellWriter, a grid-entry
      handwriting input panel. Please see:
        http://risujin.org/cellwriter

0.8.4:
  - Fixed bug with one point strokes.
0.8.3:
  - Fixed a bug with the Shift+P symbol in the bundled profile.
  - The experimental node distance recognizer has been cut.
  - New rotational invariance mode.
0.8.2:
  - This version now comes bundled with a gesture profile.
  - The user interface received a tune up.
  - More and much needed documentation.
0.8.1:
  - Fixed some ugly bugs affecting the recognizers, they are much more
    reliable now!
  - Added composite recognition mode.
0.8.0:
  - Initial release.

All 0.8.x versions use the same profile format.


Description
-----------

OneStroke is a gesture-based character input program. Because a tablet PC in
tablet mode does not have a keyboard, a software replacement is necessary.
OneStroke aims to replace the on-screen keyboard with a more elegant approach
to the problem.


Using OneStroke
---------------

Draw a one stroke symbol on the main window and OneStroke will send the
associated key stroke to the window in focus as if typed on the keyboard.

To "hold down" a key, draw the symbol and stop at the end of the stroke without
raising the pen. After a brief interval the stroke will be recognized and
the key event will generate multiple times as if the key were held down.

To cancel drawing a symbol simply move the pen off of the drawing area without
raising the pen. After a brief interval the stroke will cancel.

To learn the symbols and to modify them or create your own, right click on
the main window and open the Symbols window. Here you will see the symbols in
the current profile. The strokes are drawn from green to red. Click on a symbol
icon on the left. On the right side of the window you can now change the
associated key event. If you wish to change the symbol gesture, draw on the
main window. Make sure you deselect the symbol or close the Symbols window
before trying it out though.

Symbol sets are stored in profiles and can be modified, saved, and loaded via
the Symbols window. Profiles are saved as files in the "~/.onestroke-0.8"
directory.


Recognition Methods
-------------------

The gesture recoginition method and feedback drawing mode can also be set
via the right-click context menu. The recoginition modes are:

Composite (default)
  Combines the two methods for better reliability.

Scale dependent
  Finds distance between symbol graphs by finding the average distance between
  the pens of each graph over time. The graphs are normalized by length to
  make this comparison possible.

Scale independent
  Similar to the previous method, this variation uses segment angle difference
  instead of pen distance. It is naturally impervious to scale differences.

The experimental node distance recognizer has been removed since 0.8.3.

Rotational invariance
  Starting with version 0.8.3 you can enable the "Rotational Invarianve" toggle
  in the mode menu. This option will automatically compensate for any
  rotational differences allowing you to draw your symbols in any orientation!

Favor original orientation
  This will tilt the match score in favor of non-rotated symbols. This is
  useful if you use gestures which are rotated copies of each other and want
  the program to differentiate between them.


Creating and Modifying Gestures
-------------------------------

Gestures must consist of one pen stroke only. While the bundled profiles are
perfectly functional, you should create or modify the gestures to best suit
your personal preferences.

To create a gesture right click on the main window, select "Symbols..." and
click "New" to the right of the "Symbol:" label. A new blank symbol has now
been created but may be off screen, scroll the window to find it (it will be
selected and say 'none'). Select the key events and modifiers that should be
generated on the right pane. Now simply draw the stroke you wish to
associate with this key event on the main window. Deselect the icon or close
the symbol window and you can now try out your new gesture!

To modify a gesture, open the symbols window, scroll to find it and select it.
You can now change key event properties and draw on the main window to change
the associated stroke.


Default Profiles
----------------

These profiles are bundled with the program and are installed into empty user
profile directories. You can create your own by typing a new name into the
profile name box in the Symbols window and clicking Save.

risujin
  This is my personal gesture profile. The gestures are configured to resemble
  handwriting as closely as possible. Additional gestures are provided for
  control keys (arrow keys, backspace, etc).


Author
------

If you have any questions or comments please feel free to contact me.
I'd like to hear about bugs and feature requests!

Copyright 2007 Michael Levin <risujin@risujin.org>

The OneStroke icon was created by Eugenia Loli (http://eugenia.blogsome.com/).