Presenting Your Code

Presenting Your CodeIan Dees

http://texagon.blogspot.com

Hi, I'm Ian Dees, a software developer for a test equipment manufacturer near Portland, Ore.

Today, we're going to talk about freeing your source code from your text editor and getting it into your presentations.

TextMate

Smultron

http://www.macromates.com

http://smultron.sf.net

The basic ideas will work on any platform, but the screenshots we're looking at today will primarily be from two popular text editors for the Mac.

Let's say we're trying our hand at the great Computer Language Shootout with Ackermann's Function. Here's what one solution looks like inside our text editor.

def ackermann(m, n) $memo ||= {}

$memo[[m, n]] = $memo[[m, n]] ? $memo[[m, n]] : 0 == m ? n + 1 : 0 < m && 0 == n ? ackermann(m - 1, 1) : ackermann(m - 1, ackermann(m, n - 1))end

1.upto(8) {|n| puts ackermann(3, n)}

But if we do a Select All in our text editor and then copy and paste into our presentation, we lose all the pretty syntax highlighting.

We could just take a screenshot from our text editor and paste it into the presentation as a graphic. But that makes for large file sizes and blurry font sizes. And if we distribute our slides as PDFs, readers won't be able to cut and paste our text.

Also, it's a pretty manual process.

1 ! ackermann.rb ! 2007-09-03 23:11 ! Ian Dees

def ackermann(m, n) $memo ||= {}

$memo[[m, n]] = $memo[[m, n]] ? $memo[[m, n]] : 0 == m ? n + 1 : 0 < m && 0 == n ? ackermann(m - 1, 1) : ackermann(m - 1, ackermann(m, n - 1))end

1.upto(8) {|n| puts ackermann(3, n)}

print

If you're using Smultron as your editor, you can print to a PDF and then drag the PDF file into your slide--assuming your slides have a white background.

But I prefer a bit more flexibility. Let's look at HTML for a potential solution. We could just submit our code to Pastie, and then cut/paste the result into our presentation.

<span class="r">def</span><span class="fu">ackermann</span>(m, n)

.r { color:#080; font-weight:bold }

.fu { color:#06B; font-weight:bold }

And since Pastie's stylesheets are pretty simple, we could even tweak the colors before we put the code into our presentation.

http://www.ruby-lang.org

But there's another way that doesn't require a round trip to the Pastie servers every time you want to highlight your code.

First, get Ruby.

gem install syntax

Then, install the Syntax gem.

http://pastie.caboo.se/95056

Finally, grab the Ruby source code from this file and save it to your hard drive somewhere.

⌘B

Now, you can configure your text editor to run the script. In Smultron, hit Cmd-B to bring up the Commands window. Create a new command, bind it to a keystroke if you like, and fill in its contents like this. You'll want to substitute the paths to where you keep your Ruby interpreter and where you saved the script, of course.

Now, whenever you hit your chosen hotkey, Smultron generates the HTML and (if you've enabled it in the script) launches your browser for easy cutting and pasting.

⌘⌥R

The process is similar in TextMate. Just hit Cmd-Option-R to bring up the Filter Through Command dialog, browse to where you saved the script, and select Show as HTML.

When you press Execute, TextMate brings up a new window with highlighted code that remembers its colors...

def ackermann(m, n) $memo ||= {}

$memo[[m, n]] = $memo[[m, n]] ? $memo[[m, n]] : 0 == m ? n + 1 : 0 < m && 0 == n ? ackermann(m - 1, 1) : ackermann(m - 1, ackermann(m, n - 1))end

1.upto(8) {|n| puts ackermann(3, n)}

...when you paste it into a slide, like this.

def ackermann(m, n) $memo ||= {}

$memo[[m, n]] = $memo[[m, n]] ? $memo[[m, n]] : 0 == m ? n + 1 : 0 < m && 0 == n ? ackermann(m - 1, 1) : ackermann(m - 1, ackermann(m, n - 1))end

1.upto(8) {|n| puts ackermann(3, n)}

There will be a few minor differences, of course. Punctuation, class names, and constants might be colored a little differently between your text editor and the resulting HTML. But with a little tweaking, you can get pretty darn close.

⌘⌃R

And in the specific case of TextMate, you can do even better than just "pretty darn close." Run the "TextMate >> Create HTML From Document" command, which is bound to Cmd-Ctrl-R (as opposed to Cmd-Opt-R) on my system. By default, that brings up the raw HTML tags in a new window, but you can configure TextMate to actually render the HTML instead.

Presenting Your CodeIan Dees

http://texagon.blogspot.com

And that's it. Thanks for your time.