You are here

Home » API reference » Code Filter 7

README.txt in Code Filter 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6 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 Modules page.

3. Go to Configuration > Text formats. For each format you wish to add Code
   Filter to:

  a. Click the "configure" link.

  b. Under "Enabled filters", check the codefilter checkbox.

  c. Under "Filter processing order", 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
     "Convert line breaks into HTML" filter.

  d. Click the "Save configuration" button.

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

PRISM SUPPORT
-------------

This module package includes support for the Prism highlighting library, which
you can learn more about at http://prismjs.com.

To enable Prism:

1. Enable the codefilter_prism module.

2. Download prism.js and prism.css from prismjs.com and add them to a folder at
   sites/all/libraries/prism or sites/<sitename>/libraries/prism.

3. Following the instructions above to add codefilter parsing to your text
   format.

4. For each format you want Prism support for, check the 'Prism Library Support'
   checkbox.

codefilter_prism will automatically parse code wrapped in <?php ?> and <code>
</code> tags into a Prism compatible format.

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.

Prism integration was incorporated by Joel Pittet and Jakob Perry.

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 Modules page.

  15. 

  16. 3. Go to Configuration > Text formats. For each format you wish to add Code

  17.    Filter to:

  18. 

  19.   a. Click the "configure" link.

  20. 

  21.   b. Under "Enabled filters", check the codefilter checkbox.

  22. 

  23.   c. Under "Filter processing order", rearrange the filtering chain to resolve

  24.      any conflicts. For example, to prevent invalid XHTML in the form of

  25.      '
    ' make sure "Code filter" comes before the

  26.      "Convert line breaks into HTML" filter.

  27. 

  28.   d. Click the "Save configuration" button.

  29. 

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

  31.    code.

  32. 

  33. PRISM SUPPORT

  34. -------------

  35. 

  36. This module package includes support for the Prism highlighting library, which

  37. you can learn more about at http://prismjs.com.

  38. 

  39. To enable Prism:

  40. 

  41. 1. Enable the codefilter_prism module.

  42. 

  43. 2. Download prism.js and prism.css from prismjs.com and add them to a folder at

  44.    sites/all/libraries/prism or sites//libraries/prism.

  45. 

  46. 3. Following the instructions above to add codefilter parsing to your text

  47.    format.

  48. 

  49. 4. For each format you want Prism support for, check the 'Prism Library Support'

  50.    checkbox.

  51. 

  52. codefilter_prism will automatically parse code wrapped in  and 

  53.  tags into a Prism compatible format.

  54. 

  55. CREDITS

  56. -------

  57. 

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

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

  60. 

  61. Prism integration was incorporated by Joel Pittet and Jakob Perry.