- XHTML generation can now be turned off, allowing things like <br>

- Docs updated in preparation for 1.1 release

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@422 48356398-32a2-884e-a903-53898d9a118a

INSTALL

@@ -26,7 +26,7 @@ any earlier versions.
 
 I have been unable to get PHP 5.0.5 working on my computer, so if someone
 wants to test that, be my guest.  All tests were done on Windows XP Home,
-but operating system is quite irrelevant in this particular case.
+but operating system should not be a major factor in the library.
 
 
 
@@ -70,21 +70,36 @@ I cannot stress the importance of these two bullets enough.  Omitting either
 of them could have dire consequences not only for security but for plain
 old usability.  You can find a more in-depth discussion of why this is needed
 in docs/security.txt, in the meantime, try to change your output so this is
-the case.
+the case.  If you can't, well, we might be able to accomodate you (read
+section 3).
+
+
+
+3. Configuring HTML Purifier
+
+HTML Purifier is designed to run out-of-the-box, but occasionally HTML
+Purifier needs to be told what to do.
 
 If, for some reason, you are unable to switch to UTF-8 immediately, you can
 switch HTML Purifier's encoding.  Note that the availability of encodings is
 dependent on iconv, and you'll be missing characters if the charset you
 choose doesn't have them.
 
-    $config = HTMLPurifier_Config::createDefault();
     $config->set('Core', 'Encoding', /* put your encoding here */);
 
 An example usage for Latin-1 websites:
 
-    $config = HTMLPurifier_Config::createDefault();
     $config->set('Core', 'Encoding', 'ISO-8859-1');
 
+For those of you stuck using HTML 4.01 Transitional, you can disable
+XHTML output like this:
+
+    $config->set('Core', 'XHTML', false);
+
+However, I strongly recommend that you use XHTML. Currently, we can only
+guarantee transitional-complaint output, future versions will also allow strict
+output.
+
 
 
 3.   Using the code
@@ -106,7 +121,7 @@ advice on what to do if HTML Purifier is slowing down your application.
 
 4.   Quick install
 
-If your website is in UTF-8, use this code:
+If your website is in UTF-8 and XHTML Transitional, use this code:
 
 <?php
     set_include_path('/path/to/htmlpurifier/library'
@@ -116,7 +131,7 @@ If your website is in UTF-8, use this code:
     
     $clean_html = $purifier->purify($dirty_html);
 
-If your website is in a different encoding, use this code:
+If your website is in a different encoding or doctype, use this code:
 
 <?php
     set_include_path('/path/to/htmlpurifier/library'
@@ -125,6 +140,7 @@ If your website is in a different encoding, use this code:
     
     $config = HTMLPurifier_Config::createDefault();
     $config->set('Core', 'Encoding', 'ISO-8859-1'); //replace with your encoding
+    $config->set('Core', 'XHTML', true); //replace with false if HTML 4.01
     $purifier = new HTMLPurifier($config);
     
     $clean_html = $purifier->purify($dirty_html);