README.txt 4.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. Description
  2. -----------
  3. Gives a site owner options to disable specific messages shown to end users.
  4. The core drupal message system as offered by drupal_set_message
  5. is an excellent way for modules to send out messages to the end users.
  6. However not all drupal site owners are keen to show all the messages
  7. sent out by drupal core and all modules to their users. This module
  8. gives site administrators a reasonably powerful way to filter out
  9. messages shown to the end users.
  10. Features
  11. --------
  12. 1. Filter out messages that match a full text string exactly.
  13. 2. Filter out messages that match a regular expression.
  14. 3. Permissions to specifically hide all messages of a given type from
  15. any role.
  16. 4. Disable all filtering for specific users.
  17. 5. Disable all filtering for specific paths.
  18. 6. Apply filtering only for specific paths.
  19. 7. Debug system to get messages in the HTML without showing it to the end users.
  20. Installation
  21. ------------
  22. 1. Extract the tar.gz into your 'modules' or directory.
  23. 2. Enable the module at 'administer >> modules'.
  24. Note: The installation process will grant view permissions
  25. for all three types of messages (warning, status, and error)
  26. when it is first installed. If you wish to hide certain types
  27. of messages by user role, you can do so by removing these
  28. permissions.
  29. 3. Configure options in Administration >> Configuration >>
  30. Development >> Disable Messages.
  31. 4. Configure permissions in Administration >> People >> Permissions.
  32. Configuration
  33. -------------
  34. 1. Visit the configuration page at:
  35. 'Administration >> Configuration >> Development >> Disable Messages'
  36. 2. Add the specific messages you wish to filter out to the 'Messages
  37. to be disabled' text area. These messages should be in the form
  38. of Regular Expressions, with one entered per line. You do not
  39. have to include the opening and closing forward slashes for each
  40. regular expression. The system will automatically add /^ and $/
  41. at the beginning and end of the pattern to ensure that the match is
  42. always a full match instead of a partial match. This will help
  43. prevent unexpected filtering of messages. So if you want to filter
  44. out a specific message ensure that you add the full message including
  45. any punctuation and additional HTML if any.
  46. If you are familiar with wildcard searches using *, and not Regular
  47. Expressions, you can achieve the exact same thing by using .* as your
  48. wildcard character. For example, you could wildcard filter out
  49. any Article creation messages using the following Regular Expression:
  50. Article .* has been created.
  51. 3. Next configure 'Page and User Level Filtering Options'. By default,
  52. filtering is enabled for all users on all pages. Here you can
  53. specify the pages where filtering should be applied or excluded by
  54. setting the 'Apply filters by page' radio and textarea and entering
  55. page paths, one per line. These standard visibility controls work
  56. just like the core Block system's.
  57. You may also turn filtering off for certain Drupal User ID's (uid).
  58. This can be useful to turn off filtering for the Admin user uid of 1.
  59. You can also turn off filtering for Anonymous users, whose uid is 0.
  60. 4. If you are setting up the module for the first time, you should
  61. enable one or both of the checkboxes under 'Debug options'. These
  62. will output information about which messages are being excluded,
  63. and why. If you are on a development site, check both boxes and
  64. the debugging output will be printed at the bottom of each page.
  65. 5. Hit 'Save Configuration' to save the settings.
  66. 6. Visit 'Administration >> People >> Permissions' to set permissions.
  67. When the module is first enabled it will granted permissions
  68. to view all message types to each site role.
  69. Assign the 'view <type> message' to roles who should be able to see
  70. the given <type> of messages. Users who do not have the permissions
  71. to see a given type of messages will not be able to see any of the
  72. messages of the given type. Useful to hide warning and error
  73. messages from end users on a production site.
  74. Uninstallation
  75. --------------
  76. 1. Disable the module.
  77. 2. Uninstall the module
  78. Credits
  79. -------
  80. Written by Zyxware, http://www.zyxware.com/