You are here

README.txt in GeSHi Filter for syntax highlighting 8.2

Same filename in this branch
  1. 8.2 README.txt
  2. 8.2 codesnippetgeshi/README.txt
Same filename and directory in other branches
  1. 8 codesnippetgeshi/README.txt
codesnippetgeshi

This plugin allow the use of CodeSnippetGeshi plugin from CKeditor inside
Drupal. It is used to edit source code that will be processed by
Geshifilter module.

=== Installation ===
Go to https://ckeditor.com/cke4/addons/plugins/all and download the following
plugins:

* Ajax(https://ckeditor.com/cke4/addon/ajax)(dependency)
* XML(https://ckeditor.com/cke4/addon/xml)(dependency)
* CodeSnippet(https://ckeditor.com/cke4/addon/codesnippet)(dependency)
* CodeSnippetGeshi(https://ckeditor.com/cke4/addon/codesnippetgeshi)

Extract then into libraries(/libraries) folder. For example, you will have
a file tree like this:

...
core
...
libraries
    ajax
        plugin.js
    codesnippet
        plugin.js
    codesnippetgeshi
        plugin.js
    xml
        plugin.js
...

Go to example.com/admin/config/content/formats(replace example.com with
the real name of your site). Choose one or more texts formats to use the
plugin. In the text format you choose, add the codesnippetgeshi button
to the editor toolbar.

=== Use ===
Click on the button in the toolbar to add a new code block. A popup window
will show. In this new window choose the language you want and add the code
in the textbox. Click on "ok".
Now you are back to node edit. Your code will show in ckeditor, already with
sintax hightlight. If you need to edit, just double click on it.

=== Background Color ===
I set a background color so the code blocks are more visible. If this is not wanted,
I may remove or document how to change it.

File

codesnippetgeshi/README.txt
View source
  1. codesnippetgeshi
  2. This plugin allow the use of CodeSnippetGeshi plugin from CKeditor inside
  3. Drupal. It is used to edit source code that will be processed by
  4. Geshifilter module.
  5. === Installation ===
  6. Go to https://ckeditor.com/cke4/addons/plugins/all and download the following
  7. plugins:
  8. * Ajax(https://ckeditor.com/cke4/addon/ajax)(dependency)
  9. * XML(https://ckeditor.com/cke4/addon/xml)(dependency)
  10. * CodeSnippet(https://ckeditor.com/cke4/addon/codesnippet)(dependency)
  11. * CodeSnippetGeshi(https://ckeditor.com/cke4/addon/codesnippetgeshi)
  12. Extract then into libraries(/libraries) folder. For example, you will have
  13. a file tree like this:
  14. ...
  15. core
  16. ...
  17. libraries
  18. ajax
  19. plugin.js
  20. codesnippet
  21. plugin.js
  22. codesnippetgeshi
  23. plugin.js
  24. xml
  25. plugin.js
  26. ...
  27. Go to example.com/admin/config/content/formats(replace example.com with
  28. the real name of your site). Choose one or more texts formats to use the
  29. plugin. In the text format you choose, add the codesnippetgeshi button
  30. to the editor toolbar.
  31. === Use ===
  32. Click on the button in the toolbar to add a new code block. A popup window
  33. will show. In this new window choose the language you want and add the code
  34. in the textbox. Click on "ok".
  35. Now you are back to node edit. Your code will show in ckeditor, already with
  36. sintax hightlight. If you need to edit, just double click on it.
  37. === Background Color ===
  38. I set a background color so the code blocks are more visible. If this is not wanted,
  39. I may remove or document how to change it.