Version 16 (modified by 13 years ago) (diff) | ,
---|
Contents
Code example box with syntax highlighting
Notice: This plugin is unmaintained and available for adoption.
Description
The CodeExampleMacro renders a code example box that supports syntax highlighting. It support three types of examples: simple, correct, and incorrect.
Features:
- The SELECT ALL link highlights all of the code in the box to simplify the copy and paste action.
- A mouse click on the header (title) will show or hide the code block.
- Code from the repository can be displayed using TracLinks syntax. The multiple repository configuration (Trac >= 0.12) is supported.
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
Download the zipped source from [download:codeexamplemacro here].
Source
You can check out CodeExampleMacro from here using Subversion, or browse the source with Trac.
Example
The simple example:
{{{ #!CodeExample #!python @staticmethod 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:
{{{ #!CodeExample ## type = bad #!haskell fibs = 0 : 1 : [ a + b | a <- fibs | b <- tail fibs ] }}}
will be rendered as:
The correct example:
{{{ #!CodeExample ## type = good #!haskell fibs = 0 : 1 : zipWith (+) fibs (tail fibs) }}}
will be rendered as:
There is also support for getting sources from the repository:
{{{ #!CodeExample ## path=GPGMail/Source/GPGMailPreferences.m ## regex=".*updater\s*{" ## lines=3 #!objective-c }}}
will be rendered as:
Parameters:
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) |
repo | optional | repository to use (Trac 0.12 and upper only) |
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.
- 14038 by rjollos on 2014-07-26 00:37:35
-
Added URL to
setup.py
and bumped version to 1.1. Refs #9716.
(more)
Author/Contributors
Attachments (7)
-
example.png (15.8 KB) - added by 15 years ago.
The simple example image.
-
correct_example.png (12.9 KB) - added by 15 years ago.
The correct example image.
-
incorrect_example.png (8.9 KB) - added by 15 years ago.
The incorrect example image.
- example1.png (23.2 KB) - added by 14 years ago.
- example2.png (20.1 KB) - added by 14 years ago.
- example3.png (25.9 KB) - added by 14 years ago.
- example4.png (15.0 KB) - added by 14 years ago.
Download all attachments as: .zip