Version 34 (modified by Andras Korn, 4 years ago) (diff)

Lift color macro docs from source into wiki page

Wiki Extras for Trac


This plugin is made for Trac 1.0 It could work with Trac 0.12, but the visual impression may not be as intended.

The WikiExtrasPlugin extends the Trac Wiki in several ways:

  • Layout information on wiki pages using boxes. Four wiki processors are defined for creating boxes:
    • box -- The core box processor.
    • rbox -- Display a right aligned box to show side notes and warnings etc. This will probably be the most used box.
    • newsbox -- Display news in a right aligned box. (This box corresponds to the well-known NewsFlashMacro)
    • imagebox -- Display a single image with caption in a centered box.
  • Decorate wiki pages with a huge set of modern icons via wiki markup (|name|), or the equivalent Icon macro, and as smileys (smiley characters are configurable).
  • Decorate wiki text with the Color macro.
  • Automatic highlighting of attentional phrases like FIXME and TODO (configurable).
  • HTML 4.0 entities (named entities and numerical entities). (Same as in WikiGoodiesPlugin)
  • Automatic replacement of common text idioms by their corresponding symbols, eg arrows, fractions, etc. (Same as in WikiGoodiesPlugin, but configurable.)
  • Replace \\... UNC paths with file:/// links. (Same as in WikiGoodiesPlugin)

Each feature can be disabled individually if needed.

Icon Library License Terms

The icon library contained in this plugin is composed of the Fugue icon library with additional icons, and can be used for any commercial or personal projects, but you may not lease, license or sublicense the icons. The icon library is provided for convenience, though download and installation time is taking a hit since it contains more than 3000 unique icons in two flavors; shadowed and shadowless, yielding a grand total of almost 7000 icon files. The library is released under Creative Commons Attribution 3.0 license. Some icons are Copyright (C) Yusuke Kamiyamane, where all rights are reserved.

Additional icons are released under same license terms as Trac. Some icons are Copyright (C) Edgewall Software. All rights reserved.

See Also

ColorMacro, EmoticonsPlugin, EntityMacro, NewsFlashMacro, NoteBoxPlugin, TracFigureMacro and WikiGoodiesPlugin.

Bugs/Feature Requests

Existing bugs and feature requests for WikiExtrasPlugin are here. Some have been closed.

If you have any issues, create a new ticket.


12 / 18


1 / 6


1 / 1


trunk (1.0dev) -- To use this plugin according to built in instructions, Trac 1.0 or newer is required.

  • [download:wikiextrasplugin/trunk Download the zipped source]
  • Browse the source with Trac
  • Check out using Subversion:
    svn co


See generic instructions in Trac:TracPlugins#InstallingaTracPlugin.


Activate the plugin by adding the following line to your trac.ini file:

tracwikiextras.* = enabled

The WikiGoodiesPlugin should be deactivated when this plugin is used.

The built in documentation of the plugin explains the configuration thoroughly. The following examples are provided as an overview of the customization capabilities of the plugin.

Configure boxes (showing default configuration):

rbox_width = 300
shadowless_boxes = false
wide_toc = false

Configure icons (showing default configuration):

icon_limit = 32
showicons_limit = 96
shadowless_icons = false

Configure smileys (example):

_remove_defaults = true
smiley = :-) :)
smiley-wink = ;-) ;)

Configure attentional phrases (showing default configuration):

fixme_phrases = BUG, FIXME
todo_phrases = REVIEW, TODO

Configure symbols (example):

_remove_defaults = true
&laquo; = <<
&raquo; = >>
&hearts; = <3

WikiGoodiesPlugin refugees might find the following compatibility definitions useful:

exclamation--frame = /!\
exclamation-diamond-frame = <!>
thumb = {DN} {!OK}
thumb-up = {UP} {OK}
star = {*}
star-empty = {o}
light-bulb = (!)
priority1 = {p1} {P1}
priority2 = {p2} {P2}
priority3 = {p3} {P3}

Note: The priority smileys as defined above, {p1} etc, may not work since they conflict with InterTrac ticket report references (#1799), which are handled by the Trac core.

Color macro syntax


[[Color(text, fg/bg/size)]]


  • text is the text to decorate. Enter a leading and/or trailing space character to surround the text with a decorated space.
  • fg/bg/size defines the foreground and background colors, and a font size. All parameters are optional and separated by slash character (/).

Colors may be specified as an RGB triplet in hexadecimal format (a hex triplet; e.g. #000 or #000000 for black); they may also be specified according to their common English names (e.g. red, green, blue etc.). See here for details.


[[Color(Large red on yellow, red/yellow/150%)]]
[[Color(Red on yellow, red/yellow)]]
[[Color(Yellow background, /yellow)]]
[[Color(Large red, #f00/2em)]]
[[Color(Large on yellow, /yellow/20px)]]
[[Color(Text, can, have, commas, /yellow)]]
[[Color( Surrounding space is also decorated , white/red)]]

To set the foreground color for a larger block, the processor variant can be used (background color and font size may not display as expected due to the mechanisms of cascading style sheets, be advised and use the color parameter only):

{{{#!Color color=green


There are 3 macros that can be used to show detailed instructions to wiki authors on how to use some of these features, suitable to be placed on one wiki page each:

  • WikiBoxes:
  • WikiIcons:
  • WikiPhrases:

Please also see the built in plugin documentation presented in the plugin admin panel of your Trac environment.

Recent Changes

17307 by jun66j5 on 2018-11-07 02:56:04
TracWikiExtras 1.3.1dev: fix unable to escape symbol markups (closes #13497)
17305 by jun66j5 on 2018-11-05 07:03:03
TracWikiExtras 1.3.1dev: fix unit tests failing
17033 by rjollos on 2018-02-14 23:28:55
TracWikiExtras 1.3.1dev: Make imports compatible with Trac < 1.0.2

Refs #13374.



Author: mrelbe and cboos
Maintainer: Mikael Relbe

This plugin is based on the WikiGoodiesPlugin by cboos. Also, kudos to cboos (again) for the icon wiki markup idea: (|name|)