Contents

# Rack Olark
Rack middleware which injects the Olark JavaScript code before the end of the body of any HTML document being sent to the client. 

## Usage

    require 'rack/olark'
    use Rack::Olark, :id => '1234-567-89-0123'

Most of the options you give Rack::Olark are passed along to Olark in the following format:

    olark.configure('key', value);

There are three special options: :id, :format, and :paths. :id is your Olark API ID, and the middleware won't let your Rack app boot without it.

:format is my (possibly lame) justification for using Haml in this project - this option is passed directly to Haml::Engine, and determines the form of the script tags that are inserted into your pages. Choices are :html4, :xhtml, and :html5, with a default of :html5.

:paths decides which routes in your application will display the Olark chat box. It takes an array of routes, and you need to include the leading slash (/). As of version 0.0.4, you can now describe routes in the :paths array with a Regexp as well, and any non-Regexp entries will be handled like this:

    /^#{Regexp.escape(your_original_path_entry)}$/

Example using options:

    require 'rack/olark'
    use Rack::Olark, :id => '1234-567-89-0123', :format => :xhtml, :paths => ['/', '/aboutus'], 'box.corner_position' => 'BL', 'box.start_hidden' => true

## Acknowledgements

Code from rack/google-analytics has been used liberally and expanded/trimmed down where needed. Mucho thanks to Lee Hambley and other cool rack/google-analytics bros.

## Copyright

Copyright (c) 2011 Dan Poggi. License is 2-clause BSD, see LICENSE for details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rack-olark-0.0.4	README.md