corpus_parole: cms/drupal/profiles/drustack/libraries/htmlpurifier/INSTALL@25f3d28f51b2 (annotated)

541 e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	1
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	2	Install
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	3	How to install HTML Purifier
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	4
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	5	HTML Purifier is designed to run out of the box, so actually using the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	6	library is extremely easy. (Although... if you were looking for a
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	7	step-by-step installation GUI, you've downloaded the wrong software!)
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	8
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	9	While the impatient can get going immediately with some of the sample
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	10	code at the bottom of this library, it's well worth reading this entire
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	11	document--most of the other documentation assumes that you are familiar
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	12	with these contents.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	13
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	14
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	15	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	16	1. Compatibility
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	17
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	18	HTML Purifier is PHP 5 only, and is actively tested from PHP 5.0.5 and
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	19	up. It has no core dependencies with other libraries. PHP
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	20	4 support was deprecated on December 31, 2007 with HTML Purifier 3.0.0.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	21	HTML Purifier is not compatible with zend.ze1_compatibility_mode.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	22
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	23	These optional extensions can enhance the capabilities of HTML Purifier:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	24
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	25	* iconv : Converts text to and from non-UTF-8 encodings
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	26	* bcmath : Used for unit conversion and imagecrash protection
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	27	* tidy : Used for pretty-printing HTML
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	28
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	29	These optional libraries can enhance the capabilities of HTML Purifier:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	30
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	31	* CSSTidy : Clean CSS stylesheets using %Core.ExtractStyleBlocks
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	32	* Net_IDNA2 (PEAR) : IRI support using %Core.EnableIDNA
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	33
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	34	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	35	2. Reconnaissance
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	36
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	37	A big plus of HTML Purifier is its inerrant support of standards, so
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	38	your web-pages should be standards-compliant. (They should also use
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	39	semantic markup, but that's another issue altogether, one HTML Purifier
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	40	cannot fix without reading your mind.)
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	41
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	42	HTML Purifier can process these doctypes:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	43
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	44	* XHTML 1.0 Transitional (default)
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	45	* XHTML 1.0 Strict
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	46	* HTML 4.01 Transitional
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	47	* HTML 4.01 Strict
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	48	* XHTML 1.1
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	49
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	50	...and these character encodings:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	51
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	52	* UTF-8 (default)
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	53	* Any encoding iconv supports (with crippled internationalization support)
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	54
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	55	These defaults reflect what my choices would be if I were authoring an
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	56	HTML document, however, what you choose depends on the nature of your
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	57	codebase. If you don't know what doctype you are using, you can determine
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	58	the doctype from this identifier at the top of your source code:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	59
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	60	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	61	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	62
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	63	...and the character encoding from this code:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	64
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	65	<meta http-equiv="Content-type" content="text/html;charset=ENCODING">
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	66
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	67	If the character encoding declaration is missing, STOP NOW, and
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	68	read 'docs/enduser-utf8.html' (web accessible at
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	69	http://htmlpurifier.org/docs/enduser-utf8.html). In fact, even if it is
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	70	present, read this document anyway, as many websites specify their
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	71	document's character encoding incorrectly.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	72
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	73
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	74	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	75	3. Including the library
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	76
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	77	The procedure is quite simple:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	78
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	79	require_once '/path/to/library/HTMLPurifier.auto.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	80
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	81	This will setup an autoloader, so the library's files are only included
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	82	when you use them.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	83
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	84	Only the contents in the library/ folder are necessary, so you can remove
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	85	everything else when using HTML Purifier in a production environment.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	86
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	87	If you installed HTML Purifier via PEAR, all you need to do is:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	88
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	89	require_once 'HTMLPurifier.auto.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	90
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	91	Please note that the usual PEAR practice of including just the classes you
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	92	want will not work with HTML Purifier's autoloading scheme.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	93
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	94	Advanced users, read on; other users can skip to section 4.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	95
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	96	Autoload compatibility
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	97	----------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	98
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	99	HTML Purifier attempts to be as smart as possible when registering an
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	100	autoloader, but there are some cases where you will need to change
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	101	your own code to accomodate HTML Purifier. These are those cases:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	102
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	103	PHP VERSION IS LESS THAN 5.1.2, AND YOU'VE DEFINED __autoload
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	104	Because spl_autoload_register() doesn't exist in early versions
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	105	of PHP 5, HTML Purifier has no way of adding itself to the autoload
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	106	stack. Modify your __autoload function to test
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	107	HTMLPurifier_Bootstrap::autoload($class)
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	108
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	109	For example, suppose your autoload function looks like this:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	110
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	111	function __autoload($class) {
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	112	require str_replace('_', '/', $class) . '.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	113	return true;
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	114	}
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	115
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	116	A modified version with HTML Purifier would look like this:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	117
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	118	function __autoload($class) {
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	119	if (HTMLPurifier_Bootstrap::autoload($class)) return true;
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	120	require str_replace('_', '/', $class) . '.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	121	return true;
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	122	}
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	123
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	124	Note that there is some custom behavior in our autoloader; the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	125	original autoloader in our example would work for 99% of the time,
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	126	but would fail when including language files.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	127
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	128	AN __autoload FUNCTION IS DECLARED AFTER OUR AUTOLOADER IS REGISTERED
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	129	spl_autoload_register() has the curious behavior of disabling
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	130	the existing __autoload() handler. Users need to explicitly
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	131	spl_autoload_register('__autoload'). Because we use SPL when it
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	132	is available, __autoload() will ALWAYS be disabled. If __autoload()
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	133	is declared before HTML Purifier is loaded, this is not a problem:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	134	HTML Purifier will register the function for you. But if it is
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	135	declared afterwards, it will mysteriously not work. This
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	136	snippet of code (after your autoloader is defined) will fix it:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	137
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	138	spl_autoload_register('__autoload')
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	139
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	140	Users should also be on guard if they use a version of PHP previous
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	141	to 5.1.2 without an autoloader--HTML Purifier will define __autoload()
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	142	for you, which can collide with an autoloader that was added by you
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	143	later.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	144
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	145
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	146	For better performance
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	147	----------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	148
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	149	Opcode caches, which greatly speed up PHP initialization for scripts
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	150	with large amounts of code (HTML Purifier included), don't like
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	151	autoloaders. We offer an include file that includes all of HTML Purifier's
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	152	files in one go in an opcode cache friendly manner:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	153
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	154	// If /path/to/library isn't already in your include path, uncomment
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	155	// the below line:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	156	// require '/path/to/library/HTMLPurifier.path.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	157
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	158	require 'HTMLPurifier.includes.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	159
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	160	Optional components still need to be included--you'll know if you try to
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	161	use a feature and you get a class doesn't exists error! The autoloader
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	162	can be used in conjunction with this approach to catch classes that are
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	163	missing. Simply add this afterwards:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	164
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	165	require 'HTMLPurifier.autoload.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	166
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	167	Standalone version
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	168	------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	169
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	170	HTML Purifier has a standalone distribution; you can also generate
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	171	a standalone file from the full version by running the script
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	172	maintenance/generate-standalone.php . The standalone version has the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	173	benefit of having most of its code in one file, so parsing is much
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	174	faster and the library is easier to manage.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	175
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	176	If HTMLPurifier.standalone.php exists in the library directory, you
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	177	can use it like this:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	178
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	179	require '/path/to/HTMLPurifier.standalone.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	180
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	181	This is equivalent to including HTMLPurifier.includes.php, except that
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	182	the contents of standalone/ will be added to your path. To override this
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	183	behavior, specify a new HTMLPURIFIER_PREFIX where standalone files can
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	184	be found (usually, this will be one directory up, the "true" library
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	185	directory in full distributions). Don't forget to set your path too!
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	186
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	187	The autoloader can be added to the end to ensure the classes are
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	188	loaded when necessary; otherwise you can manually include them.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	189	To use the autoloader, use this:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	190
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	191	require 'HTMLPurifier.autoload.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	192
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	193	For advanced users
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	194	------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	195
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	196	HTMLPurifier.auto.php performs a number of operations that can be done
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	197	individually. These are:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	198
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	199	HTMLPurifier.path.php
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	200	Puts /path/to/library in the include path. For high performance,
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	201	this should be done in php.ini.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	202
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	203	HTMLPurifier.autoload.php
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	204	Registers our autoload handler HTMLPurifier_Bootstrap::autoload($class).
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	205
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	206	You can do these operations by yourself--in fact, you must modify your own
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	207	autoload handler if you are using a version of PHP earlier than PHP 5.1.2
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	208	(See "Autoload compatibility" above).
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	209
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	210
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	211	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	212	4. Configuration
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	213
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	214	HTML Purifier is designed to run out-of-the-box, but occasionally HTML
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	215	Purifier needs to be told what to do. If you answer no to any of these
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	216	questions, read on; otherwise, you can skip to the next section (or, if you're
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	217	into configuring things just for the heck of it, skip to 4.3).
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	218
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	219	* Am I using UTF-8?
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	220	* Am I using XHTML 1.0 Transitional?
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	221
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	222	If you answered no to any of these questions, instantiate a configuration
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	223	object and read on:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	224
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	225	$config = HTMLPurifier_Config::createDefault();
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	226
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	227
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	228	4.1. Setting a different character encoding
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	229
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	230	You really shouldn't use any other encoding except UTF-8, especially if you
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	231	plan to support multilingual websites (read section three for more details).
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	232	However, switching to UTF-8 is not always immediately feasible, so we can
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	233	adapt.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	234
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	235	HTML Purifier uses iconv to support other character encodings, as such,
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	236	any encoding that iconv supports <http://www.gnu.org/software/libiconv/>
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	237	HTML Purifier supports with this code:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	238
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	239	$config->set('Core.Encoding', /* put your encoding here */);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	240
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	241	An example usage for Latin-1 websites (the most common encoding for English
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	242	websites):
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	243
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	244	$config->set('Core.Encoding', 'ISO-8859-1');
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	245
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	246	Note that HTML Purifier's support for non-Unicode encodings is crippled by the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	247	fact that any character not supported by that encoding will be silently
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	248	dropped, EVEN if it is ampersand escaped. If you want to work around
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	249	this, you are welcome to read docs/enduser-utf8.html for a fix,
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	250	but please be cognizant of the issues the "solution" creates (for this
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	251	reason, I do not include the solution in this document).
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	252
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	253
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	254	4.2. Setting a different doctype
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	255
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	256	For those of you using HTML 4.01 Transitional, you can disable
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	257	XHTML output like this:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	258
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	259	$config->set('HTML.Doctype', 'HTML 4.01 Transitional');
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	260
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	261	Other supported doctypes include:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	262
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	263	* HTML 4.01 Strict
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	264	* HTML 4.01 Transitional
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	265	* XHTML 1.0 Strict
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	266	* XHTML 1.0 Transitional
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	267	* XHTML 1.1
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	268
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	269
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	270	4.3. Other settings
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	271
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	272	There are more configuration directives which can be read about
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	273	here: <http://htmlpurifier.org/live/configdoc/plain.html> They're a bit boring,
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	274	but they can help out for those of you who like to exert maximum control over
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	275	your code. Some of the more interesting ones are configurable at the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	276	demo <http://htmlpurifier.org/demo.php> and are well worth looking into
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	277	for your own system.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	278
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	279	For example, you can fine tune allowed elements and attributes, convert
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	280	relative URLs to absolute ones, and even autoparagraph input text! These
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	281	are, respectively, %HTML.Allowed, %URI.MakeAbsolute and %URI.Base, and
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	282	%AutoFormat.AutoParagraph. The %Namespace.Directive naming convention
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	283	translates to:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	284
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	285	$config->set('Namespace.Directive', $value);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	286
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	287	E.g.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	288
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	289	$config->set('HTML.Allowed', 'p,b,a[href],i');
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	290	$config->set('URI.Base', 'http://www.example.com');
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	291	$config->set('URI.MakeAbsolute', true);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	292	$config->set('AutoFormat.AutoParagraph', true);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	293
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	294
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	295	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	296	5. Caching
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	297
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	298	HTML Purifier generates some cache files (generally one or two) to speed up
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	299	its execution. For maximum performance, make sure that
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	300	library/HTMLPurifier/DefinitionCache/Serializer is writeable by the webserver.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	301
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	302	If you are in the library/ folder of HTML Purifier, you can set the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	303	appropriate permissions using:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	304
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	305	chmod -R 0755 HTMLPurifier/DefinitionCache/Serializer
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	306
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	307	If the above command doesn't work, you may need to assign write permissions
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	308	to all. This may be necessary if your webserver runs as nobody, but is
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	309	not recommended since it means any other user can write files in the
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	310	directory. Use:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	311
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	312	chmod -R 0777 HTMLPurifier/DefinitionCache/Serializer
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	313
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	314	You can also chmod files via your FTP client; this option
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	315	is usually accessible by right clicking the corresponding directory and
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	316	then selecting "chmod" or "file permissions".
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	317
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	318	Starting with 2.0.1, HTML Purifier will generate friendly error messages
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	319	that will tell you exactly what you have to chmod the directory to, if in doubt,
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	320	follow its advice.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	321
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	322	If you are unable or unwilling to give write permissions to the cache
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	323	directory, you can either disable the cache (and suffer a performance
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	324	hit):
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	325
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	326	$config->set('Core.DefinitionCache', null);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	327
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	328	Or move the cache directory somewhere else (no trailing slash):
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	329
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	330	$config->set('Cache.SerializerPath', '/home/user/absolute/path');
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	331
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	332
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	333	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	334	6. Using the code
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	335
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	336	The interface is mind-numbingly simple:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	337
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	338	$purifier = new HTMLPurifier($config);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	339	$clean_html = $purifier->purify( $dirty_html );
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	340
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	341	That's it! For more examples, check out docs/examples/ (they aren't very
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	342	different though). Also, docs/enduser-slow.html gives advice on what to
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	343	do if HTML Purifier is slowing down your application.
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	344
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	345
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	346	---------------------------------------------------------------------------
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	347	7. Quick install
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	348
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	349	First, make sure library/HTMLPurifier/DefinitionCache/Serializer is
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	350	writable by the webserver (see Section 5: Caching above for details).
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	351	If your website is in UTF-8 and XHTML Transitional, use this code:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	352
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	353	<?php
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	354	require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	355
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	356	$config = HTMLPurifier_Config::createDefault();
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	357	$purifier = new HTMLPurifier($config);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	358	$clean_html = $purifier->purify($dirty_html);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	359	?>
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	360
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	361	If your website is in a different encoding or doctype, use this code:
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	362
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	363	<?php
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	364	require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	365
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	366	$config = HTMLPurifier_Config::createDefault();
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	367	$config->set('Core.Encoding', 'ISO-8859-1'); // replace with your encoding
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	368	$config->set('HTML.Doctype', 'HTML 4.01 Transitional'); // replace with your doctype
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	369	$purifier = new HTMLPurifier($config);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	370
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	371	$clean_html = $purifier->purify($dirty_html);
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	372	?>
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	373
e756a8c72c3d integrate drupal and correct build process. update version ymh <ymh.work@gmail.com> parents: diff changeset	374	vim: et sw=4 sts=4

author	ymh <ymh.work@gmail.com>
	Tue, 20 Mar 2018 15:02:40 +0100
changeset 573	25f3d28f51b2
parent 541	e756a8c72c3d
permissions	-rwxr-xr-x