Syntax Highlighting with RedCloth

As with the LaTeX problem, I wanted something that could integrate with what I was alreadying using. Parsing the entire text twice was just not an option. RedCloth was already identifying the <code>pre</code> and <code>code</code> blocks because it doesn’t textilse those. I just had to figure out how to intercept and then stylize them. I came across <a href="http://rpheath.com/">Ryan Heath’s blog</a> and his code snippits instantly caught my eye. I shot him an email and asked him what he was using to preform the syntax highlighting. Turned out he was using the Ruby Syntax <a href="http://syntax.rubyforge.org/">gem</a>. Apparently, he tried out <a href="http://ultraviolet.rubyforge.org/">UltraViolet</a>, but couldn’t get it to run on his hosts’ server. I think the UltraViolet gem was overkill for what I wanted to accomplish and that the Syntax gem was just what I needed — simple and fast. Now that I found the tool sytlizing code, I needed to intercept the <code>code</code> blocks from RedCloth. After a little bit of fishing around in the RedCloth <a href="http://redcloth.rubyforge.org/">documentation</a>, I found the function I needed to override: rip_offtags. Before we can begin though, we have to install the Sytax gem. Preform the following on the command line: <pre><code class="multiline_code">> sudo gem install syntax</code></pre>The syntax gem contains a function called <code>convert</code> which takes code and tranforms into HTML with each token of the code put into spans. It is very simple to use. The following is taken directly from its docs: <pre><code class="multiline_code">require 'syntax/convertors/html' convertor = Syntax::Convertors::HTML.for_syntax "ruby" html = convertor.convert( File.read( "program.rb" ) ) puts html</code></pre>From the above, you can see that once we are able to intercept the code blocks from RedCloth, we just pass it onto the <code>convert</code> function and we are done. We are now ready to edit the washcloth.rb file we created when making the LaTeX extension. Add the following to the very begining of the file (before the class tag): <pre><code class="multiline_code">require 'syntax/convertors/html' # for the syntax gem</code></pre>Next we need to copy the existing rip_offtags defintion from redcloth.rb. <pre><code class="multiline_code"># File lib/redcloth.rb, line 1009 OFFTAGS = /(code|pre|kbd|notextile)/ OFFTAG_MATCH = /(?:(<\/#{ OFFTAGS }>)|(<#{ OFFTAGS }[^>]*>))(.*?)(?=<\/?#{ OFFTAGS }|\Z)/mi def rip_offtags( text ) if text =~ /<.*>/ # strip and encode pre content codepre, used_offtags = 0, {} text.gsub!( OFFTAG_MATCH ) do |line| if $3 offtag, aftertag = $4, $5 codepre += 1 used_offtags[offtag] = true if codepre - used_offtags.length > 0 htmlesc( line, :NoQuotes ) unless used_offtags['notextile'] @pre_list.last << line line = "" else # this is the part that we're interested in htmlesc( aftertag, :NoQuotes ) if aftertag and not used_offtags['notextile'] line = "<redpre##{ @pre_list.length }>" @pre_list << "#{ $3 }#{ aftertag }" end elsif $1 and codepre > 0 if codepre - used_offtags.length > 0 htmlesc( line, :NoQuotes ) unless used_offtags['notextile'] @pre_list.last << line line = "" end codepre -= 1 unless codepre.zero? used_offtags = {} if codepre.zero? end line end end text end</code></pre>The code that were need to change is the following: <pre><code class="multiline_code">htmlesc( aftertag, :NoQuotes ) if aftertag and not used_offtags['notextile'] line = "<redpre##{ @pre_list.length }>" @pre_list << "#{ $3 }#{ aftertag }"</code></pre>The local variable, <code>aftertag</code>, contains the unformatted code that we are interested in. What is happening in that block, is RedCloth is passing it off to another function which escapes special characters. Since the syntax gem will do that for us we can use it’s convert function as a drop in replacement. Chage the above code to the following: <pre><code class="multiline_code">if aftertag and not used_offtags['notextile'] convertor = Syntax::Convertors::HTML.for_syntax "ruby" aftertag = convertor.convert(aftertag, false) end line = "<redpre##{ @pre_list.length }>" @pre_list << "#{ $3 }#{ aftertag }"</code></pre>Notice that my call to convert has a second parameter set to <code>false</code>. This is because we already have <code>pre</code> and <code>code</code> tags that RedCloth is going to insert back in for us. Setting the second paramter to <code>false</code> tells convert to not add in <code>pre</code> tags. The only thing left to do is write some custom CSS to tell the browser how we want to style our tokens. <a href="/stylesheets/code.css">Here</a> is a good starting point. Just edit the colors to fit the scheme you have for your own site! <h4>Update:</h4> There is a bug in the current implementation. For instance if you have a <code>pre</code> tag inside your <code>code</code> block, RedCloth will break it out and deal with it separately which then breaks your highlighting. Once solution would be to create <code>[code]</code> blocks like we did for LaTeX rendering, but I am not sure if I like that way. Have to think about this. If you have any good ideas, let me know and post it in the comments!

2008-06-18T00:59:03Z

8 After I implemented LaTeX rendering into my views, I was quite satisfied with how it came out. LaTeX can now be effortless inserted into a field that is textile enabled with very good results. But then I began to look at the code snippits and I realized how ugly they look when compared to the rest of the site. I did a quick web search for ways to incorporate syntax highlighting in Rails applications, but I wasn’t really satisfied with what I found. Then the solution smacked me in the face. Just extend RedCloth! syntax-highlighting-with-redcloth Syntax Highlighting with RedCloth

2008-12-01T01:14:52Z