Introduction
============

This is a proof of concept adaptation of the i2 Instiki-successor wiki, created by David Heinemeier Hansson and Alexey Verkhovsky. This version uses the i2 engine from the following svn url:

http://dev.rubyonrails.org/svn/rails/tools/i2/branches/alexey  (revision 2859)

It is NOT production-ready, as many things don't quite work (it seems), include the RedCloth conversion of wiki entries into HTML. However, you are free to play with this an use it as an example of an engine, and as a demonstration to the community of the potential of the Rails Engines concept.

Like i2, WikiEngine requires RedCloth. Please read the i2 documentation for more information about versions that are compatible.

Installing WikiEngine
=====================

0. Create your rails application & set up your database

1. Make sure you've got the latest version of Rails Engines installed:

  $ cd vendor/plugins
  $ svn co https://opensvn.csie.org/rails_engines/plugins/engines

2. Add the Wiki Engine into your /vendor/plugins directory

3. Add the following line to the bottom of environment.rb, if it's not already there:

	Engines.start :wiki  # or just Engines.start to start them all.
	
34 Change into the wiki_engine directory and install the wiki databases:

  $ cd vendor/plugins/wiki_engine
  $ rake migrate

  If you have any problems, it might be an idea to try this with a clean database. Remember, this engine is proof of concept only...

5. Change /app/controllers/application.rb in the mail Rails application so it looks something like:

	class ApplicationController < ActionController::Base
	  include Wiki
	end

6. Change /app/helpers/application.rb to look like:

	module ApplicationHelper
	  include WikiHelper
	end
	
7. Copy the layout from vendor/plugins/wiki_engine/EXAMPLE_LAYOUT.rhtml to your chosen layout in /app/views/layouts (the default one which will be loaded should be named application.rhtml), and edit it if you like.

8. Either copy wholesale the vendor/plugins/wiki_engine/EXAMPLE_ROUTES.rb file over your main /config/routes.rb file, or examine the routes provided and insert them into your routes.rb file as appropriate.

9. Open a console and create your wiki as follows:

  >> Book.create :name => "Your Wiki Name", :url_name => "wiki"

10. Run the application, and go to http://yoursite.com/wiki/ (or whatever you chose as the url_name)

11. Wiki Engines!