modules/accessible/README.txt

$Id: README.txt,v 1.1 2009/02/04 23:33:58 johnbarclay Exp $

This is a helper module to make creating accessible websites easier.  It is intended to:

- add functionality to allow authors to class block headings as "offscreen"
- fix accessibility issues in other modules via hooks.  the sole example included is google_cse module

The method of the module is to try to fix as many accessiblilty issues as possible within the module,
so the work doesn't have to be done over and over again in the theming layer. Ultimately these fixes should be integrated into core or other modules, so this module will have a moving
target.

Much of accessiblity is on the theming layer, so example .tpl and template.php overrides
are included in the examples directory of this module.  These may be installed with the CVS patches such
as examples/garland/garland.patch or by copying the changed files such as examples/garland/block.tpl.php
to the theming directory you are working with.


===============================
Install and Configure
===============================

Enable the module. (admin/build/modules/list)
Give site admins permissions to "administer accessible module" (admin/user/permissions)
Configure the module (admin/settings/accessible)
Tweak block.tpl.php to use the $block->offscreen variable as you desire for block headings
  An example in in examples/garland/block.tpl.php


===============================
How to Help with this Module
===============================

1. make changes to other themes or garland to make them pass the functional accessibility evaluator
   and integrate them into the examples part.  
2. try it out and give feedback
3. if you're not a coder, but know what the html should look like for accessibility, make suggestions
    and I'll try to get to coding it.


1	$Id: README.txt,v 1.1 2009/02/04 23:33:58 johnbarclay Exp $
2
3	This is a helper module to make creating accessible websites easier. It is intended to:
4
5	- add functionality to allow authors to class block headings as "offscreen"
6	- fix accessibility issues in other modules via hooks. the sole example included is google_cse module
7
8	The method of the module is to try to fix as many accessiblilty issues as possible within the module,
9	so the work doesn't have to be done over and over again in the theming layer. Ultimately these fixes should be integrated into core or other modules, so this module will have a moving
10	target.
11
12	Much of accessiblity is on the theming layer, so example .tpl and template.php overrides
13	are included in the examples directory of this module. These may be installed with the CVS patches such
14	as examples/garland/garland.patch or by copying the changed files such as examples/garland/block.tpl.php
15	to the theming directory you are working with.
16
17
18	===============================
19	Install and Configure
20	===============================
21
22	Enable the module. (admin/build/modules/list)
23	Give site admins permissions to "administer accessible module" (admin/user/permissions)
24	Configure the module (admin/settings/accessible)
25	Tweak block.tpl.php to use the $block->offscreen variable as you desire for block headings
26	An example in in examples/garland/block.tpl.php
27
28
29	===============================
30	How to Help with this Module
31	===============================
32
33	1. make changes to other themes or garland to make them pass the functional accessibility evaluator
34	and integrate them into the examples part.
35	2. try it out and give feedback
36	3. if you're not a coder, but know what the html should look like for accessibility, make suggestions
37	and I'll try to get to coding it.
38
39