********************************************************************
                     D R U P A L    M O D U L E
********************************************************************
Name: Workflow Module
Author: John VanDyk <jvandyk at iastate dot edu>
Drupal: 4.7
********************************************************************
DESCRIPTION:

The workflow module enables you to create arbitrary workflows in 
Drupal and associate them with node types.

Workflows are made up of workflow states.

Moving from one state to another is called a transition.

Actions are associated with transitions (actions.module must be
installed for this).

Alex Reisner introduced role-based permissions for workflow states
and generally enhanced this module.

********************************************************************
INSTALLATION:

1. Place the entire workflow directory into your Drupal modules/
   directory.


2. Enable the workflow module by navigating to:

     administer > modules

   Enabling the workflow module will create the necessary database 
   tables for you.

3. If you want anyone besides the administrative user to be able
   to configure workflows (usually a bad idea), they must be given
   the "administer workflow" access permission:
   
     administer > users > configure > permissions

   When the module is enabled and the user has the "administer
   workflow" permission, a "workflow" menu should appear in the 
   menu system.

********************************************************************
GETTING STARTED:

Let's create a new workflow. Click on administer -> workflow and click
on the "add workflow" tab.

We'll start simple. Call our workflow "Draft-Done" and click Add Workflow.

Now lets add some workflow states to our workflow. Click "add state" and
enter "draft" and click the Add State button. Do the same for "done".

So we've got a workflow with two states, "draft" and "done". Now we
have to tell each state which other states it can move to. With only
two states, this is easy. Click on the "edit" link to edit the workflow
and see its states.

The "From / To -->" column lists all states. To the right are columns
for each state. Within each cell is a list of roles with checkboxes.

This is confusing. It's easiest to understand if you read rows
across from the left. For example, we start with the creation
state. Who may move a node from its creation state to the "draft"
state? Well, the author of the node, for one. So check the "author"
checkbox.

Who may move the node from the "draft" state to the "done" state?
This is up to you. If you want authors to be able to do this,
check the "author" checkbox under the "done" state. If you had
another role, say "editor", that you wanted to give the ability
to decree a node as "done", you'd check the checkbox next to
the "editor" role and not the author role. In this scenario authors
would turn in drafts and editors would say when they are "done".

Be sure to click the Save button to save your settings.

Now let's tell Drupal which node types should use this workflow. Click
on admin -> workflow. Let's assign the Draft-Done workflow
to the story node type and click Save Workflow Mapping.

Now we could add an action (previously configured using the actions
module). If you have not configured your action yet, here's a quick
guide:

- go to administer -> actions
- choose an action and click "Add new action"
- configure the action and click Save. Note that the description field
  here will be used later on

OK, back in the workflow module, click on the actions link above
your workflow. Add the action to the transition.

Now create a new story by going to create content -> story. Note that
there is no sign of workflow here because the story is in its
initial state. Click submit to create the story.

Now click the edit tab. Note that there is a select box for workflow
with the "draft" state chosen.

Changing the state to "done" and clicking Submit will fire the action
you set up earlier.


********************************************************************