You are here

Home » API reference » SpamSpan filter 8

README.txt in SpamSpan filter 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 7 README.txt
Readme
------

The SpamSpan module obfuscates email addresses to help prevent spambots from
collecting them.  It implements the technique at http://www.spamspan.com

The problem with most email address obfuscators is that they rely upon
JavaScript being enabled on the client side.  This makes the technique
inaccessible to people with screen readers.  SpamSpan however will produce
clickable links if JavaScript is enabled, and will show the email address as
<code>example [at] example.com</code> if the browser does not support
JavaScript or if JavaScript is disabled.

Installation
------------

1. Create a directory in your Drupal modules directory (probably
   modules/) called spamspan and copy all of the module's
   files into it.

2. Go to the Extend page (admin/modules), and enable the
   spamspan module (under Input Filters)

3. Go to the Text Formats and Editors page (admin/config/content/formats)
   and configure the desired input formats to enable the filter.

4. Rearrange the Filter processing order to resolve conflicts with other 
   filters.  NB: To avoid problems, you should at least make sure that the 
   SpamSpan filter has a higher weighting (greater number) than the line break 
   filter which comes with Drupal ("Convert line breaks into HTML" should come 
   above SpamSpan in the list of Enabled filters).  If you use HTML filter 
   ("Limit allowed HTML tags"), you may need to make sure that <span> is 
   one of the allowed tags. Also, URL filter ("Convert URLs into links") must 
   come after SpamSpan.

5. (optional) Set available options under "Filter Settings". 

Bugs
----

Please report any bugs using the bug tracker at
http://drupal.org/project/issues/spamspan


Module Author
------------
Original: Lawrence Akka : http://drupal.org/user/63367
November 2014 rewrite: Peter Moulding : http://petermoulding.com/spamspan
Drupal 8 port: Vitalie Cracan [@Wunderkraut]

File

README.txt
View source 
  1. Readme

  2. ------

  3. 

  4. The SpamSpan module obfuscates email addresses to help prevent spambots from

  5. collecting them.  It implements the technique at http://www.spamspan.com

  6. 

  7. The problem with most email address obfuscators is that they rely upon

  8. JavaScript being enabled on the client side.  This makes the technique

  9. inaccessible to people with screen readers.  SpamSpan however will produce

  10. clickable links if JavaScript is enabled, and will show the email address as

  11. example [at] example.com if the browser does not support

  12. JavaScript or if JavaScript is disabled.

  13. 

  14. Installation

  15. ------------

  16. 

  17. 1. Create a directory in your Drupal modules directory (probably

  18.    modules/) called spamspan and copy all of the module's

  19.    files into it.

  20. 

  21. 2. Go to the Extend page (admin/modules), and enable the

  22.    spamspan module (under Input Filters)

  23. 

  24. 3. Go to the Text Formats and Editors page (admin/config/content/formats)

  25.    and configure the desired input formats to enable the filter.

  26. 

  27. 4. Rearrange the Filter processing order to resolve conflicts with other 

  28.    filters.  NB: To avoid problems, you should at least make sure that the 

  29.    SpamSpan filter has a higher weighting (greater number) than the line break 

  30.    filter which comes with Drupal ("Convert line breaks into HTML" should come 

  31.    above SpamSpan in the list of Enabled filters).  If you use HTML filter 

  32.    ("Limit allowed HTML tags"), you may need to make sure that  is 

  33.    one of the allowed tags. Also, URL filter ("Convert URLs into links") must 

  34.    come after SpamSpan.

  35. 

  36. 5. (optional) Set available options under "Filter Settings". 

  37. 

  38. Bugs

  39. ----

  40. 

  41. Please report any bugs using the bug tracker at

  42. http://drupal.org/project/issues/spamspan

  43. 

  44. 

  45. Module Author

  46. ------------

  47. Original: Lawrence Akka : http://drupal.org/user/63367

  48. November 2014 rewrite: Peter Moulding : http://petermoulding.com/spamspan

  49. Drupal 8 port: Vitalie Cracan [@Wunderkraut]