Web Programming: Code Syntax Highlight Plugin for FCKeditor

Introduction

This is a dialog-based plugin to handle formatting of source code for FCKeditor 2.5.x. It WON’T work with the new CKEditor (yet). It makes use of the SyntaxHighlighter 2.0.xjavascript library available to download from Alex Gorbatchev’s project page (the older version 1.5.1 version is available from Google Code).

The plugin primiarily edits a <pre> tag with some custom attributes. Its mainly aimed at users editing blogs or content management systems where there is a requirement to format programming languages on a website that is being edited using FCKEditor.

The plugin will not format the code in FCKEditor – the SyntaxHighlighter javascript library dynamically generates a lot of formatted HTML at runtime, which would cause problems in FCKEditor.

Skip straight to the good bits

Can’t be bothered reading all this? View the online demo or download the plugin and go play with it yourself.

So what do I get then?

Correctly installed, the plugin is in the form of a tabbed dialogue box that looks like this:

Syntax Highlighter dialogue

Version history:

Huge thanks goes to Sergey Gurevich who wrote the updated code for the FCKEditor plugin to handle the latest version of the SyntaxHighlighter code and submitted useful bug fixes.

  • v2.1.0 [23 May 2009]
    – Plugin version information now being displayed
    – Line highlighting feature added
    DownloadDemo
  • v2.0.1 [22 March 2009]
    Minor bug fix where semi-colons were sometimes positioned in the wrong place when no advanced options were selected
    Download
  • v2.0 [2 March 2009]
    Latest version supporting SyntaxHighlighter 2.0.x
  • v1.0.2 [2 March 2009]
    Bug fixes, final release supporting the older SyntaxHighlighter 1.5.1
    Note the instructions below are for the newer version of the library and makes references to syntaxhighlight2 a lot, this version uses syntaxhighlight. The documentation in the download will be more accurate.
    Download.| Demo
  • v1.0.1 [10 Feb 2009].
  • v1.0 [30 Nov 2008]. First version.

Known bugs:

Occasionally the dialogue box does not pickup the <pre> element to be edited in Firefox. It only seems to happen when a user clicks inside the <pre> tag with the mouse but doesn’t actually move or interact with the cursor.
Fixed in version 1.0.2 – Thanks to Sergey Gurevich

Installation

1. Copying the files

Extract the contents of the zip in your plugins directory, so it ends up like this:
Folder structure

Note: Version 2 of the plugin must be extracted to a directory named ‘syntaxhighlighter2‘. The older plugin for the earlier version of the library must go in a folder named ‘syntaxhighlighter‘. The file fckplugin.js references this directory when the plugin initialises.

2. Adding it to FCKeditor

Now add in your fckconfig.js or custom js configuration file the following line (remember its javascript we are dealing with so everything is case sensitive!):

FCKConfig.Plugins.Add( 'syntaxhighlight2', 'en') ;

3. Adding it to the toolbarset

Add the button ‘SyntaxHighLight2’ button to your toolbarset:

FCKConfig.ToolbarSets["Basic"] = [
['Bold','Italic','-','OrderedList','UnorderedList','-','Link','Unlink','-','SyntaxHighLight2','-','About']
] ;

4. Configure the plugin

The plugin will work ‘out of the box’, but you can configure a default language using theSyntaxHighlight2LangDefault parameter:

FCKConfig.SyntaxHighlight2LangDefault = 'csharp' ;

The full list of languages and corresponding codes are:

    • c++ – C++
    • csharp – C#
    • css – CSS
    • delphi – Delphi
    • java – Java
    • jscript – Java Script
    • php – PHP
    • python – Python
    • ruby – Ruby
    • sql – SQL
    • vb – VB.NET
    • xhtml – XML/HTML

In FCKEditor <pre> blocks aren’t really formatted by default. I suggest editing yourfck_editorarea.css (or equivalant if you are using a custom CSS file) to something that highlights code blocks better. eg:

pre
{
background-color: #fff;
font-family: "Consolas" , "Courier New" ,Courier,mono,serif;
font-size: 12px;
color: blue;
padding: 5px;
border: 1px dashed blue;
}

Configuring SyntaxHighlighter.

You must have SyntaxHighlighter installed and working to display properly formatted code. FCKEditor does not need it, but for code to be properly formatted on your website you must have it configurated correctly. For SyntaxHighlighter2 Alex Gorbatchev’s sitehas loads of excellent information (he wrote it after all!), for the old version 1.5.1 library, the project wiki here is a good resouce, or this blog post might also be useful.

5. Use it

Now clear your browser cache (this stage is important!) and reload the editor, the new button Insert code snippet button should be ready to use.

6. Future updates

There’s some additional functionality I might add at a later date:

  • Preview tab using the SyntaxHighlighter library
  • More configuration options, eg, available languages, path to SyntaxHighlighter files
  • Dynamically adding a <pre> formatting style to the editor by default

7. And finally…

Thanks goes to Alex Gorbatchev for creating Syntax Highlighter!.

source: http://psykoptic.com

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s