README

ACCESS KEYS HELPER
------------------

This javascript routine parses the DOM tree looking for buttons and links that have an access key defined. The access keys for these elements are then displayed either:

1. Inside an "access_keys" element (if one exists), or
2. At the bottom of the BODY element, inside a newly created "access_keys" element

REQUIREMENTS

* Prototype
* JQuery (if using jQuery - note this example is to show jQuery idiom - you could also pass in function for the formating of the key list - the default format here is promiscuous and works with the current example but may fall over on other html - final note, this code should be TDD/BDD'd)

INSTALLATION

1. copy the access_keys.js file into your javascripts folder
2. include a reference to the file inside your HTML

See the demo.html file for example usage.

SUPPORTED BROWSERS

Have successfully tested on these platforms:

* Internet Explorer versions 6, 7 and 8
* Firefox on Windows and Mac
* Safari on Windows and Mac
* Google Chrome

COPYRIGHT

Released as free software with the permission of Radio New Zealand.

Copyright (c) 2009 Radio New Zealand Limited
http://www.radionz.co.nz/

AUTHOR

Nigel Ramsay of Able Technology Limited
http://www.abletech.co.nz/

TODO LIST

1. Detect browser type and platform, and display appropriate modifier keys
2. Write a plain version
3. Write a version that runs from a Bookmarklet
4. Demonstrate code through TDD/BDD