You are here

Home » API reference » Wordfilter 5

README.txt in Wordfilter 5

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
Module description
==================

This is a simple word filter that allows site administrators to filter
certain words on a Drupal site. In addition to filtering words in the
body of a node or comment, you can also filter a node or comment title.

Installation and Configuration
==============================

1) Copy the wordfilter module files to your Drupal modules 
   directory (e.g. /sites/all/modules)

2) To install, enable the wordfilter module on the Drupal
   modules page /admin/build/modules

3) Grant the 'administer words filtered' permission to the
   roles desired on the Drupal user permissions page
   /admin/user/access

4) Once the wordfilter module has been installed you can configure
   the settings at /admin/settings/wordfilter

  a) Check 'Enable word filtering on node titles' and 
     'Enable word filtering on comment titles' if you wish
     to filter titles

  b) Enter the default replacement word to use for filtering

5) Add new word filters at /admin/settings/wordfilter/add

  a) Enter a word or phrase you want to filter followed 
     by '|' and the replacement word or phrase. You can 
     enter multiple word and replacement word pairs by hitting 
     return and adding more word pairs. Any word or phrases that 
     do not have a replacement word or phrase will use the default 
     replacement word.

6) Word fitles can be edited or deleted on the wordfilter
   settings page

7) Word filtering on the body text of a node or comment is done
   via a filter enabled for an input format. To enable the wordfilter
   fiter, goto  /admin/settings/filters and then click the configure 
   link for each input format for which you want to enable the 
   wordfilter filter.

   NOTE: From the individual input format configuration pages you can
   click the Rearrange tab to adjust the filter order to resolve any filter
   conflicts.


Original Author
Allen Cook <pyro@gamerswithjobs.com>

Current Project Owner
Steve McKenzie http://drupal.org/user/45890

Current Maintainer
Jeff Warrington http://drupal.org/user/46257

File

README.txt
View source 
  1. 

  2. Module description

  3. ==================

  4. 

  5. This is a simple word filter that allows site administrators to filter

  6. certain words on a Drupal site. In addition to filtering words in the

  7. body of a node or comment, you can also filter a node or comment title.

  8. 

  9. Installation and Configuration

  10. ==============================

  11. 

  12. 1) Copy the wordfilter module files to your Drupal modules 

  13.    directory (e.g. /sites/all/modules)

  14. 

  15. 2) To install, enable the wordfilter module on the Drupal

  16.    modules page /admin/build/modules

  17. 

  18. 3) Grant the 'administer words filtered' permission to the

  19.    roles desired on the Drupal user permissions page

  20.    /admin/user/access

  21. 

  22. 4) Once the wordfilter module has been installed you can configure

  23.    the settings at /admin/settings/wordfilter

  24. 

  25.   a) Check 'Enable word filtering on node titles' and 

  26.      'Enable word filtering on comment titles' if you wish

  27.      to filter titles

  28. 

  29.   b) Enter the default replacement word to use for filtering

  30. 

  31. 5) Add new word filters at /admin/settings/wordfilter/add

  32. 

  33.   a) Enter a word or phrase you want to filter followed 

  34.      by '|' and the replacement word or phrase. You can 

  35.      enter multiple word and replacement word pairs by hitting 

  36.      return and adding more word pairs. Any word or phrases that 

  37.      do not have a replacement word or phrase will use the default 

  38.      replacement word.

  39. 

  40. 6) Word fitles can be edited or deleted on the wordfilter

  41.    settings page

  42. 

  43. 7) Word filtering on the body text of a node or comment is done

  44.    via a filter enabled for an input format. To enable the wordfilter

  45.    fiter, goto  /admin/settings/filters and then click the configure 

  46.    link for each input format for which you want to enable the 

  47.    wordfilter filter.

  48. 

  49.    NOTE: From the individual input format configuration pages you can

  50.    click the Rearrange tab to adjust the filter order to resolve any filter

  51.    conflicts.

  52. 

  53. 

  54. Original Author

  55. Allen Cook 

  56. 

  57. Current Project Owner

  58. Steve McKenzie http://drupal.org/user/45890

  59. 

  60. Current Maintainer

  61. Jeff Warrington http://drupal.org/user/46257