====== Raakt - The Ruby Accessibility Analysis Kit ======

Raakt is a web accessibility analysis tool that makes it easy to integrate basic accessibility evaluation [[http://www.standards-schmandards.com/2007/rapid-accessibility-feedback/|early in the development process]]. This means that you will save time (and money) as basic technical accessibility issues can be caught automatically as part of your automated test procedure.

What separates Raakt from other accessibility evaluation tools is that only [[:tests]] that are machine verifiable are included. This means that Raakt can be used by developers with limited web accessibility knowledge. When you do your expert accessibility evaluation, they can focus on issues that need manual assessment.

I had the pleasure of presenting Raakt at the first European Rails conference in London 2006.

Paste the code below into a text file (Some free advice: don't name your test file "raakt.rb"). This will do a simple test of a remote web page:

<code ruby>
require 'rubygems'
require 'mechanize'
require 'raakt'

agent = WWW::Mechanize.new
page = agent.get("http://www.peterkrantz.com")

raakttest = Raakt::Test.new(page.body)
result = raakttest.all

if result.length > 0
  puts "Accessibility problems detected:"
  puts result
else
  puts "No measurable accessibility problems were detected."
end
</code>

===== Quickstart =====
Getting started with Raakt is easy:

  * [[Install|Installing the Raakt gem]].
  * [[examples:commandline|Calling Raakt from the command line]]. A simple script to test remote websites.
  * Afraid of installations? Try out the [[http://www.peterkrantz.com/bacc/|online version]].









===== Using Raakt in your development environment =====
Raakt is meant to be part of your automated HTML unit tests (or acceptance tests or functional tests or what you call them). 

  * Java: Using [[frameworks:watir|Raakt in Watir]], [[frameworks:htmlunit|HTMLUnit]], [[frameworks::selenium|Selenium]].
  * ASP.NET: [[frameworks::watir|Watir]], [[frameworks:nunit|NUnit]], [[frameworks::selenium|Selenium]].
  * Ruby on Rails: [[frameworks:rails|Custom assert in Rails functional test]], [[frameworks::selenium|Selenium]].
  * PHP: [[frameworks:watir|Watir]], [[frameworks::selenium|Selenium]]
  * No framework: [[frameworks:none|Folder monitoring]] for GUI developers who produce static html documents. [[examples:batchtest|Batch testing an entire site]] as part of an automated build and deployment framework or regular quality assurance.


Would you like to use Raakt in an environment not listed here? Please file a [[http://rubyforge.org/tracker/?atid=7291&group_id=1861&func=browse|feature request]] at Rubyforge.


===== Documentation =====
To learn more about Raakt, see:
  * [[tests|Test overview]] and how Raakt tests map to other evaluation methodologies.
  * [[Rdoc documentation]].
  * [[http://raakt.rubyforge.org/svn/trunk/|The source code]].


===== Questions, Feedback, Bugs, Praise =====
  * Stumped? [[faq:faq|Frequently asked questions]] may help you.
  * Found a bug? Patches for bugs are always welcome. If you want to report a bug, please use the [[http://rubyforge.org/tracker/?atid=7288&group_id=1861&func=browse|Rubyforge issue tracker for Raakt]].
  * How to get in touch with me? Send email to peter dot krantz at gmail dot com. I would love to hear about how you are using Raakt.