Accessibility Evaluation Library API 2.0

From MemberWiki

Accessibility Home | Evaluation Library API 2.0 | Ruleset Format 2.0 | DOM Cache Objects | Evaluation Results Object | Log Object | Rules for Ruleset 2.0 | Issue Tracker |

Contents 1 Getting Started 2 RulesetEvaluation Object 2.1 Function Parameters 2.2 Methods 2.2.1 evaluate method 2.3 Function Returns 3 DOMCache Object 4 RulesetEvaluationResult Object 5 Log Object

Getting Started

• Top level file for loading evaluation library: [openajax_a11y.js]
• example usage of API:

<script src="openajax_a11y/openajax_a11y.js"                type="text/javascript">
<script src="openajax_a11y/scripts/progress_log.js"         type="text/javascript">
<script src="openajax_a11y/scripts/ruleset_results.js"      type="text/javascript">
<script src="openajax_a11y/scripts/cache_util.js"           type="text/javascript">
<script src="openajax_a11y/scripts/cache_list.js"           type="text/javascript">
<script src="openajax_a11y/scripts/cache_style.js"          type="text/javascript">
<script src="openajax_a11y/scripts/cache_dom_element.js"    type="text/javascript">
<script src="openajax_a11y/scripts/cache_owns.js"           type="text/javascript">
<script src="openajax_a11y/scripts/cache_dom_traversal.js"  type="text/javascript">
<script src="openajax_a11y/scripts/cache_links.js"          type="text/javascript">
<script src="openajax_a11y/scripts/cache_images.js"         type="text/javascript">
<script src="openajax_a11y/scripts/cache_headings.js"       type="text/javascript">
<script src="openajax_a11y/scripts/cache_landmarks.js"      type="text/javascript">
<script src="openajax_a11y/scripts/cache_tables.js"         type="text/javascript">
<script src="openajax_a11y/scripts/cache_color_contrast.js" type="text/javascript">
<script src="openajax_a11y/rules/oaa-rules_links.js"        type="text/javascript">
<script src="openajax_a11y/rules/oaa-rules_style.js"        type="text/javascript">
<script src="openajax_a11y/rulesets/wcag20-ruleset.js"      type="text/javascript">
<script src="openajax_a11y/nls/wcag20-ruleset_en-us.js"     type="text/javascript">
<script src="openajax_a11y/openajax_a11y_test.js"           type="text/javascript">

....

<script>

var result = new OpenAjax.a11y.RulesetEvaluation("WCAG_2_0", "en-us", window.document, null);
var out = result.log.toString() ;
out += result.ruleset_result.toString();
out += result.dom_cache.color_contrast.toString();

if( window.getComputedStyle ) {
  out += "Can compute style"; 
}
else {
  out += "Can NOT compute style"; 
}

document.getElementById('results').innerHTML = out;

</script>

..

<pre id="results"></pre>
 
 

RulesetEvaluation Object

function OpenAjax.a11y.RulesetEvaluation(ruleset_id, lang, document, callback) {...}
 

Constructor for a RulesetEvaluation Object. This does not execute the rules on document.

Function Parameters

Name	Type	Required	Description
ruleset_id	String	Yes	the id of the ruleset to be used for evaluation (e.g. 'WCAG_2_0' )
lang	String	Yes	the default language code of the document (e.g. 'en-us' )
document	Object	Yes	the document object to be evaluated (e.g. window.document )
callback	function	No	a callback function that can be used for monitoring progress of cache creation and rule evaluation

Methods

evaluate method

Name	Type	Required	Description
build_cache	Boolean	Yes	If true the speciality caches are created all at one time, if false speciality caches are only created when a rule needs it

Function Returns

RulesetEvaluation object containing three major object properties:

1. DOMCache object : Provides node level rule results and accessibility information
2. RulesetEvaluationResult object : Provide requirement view of rule evaluation results
3. Log object: Provides performance, progress and error information

DOMCache Object

RulesetEvaluationResult Object

Log Object