Author: jmorliaguet
Date: Sun Oct 30 16:01:12 2005
New Revision: 28820
Added:
z3lab/cpsskins/branches/jmo-perspectives/engines/default/filters/accesskeys/
z3lab/cpsskins/branches/jmo-perspectives/engines/default/filters/accesskeys/README.txt
(contents, props changed)
Log:
- added a draft for an "access key" filter.
Added:
z3lab/cpsskins/branches/jmo-perspectives/engines/default/filters/accesskeys/README.txt
==============================================================================
--- (empty file)
+++
z3lab/cpsskins/branches/jmo-perspectives/engines/default/filters/accesskeys/README.txt
Sun Oct 30 16:01:12 2005
@@ -0,0 +1,90 @@
+##############################################################################
+#
+# Copyright (c) 2005 Nuxeo and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+$Id$
+
+=================
+Access key filter
+=================
+
+Description
+-----------
+
+The *accesskey* filter adds support for access keys [1] to web pages.
+
+Access keys allow users to go to a given page by pressing a given combination
+of keys on the keyboard (ALT/CTRL, + <KEY> ).
+
+They can be used to improve the site's accessibility and to add shortcuts in
+the application's interface.
+
+
+Implementation
+--------------
+
+Access key definition
+~~~~~~~~~~~~~~~~~~~~~
+
+An access key configuration consists of:
+
+- a key (an ascii character)
+
+- a URL (fixed strings or expressions)
+
+
+Key sets
+~~~~~~~~
+
+Access keys are grouped by *sets*.
+Not two same keys may be used inside a same set.
+
+
+Access key usage
+~~~~~~~~~~~~~~~~
+
+Different key sets may be used in different contexts:
+
+- different *engines* may register different key sets.
+
+- different theme *pages* may have different key sets.
+
+- different theme *pages* may use different sets in different *perspectives*.
+
+Since a key set contain keys that are unique, it is difficult to merge
+several sets, hence pratically only one set -- the effective key set --
+will be used in a given context.
+
+
+Storage
+~~~~~~~
+
+Key sets can be defined on the filesystem (read-only) or they can be persistent
+objects stored in the ZODB.
+
+
+Rendered markup
+~~~~~~~~~~~~~~~
+
+The filter adds the following HTML markup at the top of rendered pages
+
+ <div>
+ <a href="@@some-page.html" accesskey="K"></a>
+ <a href="@@some-other-page.html" accesskey="L"></a>
+ ...
+ </div>
+
+The markup is invisible.
+
+
+[1] http://www.w3.org/TR/html4/interact/forms.html#adef-accesskey
--
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins
