You are here

Home » API reference » HTML Purifier 6.2

INSTALL.txt in HTML Purifier 6.2

Same filename and directory in other branches
  1. 5 INSTALL.txt
  2. 6 INSTALL.txt
  3. 7.2 INSTALL.txt
  4. 7 INSTALL.txt
PREREQUISITES: Make sure you check HTML Purifier and make sure that you
have fulfilled all of its requirements before running this.  Specifically,
you'll need the PHP extension ctype (in almost all PHP distributions),
and it's nice to have dom and iconv.

* Place the htmlpurifier folder in your drupal modules directory.

* Download HTML Purifier from http://htmlpurifier.org/ You will need
  4.0.0 or later.

* There are two locations you can install the HTML Purifier library.

  1. Module directory installation. This means installing the library
     folder under the module directory, so that the file
     sites/<site>/modules/htmlpurifier/library/HTMLPurifier.auto.php
     exists.  The easiest way to do this is to extract the entire
     htmlpurifier-x.y.z folder, and then copy the
     htmlpurifier-x.y.z/library folder to your module.  This method is
     convenient and simple, but does not permit HTML Purifier to be shared
     with other modules and can make upgrading the Drupal module a little
     complicated.

  2. The preferred way is making use of the libraries API,
     http://drupal.org/project/libraries. This makes the library
     available to all sites or to a specific site in a multisite
     Drupal setup. You'll need to download the libraries API module
     and enable it before enabling the htmlpurifier module so that in
     the install phase it can find the library.

     Extract the htmlpurifier-x.y.z archive to
     sites/all/libraries/htmlpurifier or to
     sites/<site>/libraries/htmlpurifier for a specific site in a
     multisite Drupal setup.  (Note that this is different from the
     module directory installation: you should preserve the *entire*
     htmlpurifier-x.y.z folder).

     The final setup should be, when making the library and module
     available to all sites:

     sites/all/libraries/htmlpurifier/library
         HTMLPurifier
         HTMLPurifier.autoload.php
         HTMLPurifier.auto.php
         HTMLPurifier.func.php
         HTMLPurifier.includes.php
         HTMLPurifier.kses.php
         HTMLPurifier.path.php
         HTMLPurifier.php
         HTMLPurifier.safe-includes.php

     Now you can safely upgrade your htmlpurifier module without
     having to re-deploy the HTML Purifier library.

* Go to Administer > Site building > Modules and enable this module

* You can now create a new input format or add the HTML Purifier to an 
  existing input format. It is recommended that you place HTML Purifier as 
  the last filter in the input format. Reorder the filters if necessary.

WARNING: Due to HTML Purifier's caching mechanism, dynamic filters MUST NOT
be placed before HTML Purifier.

File

INSTALL.txt
View source 
  1. PREREQUISITES: Make sure you check HTML Purifier and make sure that you

  2. have fulfilled all of its requirements before running this.  Specifically,

  3. you'll need the PHP extension ctype (in almost all PHP distributions),

  4. and it's nice to have dom and iconv.

  5. 

  6. * Place the htmlpurifier folder in your drupal modules directory.

  7. 

  8. * Download HTML Purifier from http://htmlpurifier.org/ You will need

  9.   4.0.0 or later.

  10. 

  11. * There are two locations you can install the HTML Purifier library.

  12. 

  13.   1. Module directory installation. This means installing the library

  14.      folder under the module directory, so that the file

  15.      sites//modules/htmlpurifier/library/HTMLPurifier.auto.php

  16.      exists.  The easiest way to do this is to extract the entire

  17.      htmlpurifier-x.y.z folder, and then copy the

  18.      htmlpurifier-x.y.z/library folder to your module.  This method is

  19.      convenient and simple, but does not permit HTML Purifier to be shared

  20.      with other modules and can make upgrading the Drupal module a little

  21.      complicated.

  22. 

  23.   2. The preferred way is making use of the libraries API,

  24.      http://drupal.org/project/libraries. This makes the library

  25.      available to all sites or to a specific site in a multisite

  26.      Drupal setup. You'll need to download the libraries API module

  27.      and enable it before enabling the htmlpurifier module so that in

  28.      the install phase it can find the library.

  29. 

  30.      Extract the htmlpurifier-x.y.z archive to

  31.      sites/all/libraries/htmlpurifier or to

  32.      sites//libraries/htmlpurifier for a specific site in a

  33.      multisite Drupal setup.  (Note that this is different from the

  34.      module directory installation: you should preserve the *entire*

  35.      htmlpurifier-x.y.z folder).

  36. 

  37.      The final setup should be, when making the library and module

  38.      available to all sites:

  39. 

  40.      sites/all/libraries/htmlpurifier/library

  41.          HTMLPurifier

  42.          HTMLPurifier.autoload.php

  43.          HTMLPurifier.auto.php

  44.          HTMLPurifier.func.php

  45.          HTMLPurifier.includes.php

  46.          HTMLPurifier.kses.php

  47.          HTMLPurifier.path.php

  48.          HTMLPurifier.php

  49.          HTMLPurifier.safe-includes.php

  50. 

  51.      Now you can safely upgrade your htmlpurifier module without

  52.      having to re-deploy the HTML Purifier library.

  53. 

  54. * Go to Administer > Site building > Modules and enable this module

  55. 

  56. * You can now create a new input format or add the HTML Purifier to an 

  57.   existing input format. It is recommended that you place HTML Purifier as 

  58.   the last filter in the input format. Reorder the filters if necessary.

  59. 

  60. WARNING: Due to HTML Purifier's caching mechanism, dynamic filters MUST NOT

  61. be placed before HTML Purifier.