Syntax Highlighting with Python Pygments

<?php

/**

DIRECTIONS:

1. Edit $codePath to point to a folder where you've kept source code files to 
apply syntax highlighting to.
2. Create a file called "test.html" and place it in the $codePath folder.
3. Save this as a snippet called "Pygmentize".
4. Insert the following into a template: [[Pygmentize? &file=`somefile.ext`]] 
where "somefile.ext" is either test.html or some other file you want to highlight.

**/



// Define the absolute path to the file we want to use as our source code to 
// highlight.

// Assumes you have created a folder in assets called "code"
$codePath = '/PATH/TO/assets/code/';

// Assumes you have created a test file called "test.html" and placed it in 
// your /assets/code directory. 
// Also assumes you will call this snippet and provide a file name like this:  
// [[Pygmentize? &file=`yourfile.ext`]]
$fileName = empty($scriptProperties['file']) ? 'test.html' : $scriptProperties['file'];

$filePath = $codePath . $fileName;



// The next lines of code set command line options (flags), based on whether or 
// not those options were specified in the snippet call. In other words, we're 
// converting MODX snippet call parameters into system command line parameters 
// to use with the "pygmentize" CLI command.
// 
// See also: http://pygments.org/docs/cmdline/

// If a lexer wasn't specified, leave this empty so Pygments can choose one 
// based on the file extension.
$lexer = empty($scriptProperties['l']) ? ('') : (' -l ' . $scriptProperties['l']);

// If a formatter wasn't specified, default to HTML.
$formatter = empty($scriptProperties['f']) ? (' -f html') : (' -f ' . $scriptProperties['f']);

// If options were not specified, leave it blank. Otherwise, wrap in quotes.
// NOTE: has not been tested with multiple options
$options = empty($scriptProperties['O']) ? ('') : (' -O "' . $scriptProperties['O'] . '"');



// If CSS output has not been disabled, register it for the current MODX resource.
// To disable CSS output, add this to the MODX snippet tag: &S=`off`
if (($scriptProperties['S'] != 'none') && ($scriptProperties['S'] != 'off')) {

    ob_start();

    // If a style was specified, use it for the CSS output.
    $style = empty($scriptProperties['S']) ? (' -S default') : (' -S ' . $scriptProperties['S']);

    // If an "a" value was specified, use it for the CSS output class prefix. 
    // Otherwise, default to the prefix ".sh".
    $a = empty($scriptProperties['a']) ? (' -a .highlight') : (' -a ' . $scriptProperties['a']);

    $cssCommand = 'pygmentize' . $formatter . $style . $a;

    system(escapeshellcmd($cssCommand));

    $css = ob_get_clean();

    $modx->regClientCSS('    <style type="text/css">' . "\n" . $css . "\n" . '    </style>');
}



$pygCommand = 'pygmentize' . $lexer . $formatter . $options . ' ' . $filePath;

system(escapeshellcmd($pygCommand));

location /assets/code/ {
    types  { }
    default_type  text/plain;
}

apt-get install python-pygments

[[*longtitle]]
[[*pagetitle]]
[[*content]]

[[SyntaxHighlighter? &brushes=`JScript`]]
<pre class="brush: js">
    ~50 lines of code
</pre>

[[Pygmentize? &S=`friendly` &file=`test.js`]]

                 SyntaxHighlighter

             Load Time    First Byte    Start Render
Run  1-10    0.335s       0.093s        0.297s
Run 11-20    0.310s       0.093s        0.337s
-----------------------------------------------------
Average      0.323s       0.093s        0.317s



                    Pygmentize

             Load Time    First Byte    Start Render
Run  1-10    0.219s       0.091s        0.191s
Run 11-20    0.228s       0.095s        0.204s
-----------------------------------------------------
Average      0.224s       0.093s        0.198s