Path

ez projects / access_keys


Access Keys

UNIX name Owner Status Version Compatible with
access_keys Jon Staines stable 1.1 4.x

Allows access keys to be set via ini file and added to template through
template operators.

Installation
-----------------
1) Extract the archive into the /extensions directory
2) Enable the extension via the admin interface or by editing the
site.ini.append in /settings/override.
3) Edit extensions/accesskeys/settings/accesskeys.ini.append.php and
add the required access keys in the following format:
Keys[]=xxx;yyy;zzz
Where xxx is the access key to press, yyy is the key's destination and zzz
is the text of the link. For example:
Keys[]=4;/What-s-On;What's On
In Firefox the above setting would send you to /What-s-On when you
press Alt+Shift+4 and the link text would be What's On.
There is a special key using s for skip to content. Do not use your own s.
This extension comes with a path to /accesskeys which is a page
listing the keys and their targets. The default access key for this
page is 0.
4) Generate the autoloads either through the admin interface or by
running:
php bin/php/ezpgenerateautoloads.php
From within the eZ Publish install directory.
5) Optional. If you want the accesskeys.ini to appear in the admin
interface's list of ini files so that it can be edited through there.
Simply create a blank file (use the touch command on Linux) to create
an accesskeys.ini in the settings/override folder for the eZ Publish
install (not the extension's settings folder).
6) Clear the cache
Usage
-----------------
There are 3 template operators that can be used in this extension:
1) ak_skip()
This writes the HTML for the Skip to Content access key link
2) ak_skip_target()
This writes the HTML for the target anchor for the Skip to Content
link
3) ak_list()
This writes the HTML for the user defined access key links set in the
accesskeys.ini.append.php file
For example in the default ezwebin pagelayout.tpl you could add the 1st
and 3rd one just under the body tag:

{ak_skip()}
{ak_list()}

And the 2nd one before the $module_result.content line:




{ak_skip_target()}

{$module_result.content}




The links use CSS to be placed off the left of the screen so that they
are visible in text browsers but not standard visual browsers such as
IE.
The text for the skip to content link can be changed in the
accesskeys.ini.append.php file by setting the value of
SkipToContentText.

 

Screenshot

This project has no reviews yet. Be the first one to review it!

No forum messages yet.