Working With Rails

Riki Engine

= rikiEngine

test to see if possible to commit… should be removed.

rikiEngine is a …

This software package is developed using the Engines plugin. To find out more about how to use engines in general, go to http://rails-engines.rubyforge.org for general documentation about the Engines mechanism.

== Installation

1. Create your Rails application, set up your databases, grab the Engines plugin and the rikiEngine, and install them.

2. Install the rikiEngine into your vendor/plugins directory

3. Modify your Engines.start call in config/environment.rb

Engines.start :riki # or :riki_engine

4. Edit your application.rb file so it looks something like the following:

class ApplicationController < ActionController::Base
  include RikiEngine
end

5. Edit your application_helper.rb file:

module ApplicationHelper
  include RikiEngine
end

6. Perform any configuration you might need. You’ll probably want to set these values in environment.rb (before the call to Engines.start):

1. BM: Not applicable now module rikiEngine config :some_option, “some_value” end

7. Initialize the database tables. You can either use the engine migrations by calling:

rake engine_migrate

to move all engines to their latest versions, or

rake engine_migrate ENGINE=riki

to migrate only this engine.

8. Copy the Example_application.rhtml and Example_routes.rb to its respective location.

9. Run your application and point your browser to http://your_app[:your_port]/books (e.g. http://localhost:3000/books) and create your first book.

10. The rikiEngine provides a default stylesheet and a small javascript helper file, so you’ll probably want to include the former and almost certainly the latter in your application’s layout. Add the following lines:

1. BM: Not applicable now <%= engine_stylesheet “riki_engine” %> <%= engine_javascript “riki_engine” %>

11. Chuckle There is no step 11 ;-)

Configuration

A number of configuration parameters are available to allow to you control how the data is stored, should you be unhappy with the defaults. These are outlined below.

module rikiEngine
  config :some_option, "some_value" 
end

= Configuration Options some_option:: This option will set some_value Usage How to use this engine TODO License Riki: A wiki build as Rails Engine

Copyright© 2006 Bart Masschelein <bart>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

NOTE: This description has been extracted from the Plugin README and so the formatting may need updating to make browser friendly