Version 11 (modified by Ryan J Ollos, 8 years ago) (diff)

Added pageoutline.

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 apply_timer(self):
        timer = QTimer(self)
        self.connect(timer, SIGNAL('timeout()'), self.update_statusbar)

will be rendered as:

The simple example image.

The incorrect example:

    def create_hint_list(self):

will be rendered as:

The incorrect example image.

The correct example:

    def update_statusbar(self):
        self.combo_box.insertItem(0, self.hints.get_current_hint())

will be rendered as:

The correct example image.

The is also support for getting sources from the repository using CodeExamplePath, BadCodeExamplePath, GoodCodeExamplePath.

regex="def update_statusbar"

will be rendered as:

The correct example image.

Parameters for *Path macros:

  • path - a file in the repository
  • regex - (optional) a regular expression indicates which to start getting
  • lines - (optional) limits number of lines of code to get

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