$Id: README.txt,v 1.2.2.7 2007-12-29 22:26:55 fago Exp $

Workflow-ng Module
------------------------
Next generation workflows for drupal.
by Wolfgang Ziegler, nuppla@zites.net


Workflow-ng allows one to customize drupal's built in workflows in a very flexible way.
In short, it's a rule-based event driven action evaluation system.

E.g. this is useful for
• sending customized mails notifiying your users about important changes
• building flexible content publishing workflows
• creating custom redirections
• and a lot more....

Modules may use workflow-ng's API to provide defaults, which can be customized by users.
Users can share their customizations by using the built-in import/export tool.


Installation
-------------

*Before* starting, make sure that you have read at least the introduction - so you know 
at least the basic concepts. You can find it here:
                     
                          http://drupal.org/node/156288                          


 * First install the token module, which is needed by workflow-ng.
   http://drupal.org/project/token
 * Then copy the whole workflow_ng directory to your modules directory and
   activate the workflow-ng and workflow-ng UI modules.
 * You can find the admin interface at /admin/build/workflow-ng.
 
 
 
Extension Modules
------------------
Workflow-ng can be extended be any module. Some modules are already included with workflow-ng:

 * Configurable Content Links
   This module provides configurable content links, that generate events when they are pressed.
   Optionally one can activate scheduling for a link, so that the user can set the date when the
   event will be invoked. This may be used for scheduled execution of arbitrary actions, e.g. one
   can use it to schedule the publishing of content: http://drupal.org/node/175319
   Each link can be configured to toggle between to different link labels. Thanks to the State Machine
   API the current link state is exposed to Views too. Access permissions can be controlled independently
   for each link.

   Note:
   To make date selecting more user friendly, install the JS Calendar of the Javascript Tools modules 
   package: http://drupal.org/node/57285



 * State Machine API
   This module provides configurable state machines for other modules. Changes between these states
   can be triggered with workflow-ng.
   It's an API module, so install only if other modules tell you to do so, or you are a developer.

 
Developer
---------
Developers check out the developer documenation:
http://drupal.org/node/156299