| 1 | [[PageOutline(2-5,Contents,pullout)]] |
| 2 | |
| 3 | = Wiki Extras for Trac = |
| 4 | |
| 5 | == Description == |
| 6 | |
| 7 | '''''This plugin is made for the upcoming Trac 0.13! ''''' |
| 8 | |
| 9 | This plugin extends the Trac Wiki in several ways: |
| 10 | |
| 11 | * Layout information on wiki pages using boxes. Four wiki processors are defined for creating boxes: |
| 12 | * `box` -- The core box processor. |
| 13 | * `rbox` -- Display a right aligned box to show side notes and warnings etc. This will probably be the most used box. |
| 14 | * `newsbox` -- Display news in a right aligned box. ''(This box corresponds to the well-known [th:NewsFlashMacro])'' |
| 15 | * `imagebox` -- Display a single image with caption in a centered box. |
| 16 | * 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). |
| 17 | * Decorate wiki text with the `Color` macro. |
| 18 | * Automatic highlighting of attentional phrases like `FIXME` and `TODO` (configurable). |
| 19 | * HTML 4.0 entities (named entities and numerical entities). ''(Same as in [th:WikiGoodiesPlugin])'' |
| 20 | * Automatic replacement of common text idioms by their corresponding symbols (e.g. arrows, fractions, etc.) ''(Same as in [th:WikiGoodiesPlugin], but configurable.)'' |
| 21 | |
| 22 | Each feature can be disabled individually if needed. |
| 23 | |
| 24 | 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]. |
| 25 | |
| 26 | |
| 27 | == Bugs/Feature Requests == |
| 28 | |
| 29 | Existing bugs and feature requests for WikiExtrasPlugin are |
| 30 | [report:9?COMPONENT=WikiExtrasPlugin here]. |
| 31 | |
| 32 | If you have any issues, create a |
| 33 | [http://trac-hacks.org/newticket?component=WikiExtrasPlugin&owner=mrelbe new ticket]. |
| 34 | |
| 35 | == Download == |
| 36 | |
| 37 | Download the zipped source from [download:wikiextrasplugin here]. |
| 38 | |
| 39 | == Source == |
| 40 | |
| 41 | You can check out WikiExtrasPlugin from [http://trac-hacks.org/svn/wikiextrasplugin here] using Subversion, or [source:wikiextrasplugin browse the source] with Trac. |
| 42 | |
| 43 | == Example == |
| 44 | |
| 45 | 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: |
| 46 | * !WikiBoxes |
| 47 | {{{ |
| 48 | [[AboutWikiBoxes]] |
| 49 | }}} |
| 50 | * !WikiIcons |
| 51 | {{{ |
| 52 | [[AboutWikiIcons]] |
| 53 | }}} |
| 54 | * !WikiPhrases |
| 55 | {{{ |
| 56 | [[AboutWikiPhrases]] |
| 57 | }}} |
| 58 | |
| 59 | |
| 60 | == Recent Changes == |
| 61 | |
| 62 | [[ChangeLog(wikiextrasplugin, 3)]] |
| 63 | |
| 64 | == Author/Contributors == |
| 65 | |
| 66 | '''Author:''' [wiki:mrelbe] [[BR]] |
| 67 | '''Maintainer:''' [wiki:mrelbe] [[BR]] |
| 68 | '''Contributors:''' |