Recently I worked on some API documentation with dozens of examples of code snippets. Anyone who reads code will tell you that color coding (syntax highlighting) makes code much easier to read.
Since I was writing the API documentation in Madcap Flare, I needed a tool that I could use in that environment. Initially I tried the Syntax Highlighter, but I couldn’t get it to work for me. So I did another search, and discoveredÂ Prettify, a syntax highlighter by Google, and that worked like a charm.
To use Prettify with Madcap Flare:
- Download the Prettify tar file and unzip it (I used Winzip).
- Copy the files from the distrib/google-code-prettifyÂ folder.
- In your Flare project, paste the files into the Resources folder (I created a Prettify subfolder under Resources).
- In Flare, open the topic containing the code snippet in the Internal Text Editor.
- In the <body> tag, add the onload instruction (B).
- Add <pre> tags around your code snippet, specifying the prettyprintÂ class (C).
NOTE: This doesn’t work for PDF output.
Update September 12, 2012: Check out the MadBlog for instructions on how to use Prettify across all the topics in your project.