=============================================================================
Windows Keys - Use the extra keys on a Windows Keyboard          Version 0.23

(C) Stephen Fryatt, 2001-2014                                2 September 2014
=============================================================================


Licence
-------

  Windows Keys is licensed under the EUPL, Version 1.1 only (the "Licence");
  you may not use this work except in compliance with the Licence.

  You may obtain a copy of the Licence at
  http://joinup.ec.europa.eu/software/page/eupl

  Unless required by applicable law or agreed to in writing, software
  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  See the Licence for the specific language governing permissions and
  limitations under the Licence.

  The source for Windows Keys can be found alongside this binary download, at
  http://www.stevefryatt.org.uk/software

  The necessary libraries and build tools can be found at
  http://www.stevefryatt.org.uk/software/build



Introduction
------------

  Windows Keys is a utility to make it easier to use the MS Windows specific
  keys under RISC OS 4.  Although the new OS recognises the keys, there is no
  easy way to use them.  Some applications, such as Zap, will support them
  but in general there is no easy way to get them to do anything.

  Windows Keys allows star commands to be attached to the Windows and Menu
  keys, for all of the Shift and Ctrl combinations.  These cam be used to
  launch applications, open directories or almost anything else.



Installation
------------

  Windows Keys requires RISC OS 4 or later.  It is 26/32 bit neutral and
  should be compatible with RISC OS 5 -- although note that this version of
  the OS already contains very similar functionality as standard.

  To install Windows Keys, copy the WinKeys module to a suitable place and
  double-click on it to run.  If you want it to run on startup, the module
  should be placed in your boot sequence: this can be done by copying it into
  the Choices:Boot.Tasks directory or including it in the Run list in
  Select's Configure application.

  The !WinKeys application allows the key combinations to be easily
  configured.  It can be run on its own, but is intended to be used as a
  plugin to Configure.  To install as such, copy it into the
  !Boot.ROxxxHook.Res.Configure directory for your version of RISC OS; there
  will now be a 'WinKeys' option in the main Configure window, although the
  machine may need to be re-booted for all the icons to appear correctly.



Setting Up the Keys
-------------------

  To set the keys, click on the 'WinKeys' option in Configure (or double
  click on !WinKeys in a directory viewer if you don't wish to add the
  plugin).  This will open a window with a section for the Windows and Menu
  keys.  Each has a line for every possible combination of Shift and Ctrl
  (the first, unmarked, line is for the key on its own): star commands can be
  entered into these, to be executed when that key combination is pressed.

  Almost any star command can be used, although there are some problems.
  "*Filer_Run" can be a problem when used with key combinations involving
  Shift.  To run applications, the new RISC OS 4 command "*StartDesktopTask"
  is more reliable and will not cause things to be loaded into a text editor
  by mistake.  Watch out for applications that use "*Filer_Run" in their !Run
  files (Oregano is an example, as it calls BookMaker and -- if installed --
  Cassia): these may need such calls changing if they are to work correctly.

  Dragging objects into the fields will enter the paths automatically.  If an
  application is dragged in the field will be cleared and the correct
  "*StartDesktopTask" command will be entered.  If a directory is dragged in,
  the field will also be cleared and the correct "*Filer_OpenDir" command
  will be entered.  For all other objects, the path of the object will be
  entered at the caret (or at the end of the field if the caret isn't
  present).

  The various commands are stored in system variables that can be set by hand
  if required.  These variables are:

  * <WinKeys$Win>
  * <WinKeys$ShiftWin>
  * <WinKeys$CtrlWin>
  * <WinKeys$ShiftCtrlWin>
  * <WinKeys$Menu>
  * <WinKeys$ShiftWMenu>
  * <WinKeys$CtrlMenu>
  * <WinKeys$ShiftCtrlMenu>

  When run, the WinKeys module will look for an Obey file in the directory
  Choices:WinKeys.SetKeys and run it if it is present.  This file should
  contain lines to set the variables above as required; the configure utility
  will automatically create this file when the 'Set' button is pressed.

  An example file might look something like this:

    | WinKeys Setup File
    |
    | This file was autogenerated by WinKey Setup.

    Set WinKeys$Win StartDesktopTask Resources:$.Apps.!TechWrite
    Set WimKeys$ShiftWin StartDesktopTask Resources:$.Apps.!Publisher
    Set WinKeys$Menu StartDesktopTask Resources:$.Apps.!Messenger
    Set WinKeys$ShiftMenu StartDesktopTask Resources:$.Apps.!Oregano
    Set WinKeys$CtrlMenu StartDesktopTask Resources:$.Apps.!FTPc

  Note that all the applications are stored within the Apps folder on the
  icon bar -- this is not necessary and can be changed as required.



Version History
---------------

  The following is a list of all the versions of Windows Keys.


  0.10 (14 September 2001)
  ------------------------

  * Initial release version.


  0.12 (18 September 2001)
  ------------------------

  * Fixed incorrect WimpSlot command in !WinKeys.!Run.
  * Interactive Help support added to WinKeys plugin.
  * Commands are now called with "Wimp_StartTask" instead of "OS_CLI".


  0.13 (23 September 2001)
  ------------------------

  * Unclaimed Windows/Menu key presses (where the associated system variable
    isn't defined) are now passed on to other applications.


  0.20 (5 December 2002)
  ----------------------

  Public Beta release.

  * Module converted to new format and checked for 32-bit compatibility.


  0.21 (15 December 2002)
  -----------------------

  Public Beta release.

  * Correctly linked version of Configure plugin supplied.


  0.22 (2 February 2014)
  ----------------------

  * Restructured module code into ObjAsm format.
  * Fixed task start code.


  0.23 (2 September 2014)
  -----------------------

  * Converted plugin code into Tokenize format and restored un-crunched
    version.
  * Updated library dependencies to new WimpLib code.



Updates and Contacting Me
-------------------------

  If you have any comments about Windows Keys, or would like to report any
  bugs that you find, you can email me at the address below.

  Updates to Windows Keys and more programs for RISC OS computers can be
  found on my website at http://www.stevefryatt.org.uk/software/

  Stephen Fryatt
  email: steve@stevefryatt.org.uk
