You are here

Home » API reference » Code Filter 6

README.txt in Code Filter 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 7 README.txt
ABOUT
-----

This is a simple filter module. It handles <code></code> and <?php ?> tags so
that users can post code without having to worry about escaping with &lt; and
&gt;


INSTALLATION
------------

1. Copy the codefilter folder to your website's sites/all/modules directory.

2. Enable the codefilter.module on the Administer > Site Building > Modules
   page.

3. Go to Administer > Site configuration > Input formats. For each format you
   wish to add Code Filter to:

  a. Click the "configure" link.

  b. Under "Filters", check the codefilter checkbox.

  c. Click the "Save configuration" button.

  d. Click the "configure" link again and then click the "Rearrange" tab.

  e. Rearrange the filtering chain to resolve any conflicts. For example, to
     prevent invalid XHTML in the form of '<p><div class="codefilter">' make
     sure "Code filter" comes before the "Line break converter".

  f. Click the "Save configuration" button.

4. (optionally) Edit your theme to provide a div.codeblock style for blocks of
   code.


CREDITS
-------

This mini-module was originally made by Steven Wittens <unconed@drupal.org>,
based on the PHP filter in Kjartan Mannes's <kjartan@drupal.org> project.module.

File

README.txt
View source 
  1. ABOUT

  2. -----

  3. 

  4. This is a simple filter module. It handles  and  tags so

  5. that users can post code without having to worry about escaping with < and

  6. >

  7. 

  8. 

  9. INSTALLATION

  10. ------------

  11. 

  12. 1. Copy the codefilter folder to your website's sites/all/modules directory.

  13. 

  14. 2. Enable the codefilter.module on the Administer > Site Building > Modules

  15.    page.

  16. 

  17. 3. Go to Administer > Site configuration > Input formats. For each format you

  18.    wish to add Code Filter to:

  19. 

  20.   a. Click the "configure" link.

  21. 

  22.   b. Under "Filters", check the codefilter checkbox.

  23. 

  24.   c. Click the "Save configuration" button.

  25. 

  26.   d. Click the "configure" link again and then click the "Rearrange" tab.

  27. 

  28.   e. Rearrange the filtering chain to resolve any conflicts. For example, to

  29.      prevent invalid XHTML in the form of '
    ' make

  30.      sure "Code filter" comes before the "Line break converter".

  31. 

  32.   f. Click the "Save configuration" button.

  33. 

  34. 4. (optionally) Edit your theme to provide a div.codeblock style for blocks of

  35.    code.

  36. 

  37. 

  38. CREDITS

  39. -------

  40. 

  41. This mini-module was originally made by Steven Wittens ,

  42. based on the PHP filter in Kjartan Mannes's  project.module.