wiki:WikiExtrasPlugin

Version 25 (modified by rjollos, 18 months ago) (diff)

Added syntax highlighting.

Wiki Extras for Trac

Description

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 (e.g. 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 3.000 unique icons in two flavors; shadowed and shadowless (yielding a grand total of almost 7.000 icon files).

The Fugue icon library is released under Creative Commons Attribution 3.0 license.
Some icons are Copyright (C) Yusuke Kamiyamane. All rights 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.

If you have any issues, create a new ticket.

Download Source

  • trunk (0.13.2dev) -- To use this plugin according to built in instructions, Trac 0.13dev r10730 is required.

Install

See generic instructions in Trac:TracPlugins#InstallingaTracPlugin.

Configuration

Activate the plugin:

[components]
tracwikiextras.* = enabled

The WikiGoodiesPlugin should be deactivated when this plugin is used.

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

Configure boxes (showing default configuration):

[wikiextras]
rbox_width = 300
shadowless_boxes = false
wide_toc = false

Configure icons (showing default configuration):

[wikiextras]
icon_limit = 32
showicons_limit = 96
shadowless_icons = false

Configure smileys (example):

[wikiextras-smileys]
_remove_defaults = true
smiley = :-) :)
smiley-wink = ;-) ;)

Configure attentional phrases (showing default configuration):

[wikiextras]
fixme_phrases = BUG, FIXME
todo_phrases = REVIEW, TODO
done_phrases = DONE, DEBUGGED, FIXED, REVIEWED

Configure symbols (example):

[wikiextras-symbols]
_remove_defaults = true
&laquo; = <<
&raquo; = >>
&hearts; = <3

WikiGoodiesPlugin refugees might find the following compatibility definitions useful:

[wikiextras-smileys]
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.

Example

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
    [[AboutWikiBoxes]]
    
  • WikiIcons
    [[AboutWikiIcons]]
    
  • WikiPhrases
    [[AboutWikiPhrases]]
    

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

Recent Changes

[11714] by mrelbe on 2012-07-08 15:11:24
WikiExtrasPlugin/0.13.2dev: Fugue Icon Library Version 3.4.4 (June 20, 2012)
[11430] by mrelbe on 2012-03-25 22:14:50
WikiExtrasPlugin/0.13.2dev: Fugue Icon Library Version 3.3.4 (March 15, 2012)
[11095] by mrelbe on 2012-01-02 17:22:50
WikiExtrasPlugin/0.13.2dev: Fugue Icon Library Version 3.3 (November 19, 2011)

Author/Contributors

Author: mrelbe and cboos
Maintainer: mrelbe
Contributors:

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