[Summary view] [Print] [Text view]

   1  $Id: README.txt,v 1.1.2.11 2009/12/10 11:58:31 fago Exp $
   2  
   3  Rules Module
   4  ------------
   5  by Wolfgang Ziegler, nuppla@zites.net
   6  
   7  
   8  The rules modules allows site administrators to define conditionally executed actions
   9   based on occurring events (ECA-rules). It's a replacement with more features for the
  10   trigger module in core and the successor of the workflow-ng module.
  11  
  12  It opens new opportunities for site builders to extend the site in ways not possible
  13  before.
  14  
  15  
  16  
  17  Installation
  18  -------------
  19  
  20  *Before* starting, make sure that you have read at least the introduction - so you know 
  21  at least the basic concepts. You can find it here:
  22                       
  23                            http://drupal.org/node/298480
  24  
  25   * Copy the whole rules directory to your modules directory and
  26     activate the rules module.
  27   * You don't need to enable the "rules simpletest" module unless you want to run the tests!
  28   * You can find the admin interface at /admin/rules.
  29  
  30  Notes:
  31  
  32   * If you have the php module activated, you can use a php input evaluator in 
  33     your rules.
  34  
  35   * If you install the token module, you can make use of token replacements in your rules.
  36     Get the module from http://drupal.org/project/token. Make sure you have a recent version,
  37     6.12 or later. Then just activate the module - that's it.
  38  
  39     You don't need to enable the token actions module as rules provides already equivalent
  40     actions, which are better integrated into the rules module. 
  41     
  42  Documentation
  43  -------------
  44  Check out the docs at http://drupal.org/node/298476
  45  
  46  
  47  Rules Scheduler
  48  ---------------
  49  
  50   * If you enable the rules scheduler module, you get new actions, that allow you to
  51     schedule the execution of rule sets.
  52   * Make sure that you have configured cron for your drupal installation as cron
  53     is used for scheduling the rule sets. For help see http://drupal.org/cron
  54   * If the views module (http://drupal.org/project/views) is installed, the module displays
  55     the list of scheduled tasks in the UI. 
  56  
  57  
  58  Rules Forms
  59  -----------
  60  
  61   * If you want to manipulate or customize forms on your site, you can use the rules
  62     forms module. It provides events, conditions and actions for rule-based form customization.
  63   * Take a look at the README.txt file in rules forms module subfolder.
  64   
  65  
  66  Rules Simpletest
  67  ----------------
  68  
  69   This module just provides some test case for the rules module. You don't need to
  70   activate it unless you want to run these tests with the simpletest module.
  71