| 1 | | = Note boxes with icons = |
| 2 | | [[PageOutline(2-5,Contents,pullout)]] |
| 3 | | |
| 4 | | == Description == |
| 5 | | |
| 6 | | !NoteBox Plugin will render an HTML-!DivContainer in different colors with different Icons. |
| 7 | | [[BR]] |
| 8 | | The following containers are possible: |
| 9 | | |
| 10 | | * ![[NoteBox(warn, my Text)]] |
| 11 | | * will render a red div-container with the given Text and a stopsign-image |
| 12 | | * ![[NoteBox(tip, my Text)]] |
| 13 | | * will render a green div-container with the given Text and a lightbulb-image |
| 14 | | * ![[NoteBox(note, my Text)]] |
| 15 | | * will render a blue div-container with the given Text and a notepaper-image |
| 16 | | [[BR]] |
| 17 | | |
| 18 | | It will look like this: |
| 19 | | [[Image(notebox_preview_v0.1.png)]] |
| 20 | | |
| 21 | | The [http://trac.edgewall.org/browser/tags/trac-0.11/trac/wiki/api.py?marks=118-139#L118 parse_args] function from the Trac API is used to parse the input, therefore commas must be escaped with a backslash. That is, make the following replacement: `,` -> `\,`. Everything in the second argument is interpreted as wiki markup, however a second macro cannot be embedded within the macro. |
| 22 | | |
| 23 | | == See Also == |
| 24 | | |
| 25 | | WikiExtrasPlugin |
| 26 | | |
| 27 | | == Bugs/Feature Requests == |
| 28 | | |
| 29 | | Existing bugs and feature requests for NoteBoxPlugin are |
| 30 | | [report:9?COMPONENT=NoteBoxPlugin here]. |
| 31 | | |
| 32 | | If you have any issues, create a |
| 33 | | [http://trac-hacks.org/newticket?component=NoteBoxPlugin&owner=rjollos new ticket]. |
| 34 | | |
| 35 | | == Download / Source == |
| 36 | | |
| 37 | | Download the zipped source from [download:noteboxplugin here]. |
| 38 | | |
| 39 | | You can check out NoteBoxPlugin from [/svn/noteboxplugin here] using Subversion, or [source:noteboxplugin browse the source] with Trac (the anchor will only be present in Trac 0.12 or later, so you'll have to scroll to the appropriate location the page in earlier version of Trac. |
| 40 | | |
| 41 | | == Installation == |
| 42 | | |
| 43 | | For detailed installation steps, please refer to t:TracPlugins. The following steps should work for most Trac configurations. |
| 44 | | |
| 45 | | 1. Unzip the code and type |
| 46 | | {{{ |
| 47 | | $>python setup.py install |
| 48 | | }}} |
| 49 | | 2. or use {{{easy_install}}} as below then, restart web server, finally enable it at {{{admin/general/plugins}}} |
| 50 | | {{{ |
| 51 | | #!sh |
| 52 | | easy_install http://trac-hacks.org/svn/noteboxplugin/0.11 |
| 53 | | }}} |
| 54 | | |
| 55 | | If the plugin is installed and functioning correctly, you should see example of its use at WikiMacros#NoteBox-macro. |
| 56 | | |
| 57 | | == Example == |
| 58 | | |
| 59 | | Use either |
| 60 | | * '''![[NoteBox(warn, my Text)]]''' |
| 61 | | * '''![[NoteBox(tip, my Text)]]''' |
| 62 | | * '''![[NoteBox(note, my Text)]]''' |
| 63 | | where ''my Text'' can be replaced with your text. |
| 64 | | |
| 65 | | == Recent Changes == |
| 66 | | |
| 67 | | [[ChangeLog(noteboxplugin, 3)]] |
| 68 | | |
| 69 | | == Author/Contributors == |
| 70 | | |
| 71 | | '''Author:''' [wiki:gruenebe] [[BR]] |
| 72 | | '''Maintainer:''' rjollos [[BR]] |
| 73 | | '''Contributors:''' |
| | 1 | [[redirect(NoteBoxMacro)]] |
