Drupal 6 syntaxhighlighter module

This Drupal 6 module does program code list syntax highlighting like this:

class Person(ln : String, fn : String, s : Person)
{
    def lastName = ln;
    def firstName = fn;
    def spouse = s;
    
    def this(ln : String, fn : String) = { this(ln, fn, null); }

    def introduction() : String = 
        return "Hi, my name is " + firstName + " " + lastName +
            (if (spouse != null) " and this is my spouse, " + spouse.firstName + " " + spouse.lastName + "." 
             else ".");
}

It uses the Syntax Highlighter Javascript library to perform the highlighting on the client browser.

The module is at the Drupal Syntaxhighlighter module project page. Before installing the module, first download the latest Syntax Highlighter Javascript Library. Unzip the entire content into a sub-directory inside sites/all/libraries. You can use any directory name, in any level of nesting or even no directory. You can delete the 'src' directory from the extracted files if you want. It's not needed for normal usage. Then install the module. Refer to the module README.txt file for details.

Module configuration

Go to 'admin/settings/syntaxhighlighter' to make configuration change:

(The checkboxes and radio buttons are displayed in columns above with the Multi-column checkboxes radios module. Install and enable that module to get it display like it's here. Otherwise, the checkboxes and radio buttons are in single long column.)

The first set of checkboxes allow you to selectively enable languages. You may want to enable only the languages you need to avoid loading unnecessary Javascript files. However, choosing all should not be any problem in any case because browses cache Javascript files.

The theme radio buttons let you choose the stylesheet used by the Syntax highlighter display.

The "Tag name" setting lets you change the code markup tag to some other legal html tag if <pre> for some reason cannot be used. For example, you can use the <code> tag instead.

Enable "Legacy mode" to support old style markup format. For most users this should just be disabled. This is provided in case you have contents that use the old style Syntax highlighter markup.

Use the "Turn off Syntax Highlighter on these pages" setting to disable the Syntax highlighter to avoid compatibility problem.

The "Default expressions" setting let you enter Javascript statements to initialize the Syntax highlighter to some site wide defaults.

Visit the 'admin/help/syntaxhighlighter' page for module help.

Content markup

Markup your program listing like this:

{syntaxhighlighter OPTIONS}
// paste your code verbatim in between the markup
#include <iostream>
// etc etc etc
{/syntaxhighlighter}

where OPTIONS is a syntax highlighter options string. See the Syntax Highlighter Javascript library page for details. To highlight some C++ code:

{syntaxhighlighter brush: cpp}
// paste your code verbatim in between the markup
#include <iostream>
// etc etc etc
{/syntaxhighlighter}

and that becomes:

// paste your code verbatim in between the markup
#include <iostream>
// etc etc etc

Click to see a sample of all syntax highlighted languages.

TinyMCE Wysiwyg editor integration

This provides a Syntax Highlighter button:

that brings up the Syntax Highlighter dialog:

where you can insert code and configure the syntax highlighter property. You can see this in action on the comment form below.

See the bottom of this module's project page for detail on how to setup this.

The GeSHi Filter module also does syntax highlight. It is a server side filter, so processing is done using PHP inside Drupal on the web server. Whereas this module off loads the processing entirely to the client browser.