You are here

README.txt in Block ARIA Landmark Roles 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
ABOUT THIS MOUDLE
-----------------

Inspired by Block Class, this module adds additional elements to the block
configuration forms that allow users to assign blocks ARIA landmark roles.

WHAT ARE ARIA LANDMARK ROLES?
-----------------------------

The WAI ARIA specification defines a set of specialised “landmark” roles. These 
roles provide a method to programmatically identify commonly found sections of 
web page content in a consistent way. they can be used now in whatever flavour 
of (X)HTML you prefer. This allows assistive technologies to provide users with 
features which they can use to identify and navigate to sections of page content.

For further information, go to http://www.w3.org/WAI/PF/aria or 
http://www.nomensa.com/blog/2010/wai-aria-document-landmark-roles.

INSTALLATION
------------

See http://drupal.org/documentation/install/modules-themes/modules-6.

USAGE
-----

Within your block.tpl.php, include the following snippet within the opening div
tag:

<?php print $aria_role; ?>

Here is the first line of Garland's block.tpl.php before the code is inserted:

<div id="block-<?php print $block->module .'-'. $block->delta; ?>" class="block block-<?php print $block->module ?>">

And here's what the code should look like after adding the snippet:

<div id="block-<?php print $block->module .'-'. $block->delta; ?>" class="block block-<?php print $block->module ?>" <?php print $aria_role; ?>>

IMPORTANT: Remember to separate the PHP snippet from the existing markup with a single space.

AUTHOR
------

Oliver Davies (http://drupal.org/user/381388)

File

README.txt
View source
  1. ABOUT THIS MOUDLE
  2. -----------------
  3. Inspired by Block Class, this module adds additional elements to the block
  4. configuration forms that allow users to assign blocks ARIA landmark roles.
  5. WHAT ARE ARIA LANDMARK ROLES?
  6. -----------------------------
  7. The WAI ARIA specification defines a set of specialised “landmark” roles. These
  8. roles provide a method to programmatically identify commonly found sections of
  9. web page content in a consistent way. they can be used now in whatever flavour
  10. of (X)HTML you prefer. This allows assistive technologies to provide users with
  11. features which they can use to identify and navigate to sections of page content.
  12. For further information, go to http://www.w3.org/WAI/PF/aria or
  13. http://www.nomensa.com/blog/2010/wai-aria-document-landmark-roles.
  14. INSTALLATION
  15. ------------
  16. See http://drupal.org/documentation/install/modules-themes/modules-6.
  17. USAGE
  18. -----
  19. Within your block.tpl.php, include the following snippet within the opening div
  20. tag:
  21. Here is the first line of Garland's block.tpl.php before the code is inserted:
  22. And here's what the code should look like after adding the snippet:
  23. >
  24. IMPORTANT: Remember to separate the PHP snippet from the existing markup with a single space.
  25. AUTHOR
  26. ------
  27. Oliver Davies (http://drupal.org/user/381388)