README.txt 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. --------------------------------------------------------------------------------
  2. Rules Links
  3. --------------------------------------------------------------------------------
  4. This module allows you to create links, which trigger rules.
  5. Dependencies
  6. ------------
  7. Rules Links dependes on following modules:
  8. * Rules - http://drupal.org/project/rules
  9. * Entity API - http://drupal.org/project/entity
  10. * (Optionally) Views 3 - http://drupal.org/project/views
  11. Usage
  12. -----
  13. To create a new link go to admin/config/workflow/rules_links and click on
  14. "Add rules link". Enter the title of your link and set all the settings. After
  15. clicking on the "Save Rules Link" button, the module will generate a new And-
  16. and Rules-Set and their forms will be embedded into the rules link editing form.
  17. The And-Sets are called Visibility Conditions and will define when to render
  18. the links. The Rules set is the rule, that will be triggered on clicking the
  19. rule. Additionally Rules Links also generates access permission for each link,
  20. which you'll have to set in admin/people/permissions.
  21. The best way to display the links is currently using views. Rules Links link
  22. will create a Views field for each link, using the title of the link as title
  23. for the field. So if you have link for nodes with the delete 'Delete node',
  24. you'll find the Views field under name 'Content: Delete node'.
  25. Alternatively you can use render the links directly in the entities that can be
  26. displayed, using the option 'Show link in entity' in the Rules Links settings.
  27. Note that this will not work for links were the parameters have multiple.
  28. paramaters.
  29. If you would like to render a link yourself in a theme or in a module, than use
  30. the function rules_link_render_link().