My Aide Engine plugin
Plugin details
Documentation
ruby script/plugin install http://rubyforge.org/frs/download.php/15336/my_aide_engine_0.1.tar.gz
"My Aide" is a Rails Engine that can be plugged into any Rails application. Here's a brief overview.
A) client:
pops up on every page like MS Word's Assistant. She hosts the following,
i) a "Live Search" text field which dumps back the results sent by the server.
ii) a "Notes Taker" which can take notes for a page and retrive them whenever required, sorted by timestamp.
iii) a "Cameraman" who can take client snapshots, save them on sever, and make them available whenever required.
iv) a "Guide" who provides a brief description of the page. ( static help info )
B) server:
runs as an Engine inside the scope of Rails. It uses the database for managing client history. Two method stubs 'wizard_live_search' and 'wizard_page_info' , one each for 'live search' and 'help' are provided. They are mixed into ApplicationController. Any controller which wants to use them should override these stubs.
Benefits:
a) easy to plugin and use in any rails application.
b) introduces consistent semantics for live search and page info.
c) eliminates the need of external utilities to maintain notes and manage data snapshots which are often used in live applications.
Further Documentation
There is currently no advanced documentation for this plugin.
New documentationEdit plugin | (0 older versions) | Last edited by: hardway, about 1 year ago

