README.txt in Quail API 7

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Dependencies
 * Installation
 * Contributers
 * Errata



INTRODUCTION
------------

Current Maintainer: Kevin Day <thekevinday@gmail.com>.

Provides an API for the 3rd-party Quail Library to drupal modules.
Quail API is a complete rewrite of parts of the Drupal 6 project called "Accessible Content".


The Quail Library is a 3rd-party PHP project located at: <quail-lib.org> and <code.google.com/p/quail-lib/>.
This 3rd-party libary provides accessibility validation for common web-accessibility standards, such as: Section 508 and WCAG 2.
Unlike other web accessibility scanners, such as WAVE (<wave.webaim.org>), the Quail Library includes context-specific validation.
This validation is a double-edged sword in that it helps catch and identify far more violations to a given standard but at the cost of producing more false positives.


The Accessible Content module in which this module was based off of was written by Kevin Miller.
The mentioned project may be found on drupals website at <drupal.org/project/accessible_content>.
The original feature request for a drupal 7 version of the Accessible Content module may be found on drupals website at <drupal.org/node/1071830>.



DEPENDENCIES
------------
libraries module: <drupal.org/project/libraries>.



INSTALLATION
------------
Add the module to /sites/all/modules/.

Download the 3rd-party Quail Library from <code.google.com/p/quail-lib/>.
Extract the library into /sites/all/libraries/ as a directory called 'quail'.
Therefore the 3rd-party Quail Library should be located at /sites/all/libraries/quail/.

Although this is optional, I strongly suggest applying the patch located at miscellaneous/quail-bug_fixes.patch.
For instructions on how to apply a patch, read <drupal.org/patch>.

To use the functionality provided by this project, another module must be used.
Try the quail_api_node module from <drupal.org/project/1293724> to make use of the provided functionality.


CONTRIBUTERS
------------
Drupal 7 version by Kevin Day.
Original version by Kevin Miller.


ERRATA
------
The 3rd-party Quail Library has a number of problems that should be fixed to get the best possible usage experience.
The upstream developer has not responded or fixed any of the bugs and as such the patches for these problems will be distributed with this project.

A list of issues have been reported upstream at <code.google.com/p/quail-lib/issues/list>:
- <code.google.com/p/quail-lib/issues/detail?id=29>
- <code.google.com/p/quail-lib/issues/detail?id=30>
- <code.google.com/p/quail-lib/issues/detail?id=31>
- <code.google.com/p/quail-lib/issues/detail?id=32>
- <code.google.com/p/quail-lib/issues/detail?id=33>
- <code.google.com/p/quail-lib/issues/detail?id=34>
- <code.google.com/p/quail-lib/issues/detail?id=35>

There have been more issues but I got tired of reporting them when there is no upstream activity.
All of the bugfixes have been rolled into a single patch called quail-bug_fixes.patch.

The following (optional) patches have been provided to help reduce the number of false positives produced by the quail library:
- quail-reduce-pNotUsedAsHeader-false_positives.patch
  - I have found that the pNotUsedAsHeader has a tendency to improperly mark a significant amount of bold sentences as headers.
  - This patch is an attempt to reduce the number of false-positives by throwing out text that ends in a period.
  - Such cases are more likely to be sentences rather than headers.
- quail-php_54.patch
  - Fixes a bug in the quail library when using php 5.4+.
  - This version does not always apply due to tabs, instead use the quail-php_54-2.patch.
- quail-php_54-2.patch
  - Fixes a bug in the quail library when using php 5.4+.