18 votes

EyeCatch Syntax Highlighter

One of the main issues when posting code on a blog is that it is very hard to read. Several javascript libraries have been made to solve this problem, and the most used one to date is Syntax Highlighter by Alex Gorbatchev.

My website is running on Umbraco and it uses TinyMCE v3 as text editor. Inspired by the old SyntaxHighlighter plugin by Nawaf Albadia I created a new and improved version that is compatible with the latest version of Syntax Highlighter (3.0.83).

I also created a version that is designed to run on Umbraco v4.7 and also leverages the power of Client Dependency Framework. This means that all the necessary stylesheets and javascripts are added and minified automatically. All you need to do is to add one line to your master template.

HOW TO INSTALL:

  1. Uninstall the installed version (otherwise TinyMCE.config will be messed up).
  2. Head over to the project page on our.umbraco.org and download the package there.
  3. Install it in the Developer section in Umbraco by clicking "Packages" -> "Install local package". Browse to the file you downloaded and click install.
  4. Then add the macro "EyeCatch Syntax Highlighter" to the <head /> section of the page you want syntax highlighting on. If you want to use a different theme than the default one, just specifiy the name in the "Theme" parameter. Otherwise leave blank.
    Note: This version of the package requires that jQuery is loaded on your page before the macro. In future versions this will not be needed.
  5. Open a content page with a richtext editor on it, and click the code icon to the right on the toolbar. Paste your code in the window that appears, choose the language and then optionally some settings.

HOW TO USE:

  1. Go to a content page with the TinyMCE editor on it. Click the code button that has now appeared on the right side of the toolbar.
  2. Paste your code in the textarea, select the language and optionally set some settings.
  3. Press insert and then save your page.
Thats it! Simple eh?

AVAILABLE THEMES

  • Default (blank)
  • Django
  • Eclipse
  • Emacs
  • Fade To Grey
  • Midnight
  • RDark

You can also use a custom theme by uploading your css file to "/umbraco_client/tinymce3/plugins/syntaxhighlighter/styles/themes/" and specifying the file name (without .css) as the Theme parameter.

VERSION HISTORY

Version 1.2
No longer dependent on jQuery.

Works with latest Umbraco versions.

Version 1.1.1
Runat="server" in <head> element no longer needed.
Fixed uninstall bug where command element would not properly be removed from tinymceconfig.config.

Version 1.1
Added possibility of editing code snippets from TinyMCE.
Fixed bug where scripts would be loaded outside <html> tags

Version 1.0.1
Fixed bug where inserted scripts and styles would be inserted after </html> insted of in <head>
Tweaked HTML generation of the TinyMCE plugin.

Version 1.0
Initial release

Screenshots

Package owner

Ove Andersen

Ove Andersen

Ove has 1536 karma points

Package Compatibility

This package is compatible with the following versions as reported by community members who have downloaded this package:
Untested or doesn't work on Umbraco Cloud
8.0.x (untested)
7.12.x (untested)
7.11.x (untested)
7.10.x (untested)
7.9.x (untested)
7.8.x (untested)
7.7.x (untested)
7.6.x (untested)
7.5.x (untested)
7.4.x (untested)
7.3.x (untested)
7.2.x (untested)
7.1.x (untested)
7.0.x (untested)
6.1.x (untested)
6.0.x (untested)

You must login before you can report on package compatibility.

Package Information

  • Package owner: Ove Andersen
  • Created: 28/05/2011
  • Current version 1.2
  • License GPLv3
  • Downloads: 3921

External resources