You are here

Home » API reference » Rules 6

README.txt in Rules 6

Same filename in this branch
  1. 6 README.txt
  2. 6 rules_forms/README.txt
Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
Rules Module
------------
by Wolfgang Ziegler, nuppla@zites.net


The rules modules allows site administrators to define conditionally executed actions
 based on occurring events (ECA-rules). It's a replacement with more features for the
 trigger module in core and the successor of the workflow-ng module.

It opens new opportunities for site builders to extend the site in ways not possible
before.



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/298480

 * Copy the whole rules directory to your modules directory and
   activate the rules module.
 * You don't need to enable the "rules simpletest" module unless you want to run the tests!
 * You can find the admin interface at /admin/rules.

Notes:

 * If you have the php module activated, you can use a php input evaluator in 
   your rules.

 * If you install the token module, you can make use of token replacements in your rules.
   Get the module from http://drupal.org/project/token. Make sure you have a recent version,
   6.12 or later. Then just activate the module - that's it.

   You don't need to enable the token actions module as rules provides already equivalent
   actions, which are better integrated into the rules module. 
   
Documentation
-------------
Check out the docs at http://drupal.org/node/298476


Rules Scheduler
---------------

 * If you enable the rules scheduler module, you get new actions, that allow you to
   schedule the execution of rule sets.
 * Make sure that you have configured cron for your drupal installation as cron
   is used for scheduling the rule sets. For help see http://drupal.org/cron
 * If the views module (http://drupal.org/project/views) is installed, the module displays
   the list of scheduled tasks in the UI. 


Rules Forms
-----------

 * If you want to manipulate or customize forms on your site, you can use the rules
   forms module. It provides events, conditions and actions for rule-based form customization.
 * Take a look at the README.txt file in rules forms module subfolder.
 

Rules Simpletest
----------------

 This module just provides some test case for the rules module. You don't need to
 activate it unless you want to run these tests with the simpletest module.

File

README.txt
View source 
  1. 

  2. Rules Module

  3. ------------

  4. by Wolfgang Ziegler, nuppla@zites.net

  5. 

  6. 

  7. The rules modules allows site administrators to define conditionally executed actions

  8.  based on occurring events (ECA-rules). It's a replacement with more features for the

  9.  trigger module in core and the successor of the workflow-ng module.

  10. 

  11. It opens new opportunities for site builders to extend the site in ways not possible

  12. before.

  13. 

  14. 

  15. 

  16. Installation

  17. -------------

  18. 

  19. *Before* starting, make sure that you have read at least the introduction - so you know 

  20. at least the basic concepts. You can find it here:

  21.                      

  22.                           http://drupal.org/node/298480

  23. 

  24.  * Copy the whole rules directory to your modules directory and

  25.    activate the rules module.

  26.  * You don't need to enable the "rules simpletest" module unless you want to run the tests!

  27.  * You can find the admin interface at /admin/rules.

  28. 

  29. Notes:

  30. 

  31.  * If you have the php module activated, you can use a php input evaluator in 

  32.    your rules.

  33. 

  34.  * If you install the token module, you can make use of token replacements in your rules.

  35.    Get the module from http://drupal.org/project/token. Make sure you have a recent version,

  36.    6.12 or later. Then just activate the module - that's it.

  37. 

  38.    You don't need to enable the token actions module as rules provides already equivalent

  39.    actions, which are better integrated into the rules module. 

  40.    

  41. Documentation

  42. -------------

  43. Check out the docs at http://drupal.org/node/298476

  44. 

  45. 

  46. Rules Scheduler

  47. ---------------

  48. 

  49.  * If you enable the rules scheduler module, you get new actions, that allow you to

  50.    schedule the execution of rule sets.

  51.  * Make sure that you have configured cron for your drupal installation as cron

  52.    is used for scheduling the rule sets. For help see http://drupal.org/cron

  53.  * If the views module (http://drupal.org/project/views) is installed, the module displays

  54.    the list of scheduled tasks in the UI. 

  55. 

  56. 

  57. Rules Forms

  58. -----------

  59. 

  60.  * If you want to manipulate or customize forms on your site, you can use the rules

  61.    forms module. It provides events, conditions and actions for rule-based form customization.

  62.  * Take a look at the README.txt file in rules forms module subfolder.

  63.  

  64. 

  65. Rules Simpletest

  66. ----------------

  67. 

  68.  This module just provides some test case for the rules module. You don't need to

  69.  activate it unless you want to run these tests with the simpletest module.

  70.