Version 13 (modified by Alexander Slesarev, 8 years ago) (diff)

Added title description.

Code example box with syntax highlighting


The CodeExampleMacro renders a code example box that supports syntax highlighting. It support three types of examples: simple, correct, and incorrect. The SELECT ALL link highlights all of the code in the box to simplify the copy and paste action.

All rights reserved by Codedgers Inc.

Bugs/Feature Requests

Existing bugs and feature requests for CodeExampleMacro are here.

If you have any issues, create a new ticket.


Download the zipped source from [download:codeexamplemacro here].


You can check out CodeExampleMacro from here using Subversion, or browse the source with Trac.


The simple example:

def get_templates_dirs():
    """ Notify Trac about templates dir. """
    from pkg_resources import resource_filename
    return [resource_filename(__name__, 'templates')]

will be rendered as:

The incorrect example:

## type = bad
fibs = 0 : 1 : [ a + b | a <- fibs | b <- tail fibs ]

will be rendered as:

The correct example:

## type = good
fibs = 0 : 1 : zipWith (+) fibs (tail fibs)

will be rendered as:

There is also support for getting sources from the repository:

## path=GPGMail/Source/GPGMailPreferences.m
## regex=".*updater\s*{"
## lines=3

will be rendered as:


  • type - (optional) a type of the example: simple (default), good, bad
  • title - (optional) the title of the example
  • path - (optional) a file in the repository (using TracLinks format for source code)
  • regex - (optional) a regular expression indicates where to start an example
  • lines - (optional) number of lines to show

Recent Changes

14903 by rjollos on 2015-09-21 15:43:45
Removes svn:mime-type text/plain.
14039 by rjollos on 2014-07-26 00:37:54
1.2: Include images in egg and fixed links to sample screenshots. Fixes #8331.

Thanks to AllenB and ilewismsl for the patches.

14038 by rjollos on 2014-07-26 00:37:35
Added URL to and bumped version to 1.1. Refs #9716.


Author: nuald
Maintainer: nuald

Attachments (7)

Download all attachments as: .zip