====== ActionFlow ======
{{flow2.jpg?100 |}}
\\ \\
//simplicity and fluidity with a Rails twist//





===== What's ActionFlow anyways ?! =====

ActionFlow is a declarative flow controller usable by Ruby on Rails applications. Its an efficient, easy and simple Domain Specific Language which allows developers to organize a suite of user actions aimed at a precise goal.

It's as simple as this.

Well, not really. You should definitely read about the main [[concepts]] before venturing into ActionFlow.

===== Getting started =====


==== Prerequisites ====

This documentation WIKI assumes you are already functionnal with both Ruby and Ruby on Rails. If you're not, then ActionFlow wasn't meant for you in the first place. There are many places to look for if you need help with [[http://www.ruby-lang.org/en/|Ruby]] or [[http://www.rubyonrails.com/|Ruby on Rails]]. I will not cover that here.

==== Install ====

I'm not going to cover the basics of installing Ruby, Rails and whatever is needed. Get documentation out there; there's plenty of useful howto's available. To install ActionFlow latest (and sometimes unstable...) version, go to your rails application root and type

<file>script/plugin install svn://rubyforge.org/var/svn/actionflow/trunk/action_flow</file>

Scared to live on the edge ? Download official releases at [[http://rubyforge.org/projects/actionflow/|rubyforge]].




==== For the lazy ====

For those of you who are too lazy to read documentation and APIs, I've compiled a couple howtos to help you get started fast. Don't be scared, ActionFlow DSL is so easy to use you can create complete flows in minutes.

  * [[Creating Controllers]]
  * [[Creating Views]]
  * [[Basic Mapping Example]]
  * [[Demo Application]]


<note important>
Still, I **strongly** recommend reading at least about the main [[concepts]] of ActionFlow.
</note>

==== For the hardcore ====

There are three main documentation sources to help you master ActionFlow. Use them at will.

  * This WIKI... dah.
  * The [[API]]
  * [[http://viewvc.rubyforge.mmmultiworks.com/cgi/viewvc.cgi/?root=actionflow|The source code]]





===== Getting help =====

There are numerous ways to contact the ActionFlow developers and users. The suggested one is via the mailing lists, but you can still use whatever means you see fit.

==== Mailing Lists ====

There are two mailing lists available. Most of the people will want to use the users mailing list. If you want any help on using ActionFlow or have any question regarding installation or anything which is not related to the source code of ActionFlow, this is the place to go for help.

If you have any improvements to suggest or would like to submit patches or anything else **directly** related to ActionFlow source code, use the developer mailing list instead.

  * [[http://rubyforge.org/mailman/listinfo/actionflow-user|User mailing list]]
  * [[http://rubyforge.org/mailman/listinfo/actionflow-devel|Development mailing list]]
  
==== Forums ====

There are also forums available for discussion. Visit [[http://rubyforge.org/forum/?group_id=2769|the forums]] to search for previous messages or start a new thread and I'll get back to you as soon as possible. Don't be shy.

==== Trackers ====

There are bugs and features request trackers available to the ActionFlow community as well. Submit any official feature requests and patches on the [[http://rubyforge.org/tracker/?group_id=2769|trackers]].