You are here

README.txt in Custom filter 2.0.x

Custom filter module provides an ability to create some filter without writing
any module.
When we create a new Input format, we will be asked to choose the filters we
want. Some modules hook into filter module and provide additional filters here,
e.g. Textile, GeshiFilter, MathFilter. This module does the same thing, except
that it allows the users with the right permission to define their own filters.

How do we define our own filters?
First, we need to create a filter; a filter is a container for filter rules.
When we create/configure a new input format, every defined filter will appear in
the filters list.

A filter is only a container. We need to define some filter rules if we want it
to work. So, an input format contains one or more filters, each of those has its
own filter rules.

The project page for this module in drupal is:
http://drupal.org/project/customfilter

Documentation and some examples are in http://drupal.org/node/210551

=INSTALLATION=

1. Just copy the entire Custom filter directory into the module directory, and
   enable it at Administer/Site building/Modules.
2. The settings page is at admin/settings/customfilter.
   Non-administrator users need to have "administer customfilter" permission to
   use this.

=NOTES=

1. The PHP code used in the replacement rules must set the variable $result,
   which is then used from the module.
2. The variable $vars is an instance of stdClass(); therefore it cannot be used
   as an array.
3. The module defines a new constant that allows PHP code used in the
   replacement rules to know the version of the API implemented from the module.

File

README.txt
View source
  1. Custom filter module provides an ability to create some filter without writing
  2. any module.
  3. When we create a new Input format, we will be asked to choose the filters we
  4. want. Some modules hook into filter module and provide additional filters here,
  5. e.g. Textile, GeshiFilter, MathFilter. This module does the same thing, except
  6. that it allows the users with the right permission to define their own filters.
  7. How do we define our own filters?
  8. First, we need to create a filter; a filter is a container for filter rules.
  9. When we create/configure a new input format, every defined filter will appear in
  10. the filters list.
  11. A filter is only a container. We need to define some filter rules if we want it
  12. to work. So, an input format contains one or more filters, each of those has its
  13. own filter rules.
  14. The project page for this module in drupal is:
  15. http://drupal.org/project/customfilter
  16. Documentation and some examples are in http://drupal.org/node/210551
  17. =INSTALLATION=
  18. 1. Just copy the entire Custom filter directory into the module directory, and
  19. enable it at Administer/Site building/Modules.
  20. 2. The settings page is at admin/settings/customfilter.
  21. Non-administrator users need to have "administer customfilter" permission to
  22. use this.
  23. =NOTES=
  24. 1. The PHP code used in the replacement rules must set the variable $result,
  25. which is then used from the module.
  26. 2. The variable $vars is an instance of stdClass(); therefore it cannot be used
  27. as an array.
  28. 3. The module defines a new constant that allows PHP code used in the
  29. replacement rules to know the version of the API implemented from the module.