[[PageOutline(2-5,Contents,pullout)]]

= Wiki Extras for Trac =

== Description ==

 '''''This plugin is made for the upcoming Trac 0.13! '''''

This plugin 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 [th:NewsFlashMacro])''
   * `imagebox` -- Display a single image with caption in a centered box.
 * Decorate wiki pages with a huge set of modern icons, the [http://p.yusukekamiyamane.com Fugue icon library], via the `Icon` macro and as smileys (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 [th:WikiGoodiesPlugin])''
 * Automatic replacement of common text idioms by their corresponding symbols (e.g. arrows, fractions, etc.) ''(Same as in [th:WikiGoodiesPlugin], but configurable.)''

Each feature can be disabled individually if needed.

The [http://p.yusukekamiyamane.com Fugue icon library], with more than 3.000 icons, is contained in this plugin for convenience (though installation time is taking a hit). The icons are released under [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 license], and can be used for any commercial or personal projects, but you may not lease, license or sublicense the icons. Some icons are Copyright (C) [http://p.yusukekamiyamane.com/ Yusuke Kamiyamane].


== Bugs/Feature Requests == 

Existing bugs and feature requests for WikiExtrasPlugin are 
[report:9?COMPONENT=WikiExtrasPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=WikiExtrasPlugin&owner=mrelbe new ticket].

== Download ==

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

== Source ==

You can check out WikiExtrasPlugin from [http://trac-hacks.org/svn/wikiextrasplugin here] using Subversion, or [source:wikiextrasplugin browse the source] with Trac.

== 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]]
}}}


== Recent Changes ==

[[ChangeLog(wikiextrasplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:mrelbe] [[BR]]
'''Maintainer:''' [wiki:mrelbe] [[BR]]
'''Contributors:'''